tidy_json 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16df8d716d6fcdfeba6ed6afbf5954089e172f39b61a73fa853babb5d3c2cde6
-  data.tar.gz: bc64fa60a34d16af688444e0fb706c7a087dc38ced05babcc0680bf1874fed8f
+  metadata.gz: dfdad155c72b5ef6d411fbdd2dae876a4d7951e97f2f59f0817d09be0d1b1f8a
+  data.tar.gz: 40fbd785790e3dc649c1ab8ac16696b359f832cc43da577e71fe9b55a5467212
 SHA512:
-  metadata.gz: 54185c4b206f63502a061f2a8397a78697fee2eea068c77b1392f02c24d95136ecac03026c1b08b1782c554c0d3356373c367980ce857197f5c3ff2061393663
-  data.tar.gz: ba130a35229098c25b0e750dc631f725c53013eac9b69a702c26110cd321930c056f13627c066ac805a72851405cdc5203e90638def06e75396970a2c5b52b7d
+  metadata.gz: a62c5325d5ec264c61321518e26997170f5a1b34210d6c93052dfa2ab7aedce355ef0f9f9688dc4a18cd4113fafb121b314528374ba509b7e47f7a1f0f4afb7f
+  data.tar.gz: 2351e73fd6c2c6e8da966b02cec5da2eeaff8ca77a090c5ac5e7aff96122e27f12ac8c770b1b89ce943e6300e21325b099442750137ca54183fee568b8db048b

data/README.md

@@ -1,6 +1,6 @@
 # TidyJson
 
-[![Travis Build Status][travis_build_status_badge]][travis_build_status]  [![Circle CI Build Status][cci_build_status_badge]][cci_build_status]  ![Gem Version][gem_version_badge]
+[![Build Status][travis_build_status_badge]][travis_build_status]  [![cci_build_status_badge]][cci_build_status]  ![Gem Version][gem_version_badge]
 
 A mixin providing (recursive) JSON serialization and pretty printing.
 
@@ -24,7 +24,7 @@ gem 'tidy_json'
 ```ruby
 require 'tidy_json'
 
-class Jsonable
+class JsonableObject
   attr_reader :a, :b
   def initialize
     @a = { a: 'uno', b: 'dos', c: ['I', 'II', 'III', ['i.', 'ii.', 'iii.', { 'ichi': "\u{4e00}", 'ni': "\u{4e8c}", 'san': "\u{4e09}", 'yon': "\u{56db}" }]] }
@@ -32,45 +32,42 @@ class Jsonable
   end
 end
 
-complex_object = Jsonable.new
-puts JSON.parse complex_object.stringify
+my_jsonable = JsonableObject.new
+
+JSON.parse my_jsonable.stringify
 # => {"class"=>"Jsonable", "a"=>{"a"=>"uno", "b"=>"dos", "c"=>["I", "II", "III", ["i.", "ii.", "iii.", {"ichi"=>"一", "ni"=>"二", "san"=>"三", "yon"=>"四"}]]}, "b"=>{"a"=>1, "b"=>["two", 3, "<abbr title=\"four\">IV</abbr>"]}}
 
-puts complex_object.to_tidy_json
+puts my_jsonable.to_tidy_json(indent: 8)
 # {
-# "class": "Jsonable",
-# "a":
-#  {
-#    "a": "uno",
-#    "b": "dos",
-#    "c":
-#      [
-#        "I",
-#        "II",
-#        "III",
-#          [
-#            "i.",
-#            "ii.",
-#            "iii.",
-#            {
-#              "ichi":"一",
-#              "ni":"二",
-#              "san":"三",
-#              "yon":"四"
-#            }
-#          ]
-#      ]
-#   },
-# "b":
-#   {
-#     "a": 1,
-#     "b":
-#       [
-#         "two",
-#         3,
-#         "<abbr title=\"four\">IV</abbr>"
-#       ]
-#    }
+#        "class": "JsonableObject",
+#        "a": {
+#                "a": "uno",
+#                "b": "dos",
+#                "c": [
+#                        "I",
+#                        "II",
+#                        "III",
+#                        [
+#                                "i.",
+#                                "ii.",
+#                                "iii.",
+#                                {
+#                                        "ichi": "一",
+#                                        "ni": "二",
+#                                        "san": "三",
+#                                        "yon": "四"
+#                                }
+#                        ]
+#                ]
+#        },
+#        "b": {
+#                "a": 1,
+#                "b": [
+#                        "two",
+#                        3,
+#                        "<abbr title=\"four\">IV</abbr>"
+#                ]
+#        }
 # }
 # => nil
 ```
