tidy_json 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfdad155c72b5ef6d411fbdd2dae876a4d7951e97f2f59f0817d09be0d1b1f8a
-  data.tar.gz: 40fbd785790e3dc649c1ab8ac16696b359f832cc43da577e71fe9b55a5467212
+  metadata.gz: 1ee82014d81eee49d6386266ea0b95ac1774291db69bdc50e32a062b7e39613e
+  data.tar.gz: fa30e666d9762736b9f61e89ce94b0ab2384df7cc7b011dd21114399d88b56e1
 SHA512:
-  metadata.gz: a62c5325d5ec264c61321518e26997170f5a1b34210d6c93052dfa2ab7aedce355ef0f9f9688dc4a18cd4113fafb121b314528374ba509b7e47f7a1f0f4afb7f
-  data.tar.gz: 2351e73fd6c2c6e8da966b02cec5da2eeaff8ca77a090c5ac5e7aff96122e27f12ac8c770b1b89ce943e6300e21325b099442750137ca54183fee568b8db048b
+  metadata.gz: 0fe08f848f90052cef2c6cff40c56cd9abd7afefc9d8998091d64fa6a8f710df2682f4c7c17eac9bbdb9185b5418e7da7ecfb6e8a1f82a860b4faaa481bfb97c
+  data.tar.gz: 3b6c7bbb72b216e9759f2c822ad35e206b41faafa21f3f9eb5bb79313008ba64562d99159d1f6e2e1485e9833e8a2f7916a8c8d1a307ab929b1f77f7f32a878d

data/README.md

@@ -24,7 +24,7 @@ gem 'tidy_json'
 ```ruby
 require 'tidy_json'
 
-class JsonableObject
+class Jsonable
   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,42 +32,42 @@ class JsonableObject
   end
 end
 
-my_jsonable = JsonableObject.new
+my_jsonable = Jsonable.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 my_jsonable.to_tidy_json(indent: 8)
+puts my_jsonable.to_tidy_json(indent: 4)
 # {
-#        "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>"
-#                ]
-#        }
+#     "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>"
+#        ]
+#    }
 # }
 # => nil
 ```

data/lib/tidy_json/dedication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TidyJson # :nodoc:
   DEDICATION = "\n#{'.' * 50}\n#{'.' * 19} IN MEMORIAM #{'.' * 18}\n" \
                "#{'.' * 16} Michael Di Pardo #{'.' * 16}\n" \
@@ -6,5 +8,5 @@ module TidyJson # :nodoc:
                "#{'.' * 11} Please consider supporting #{'.' * 11}\n" \
                "#{'.' * 13} the MS Society of Canada #{'.' * 11}\n" \
                "#{'.' * 8} https://mssociety.ca/get-involved #{'.' * 7}\n" \
-               "#{'.' * 50}\n\n".freeze
+               "#{'.' * 50}\n\n"
 end

data/lib/tidy_json/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TidyJson
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'
 end

data/lib/tidy_json.rb

@@ -74,7 +74,7 @@ module TidyJson
   # Writes a JSON representation of the sender object to the file specified by +out+.
   #
   # @param out [String] The destination filename.
-  # @param opts [Hash] Formatting options for this object's +#to_tidy_json+ method.
+  # @param opts [Hash] Formatting options for this object's +#to_tidy_json+ method, when called.
   #     [: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.
@@ -82,7 +82,16 @@ module TidyJson
     path = nil
 
     File.open("#{out}.json", 'w') do |f|
-      path = f << to_tidy_json(opts)
+      path =
+        f << if !instance_variables.empty?
+               if opts[:tidy] then to_tidy_json(opts)
+               else stringify
+               end
+             else
+               if opts[:tidy] then to_tidy_json(opts)
+               else to_json
+               end
+           end
     end
 
     path.path
@@ -245,6 +254,10 @@ module TidyJson
     # @!attribute indent
     #   @return [String] the string of white space used by this +Formatter+ to indent object members.
 
+    ##
+    # Returns a new instance of +Formatter+.
+    # @param format_options [Hash] Formatting options.
+    #     [:indent] the number of white spaces to indent. The default is 2.
     def initialize(format_options = {})
       ##
       # The number of times to reduce the left indent of a nested array's opening

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/master' }
+  spec.metadata    = { 'documentation_uri' => 'https://rubydoc.org/github/rdipardo/tidy_json' }
   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)/) })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tidy_json
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Robert Di Pardo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -72,7 +72,7 @@ homepage: https://github.com/rdipardo/tidy_json
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://rubydoc.org/github/rdipardo/tidy_json/master
+  documentation_uri: https://rubydoc.org/github/rdipardo/tidy_json
 post_install_message: |2+
 
   ..................................................