json-repair 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17c6b285b495a3c053ae838e701205ec682f7648856cadb52d00da5d348f393c
-  data.tar.gz: 644acd7c8840e0a1edf4399297c1bbcc17739cdd13ab6ee9102880981a00bc84
+  metadata.gz: b50bffd203f06c7b7d2fa875802b66dd6fc944d01fe7c7f6c349233b2dc73d60
+  data.tar.gz: f018489c9572a61a72e9784af8f2b2fec335e215933ad0efea1265cff7d7be4e
 SHA512:
-  metadata.gz: 6bbe9f8d1e5558ab344987a867dc1aae6859c7e33b537cf20b78d97b5db4734c33388d7514b5db85decf8ca156d91efd4fe98d7cd8b42bc2c2fa81822a0ce9bd
-  data.tar.gz: '0175953daedfe95efb9dc1777d38c2e6034e1822b0463fe50cf52dc946a17cd5a363bab862bc776399bd2e34c249b682298c2989f5ce7fa959cd667c4845d013'
+  metadata.gz: 7b1047f154815fde7e587fac75c1316ccf799a3ce73c8d5da97ae94305cc8368ea745f7472972a552da4a9df61acb54730d39a2080eb5e61e9fc46d234bbcfd0
+  data.tar.gz: 25d80f6b35509da21cbf0932a67187bd8f69ccac2f06c15e93dbc74a45c0ae4018145051f6d601df5b651aa33036d8cd4dcafefe800f5533110271a38500b4d7

data/.rubocop.yml

@@ -10,32 +10,32 @@ Style/Documentation:
 
 Metrics/ClassLength:
   Exclude:
-    - lib/json/repair/repairer.rb
+    - lib/json/repairer.rb
 
 Metrics/AbcSize:
   Exclude:
-    - lib/json/repair/repairer.rb
+    - lib/json/repairer.rb
 
 Metrics/MethodLength:
   Exclude:
-    - lib/json/repair/repairer.rb
+    - lib/json/repairer.rb
 
 Metrics/CyclomaticComplexity:
   Exclude:
-    - lib/json/repair/repairer.rb
+    - lib/json/repairer.rb
 
 Metrics/PerceivedComplexity:
   Exclude:
-    - lib/json/repair/repairer.rb
+    - lib/json/repairer.rb
 
 Metrics/BlockLength:
   Exclude:
-    - lib/json/repair/repairer.rb
+    - lib/json/repairer.rb
     - spec/**/*
 
 Metrics/BlockNesting:
   Exclude:
-    - lib/json/repair/repairer.rb
+    - lib/json/repairer.rb
 
 Metrics/ModuleLength:
   Exclude:

data/CHANGELOG.md

@@ -2,4 +2,8 @@
 
 ### 2024-05-23 (0.1.0)
 
-* Initial setup
+* Initial setup
+
+### 2024-06-01 (0.2.0)
+
+* Moved the repair method to the JSON module

data/README.md

@@ -1,6 +1,6 @@
-# JSON::Repair
+# JSON::Repair [![Gem Version](https://badge.fury.io/rb/json-repair.svg)](https://badge.fury.io/rb/json-repair) [![Build Status](https://github.com/sashazykov/json-repair-rb/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/sashazykov/json-repair-rb/actions)
 
-This is a Ruby gem designed to repair broken JSON strings. Inspired by the [jsonrepair js library](https://github.com/josdejong/jsonrepair/). It efficiently handles and corrects malformed JSON data, making it especially useful in scenarios where JSON output from LLMs might not strictly adhere to JSON standards. Whether it's missing quotes, misplaced commas, or unexpected characters, it ensures that the JSON data is valid and can be parsed correctly.
+This is a Ruby gem designed to repair broken JSON strings. Inspired by and based on the [jsonrepair js library](https://github.com/josdejong/jsonrepair/). It efficiently handles and corrects malformed JSON data, making it especially useful in scenarios where JSON output from LLMs might not strictly adhere to JSON standards. Whether it's missing quotes, misplaced commas, or unexpected characters, it ensures that the JSON data is valid and can be parsed correctly.
 
 ## Installation
 
@@ -25,7 +25,7 @@ require 'json/repair'
 
 # Example of repairing a JSON string
 broken_json = '{name: Alice, "age": 25,}'
-repaired_json = JSON::Repair.repair(broken_json)
+repaired_json = JSON.repair(broken_json)
 puts repaired_json  # Outputs: {"name": "Alice", "age": 25}
 ```
 
@@ -48,3 +48,10 @@ The gem is available as open source under the terms of the [ISC License](https:/
 ## Code of Conduct
 
 Everyone interacting in the JSON::Repair project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/sashazykov/json-repair-rb/blob/main/CODE_OF_CONDUCT.md).
+
+## Similar libraries in other languages
+
+- Typescript: https://github.com/josdejong/jsonrepair
+- Go: https://github.com/RealAlexandreAI/json-repair
+- JavaScript: https://github.com/RyanMarcus/dirty-json
+- Python: https://github.com/mangiucugna/json_repair

data/lib/json/repair/version.rb

@@ -2,6 +2,6 @@
 
 module JSON
   module Repair
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/json/repair.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
 require_relative 'repair/version'
-require_relative 'repair/repairer'
+require_relative 'repairer'
 
 module JSON
-  module Repair
-    class JSONRepairError < StandardError; end
+  class JSONRepairError < StandardError; end
 
-    def self.repair(json)
-      Repairer.new(json).repair
-    end
+  def self.repair(json)
+    Repairer.new(json).repair
   end
 end