tidy_json 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53537db0fe360e1e7d7fe1ba75cb91418c6efa9ee9f108c2f8a2e3020bffed39
-  data.tar.gz: f665d2faff39441554d62de9cf91a6af9462d146501f1ba979d0b5ea21785e9d
+  metadata.gz: 2c999cbe79e0f4f5436ac7038e1cd15ba1d406d3ef44c583b72a3bf393bad402
+  data.tar.gz: 77335cd28abcf318b87d241d2c15fce228fcc4a348a3cf0362603fb280e2bd97
 SHA512:
-  metadata.gz: 01d9f6899b775b39c1cad8acbdf9bdbf563f5a61bd74ca5e395c47d0acb0cc8f963328d5a617c2366aeccd70d5b2f2d423c59485e828055e8743b945e45afd52
-  data.tar.gz: ae1c4ce4ee8b0b123b3627c694bfb9a2acec49b53387d830ce6acd2215347305552e6fbe2248197991f47ab0be07cd2888c824bb71fee3f56a86678dd05a063c
+  metadata.gz: 2076f573353e583bd6742bb3b276b971d27460ba117b37d4ff6e62f505dce9bbb081673d5184ffe5d36a3ca84a10d18b6a97c7ddf48a0e53377d4397fa52a338
+  data.tar.gz: 4af6bc7b026ad1df3b107905e134c8413edd209a6804b0ac1ba2ecb5c2694bf4fefb6266e4241e86713cb55e2ab4f5d561ff2b3884995c290a6f51ac12dbf741

data/.yardopts

@@ -1,3 +1,2 @@
---exclude lib/tidy_json/dedication.rb
 --private lib/**/*.rb
 --files README.md,LICENSE

data/Gemfile

@@ -6,6 +6,8 @@ gemspec
 
 group :test do
   gem 'rake'
+  gem 'test-unit', '~> 3.4'
+  gem 'yard', '~> 0.9'
 end
 
 group :development do

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2021 Robert Di Pardo
+Copyright (c) 2019-2022 Robert Di Pardo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # tidy_json
 
-![Gem Version][gem_version_badge]  ![Downloads][gem_downloads]  [![Travis CI][travis_build_status_badge]][travis_build_status]  [![codecov][codecov_badge]][codecov_status]
+![Gem Version][gem_version_badge]  ![Downloads][gem_downloads]  [![GH Actions][build_status_badge]][build_status]  [![codecov][codecov_badge]][codecov_status]
 
 A mixin providing (recursive) JSON serialization and pretty printing.
 
