tidy_json 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c8377fc4c17ae11f718b6cadd5a0bbf5a806c1706f8184370e036dbeb714d73
-  data.tar.gz: dd9dcac5f8b3294f1edbd7a05762ad89277e6b593b0610d79d501e3d68e62fea
+  metadata.gz: 16df8d716d6fcdfeba6ed6afbf5954089e172f39b61a73fa853babb5d3c2cde6
+  data.tar.gz: bc64fa60a34d16af688444e0fb706c7a087dc38ced05babcc0680bf1874fed8f
 SHA512:
-  metadata.gz: 62b421c64ac5ecbd6fcc54a9e43f57d1e04ae52b6b6ab21c5eb65d65b4a267e44a28dde2ee67cf80167c5d0857c242c246e3881d510f00493e44b835fb17b52a
-  data.tar.gz: 0b7534efee7f35486f1bc8f60dab7031f762aa6fdc69a7eb83d603b2cfae25583aa702e4009ff8dba284a0e1b3136e0c4bafe39f43e235951d7bc93a767eca1a
+  metadata.gz: 54185c4b206f63502a061f2a8397a78697fee2eea068c77b1392f02c24d95136ecac03026c1b08b1782c554c0d3356373c367980ce857197f5c3ff2061393663
+  data.tar.gz: ba130a35229098c25b0e750dc631f725c53013eac9b69a702c26110cd321930c056f13627c066ac805a72851405cdc5203e90638def06e75396970a2c5b52b7d

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Robert Di Pardo
+Copyright (c) 2019-2020 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,24 +1,16 @@
 # TidyJson
 
-[![Build Status](https://travis-ci.com/rdipardo/tidy_json.svg)](https://travis-ci.com/rdipardo/tidy_json)
+[![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]
 
 A mixin providing (recursive) JSON serialization and pretty printing.
 
 ### Installation
 
-#### Minimal
-
-```bash
-    $ gem install tidy_json
-```
-
-#### Development (tests, YARD docs)
-
 ```bash
-    $ gem install -​-development tidy_json
+$ gem install tidy_json
 ```
 
-Or, with `bundler`:
+Or, in your `Gemfile`:
 
 ```ruby
 source 'https://rubygems.org'
@@ -32,21 +24,53 @@ gem 'tidy_json'
 ```ruby
 require 'tidy_json'
 
-JSON.parse [].stringify
-# => {"class"=>"Array"}
+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}" }]] }
+    @b = { a: 1, b: ['two', 3, '<abbr title="four">IV</abbr>'] }
+  end
+end
 
-complex_object = { :a => 1, :b => ['two', 3, '<abbr title="four">IV</abbr>'] }
-# => {:a=>1, :b=>["two", 3, "<abbr title=\"four\">IV</abbr>"]}
+complex_object = Jsonable.new
+puts JSON.parse complex_object.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
 # {
-# "a": 1,
+# "class": "Jsonable",
+# "a":
+#  {
+#    "a": "uno",
+#    "b": "dos",
+#    "c":
+#      [
+#        "I",
+#        "II",
+#        "III",
+#          [
+#            "i.",
+#            "ii.",
+#            "iii.",
+#            {
+#              "ichi":"一",
+#              "ni":"二",
+#              "san":"三",
+#              "yon":"四"
+#            }
+#          ]
+#      ]
+#   },
 # "b":
-#   [
-#     "two",
-#     3,
-#     "<abbr title=\"four\">IV</abbr>"
-#   ]
+#   {
+#     "a": 1,
+#     "b":
+#       [
+#         "two",
+#         3,
+#         "<abbr title=\"four\">IV</abbr>"
+#       ]
+#    }
 # }
 # => nil
 ```
@@ -57,12 +81,16 @@ puts complex_object.to_tidy_json
 - [json](https://rubygems.org/gems/json) ~> 2.2
 
 #### Building
-- [bundler](https://rubygems.org/gems/bundler) ~> 2.1
+- [bundler](https://rubygems.org/gems/bundler) ~> 1.17
 - [minitest](https://rubygems.org/gems/minitest) ~> 5.0
 - [yard](https://rubygems.org/gems/yard) ~> 0.9
 
 ### License
 [MIT](https://opensource.org/licenses/MIT)
 
-### Author
-[Robert Di Pardo](mailto:rdipardo0520@conestogac.on.ca)
+
+[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
+[gem_version_badge]: https://img.shields.io/gem/v/tidy_json

data/lib/tidy_json/dedication.rb

@@ -1,10 +1,8 @@
 module TidyJson # :nodoc:
-  DEDICATION = "#{'.' * 50}\n#{'.' * 20} tidy_json #{'.' * 19}\n" \
-               "#{'.' * 12} (c) 2019 Robert Di Pardo #{'.' * 12}\n" \
-               "#{'.' * 50}\n#{'.' * 19} IN MEMORIAM #{'.' * 18}\n" \
+  DEDICATION = "#{'.' * 50}\n#{'.' * 19} IN MEMORIAM #{'.' * 18}\n" \
                "#{'.' * 16} Michael Di Pardo #{'.' * 16}\n" \
                "#{'.' * 19} 1950 - 2019 #{'.' * 18}\n#{'.' * 50}\n" \
-               "#{'.' * 12} Please consider supporting #{'.' * 11}\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"

data/lib/tidy_json/version.rb

@@ -1,3 +1,3 @@
 module TidyJson
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/tidy_json.rb

@@ -73,7 +73,7 @@ module TidyJson
   # Writes a pretty-printed 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>_<current_UNIX_time></tt>.json
+  # @param out [String] The destination filename. Defaults to <tt><obj_class_name>_<unix timestamp></tt>.json
   # @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}")
     path = nil
@@ -374,7 +374,7 @@ end
 # ~TidyJson
 
 ##
-# Exposes the +TidyJson+ mixin to all Ruby objects.
+# Includes +TidyJson+ in every Ruby class.
 # ====
 #  class Object
 #    include TidyJson

data/tidy_json.gemspec

@@ -4,21 +4,22 @@ require_relative 'lib/tidy_json/dedication'
 Gem::Specification.new do |spec|
   spec.name        = 'tidy_json'
   spec.version     = TidyJson::VERSION
-  spec.date        = Time.now.to_s[0..9].to_s
+  spec.date        = Time.now.to_s[0..9]
   spec.summary     = 'Serialize any Ruby object as readable JSON'
   spec.description = 'A mixin providing (recursive) JSON serialization and pretty printing.'
   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.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)/) })
   end
   spec.test_files = Dir['test/*']
   spec.require_paths = ['lib']
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3')
   spec.add_runtime_dependency 'json', '~> 2.2'
-  spec.add_development_dependency 'bundler', '~> 2.1'
+  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.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Robert Di Pardo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-19 00:00:00.000000000 Z
+date: 2020-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -85,17 +85,15 @@ files:
 homepage: https://github.com/rdipardo/tidy_json
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://rubydoc.org/github/rdipardo/tidy_json
 post_install_message: |
-  ..................................................
-  .................... tidy_json ...................
-  ............ (c) 2019 Robert Di Pardo ............
   ..................................................
   ................... IN MEMORIAM ..................
   ................ Michael Di Pardo ................
   ................... 1950 - 2019 ..................
   ..................................................
-  ............ Please consider supporting ...........
+  ........... Please consider supporting ...........
   ............. the MS Society of Canada ...........
   ........ https://mssociety.ca/get-involved .......
   ..................................................
@@ -107,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="