json_comments-0.2.2/.cargo_vcs_info.json0000644000000001360000000000100137130ustar { "git": { "sha1": "e97d7f521676e78d70637ee7ff3d3a4bfc845a56" }, "path_in_vcs": "" }json_comments-0.2.2/.github/workflows/build.yml000064400000000000000000000013301046102023000177170ustar 00000000000000name: Build on: push: branches: [main] paths_ignore: '*.md' pull_request: jobs: build: runs-on: ubuntu-latest strategy: matrix: rust: - stable - beta - nightly continue-on-error: ${{ matrix.rust == 'nightly' }} steps: - uses: actions/checkout@v2 - uses: actions-rs/toolchain@v1 with: toolchain: ${{ matrix.rust }} profile: minimal override: true components: rustfmt, clippy - name: Build run: cargo build -v - name: Test run: cargo test -v - name: Format check run: cargo fmt -v -- --check - name: Lint run: cargo clippy -- -D warnings json_comments-0.2.2/.gitignore000064400000000000000000000000361046102023000144720ustar 00000000000000/target **/*.rs.bk Cargo.lock json_comments-0.2.2/Cargo.toml0000644000000015430000000000100117140ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2018" name = "json_comments" version = "0.2.2" authors = ["Thayne McCombs "] description = "Library to strip comments from JSON before parsing" readme = "README.md" license = "Apache-2.0" repository = "https://github.com/tmccombs/json-comments-rs" [dev-dependencies.serde_json] version = "1.0" [badges.travis-ci] repository = "tmccombs/json-comments-rs" json_comments-0.2.2/Cargo.toml.orig000064400000000000000000000006161046102023000153750ustar 00000000000000[package] name = "json_comments" version = "0.2.2" authors = ["Thayne McCombs "] edition = "2018" license = "Apache-2.0" readme = "README.md" repository = "https://github.com/tmccombs/json-comments-rs" description = "Library to strip comments from JSON before parsing" [badges] travis-ci = { repository = "tmccombs/json-comments-rs" } [dev-dependencies] serde_json = "1.0" json_comments-0.2.2/LICENSE000064400000000000000000000261351046102023000135170ustar 00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. json_comments-0.2.2/README.md000064400000000000000000000031771046102023000137720ustar 00000000000000# json-comments-rs [![Build Status](https://github.com/tmccombs/json-comments-rs/actions/workflows/build/badge.svg?branch=main)](https://github.com/tmccombs/json-comments-rs/actions) [![Docs](https://docs.rs/json_comments/badge.svg)](https://docs.rs/json_comments/) `json_comments` is a library to strip out comments from JSON-like text. By processing text through a [`StripComments`] adapter first, it is possible to use a standard JSON parser (such as [serde\_json](https://crates.io/crates/serde_json) with quasi-json input that contains comments. In fact, this code makes few assumptions about the input and could probably be used to strip comments out of other types of code as well, provided that strings use double quotes and backslashes are used for escapes in strings. The following types of comments are supported: - C style block comments (`/* ... */`) - C style line comments (`// ...`) - Shell style line comments (`# ...`) ## Example using serde\_json ```rust use serde_json::{Result, Value}; use json_comments::StripComments; fn main() -> Result<()> { // Some JSON input data as a &str. Maybe this comes form the user. let data = r#" { "name": /* full */ "John Doe", "age": 43, "phones": [ "+44 1234567", // work phone "+44 2345678" // home phone ] }"#; // Strip the comments from the input (use `as_bytes()` to get a `Read`). let stripped = StripComments::new(data.as_bytes()); // Parse the string of data into serde_json::Value. let v: Value = serde_json::from_reader(stripped)?; println!("Please call {} at the number {}", v["name"], v["phones"][0]); Ok(()) } ``` json_comments-0.2.2/src/lib.rs000064400000000000000000000265721046102023000144220ustar 00000000000000//! `json_comments` is a library to strip out comments from JSON-like test. By processing text //! through a [`StripComments`] adapter first, it is possible to use a standard JSON parser (such //! as [serde_json](https://crates.io/crates/serde_json) with quasi-json input that contains //! comments. //! //! In fact, this code makes few assumptions about the input and could probably be used to strip //! comments out of other types of code as well, provided that strings use double quotes and //! backslashes are used for escapes in strings. //! //! The following types of comments are supported: //! - C style block comments (`/* ... */`) //! - C style line comments (`// ...`) //! - Shell style line comments (`# ...`) //! //! ## Example using serde_json //! //! ``` //! use serde_json::{Result, Value}; //! use json_comments::StripComments; //! //! # fn main() -> Result<()> { //! // Some JSON input data as a &str. Maybe this comes form the user. //! let data = r#" //! { //! "name": /* full */ "John Doe", //! "age": 43, //! "phones": [ //! "+44 1234567", // work phone //! "+44 2345678" // home phone //! ] //! }"#; //! //! // Strip the comments from the input (use `as_bytes()` to get a `Read`). //! let stripped = StripComments::new(data.as_bytes()); //! // Parse the string of data into serde_json::Value. //! let v: Value = serde_json::from_reader(stripped)?; //! //! println!("Please call {} at the number {}", v["name"], v["phones"][0]); //! //! # Ok(()) //! # } //! ``` //! use std::io::{ErrorKind, Read, Result}; #[derive(Eq, PartialEq, Copy, Clone, Debug)] enum State { Top, InString, StringEscape, InComment, InBlockComment, MaybeCommentEnd, InLineComment, } use State::*; /// A [`Read`] that transforms another [`Read`] so that it changes all comments to spaces so that a downstream json parser /// (such as json-serde) doesn't choke on them. /// /// The supported comments are: /// - C style block comments (`/* ... */`) /// - C style line comments (`// ...`) /// - Shell style line comments (`# ...`) /// /// ## Example /// ``` /// use json_comments::StripComments; /// use std::io::Read; /// /// let input = r#"{ /// // c line comment /// "a": "comment in string /* a */", /// ## shell line comment /// } /** end */"#; /// /// let mut stripped = String::new(); /// StripComments::new(input.as_bytes()).read_to_string(&mut stripped).unwrap(); /// /// assert_eq!(stripped, "{ /// \n\"a\": \"comment in string /* a */\", /// \n} "); /// /// ``` /// pub struct StripComments { inner: T, state: State, settings: CommentSettings, } impl StripComments where T: Read, { pub fn new(input: T) -> Self { Self { inner: input, state: Top, settings: CommentSettings::default(), } } /// Create a new `StripComments` with settings which may be different from the default. /// /// This is useful if you wish to disable allowing certain kinds of comments. #[inline] pub fn with_settings(settings: CommentSettings, input: T) -> Self { Self { inner: input, state: Top, settings, } } } macro_rules! invalid_data { () => { return Err(ErrorKind::InvalidData.into()) }; } impl Read for StripComments where T: Read, { fn read(&mut self, buf: &mut [u8]) -> Result { let count = self.inner.read(buf)?; if count > 0 { for c in buf[..count].iter_mut() { self.state = match self.state { Top => top(c, &self.settings), InString => in_string(*c), StringEscape => InString, InComment => in_comment(c, &self.settings)?, InBlockComment => in_block_comment(c), MaybeCommentEnd => maybe_comment_end(c), InLineComment => in_line_comment(c), } } } else if self.state != Top && self.state != InLineComment { invalid_data!(); } Ok(count) } } /// Settings for `StripComments` /// /// The default is for all comment types to be enabled. #[derive(Copy, Clone, Debug)] pub struct CommentSettings { /// True if c-style block comments (`/* ... */`) are allowed block_comments: bool, /// True if c-style `//` line comments are allowed slash_line_comments: bool, /// True if shell-style `#` line comments are allowed hash_line_comments: bool, } impl Default for CommentSettings { fn default() -> Self { Self::all() } } impl CommentSettings { /// Enable all comment Styles pub const fn all() -> Self { Self { block_comments: true, slash_line_comments: true, hash_line_comments: true, } } /// Only allow line comments starting with `#` pub const fn hash_only() -> Self { Self { hash_line_comments: true, block_comments: false, slash_line_comments: false, } } /// Only allow "c-style" comments. /// /// Specifically, line comments beginning with `//` and /// block comment like `/* ... */`. pub const fn c_style() -> Self { Self { block_comments: true, slash_line_comments: true, hash_line_comments: false, } } /// Create a new `StripComments` for `input`, using these settings. /// /// Transform `input` into a [`Read`] that strips out comments. /// The types of comments to support are determined by the configuration of /// `self`. /// /// ## Examples /// /// ``` /// use json_comments::CommentSettings; /// use std::io::Read; /// /// let input = r#"{ /// // c line comment /// "a": "b" /// /** multi line /// comment /// */ }"#; /// /// let mut stripped = String::new(); /// CommentSettings::c_style().strip_comments(input.as_bytes()).read_to_string(&mut stripped).unwrap(); /// /// assert_eq!(stripped, "{ /// \n\"a\": \"b\" /// }"); /// ``` /// /// ``` /// use json_comments::CommentSettings; /// use std::io::Read; /// /// let input = r#"{ /// ## shell line comment /// "a": "b" /// }"#; /// /// let mut stripped = String::new(); /// CommentSettings::hash_only().strip_comments(input.as_bytes()).read_to_string(&mut stripped).unwrap(); /// /// assert_eq!(stripped, "{ /// \n\"a\": \"b\"\n}"); /// ``` #[inline] pub fn strip_comments(self, input: I) -> StripComments { StripComments::with_settings(self, input) } } fn top(c: &mut u8, settings: &CommentSettings) -> State { match *c { b'"' => InString, b'/' => { *c = b' '; InComment } b'#' if settings.hash_line_comments => { *c = b' '; InLineComment } _ => Top, } } fn in_string(c: u8) -> State { match c { b'"' => Top, b'\\' => StringEscape, _ => InString, } } fn in_comment(c: &mut u8, settings: &CommentSettings) -> Result { let new_state = match c { b'*' if settings.block_comments => InBlockComment, b'/' if settings.slash_line_comments => InLineComment, _ => invalid_data!(), }; *c = b' '; Ok(new_state) } fn in_block_comment(c: &mut u8) -> State { let old = *c; *c = b' '; if old == b'*' { MaybeCommentEnd } else { InBlockComment } } fn maybe_comment_end(c: &mut u8) -> State { let old = *c; *c = b' '; match old { b'/' => Top, b'*' => MaybeCommentEnd, _ => InBlockComment, } } fn in_line_comment(c: &mut u8) -> State { if *c == b'\n' { Top } else { *c = b' '; InLineComment } } #[cfg(test)] mod tests { use super::*; use std::io::{ErrorKind, Read}; fn strip_string(input: &str) -> String { let mut out = String::new(); let count = StripComments::new(input.as_bytes()) .read_to_string(&mut out) .unwrap(); assert_eq!(count, input.len()); out } #[test] fn block_comments() { let json = r#"{/* Comment */"hi": /** abc */ "bye"}"#; let stripped = strip_string(json); assert_eq!(stripped, r#"{ "hi": "bye"}"#); } #[test] fn block_comments_with_possible_end() { let json = r#"{/* Comment*PossibleEnd */"hi": /** abc */ "bye"}"#; let stripped = strip_string(json); assert_eq!( stripped, r#"{ "hi": "bye"}"# ); } // See https://github.com/tmccombs/json-comments-rs/issues/12 // Make sure we can parse a block comment that ends with more than one "*" #[test] fn doc_comment() { let json = r##"/** C **/ { "foo": 123 }"##; let stripped = strip_string(json); assert_eq!(stripped, r##" { "foo": 123 }"##); } #[test] fn line_comments() { let json = r#"{ // line comment "a": 4, # another }"#; let expected = "{ \n \"a\": 4, \n }"; assert_eq!(strip_string(json), expected); } #[test] fn incomplete_string() { let json = r#""foo"#; let mut stripped = String::new(); let err = StripComments::new(json.as_bytes()) .read_to_string(&mut stripped) .unwrap_err(); assert_eq!(err.kind(), ErrorKind::InvalidData); } #[test] fn incomplete_comment() { let json = r#"/* foo "#; let mut stripped = String::new(); let err = StripComments::new(json.as_bytes()) .read_to_string(&mut stripped) .unwrap_err(); assert_eq!(err.kind(), ErrorKind::InvalidData); } #[test] fn incomplete_comment2() { let json = r#"/* foo *"#; let mut stripped = String::new(); let err = StripComments::new(json.as_bytes()) .read_to_string(&mut stripped) .unwrap_err(); assert_eq!(err.kind(), ErrorKind::InvalidData); } #[test] fn no_hash_comments() { let json = r#"# bad comment {"a": "b"}"#; let mut stripped = String::new(); CommentSettings::c_style() .strip_comments(json.as_bytes()) .read_to_string(&mut stripped) .unwrap(); assert_eq!(stripped, json); } #[test] fn no_slash_line_comments() { let json = r#"// bad comment {"a": "b"}"#; let mut stripped = String::new(); let err = CommentSettings::hash_only() .strip_comments(json.as_bytes()) .read_to_string(&mut stripped) .unwrap_err(); assert_eq!(err.kind(), ErrorKind::InvalidData); } #[test] fn no_block_comments() { let json = r#"/* bad comment */ {"a": "b"}"#; let mut stripped = String::new(); let err = CommentSettings::hash_only() .strip_comments(json.as_bytes()) .read_to_string(&mut stripped) .unwrap_err(); assert_eq!(err.kind(), ErrorKind::InvalidData); } }