@@ -130,21 +130,21 @@ The `jtidy` executable bundled with this gem is in no way affiliated with, nor b
 the HTML parser and pretty printer [of the same name](https://github.com/jtidy/jtidy).
 
 The JTidy source code and binaries are licensed under the terms of the Zlib-Libpng License.
-More information is available [here](https://github.com/jtidy/jtidy/blob/master/LICENSE.txt).
+More information is available [here](https://raw.githubusercontent.com/jtidy/jtidy/master/LICENSE.txt).
 
 ### License
 Distributed under the terms of the [MIT License][].
 
 
-[travis_build_status]: https://app.travis-ci.com/github/rdipardo/tidy_json
-[travis_build_status_badge]: https://app.travis-ci.com/rdipardo/tidy_json.svg?branch=master
+[build_status]: https://github.com/rdipardo/tidy_json/actions/workflows/tests.yml
+[build_status_badge]: https://github.com/rdipardo/tidy_json/actions/workflows/tests.yml/badge.svg
 [codecov_status]: https://codecov.io/gh/rdipardo/tidy_json/branch/master
 [codecov_badge]: https://codecov.io/gh/rdipardo/tidy_json/branch/master/graph/badge.svg
 [gem_version_badge]: https://img.shields.io/gem/v/tidy_json?color=%234ec820&label=gem%20version&logo=ruby&logoColor=%23e9573f
 [gem_downloads]: https://img.shields.io/gem/dt/tidy_json?logo=ruby&logoColor=%23e9573f
-[MIT License]: https://github.com/rdipardo/tidy_json/blob/master/LICENSE
+[MIT License]: https://raw.githubusercontent.com/rdipardo/tidy_json/master/LICENSE
 [installing the gem]: https://github.com/rdipardo/tidy_json#installation
 <!-- API spec -->
 [`JSON.generate`]: https://github.com/flori/json/blob/d49c5de49e54a5ad3f6fcf587f98d63266ef9439/lib/json/pure/generator.rb#L111
-[the docs]: https://rubydoc.org/github/rdipardo/tidy_json/TidyJson/Formatter#initialize-instance_method
+[the docs]: https://rubydoc.info/github/rdipardo/tidy_json/TidyJson/Formatter#initialize-instance_method
 [0.3.0]: https://github.com/rdipardo/tidy_json/releases/tag/v0.3.0

data/bin/jtidy

@@ -51,7 +51,7 @@ class Jtidy # :nodoc:
         OPTIONS[k][0].eql? key
       end.first || '')[0..1]
     end
-    warn "Ignoring options: #{(ignored.join ', ')}"
+    warn "Ignoring options: #{ignored.join ', '}"
   end
 
   def self.parse(options)
@@ -69,7 +69,7 @@ class Jtidy # :nodoc:
 
       opts.on_tail('-V', '--version', 'Show version') do
         show_unused format_options
-        puts ::JtidyInfo.new.to_s
+        puts ::JtidyInfo.new
         exit 0
       end
 
@@ -95,7 +95,10 @@ begin
     raise OptionParser::InvalidArgument
   end
 
-  if !(INPUT_FILE.nil? || INPUT_FILE.strip.empty?)
+  if INPUT_FILE.nil? || INPUT_FILE.strip.empty?
+    Jtidy.parse %w[--help]
+
+  else
     tidy = ''
     fname = INPUT_FILE.strip.gsub('\\', '/')
     ext = File.extname(fname)
@@ -111,7 +114,7 @@ begin
               end
 
     begin
-      File.open((input + '.json'), 'r') do |json|
+      File.open("#{input}.json", 'r') do |json|
         begin
           tidy = TidyJson.tidy(JSON.parse(json.read.strip), OPTS)
         rescue JSON::JSONError => e
@@ -127,16 +130,13 @@ begin
                     "#{input}-tidy"
                   else outfile
                   end) + '.json'
-        File.open(output, 'w') { |fd| fd.write(tidy) }
+        File.write(output, tidy)
         puts "\nWrote: #{output}"
         puts "#{tidy[0..1024]}\n . . ." if OPTS[:preview]
       end
     rescue Errno::ENOENT, Errno::EACCES, IOError => e
       warn "#{__FILE__}.#{__LINE__}: #{e.message}"
     end
-
-  else
-    Jtidy.parse %w[--help]
   end
 rescue OptionParser::InvalidArgument, OptionParser::MissingArgument
   Jtidy.parse %w[--help]

data/bin/jtidy_info.rb

@@ -1,17 +1,14 @@
 # frozen_string_literal: true
 
-module TidyJson # :nodoc:
-  class JtidyInfo
+module TidyJson
+  class JtidyInfo # :nodoc:
     NOTICE = [
       '#',
       '# jtidy is in no way affiliated with, nor based on, ',
       '# the HTML parser and pretty printer of the same name.',
       '#',
-      '# The JTidy source code and binaries are licensed under',
-      '# the terms of the Zlib-Libpng License.',
-      '#',
       '# More information is available here:',
-      '# https://github.com/jtidy/jtidy/blob/master/LICENSE.txt',
+      '# https://github.com/rdipardo/tidy_json#command-line-usage',
       '#'
     ].join("\n").freeze
 

data/lib/tidy_json/formatter.rb

@@ -80,10 +80,8 @@ module TidyJson
       indent = @format[:indent]
 
       is_last = (obj.length <= 1) ||
-                (obj.length > 1 &&
-                  (obj.instance_of?(Array) &&
-                    !(node === obj.first) &&
-                      (obj.size.pred == obj.rindex(node))))
+                (obj.instance_of?(Array) &&
+                  (obj.size.pred == obj.rindex(node)))
 
       if node.instance_of?(Array)
         str << '['
@@ -132,12 +130,7 @@ module TidyJson
         node.each_with_index do |h, idx|
           # format values which are hashes themselves
           if h.last.instance_of?(Hash)
-            key = if h.first.eql? ''
-                    "#{indent * 2}\"<##{h.last.class.name.downcase}>\": "
-                  else
-                    "#{indent * 2}\"#{h.first}\": "
-                  end
-
+            key = "#{indent * 2}\"#{h.first || "<##{h.last.class.name.downcase}>"}\": "
             str << key << '{'
             str << "\n" unless h.last.empty?
 
@@ -171,8 +164,8 @@ module TidyJson
       end
 
       trim str.gsub(/(#{indent})+[\n\r]+/, '')
-              .gsub(/\}\,+/, '},')
-              .gsub(/\]\,+/, '],')
+              .gsub(/\},+/, '},')
+              .gsub(/\],+/, '],')
     end
     # ~Formatter#format_node
 
@@ -210,7 +203,7 @@ module TidyJson
 
       elsif !node.instance_of?(String) then graft << node.to_s
 
-      else graft << "\"#{node.gsub(/\"/, '\\"')}\""
+      else graft << "\"#{node.gsub('"', '\\"')}\""
       end
 
       graft.strip