@@ -81,7 +78,6 @@ puts complex_object.to_tidy_json
 - [json](https://rubygems.org/gems/json) ~> 2.2
 
 #### Building
-- [bundler](https://rubygems.org/gems/bundler) ~> 1.17
 - [minitest](https://rubygems.org/gems/minitest) ~> 5.0
 - [yard](https://rubygems.org/gems/yard) ~> 0.9
 
@@ -91,6 +87,6 @@ puts complex_object.to_tidy_json
 
 [travis_build_status]: https://travis-ci.com/rdipardo/tidy_json
 [cci_build_status]: https://circleci.com/gh/rdipardo/tidy_json
-[travis_build_status_badge]: https://travis-ci.com/rdipardo/tidy_json.svg
 [cci_build_status_badge]: https://circleci.com/gh/rdipardo/tidy_json.svg?style=svg
+[travis_build_status_badge]: https://travis-ci.com/rdipardo/tidy_json.svg
 [gem_version_badge]: https://img.shields.io/gem/v/tidy_json

data/lib/tidy_json/dedication.rb

@@ -1,9 +1,10 @@
 module TidyJson # :nodoc:
-  DEDICATION = "#{'.' * 50}\n#{'.' * 19} IN MEMORIAM #{'.' * 18}\n" \
+  DEDICATION = "\n#{'.' * 50}\n#{'.' * 19} IN MEMORIAM #{'.' * 18}\n" \
                "#{'.' * 16} Michael Di Pardo #{'.' * 16}\n" \
-               "#{'.' * 19} 1950 - 2019 #{'.' * 18}\n#{'.' * 50}\n" \
+               "#{'.' * 11} Feb 4, 1950 - Oct 28, 2019 #{'.' * 11}\n" \
+               "#{'.' * 50}\n" \
                "#{'.' * 11} Please consider supporting #{'.' * 11}\n" \
                "#{'.' * 13} the MS Society of Canada #{'.' * 11}\n" \
                "#{'.' * 8} https://mssociety.ca/get-involved #{'.' * 7}\n" \
-               "#{'.' * 50}\n"
+               "#{'.' * 50}\n\n".freeze
 end

data/lib/tidy_json/version.rb

@@ -1,3 +1,3 @@
 module TidyJson
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'.freeze
 end

data/lib/tidy_json.rb

@@ -9,16 +9,19 @@ module TidyJson
   # Emits a pretty-printed JSON representation of the given +obj+.
   #
   # @param obj [Object] A Ruby object that can be parsed as JSON.
+  # @param opts [Hash] Formatting options.
+  #     [:indent] the number of white spaces to indent
   # @return [String] A pretty-printed JSON string.
-  def self.tidy(obj = {})
+  def self.tidy(obj = {}, opts = {})
+    formatter = Formatter.new(opts)
     str = ''
 
     if obj.instance_of?(Hash)
       str << "{\n"
 
       obj.each do |k, v|
-        str << "\"#{k}\": "
-        str << Serializer.format_node(v, obj)
+        str << formatter.indent << "\"#{k}\": "
+        str << formatter.format_node(v, obj)
       end
 
       str << "}\n"
@@ -27,7 +30,8 @@ module TidyJson
       str << "[\n"
 
       obj.each do |v|
-        str << Serializer.format_node(v, obj)
+        str << formatter.indent
+        str << formatter.format_node(v, obj)
       end
 
       str << "]\n"
@@ -37,19 +41,16 @@ module TidyJson
   end
 
   ##
-  # Like +TidyJson::tidy+, but callable by the sender object with the option *not* to pretty-print.
+  # Like +TidyJson::tidy+, but callable by the sender object.
   #
-  # @param pretty [Boolean] Whether or not the returned string should be pretty-printed.
+  # @param opts [Hash] Formatting options.
+  #     [:indent] the number of white spaces to indent
   # @return [String] A pretty-printed JSON string.
-  def to_tidy_json(pretty = true)
+  def to_tidy_json(opts = {})
     if !instance_variables.empty?
-      if pretty then TidyJson.tidy(JSON.parse(stringify))
-      else stringify
-      end
+      TidyJson.tidy(JSON.parse(stringify), opts)
     else
-      if pretty then TidyJson.tidy(self)
-      else to_json
-      end
+      TidyJson.tidy(self, opts)
     end
   end
 
@@ -70,16 +71,18 @@ module TidyJson
   end
 
   ##
-  # Writes a pretty-printed JSON representation of the sender object to the file specified by +out+.
+  # Writes a JSON representation of the sender object to the file specified by +out+.
   #
-  # @param pretty [Boolean] Whether or not the output should be pretty-printed.
-  # @param out [String] The destination filename. Defaults to <tt><obj_class_name>_<unix timestamp></tt>.json
+  # @param out [String] The destination filename.
+  # @param opts [Hash] Formatting options for this object's +#to_tidy_json+ method.
+  #     [:tidy] whether or not the output should be pretty-printed
+  #     [:indent] the number of white spaces to indent
   # @return [String, nil] The path to the written output file, if successful.
-  def write_json(pretty = true, out = "#{self.class.name}_#{Time.now.to_i}")
+  def write_json(out = "#{self.class.name}_#{Time.now.to_i}", opts = { tidy: false })
     path = nil
 
     File.open("#{out}.json", 'w') do |f|
-      path = f << to_tidy_json(pretty)
+      path = f << to_tidy_json(opts)
     end
 
     path.path
@@ -92,15 +95,6 @@ module TidyJson
   #
   # @api private
   class Serializer
-    ##
-    # The number of times to reduce the left margin of a nested array's opening
-    # bracket
-    @margins_to_backspace = 0
-
-    ##
-    # True if printing a nested array
-    @should_backspace = false
-
     ##
     # Searches +obj+ to a *maximum* depth of 2 for readable attributes,
     # storing them as key-value pairs in +json_hash+.
@@ -210,7 +204,7 @@ module TidyJson
               json_hash[key] << val
             end
 
-          # process uncollected data members
+          # process uncollected class members
           else
             # member a class object
             if val.instance_variables.first
@@ -238,6 +232,37 @@ module TidyJson
       json_hash
     end
     # ~Serializer.serialize
+  end
+  # ~Serializer
+
+  ##
+  # A purpose-built JSON formatter.
+  #
+  # @api private
+  class Formatter
+    attr_reader :indent
+
+    # @!attribute indent
+    #   @return [String] the string of white space used by this +Formatter+ to indent object members.
+
+    def initialize(format_options = {})
+      ##
+      # The number of times to reduce the left indent of a nested array's opening
+      # bracket
+      @left_bracket_offset = 0
+
+      ##
+      # True if printing a nested array
+      @need_offset = false
+
+      indent_width = format_options[:indent]
+
+      # don't use the more explicit #integer? method because it's defined for
+      # floating point numbers also
+      good_width = indent_width.positive? if indent_width.respond_to? :times
+
+      @indent = "\s" * (good_width ? indent_width : 2)
+    end
 
     ##
     # Returns the given +node+ as pretty-printed JSON.
@@ -245,70 +270,71 @@ module TidyJson
     # @param node [#to_s] A visible attribute of +obj+.
     # @param obj [{Object => Object}, <Object>] The enumerable object containing +node+.
     # @return [String] A formatted string representation of +node+.
-    def self.format_node(node, obj)
+    def format_node(node, obj)
       str = ''
+      indent = @indent
 
       if node.instance_of?(Array)
-        str << "\n\t[\n"
+        str << "[\n"
 
         node.each do |elem|
           if elem.instance_of?(Hash)
-            str << "\t\t{\n"
+            str << "#{(indent * 2)}{\n"
 
             elem.each_with_index do |inner_h, h_idx|
-              str << "\t\t\t\"#{inner_h.first}\":"
-              str << node_to_str(inner_h.last)
+              str << "#{(indent * 3)}\"#{inner_h.first}\": "
+              str << node_to_str(inner_h.last, 4)
               str << ', ' unless h_idx == (elem.to_a.length - 1)
               str << "\n"
             end
 
-            str << "\t\t}"
+            str << "#{(indent * 2)}}"
             str << ',' unless node.index(elem) == (node.length - 1)
             str << "\n" unless node.index(elem) == (node.length - 1)
 
           else
 
             if elem.instance_of?(Array) && elem.any? { |e| e.instance_of?(Array) }
-              @margins_to_backspace = elem.take_while { |e| e.instance_of?(Array) }.size
+              @left_bracket_offset = elem.take_while { |e| e.instance_of?(Array) }.size
             end
 
-            str << "\t\t"
+            str << (indent * 2)
             str << node_to_str(elem)
             str << ",\n" unless node.index(elem) == (node.length - 1)
           end
         end
 
-        str << "\n\t]\n"
+        str << "\n#{indent}]\n"
 
       elsif node.instance_of?(Hash)
-        str << "\n\t{\n"
+        str << "{\n"
 
         node.each_with_index do |h, idx|
           if h.last.instance_of?(Hash)
             key = if h.first.eql? ''
-                    "\t\t\"<##{h.last.class.name.downcase}>\":"
+                    "#{indent * 2}\"<##{h.last.class.name.downcase}>\": "
                   else
-                    "\t\t\"#{h.first}\":"
+                    "#{indent * 2}\"#{h.first}\": "
                   end
             str << key
-            str << "\n\t\t\t{\n"
+            str << "{\n"
 
             h.last.each_with_index do |inner_h, inner_h_idx|
-              str << "\t\t\t\t\"#{inner_h.first}\":"
+              str << "#{indent * 3}\"#{inner_h.first}\": "
               str << node_to_str(inner_h.last, 4)
               str << ",\n" unless inner_h_idx == (h.last.to_a.length - 1)
             end
 
-            str << "\n\t\t\t}"
+            str << "\n#{indent * 2}}"
           else
-            str << "\t\t\"#{h.first}\": "
+            str << "#{indent * 2}\"#{h.first}\": "
             str << node_to_str(h.last)
           end
 
           str << ",\n" unless idx == (node.to_a.length - 1)
         end
 
-        str << "\n\t}"
+        str << "\n#{indent}}"
         str << ', ' unless (obj.length <= 1) || \
                            ((obj.length > 1) && \
                            (obj.instance_of?(Hash) && \
@@ -326,50 +352,54 @@ module TidyJson
         str << "\n"
       end
 
-      str.gsub(/\t+[\n\r]+/, '').gsub(/\}\,+/, '},').gsub(/\]\,+/, '],')
+      str.gsub(/(#{indent})+[\n\r]+/, '').gsub(/\}\,+/, '},').gsub(/\]\,+/, '],')
     end
-    # ~Serializer.format_node
+    # ~Formatter#format_node
 
     ##
     # Returns a JSON-appropriate string representation of +node+.
     #
     # @param node [#to_s] A visible attribute of a Ruby object.
-    # @param tabs [Fixnum] Tab width at which to start printing this node.
+    # @param tabs [Integer] Tab width at which to start printing this node.
     # @return [String] A formatted string representation of +node+.
-    def self.node_to_str(node, tabs = 0)
+    def node_to_str(node, tabs = 0)
       graft = ''
-
       tabs += 2 if tabs.zero?
-      if @should_backspace
+
+      if @need_offset
         tabs -= 1
-        @margins_to_backspace -= 1
+        @left_bracket_offset -= 1
       end
 
+      indent = @indent * (tabs / 2)
+
       if node.nil? then graft << 'null'
-      elsif node.instance_of?(Hash)
 
+      elsif node.instance_of?(Hash)
         format_node(node, node).scan(/.*$/) do |n|
-          graft << "\n" << ("\t" * tabs).to_s << n
+          graft << "\n" << indent << n
         end
 
       elsif node.instance_of?(Array)
-        @should_backspace = @margins_to_backspace.positive?
+        @need_offset = @left_bracket_offset.positive?
 
         format_node(node, {}).scan(/.*$/) do |n|
-          graft << "\n" << ("\t" * tabs).to_s << n
+          graft << "\n" << indent << n
         end
 
       elsif !node.instance_of?(String) then graft << node.to_s
+
       else graft << "\"#{node.gsub(/\"/, '\\"')}\""
       end
 
-      graft.rstrip
+      graft.strip
     end
-    # ~Serializer.node_to_str
+    # ~Formatter.node_to_str
   end
-  # ~Serializer
+  # ~Formatter
 
   private_constant :Serializer
+  private_constant :Formatter
 end
 # ~TidyJson
 

data/test/test_tidy_json.rb

@@ -27,13 +27,15 @@ class TidyJsonTest < Minitest::Test
   end
 
   def test_tidy_static
-    assert_equal(TidyJson.tidy(a: 'one', A: 'ONE', b: nil), "{\n\"a\": \"one\", \n\"A\": \"ONE\", \n\"b\": null\n}\n")
+    assert_equal(TidyJson.tidy(a: 'one', A: 'ONE', b: nil), "{\n  \"a\": \"one\", \n  \"A\": \"ONE\", \n  \"b\": null\n}\n")
     assert_equal(TidyJson.tidy({}).length, 4)
   end
 
   def test_tidy_instance
     assert_equal({}.to_tidy_json, "{\n}\n")
-    assert_equal(JsonableObject.new.to_tidy_json.length, 568)
+    assert_equal([].to_tidy_json, "[\n]\n")
+    assert_equal(Object.new.to_tidy_json, '')
+    assert_equal(JsonableObject.new.to_tidy_json.length, 650)
   end
 
   def test_stringify_instance
@@ -41,9 +43,26 @@ class TidyJsonTest < Minitest::Test
   end
 
   def test_writers
-    output = @@t.write_json(false)
+    output = @@t.write_json
     assert(File.exist?(output))
-    pretty_output = @@t.write_json(true, 'prettified')
+    pretty_output = @@t.write_json('prettified', tidy: true, indent: 4)
     assert(File.exist?(pretty_output))
   end
+
+  def test_indent_bounds_checking
+    assert_equal(Object.new.to_tidy_json(indent: '8'), '')
+    assert_equal('Object'.to_tidy_json(indent: []), '')
+    assert_equal(0.to_tidy_json(indent: -89), '')
+    assert_equal(3.1425.to_tidy_json(indent: 3.1425), '')
+    assert_equal(''.to_tidy_json(indent: +0), '')
+    assert_equal([].to_tidy_json(indent: -8.00009), "[\n]\n")
+    assert_equal(JSON.parse(Object.new.stringify).to_tidy_json(indent: nil),
+                 "{\n  \"class\": \"Object\"\n}\n")
+    assert_equal(JSON.parse(''.stringify).to_tidy_json(indent: -16.009),
+                 "{\n  \"class\": \"String\"\n}\n")
+    assert_equal(JSON.parse({}.stringify).to_tidy_json(indent: '8'),
+                 "{\n  \"class\": \"Hash\"\n}\n")
+    assert_equal(JSON.parse(%w[k l m].stringify).to_tidy_json(indent: '<<'),
+                 "{\n  \"class\": \"Array\"\n}\n")
+  end
 end

data/tidy_json.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors     = ['Robert Di Pardo']
   spec.email       = 'rdipardo0520@conestogac.on.ca'
   spec.homepage    = 'https://github.com/rdipardo/tidy_json'
-  spec.metadata    = {'documentation_uri' => 'https://rubydoc.org/github/rdipardo/tidy_json'}
+  spec.metadata    = { 'documentation_uri' => 'https://rubydoc.org/github/rdipardo/tidy_json/master' }
   spec.license     = 'MIT'
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     ['.yardopts'].concat(`git ls-files -z`.split("\x0").reject { |f| f.match(/^(\.[\w+\.]+|test|spec|features)/) })
@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3')
   spec.add_runtime_dependency 'json', '~> 2.2'
-  spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.rdoc_options = ['-x test/*']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tidy_json
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert Di Pardo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2020-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -86,17 +72,19 @@ homepage: https://github.com/rdipardo/tidy_json
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://rubydoc.org/github/rdipardo/tidy_json
-post_install_message: |
+  documentation_uri: https://rubydoc.org/github/rdipardo/tidy_json/master
+post_install_message: |2+
+
   ..................................................
   ................... IN MEMORIAM ..................
   ................ Michael Di Pardo ................
-  ................... 1950 - 2019 ..................
+  ........... Feb 4, 1950 - Oct 28, 2019 ...........
   ..................................................
   ........... Please consider supporting ...........
   ............. the MS Society of Canada ...........
   ........ https://mssociety.ca/get-involved .......
   ..................................................
+
 rdoc_options:
 - "-x test/*"
 require_paths:
@@ -112,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Serialize any Ruby object as readable JSON