tidy_json 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63e286aa3b914d96b71dc8e32904e0ca0514deb1159bf9a8ef40978f7b2a2ea0
-  data.tar.gz: f7f30ca7fab2e95b93b4aa385d5e2a4752899b273a160e8a64151c68248fb0d5
+  metadata.gz: bf122c3cc2a34f2252b766f1a47f52bada4c4ff5b5334555ea62a572848d8531
+  data.tar.gz: bcd9134752408044711fc2b4ff3732afba7b65995b9c511c9df7e8fe666df4b5
 SHA512:
-  metadata.gz: 7a55fad57a8ffd7d303bb19cbd2f89665faad9089650d7324809fb7c4f1553c27b7783d6e608d0c284b3e91617801ae100a391bb11d142d023d3f037914ed8a0
-  data.tar.gz: 612e14c4480664a0ddb64cc8caac22915a60ca3709e3b1f5cae974eae050333104c5066ba513f70c1c5686dbc096f8c2663853126d4df2bd74d62860d4375ee3
+  metadata.gz: 0d9d164a90b41f3c5793ebaa04b361a5e1c15bf8ed7580a367421e08c06bcc7cd0f5f8555adc1e9adcff57585c59554472b129797343f78714f964c45c8a7ce6
+  data.tar.gz: 950f0eab8248273ce6b80a37918226d2637f436b99552844450bec62d6b3ab40dbe887c81c6fadc4baabd53dc1a2faaac834e6e68082b17d6fd1ac0d709d16ba

data/README.md