@@ -223,7 +216,7 @@ module TidyJson
     # @param node [String] A serialized object member.
     # @return [String] A copy of +node+ without a trailing comma.
     def trim(node)
-      if (extra_comma = /(?<trail>,\s*[\]\}]\s*)$/.match(node))
+      if (extra_comma = /(?<trail>,\s*[\]}]\s*)$/.match(node))
         node.sub(extra_comma[:trail],
                  extra_comma[:trail]
                  .slice(1, node.length.pred)

data/lib/tidy_json/serializer.rb

@@ -7,15 +7,93 @@ module TidyJson
   # @api private
   class Serializer
     ##
-    # Searches +obj+ to a maximum depth of 2 for readable attributes, storing
-    # them as key-value pairs in +json_hash+.
+    # Searches +obj+ for readable attributes, storing them as key-value pairs in
+    # +json_hash+.
     #
     # @param obj [Object] A Ruby object that can be parsed as JSON.
     # @param json_hash [{String,Symbol => #to_s}] Accumulator.
     # @return [{String => #to_s}] A hash mapping of +obj+'s visible attributes.
+    # @note Hashes will be searched for nested objects to a maximum depth of 2;
+    #   arrays to a maximum depth of 3.
+    # @example
+    #   class Obj
+    #     class Child
+    #       def initialize; @a = { a: 1 } end
+    #        attr_reader :a
+    #     end
+    #     def initialize; @a = { b: Child.new } end
+    #     attr_accessor :a
+    #   end
+    #
+    #   o = Obj.new
+    #   puts o.to_tidy_json
+    #   <<JSON
+    #   {
+    #      "class": "Obj",
+    #      "a": {
+    #         "b": {
+    #           "class": "Obj::Child",
+    #            "a": {
+    #              "a": 1
+    #          }
+    #        }
+    #      }
+    #   }
+    #   JSON
+    #
+    #   # depth > 2: unreachable objects are not serialized
+    #   o.a = { b: { c: { d: Obj::Child.new } } }
+    #   puts o.to_tidy_json
+    #   <<JSON
+    #   {
+    #      "class": "Obj",
+    #      "a": {
+    #         "b": {
+    #           "c": {
+    #             "d": "#<Obj::Child:0x0000559d4da865c0>"
+    #          }
+    #        }
+    #      }
+    #   }
+    #   JSON
+    #
+    #   # object arrays can be nested up to 3 levels deep
+    #   o.a = [ [ Obj::Child.new, [ Obj::Child.new, [ Obj::Child.new ] ] ] ]
+    #   puts o.to_tidy_json
+    #   <<JSON
+    #   {
+    #     "class": "Obj",
+    #     "a": [
+    #       {
+    #         "class": "Obj::Child",
+    #         "a": {
+    #           "a": 1
+    #         }
+    #       },
+    #       [
+    #         [
+    #           {
+    #             "class": "Obj::Child",
+    #             "a": {
+    #               "a": 1
+    #             }
+    #           },
+    #           [
+    #             {
+    #               "class": "Obj::Child",
+    #               "a": {
+    #                 "a": 1
+    #               }
+    #             }
+    #           ]
+    #         ]
+    #       ]
+    #     ]
+    #   }
+    #   JSON
     def self.serialize(obj, json_hash)
       obj.instance_variables.each do |m|
-        key = m.to_s[/[^\@]\w*/].to_sym
+        key = m.to_s[/[^@]\w*/].to_sym
 
         next unless key && !key.eql?('')
 
@@ -28,24 +106,10 @@ module TidyJson
         begin
           # process class members of Hash type
           if val.instance_of?(Hash)
-            nested_key = ''
-            nested = nil
-
-            val.each.any? do |k, v|
-              unless v.instance_variables.empty?
-                nested_key = k
-                nested = v
-              end
-            end
-
             json_hash[key] = val
 
-            if nested
-              pos = val.keys.select { |k| k === nested_key }.first.to_sym
-              nested.instance_variables.each do
-                json_hash[key][pos] = serialize(nested,
-                                                class: nested.class.name)
-              end
+            val.each.any? do |k, v|
+              json_hash[key][k.to_sym] = serialize(v, class: v.class.name) unless v.instance_variables.empty?
             end
 
           # process class members of Array type
@@ -75,6 +139,11 @@ module TidyJson
                   elsif e.respond_to?(:each)
                     temp = []
                     e.each do |el|
+                      if el.respond_to?(:each)
+                        el.each_with_index do |ell, idx|
+                          el[idx] = serialize(ell, class: ell.class.name) unless ell.instance_variables.empty?
+                        end
+                      end
                       temp << if el.instance_variables.empty? then el
                               else JSON.parse(el.stringify)
                               end

data/lib/tidy_json/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TidyJson
-  VERSION = '0.5.0'
+  VERSION = '0.5.2'
 end