jsonc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8181db363d5c3a12bad8d2a213121d4b790b41eef2eb47951a2133ab982e97fe
+  data.tar.gz: 9ebd700ac4b38e1db67d6b0820115b2e6d29069a672a9dae079c097159f41a16
+SHA512:
+  metadata.gz: 04f4d89a5d3b73ea2eb6d1b9a75d3abeda31e95d23b71e447d8b4fb9573670bfaa74197815255caec9af7021f9135fc750804b50f6e27c7bc24acf0908967d97
+  data.tar.gz: 60e5016c2360518153ae492a43948f7980cc4810c66e80ab00014799e0a5c885b5bb2ee488e84123e978df090c6f0736959cd9a3cb1ffb078eb3e498e0e62d89

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+plugins:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-08-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Yoshiki Takagi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# JSONC
+
+[![Gem Version](https://badge.fury.io/rb/jsonc.svg)](https://badge.fury.io/rb/jsonc)
+
+A simple Ruby gem to parse JSON with Comments (JSONC) and trailing commas.
+
+This gem provides `JSONC.parse` and `JSONC.load_file` methods that act as drop-in replacements for the standard `JSON` library, with added support for modern JSON extensions.
+
+## Features
+
+- **Comments**: Parses JSON with `//` single-line and `/* */` multi-line comments.
+- **Trailing Commas**: Parses JSON with trailing commas in objects and arrays.
+- **Standard Interface**: Forwards all options (e.g., `symbolize_names`) to the standard `JSON.parse` method.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add jsonc
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install jsonc
+```
+
+## Usage
+
+### Parsing a String
+
+Use `JSONC.parse` in place of `JSON.parse`.
+
+```ruby
+require 'jsonc'
+
+jsonc_string = <<-JSONC
+{
+  // The name of the user
+  "name": "Jules",
+  /*
+    The user's role.
+    Can be "agent" or "user".
+  */
+  "role": "agent", // Trailing commas are allowed!
+}
+JSONC
+
+parsed_hash = JSONC.parse(jsonc_string)
+# => { "name" => "Jules", "role" => "agent" }
+
+puts parsed_hash["name"]
+# => Jules
+```
+
+### Loading a File
+
+Use `JSONC.load_file` in place of `JSON.load_file`.
+
+```ruby
+# Given a file named 'config.jsonc' with the content from above:
+
+require 'jsonc'
+
+parsed_hash = JSONC.load_file('config.jsonc', symbolize_names: true)
+# => { name: "Jules", role: "agent" }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ytkg/jsonc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ytkg/jsonc/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the JSONC project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ytkg/jsonc/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/jsonc/parser/comment_remover.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module JSONC
+  class Parser
+    class CommentRemover
+      def initialize(string)
+        @string = string
+        @index = 0
+        @result = String.new
+        @state = :normal
+      end
+
+      def parse
+        while @index < @string.length
+          case @state
+          when :normal then parse_normal
+          when :in_string then parse_string
+          when :in_line_comment then parse_line_comment
+          when :in_block_comment then parse_block_comment
+          end
+        end
+        raise JSON::ParserError, "Unclosed block comment" if @state == :in_block_comment
+
+        @result
+      end
+
+      private
+
+      # rubocop:disable Metrics/MethodLength
+      def parse_normal
+        char = @string[@index]
+        if char == '"'
+          @state = :in_string
+          @result << char
+          @index += 1
+        elsif char == "/" && @string[@index + 1] == "/"
+          @state = :in_line_comment
+          @index += 2
+        elsif char == "/" && @string[@index + 1] == "*"
+          @state = :in_block_comment
+          @index += 2
+        else
+          @result << char
+          @index += 1
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # rubocop:disable Metrics/MethodLength
+      def parse_string
+        char = @string[@index]
+        if char == "\\"
+          @result << char << @string[@index + 1]
+          @index += 2
+        elsif char == '"'
+          @state = :normal
+          @result << char
+          @index += 1
+        else
+          @result << char
+          @index += 1
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def parse_line_comment
+        char = @string[@index]
+        if char == "\n"
+          @state = :normal
+          @result << char
+        end
+        @index += 1
+      end
+
+      def parse_block_comment
+        char = @string[@index]
+        if char == "*" && @string[@index + 1] == "/"
+          @state = :normal
+          @index += 2
+        else
+          @result << "\n" if char == "\n"
+          @index += 1
+        end
+      end
+    end
+  end
+end

data/lib/jsonc/parser/trailing_comma_remover.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module JSONC
+  class Parser
+    class TrailingCommaRemover
+      def initialize(string)
+        @string = string
+        @index = 0
+        @result = String.new
+        @state = :normal
+      end
+
+      def parse
+        while @index < @string.length
+          case @state
+          when :normal then parse_normal
+          when :in_string then parse_string
+          end
+        end
+        @result
+      end
+
+      private
+
+      def parse_normal
+        char = @string[@index]
+        if char == '"'
+          @state = :in_string
+          @result << char
+        elsif char == ","
+          @result << char unless find_next_meaningful_char_is_closing_bracket?
+        else
+          @result << char
+        end
+        @index += 1
+      end
+
+      def parse_string # rubocop:disable Metrics/MethodLength
+        char = @string[@index]
+        if char == "\\"
+          @result << char << @string[@index + 1]
+          @index += 2
+        elsif char == '"'
+          @state = :normal
+          @result << char
+          @index += 1
+        else
+          @result << char
+          @index += 1
+        end
+      end
+
+      def find_next_meaningful_char_is_closing_bracket?
+        i = @index + 1
+        while i < @string.length
+          char = @string[i]
+          return true if ["]", "}"].include?(char)
+          return false unless char.strip.empty?
+
+          i += 1
+        end
+        false
+      end
+    end
+  end
+end

data/lib/jsonc/parser.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "parser/comment_remover"
+require_relative "parser/trailing_comma_remover"
+
+module JSONC
+  # The main parser class. It orchestrates the removal of comments and trailing commas.
+  class Parser
+    def self.parse(string)
+      comment_free_string = CommentRemover.new(string).parse
+      TrailingCommaRemover.new(comment_free_string).parse
+    end
+  end
+end

data/lib/jsonc/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JSONC
+  VERSION = "0.1.0"
+end

data/lib/jsonc.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "jsonc/version"
+require_relative "jsonc/parser"
+
+module JSONC
+  class Error < StandardError; end
+
+  def self.parse(string, **opts)
+    sanitized_string = Parser.parse(string)
+    JSON.parse(sanitized_string, **opts)
+  end
+
+  def self.load_file(path, **opts)
+    parse(File.read(path), **opts)
+  end
+end

data/sig/jsonc.rbs

@@ -0,0 +1,4 @@
+module Jsonc
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: jsonc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshiki Takagi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-08-26 00:00:00.000000000 Z
+dependencies: []
+description: A simple parser for JSONC (JSON with comments).
+email:
+- yoshiki.tkg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/jsonc.rb
+- lib/jsonc/parser.rb
+- lib/jsonc/parser/comment_remover.rb
+- lib/jsonc/parser/trailing_comma_remover.rb
+- lib/jsonc/version.rb
+- sig/jsonc.rbs
+homepage: https://github.com/ytkg/jsonc
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ytkg/jsonc
+  source_code_uri: https://github.com/ytkg/jsonc
+  changelog_uri: https://github.com/ytkg/jsonc/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A simple parser for JSON with comments (JSONC).
+test_files: []