@@ -100,21 +100,51 @@ puts my_jsonable.to_tidy_json(indent: 4, sort: true, space_before: 2, ascii_only
 # => nil
 ```
 
+### Command Line Usage
+
+After [installing the gem][], pass the name of a file containing JSON to `jtidy`
+(with or without a file extension). Run `jtidy -h` for a complete list of
+formatting options:
+
+```
+jtidy FILE[.json] [-i [2,4,6,8,10,12]] [-p [1..8]] [-v [1..8]] [-o D] [-a D] [-m N] [-e] [-A] [-N] [-s] [-P]
+    -i, --indent [2,4,6,8,10,12]     The number of spaces to indent each object member [2]
+    -p, --prop-name-space [1..8]     The number of spaces to put after property names [0]
+    -v, --value-space [1..8]         The number of spaces to put before property values [1]
+    -o, --object-delim D             A string of whitespace to delimit object members [\n]
+    -a, --array-delim D              A string of whitespace to delimit array elements [\n]
+    -m, --max-nesting N              The maximum level of data structure nesting in the generated JSON; 0 == "no depth checking" [100]
+    -e, --escape                     Escape /'s [false]
+    -A, --ascii                      Generate ASCII characters only [false]
+    -N, --nan                        Allow NaN, Infinity and -Infinity [false]
+    -s, --sort                       Sort property names [false]
+    -P, --preview                    Show preview of output [false]
+    -V, --version                    Show version
+    -h, --help                       Show this help message
+```
+
+### Notice
+The `jtidy` executable bundled with this gem is in no way affiliated with, nor based on,
+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).
+
 ### License
 Distributed under the terms of the [MIT License][].
 
 
 [travis_build_status]: https://travis-ci.com/rdipardo/tidy_json
-[cci_build_status]: https://circleci.com/gh/rdipardo/tidy_json/tree/master
+[cci_build_status]: https://circleci.com/gh/rdipardo/tidy_json/tree/testing
 [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?branch=master
-[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
+[codecov_status]: https://codecov.io/gh/rdipardo/tidy_json/branch/testing
+[codecov_badge]: https://codecov.io/gh/rdipardo/tidy_json/branch/testing/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
-
+[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
-[0.3.0]: https://github.com/rdipardo/tidy_json/releases/tag/v0.3.0
+[0.3.0]: https://github.com/rdipardo/tidy_json/releases/tag/v0.3.0

data/bin/jtidy

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'tidy_json'
+require_relative 'jtidy_info'
+
+class Jtidy # :nodoc:
+  OPTIONS = {
+    '-i [2,4,6,8,10,12]': [:indent, Integer, '--indent [2,4,6,8,10,12]',
+                           'The number of spaces to indent each object member [2]'],
+    '-p [1..8]': [:space_before, Integer, '--prop-name-space [1..8]',
+                  'The number of spaces to put after property names [0]'],
+    '-v [1..8]': [:space, Integer, '--value-space [1..8]',
+                  'The number of spaces to put before property values [1]'],
+    '-o D': [:object_nl, String, '--object-delim D',
+             'A string of whitespace to delimit object members [\n]'],
+    '-a D': [:array_nl, String, '--array-delim D',
+             'A string of whitespace to delimit array elements [\n]'],
+    '-m N': [:max_nesting, Integer, '--max-nesting N',
+             'The maximum level of data structure nesting in the generated ' \
+             'JSON; 0 == "no depth checking" [100]'],
+    '-e': [:escape_slash, nil, '--escape', 'Escape /\'s [false]'],
+    '-A': [:ascii_only, nil, '--ascii', 'Generate ASCII characters only [false]'],
+    '-N': [:allow_nan, nil, '--nan', 'Allow NaN, Infinity and -Infinity [false]'],
+    '-s': [:sort, nil, '--sort', 'Sort property names [false]'],
+    # script-only options
+    '-P': [:preview, nil, '--preview', 'Show preview of output [false]']
+  }.freeze
+
+  def self.unescape(str)
+    str.gsub(/\\b|\\h|\\n|\\r|\\s|\\t|\\v/,
+             {
+               '\\b': "\b",
+               '\\h': "\h",
+               '\\n': "\n",
+               '\\r': "\r",
+               '\\s': "\s",
+               '\\t': "\t",
+               '\\v': "\v"
+             })
+  end
+
+  def self.show_unused(opts)
+    return if opts.empty?
+
+    ignored = opts.keys.map do |key|
+      (OPTIONS.keys.select do |k|
+        OPTIONS[k][0].eql? key
+      end.first || '')[0..1]
+    end
+    warn "Ignoring options: #{(ignored.join ', ')}"
+  end
+
+  def self.parse(options)
+    format_options = {}
+    OptionParser.new do |opts|
+      opts.banner = \
+        "#{File.basename __FILE__} FILE[.json] " \
+        "#{(OPTIONS.keys.map { |k| "[#{k}]" }).join ' '}"
+      OPTIONS.each_key do |k|
+        opt, type, long_name, desc = OPTIONS[k]
+        opts.on(k, long_name, type, desc) do |v|
+          format_options[opt] = (type == String ? unescape(v) : v)
+        end
+      end
+
+      opts.on_tail('-V', '--version', 'Show version') do
+        show_unused format_options
+        puts ::JtidyInfo.new.to_s
+        exit 0
+      end
+
+      opts.on_tail('-h', '--help', 'Show this help message') do
+        show_unused format_options
+        puts opts
+        exit 0
+      end
+    end.parse! options
+
+    format_options
+  end
+
+  private_class_method :unescape, :show_unused
+end
+
+begin
+  begin
+    OPTS = Jtidy.parse(ARGV).freeze
+    INPUT_FILE = ARGV[0].freeze
+  rescue OptionParser::InvalidOption => e
+    warn e.message.capitalize
+    raise OptionParser::InvalidArgument
+  end
+
+  if !INPUT_FILE.nil? && !INPUT_FILE.empty?
+    tidy = ''
+    fname = INPUT_FILE.gsub('\\', '/')
+    ext = File.extname(fname)
+    input = File.join(
+      File.expand_path(File.dirname(fname)), File.basename(fname, ext)
+    )
+
+    begin
+      File.open((input + '.json').to_s, 'r') do |json|
+        begin
+          tidy = TidyJson.tidy(JSON.parse(json.read.strip), OPTS)
+        rescue JSON::JSONError => e
+          warn "#{__FILE__}.#{__LINE__}: #{e.message}"
+        end
+      end
+
+      if tidy.length.positive?
+        output = (input + '-tidy.json').to_s
+        File.open(output, 'w') { |fd| fd.write(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]
+end

data/bin/jtidy_info.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module TidyJson # :nodoc:
+  class JtidyInfo
+    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',
+      '#'
+    ].join("\n").freeze
+
+    attr_reader :meta
+
+    def initialize
+      gem = Gem::Specification.find_by_name('tidy_json')
+      @meta = {
+        name: "jtidy #{gem.version}",
+        license: "License: #{gem.license}",
+        bugs: "Bugs: #{gem.metadata['bug_tracker_uri']}",
+        notice: NOTICE
+      }
+    end
+
+    def to_s
+      (@meta.values.join "\n").freeze
+    end
+  end
+end

data/lib/tidy_json/formatter.rb

@@ -14,16 +14,16 @@ module TidyJson
     # Returns a new instance of +Formatter+.
     #
     # @param opts [Hash] Formatting options.
-    # @option opts [[2,4,6,8,10,12]] :indent (2) An even number of spaces to
-    #   indent each object member.
-    # @option opts [[2..8]] :space_before (0) The number of spaces to put
-    #   before each +:+ delimiter.
-    # @option opts [[2..8]] :space (1) The number of spaces to put after
-    #   each +:+ delimiter.
-    # @option opts [String] :object_nl ("\n") A string to put at the end of
+    # @option opts [[2,4,6,8,10,12]] :indent (2) The number of spaces to indent
     #   each object member.
-    # @option opts [String] :array_nl ("\n") A string to put at the end of
-    #   each array member.
+    # @option opts [[1..8]] :space_before (0) The number of spaces to put after
+    #   property names.
+    # @option opts [[1..8]] :space (1) The number of spaces to put before
+    #   property values.
+    # @option opts [String] :object_nl ("\n") A string of whitespace to delimit
+    #   object members.
+    # @option opts [String] :array_nl ("\n") A string of whitespace to delimit
+    #   array elements.
     # @option opts [Numeric] :max_nesting (100) The maximum level of data
     #   structure nesting in the generated JSON. Disable depth checking by
     #   passing +max_nesting: 0+.
@@ -31,12 +31,12 @@ module TidyJson
     #   slash (/) should be escaped.
     # @option opts [Boolean] :ascii_only (false) Whether or not only ASCII
     #   characters should be generated.
-    # @option opts [Boolean] :allow_nan (false) Whether or not +NaN+,
-    #   +Infinity+ and +-Infinity+ should be generated. If +false+, an
-    #   exception is thrown if these values are encountered.
+    # @option opts [Boolean] :allow_nan (false) Whether or not to allow +NaN+,
+    #   +Infinity+ and +-Infinity+. If +false+, an exception is thrown if one
+    #   of these values is encountered.
     # @option opts [Boolean] :sort (false) Whether or not object members should
-    #   be sorted by key.
-    # @see https://github.com/flori/json/blob/d49c5de49e54a5ad3f6fcf587f98d63266ef9439/lib/json/pure/generator.rb#L111 JSON::Pure::Generator
+    #   be sorted by property name.
+    # @see https://github.com/flori/json/blob/b8c1c640cd375f2e2ccca1b18bf943f80ad04816/lib/json/pure/generator.rb#L111 JSON::Pure::Generator
     def initialize(opts = {})
       # The number of times to reduce the left indent of a nested array's
       # opening bracket
@@ -46,18 +46,19 @@ module TidyJson
       @need_offset = false
 
       valid_indent = (2..12).step(2).include?(opts[:indent])
-      valid_space_before = (2..8).include?(opts[:space_before])
-      valid_space_after = (2..8).include?(opts[:space])
+      valid_space_before = (1..8).include?(opts[:space_before])
+      valid_space_after = (1..8).include?(opts[:space])
       # don't test for the more explicit :integer? method because it's defined
       # for floating point numbers also
       valid_depth = opts[:max_nesting] >= 0 \
                     if opts[:max_nesting].respond_to?(:times)
+      valid_newline = ->(str) { str.respond_to?(:strip) && str.strip.empty? }
       @format = {
         indent: "\s" * (valid_indent ? opts[:indent] : 2),
         space_before: "\s" * (valid_space_before ? opts[:space_before] : 0),
         space: "\s" * (valid_space_after ? opts[:space] : 1),
-        object_nl: opts[:object_nl] || "\n",
-        array_nl: opts[:array_nl] || "\n",
+        object_nl: (valid_newline.call(opts[:object_nl]) ? opts[:object_nl] : "\n"),
+        array_nl: (valid_newline.call(opts[:array_nl]) ? opts[:array_nl] : "\n"),
         max_nesting: valid_depth ? opts[:max_nesting] : 100,
         escape_slash: opts[:escape_slash] || false,
         ascii_only: opts[:ascii_only] || false,

data/lib/tidy_json/version.rb

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

data/tidy_json.gemspec

@@ -12,18 +12,22 @@ Gem::Specification.new do |spec|
   spec.authors     = ['Robert Di Pardo']
   spec.email       = 'dipardo.r@gmail.com'
   spec.homepage    = 'https://github.com/rdipardo/tidy_json'
-  spec.metadata    = { 'documentation_uri' => 'https://rubydoc.org/github/rdipardo/tidy_json' }
   spec.license     = 'MIT'
+  spec.metadata    = {
+    'documentation_uri' => 'https://rubydoc.org/github/rdipardo/tidy_json',
+    'bug_tracker_uri' => 'https://github.com/rdipardo/tidy_json/issues'
+  }
   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)/) })
+    ['.yardopts'].concat(`git ls-files -z`.split("\x0").reject { |f| f.match(/^(\.[\w+\.]+|test|spec|features|codecov)/) })
   end
   spec.test_files = Dir['test/*']
   spec.require_paths = ['lib']
+  spec.executables = ['jtidy']
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3')
   spec.add_runtime_dependency 'json', '~> 2.5'
-  spec.add_development_dependency 'codecov', '0.2.5'
+  spec.add_development_dependency 'codecov', '~> 0.2.5'
   spec.add_development_dependency 'simplecov', '~> 0.17'
-  spec.add_development_dependency 'test-unit', '~> 3.3'
+  spec.add_development_dependency 'test-unit', '~> 3.4'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.rdoc_options = ['-x test/*']
   spec.post_install_message = TidyJson::DEDICATION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tidy_json
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Robert Di Pardo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
+date: 2021-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -28,14 +28,14 @@ dependencies:
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.5
 - !ruby/object:Gem::Dependency
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,8 @@ dependencies:
         version: '0.9'
 description: A mixin providing (recursive) JSON serialization and pretty printing.
 email: dipardo.r@gmail.com
-executables: []
+executables:
+- jtidy
 extensions: []
 extra_rdoc_files: []
 files:
@@ -91,6 +92,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/jtidy
+- bin/jtidy_info.rb
 - lib/tidy_json.rb
 - lib/tidy_json/dedication.rb
 - lib/tidy_json/formatter.rb
@@ -105,6 +108,7 @@ licenses:
 - MIT
 metadata:
   documentation_uri: https://rubydoc.org/github/rdipardo/tidy_json
+  bug_tracker_uri: https://github.com/rdipardo/tidy_json/issues
 post_install_message: |2+
 
   ....................................................
@@ -139,11 +143,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Serialize any Ruby object as readable JSON
 test_files:
-- test/codecov_runner.rb
 - test/JsonableObject.json
+- test/codecov_runner.rb
 - test/test_tidy_json.rb