jiffy 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe32595cfa71cdbb4d6ab8aadab3da303ced671f
+  data.tar.gz: 3db1aeb55a7e6f78ce15a19d2240e4bcb530134c
+SHA512:
+  metadata.gz: 4a759a9452c53cdefe2e9d724a53eddb415491104ec8af2c9f1ed1e85d94a6186fdc157352467d61af87052bb283a179d7aaad29bb53e284de0468a19f8f0ac9
+  data.tar.gz: e51d267574c1953e73b56d9c96050a2b59ef3d121142900306cfb66a420bc87c5fb3feb39917d8e413be4cfba9bc4d098e32f1872d94a0f7c71a32003b911d0b

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    jiffy (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.3.3)
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jiffy!
+  minitest
+  rake

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Jonas Amundsen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,144 @@
+Jiffy
+=====
+
+[![Build Status](https://travis-ci.org/badeball/jiffy.png)](https://travis-ci.org/badeball/jiffy)
+
+A streaming-based JSON formatter in Ruby that utilizes Ragel in order to parse
+and continuously format JSON data. This allows it to achieve a somewhat
+constant memory usage, independent of the input size. This is contrary to
+libraries that translates JSON into its own internal AST or those which simply
+uses JSON#pretty_generate.
+
+## Installation
+
+The utility can be installed using `gem`, but is also packaged for Arch Linux.
+
+```
+$ gem install jiffy
+```
+
+It can be installed system-wide using the following options.
+
+```
+$ gem install --no-user-install -i "$(ruby -e'puts Gem.default_dir')" -n /usr/bin jiffy
+```
+
+### Arch Linux
+
+```
+$ yaourt -Syua ruby-jiffy
+```
+
+## Usage
+
+```ruby
+require 'jiffy'
+
+Jiffy.new(in: 'some.json').format
+
+# {
+#   "menu": {
+#     "id": "file",
+#     "value": "File",
+#     "popup": {
+#       "menuitem": [
+#         {
+#           "value": "New",
+#           "onclick": "CreateNewDoc()"
+#         },
+#         {
+#           "value": "Open",
+#           "onclick": "OpenDoc()"
+#         },
+#         {
+#           "value": "Close",
+#           "onclick": "CloseDoc()"
+#         }
+#       ]
+#     }
+#   }
+# }
+```
+
+One can also chose to specify an IO object as input stream.
+
+```ruby
+Jiffy.new(in: File.open('some.json')).format
+```
+
+It is also possible to specify an IO object as output stream.
+
+```ruby
+require 'stringio'
+
+out = StringIO.new
+
+Jiffy.new(in: 'some.json', out: out).format
+```
+
+### Command line usage
+
+With this tool, one can immediately get a sense of the JSON-structure of a file
+of any size. The executable can read from a file specified as an argument or
+read from standard input.
+
+```
+$ jiffy incredibly-large.json | less
+```
+
+```
+$ cat incredibly-large.json | jiffy | less
+```
+
+## Compatibility
+
+Tested against the following Ruby versions.
+
+* 2.0.0
+* 2.1.0
+* 2.1.1
+* 2.1.2
+* 2.1.3
+* 2.1.4
+* 2.1.5
+
+## Changelog
+
+### 1.0.1
+
+* The application is renamed Jiffy.
+* The executable may now read from standard input.
+* SIGTERM and SIGINT is now handled properly and a ruby stacktrace is now shown.
+
+### 1.0.0
+
+* ArgumentError is raised instead of custom error classes for each argument.
+* Fixing an issue where unparseable values would raise NameError and not UnparseableError.
+* Unexpected end of input is now properly handled and an UnparseableError is raised.
+* Removing parsing of NaN and Infinity.
+
+### 0.0.6
+
+* Correcting an issue where a file was missing from the gemspec.
+
+### 0.0.5
+
+* Adding a command line option to show the version number.
+
+### 0.0.4
+
+* Fixing an issue where using an IO object as input source would always raise
+  an error.
+
+### 0.0.3
+
+* Added install instructions to the README.
+* #2: Added command line help text to the executable.
+
+### 0.0.2
+
+* #1: The executable now handles closed pipes.
+
+### 0.0.1
+
+* Initial work on the project.

data/bin/jiffy

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'jiffy'
+require 'jiffy/version'
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: jiffy [options] [FILE]"
+  opts.separator "Standard input is read when FILE is not present"
+  opts.separator ""
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-v", "--version", "Print the version number of format-json") do
+    puts "jiffy #{Jiffy::VERSION}"
+    exit
+  end
+end
+
+opts.parse!
+
+Signal.trap("INT") do
+  puts "Aborted"
+  exit 1
+end
+
+Signal.trap("TERM") do
+  puts "Aborted"
+  exit 1
+end
+
+begin
+  if ARGV.empty?
+    Jiffy.new(in: STDIN).format
+  else
+    Jiffy.new(in: ARGF).format
+  end
+rescue Jiffy::UnparseableError => e
+  $stderr.puts e
+  exit! 1
+rescue Errno::EPIPE
+  # Do nothing
+end

data/jiffy.gemspec

@@ -0,0 +1,104 @@
+require File.join(File.dirname(__FILE__), 'lib', 'jiffy', 'version')
+
+Gem::Specification.new do |s|
+  s.name        = 'jiffy'
+  s.version     = Jiffy::VERSION
+  s.license     = 'MIT'
+  s.date        = '2014-12-03'
+
+  s.summary     = 'A streaming-based JSON formatter in Ruby.'
+  s.description = 'Jiffy utilizes Ragel in order to parse and continuously format JSON data. This allows it to achieve a constant memory usage, independent of the input size.'
+
+  s.authors     = ['Jonas Amundsen']
+  s.email       = ['jonasba+gem@gmail.com']
+  s.homepage    = 'https://github.com/badeball/jiffy'
+
+  s.executables = 'jiffy'
+
+  s.files       = %w[
+    bin/jiffy
+    lib/jiffy/parsers/json.rb
+    lib/jiffy/parsers/json.rl
+    lib/jiffy/parsers/json_array.rb
+    lib/jiffy/parsers/json_array.rl
+    lib/jiffy/parsers/json_common.rl
+    lib/jiffy/parsers/json_float.rb
+    lib/jiffy/parsers/json_float.rl
+    lib/jiffy/parsers/json_object.rb
+    lib/jiffy/parsers/json_object.rl
+    lib/jiffy/parsers/json_string.rb
+    lib/jiffy/parsers/json_string.rl
+    lib/jiffy/parsers/json_value.rb
+    lib/jiffy/parsers/json_value.rl
+    lib/jiffy/json_outputter.rb
+    lib/jiffy/version.rb
+    lib/jiffy.rb
+    test/negative-examples/hexadecimal.json
+    test/negative-examples/infinity-value.json
+    test/negative-examples/leading-comma.json
+    test/negative-examples/leading-zero.json
+    test/negative-examples/line-break.json
+    test/negative-examples/missing-colon.json
+    test/negative-examples/nan-value,json
+    test/negative-examples/positive-float.json
+    test/negative-examples/positive-integer.json
+    test/negative-examples/single-quote.json
+    test/negative-examples/string-as-root.json
+    test/negative-examples/tab-character.json
+    test/negative-examples/trailing-array-seperator.json
+    test/negative-examples/trailing-object-seperator.json
+    test/negative-examples/true-as-root.json
+    test/negative-examples/unclosed-array.json
+    test/negative-examples/unclosed-object.json
+    test/positive-examples/array-as-root.json
+    test/positive-examples/array-nested-inside-array.json
+    test/positive-examples/array-nested-inside-object.json
+    test/positive-examples/false-value.json
+    test/positive-examples/null-value.json
+    test/positive-examples/number-1.json
+    test/positive-examples/number-10.json
+    test/positive-examples/number-11.json
+    test/positive-examples/number-12.json
+    test/positive-examples/number-13.json
+    test/positive-examples/number-14.json
+    test/positive-examples/number-15.json
+    test/positive-examples/number-16.json
+    test/positive-examples/number-17.json
+    test/positive-examples/number-18.json
+    test/positive-examples/number-19.json
+    test/positive-examples/number-2.json
+    test/positive-examples/number-20.json
+    test/positive-examples/number-3.json
+    test/positive-examples/number-4.json
+    test/positive-examples/number-5.json
+    test/positive-examples/number-6.json
+    test/positive-examples/number-7.json
+    test/positive-examples/number-8.json
+    test/positive-examples/number-9.json
+    test/positive-examples/object-as-root.json
+    test/positive-examples/object-nested-inside-array.json
+    test/positive-examples/object-nested-inside-object.json
+    test/positive-examples/seperated-array-values.json
+    test/positive-examples/seperated-object-properties.json
+    test/positive-examples/string-backspace.json
+    test/positive-examples/string-carriage-return.json
+    test/positive-examples/string-formfeed.json
+    test/positive-examples/string-horizontal-tab.json
+    test/positive-examples/string-newline.json
+    test/positive-examples/string-quotation.json
+    test/positive-examples/string-reverse-solidus.json
+    test/positive-examples/string-solidus.json
+    test/positive-examples/string-trivial.json
+    test/positive-examples/string-unicode.json
+    test/positive-examples/true-value.json
+    test/jiffy_test.rb
+    Gemfile
+    Gemfile.lock
+    jiffy.gemspec
+    LICENSE
+    README.md
+  ]
+
+  s.add_development_dependency('minitest')
+  s.add_development_dependency('rake')
+end

data/lib/jiffy/json_outputter.rb

@@ -0,0 +1,62 @@
+class Jiffy
+  class JsonOutputter
+    attr_accessor :out, :indent
+
+    def initialize(options)
+      self.out = options[:out] || $stdout
+
+      raise ArgumentError, 'Invalid output source' unless out.respond_to? :print
+
+      self.indent = 0
+    end
+
+    def process_token(token, payload = nil)
+      case token
+        when :begin_object
+          output '{', indent: 1, newline_after: true
+        when :end_object
+          output '}', indent: -1, newline_before: true
+        when :begin_array
+          output '[', indent: 1, newline_after: true
+        when :end_array
+          output ']', indent: -1, newline_before: true
+        when :value_separator
+          output ',', newline_after: true
+        when :name_separator
+          output ': '
+        when :begin_string, :end_string
+          output '"'
+        when :null
+          output 'null'
+        when :nan
+          output 'NaN'
+        when :inf
+          output 'Infinity'
+        when :true
+          output 'true'
+        when :false
+          output 'false'
+        when :char
+          output payload
+        when :number
+          output payload.to_s
+        else
+          puts "Unknown token: #{token.inspect}"
+      end
+    end
+
+    alias_method :t, :process_token
+
+    def output(content, options = {})
+      self.indent += options[:indent] if options[:indent]
+
+      if options[:newline_before]
+        out.print "\n" << '  ' * self.indent
+      end
+
+      out.print content
+
+      out.print "\n" << '  ' * self.indent if options[:newline_after]
+    end
+  end
+end

data/lib/jiffy/parsers/json.rb

@@ -0,0 +1,293 @@
+
+# line 1 "json.rl"
+
+# line 27 "json.rl"
+
+
+class Jiffy
+  module Parsers
+    module Json
+      def initialize(*args)
+        
+# line 13 "json.rb"
+class << self
+	attr_accessor :_json_actions
+	private :_json_actions, :_json_actions=
+end
+self._json_actions = [
+	0, 1, 0, 1, 1
+]
+
+class << self
+	attr_accessor :_json_key_offsets
+	private :_json_key_offsets, :_json_key_offsets=
+end
+self._json_key_offsets = [
+	0, 0, 7, 9, 10, 12, 13, 15, 
+	16, 18, 19
+]
+
+class << self
+	attr_accessor :_json_trans_keys
+	private :_json_trans_keys, :_json_trans_keys=
+end
+self._json_trans_keys = [
+	13, 32, 47, 91, 123, 9, 10, 42, 
+	47, 42, 42, 47, 10, 42, 47, 42, 
+	42, 47, 10, 13, 32, 47, 9, 10, 
+	0
+]
+
+class << self
+	attr_accessor :_json_single_lengths
+	private :_json_single_lengths, :_json_single_lengths=
+end
+self._json_single_lengths = [
+	0, 5, 2, 1, 2, 1, 2, 1, 
+	2, 1, 3
+]
+
+class << self
+	attr_accessor :_json_range_lengths
+	private :_json_range_lengths, :_json_range_lengths=
+end
+self._json_range_lengths = [
+	0, 1, 0, 0, 0, 0, 0, 0, 
+	0, 0, 1
+]
+
+class << self
+	attr_accessor :_json_index_offsets
+	private :_json_index_offsets, :_json_index_offsets=
+end
+self._json_index_offsets = [
+	0, 0, 7, 10, 12, 15, 17, 20, 
+	22, 25, 27
+]
+
+class << self
+	attr_accessor :_json_indicies
+	private :_json_indicies, :_json_indicies=
+end
+self._json_indicies = [
+	0, 0, 2, 3, 4, 0, 1, 5, 
+	6, 1, 7, 5, 7, 0, 5, 0, 
+	6, 8, 9, 1, 10, 8, 10, 11, 
+	8, 11, 9, 11, 11, 12, 11, 1, 
+	0
+]
+
+class << self
+	attr_accessor :_json_trans_targs
+	private :_json_trans_targs, :_json_trans_targs=
+end
+self._json_trans_targs = [
+	1, 0, 2, 10, 10, 3, 5, 4, 
+	7, 9, 8, 10, 6
+]
+
+class << self
+	attr_accessor :_json_trans_actions
+	private :_json_trans_actions, :_json_trans_actions=
+end
+self._json_trans_actions = [
+	0, 0, 0, 3, 1, 0, 0, 0, 
+	0, 0, 0, 0, 0
+]
+
+class << self
+	attr_accessor :json_start
+end
+self.json_start = 1;
+class << self
+	attr_accessor :json_first_final
+end
+self.json_first_final = 10;
+class << self
+	attr_accessor :json_error
+end
+self.json_error = 0;
+
+class << self
+	attr_accessor :json_en_main
+end
+self.json_en_main = 1;
+
+
+# line 34 "json.rl"
+        super
+      end
+
+      def parse_json
+        pe = :ignored
+        eof = :ignored
+        leftover = []
+
+        
+# line 128 "json.rb"
+begin
+	p ||= 0
+	pe ||= data.length
+	cs = json_start
+end
+
+# line 43 "json.rl"
+
+        while chunk = io.read(1_000_000)
+          self.data = leftover + chunk.unpack("c*")
+          p ||= 0
+          pe = data.length
+
+          
+# line 143 "json.rb"
+begin
+	_klen, _trans, _keys, _acts, _nacts = nil
+	_goto_level = 0
+	_resume = 10
+	_eof_trans = 15
+	_again = 20
+	_test_eof = 30
+	_out = 40
+	while true
+	_trigger_goto = false
+	if _goto_level <= 0
+	if p == pe
+		_goto_level = _test_eof
+		next
+	end
+	if cs == 0
+		_goto_level = _out
+		next
+	end
+	end
+	if _goto_level <= _resume
+	_keys = _json_key_offsets[cs]
+	_trans = _json_index_offsets[cs]
+	_klen = _json_single_lengths[cs]
+	_break_match = false
+	
+	begin
+	  if _klen > 0
+	     _lower = _keys
+	     _upper = _keys + _klen - 1
+
+	     loop do
+	        break if _upper < _lower
+	        _mid = _lower + ( (_upper - _lower) >> 1 )
+
+	        if data[p].ord < _json_trans_keys[_mid]
+	           _upper = _mid - 1
+	        elsif data[p].ord > _json_trans_keys[_mid]
+	           _lower = _mid + 1
+	        else
+	           _trans += (_mid - _keys)
+	           _break_match = true
+	           break
+	        end
+	     end # loop
+	     break if _break_match
+	     _keys += _klen
+	     _trans += _klen
+	  end
+	  _klen = _json_range_lengths[cs]
+	  if _klen > 0
+	     _lower = _keys
+	     _upper = _keys + (_klen << 1) - 2
+	     loop do
+	        break if _upper < _lower
+	        _mid = _lower + (((_upper-_lower) >> 1) & ~1)
+	        if data[p].ord < _json_trans_keys[_mid]
+	          _upper = _mid - 2
+	        elsif data[p].ord > _json_trans_keys[_mid+1]
+	          _lower = _mid + 2
+	        else
+	          _trans += ((_mid - _keys) >> 1)
+	          _break_match = true
+	          break
+	        end
+	     end # loop
+	     break if _break_match
+	     _trans += _klen
+	  end
+	end while false
+	_trans = _json_indicies[_trans]
+	cs = _json_trans_targs[_trans]
+	if _json_trans_actions[_trans] != 0
+		_acts = _json_trans_actions[_trans]
+		_nacts = _json_actions[_acts]
+		_acts += 1
+		while _nacts > 0
+			_nacts -= 1
+			_acts += 1
+			case _json_actions[_acts - 1]
+when 0 then
+# line 5 "json.rl"
+		begin
+
+      if np = parse_json_object(p, pe)
+         begin p = (( np))-1; end
+
+      else
+        p = p - 1;
+        	begin
+		p += 1
+		_trigger_goto = true
+		_goto_level = _out
+		break
+	end
+
+      end
+    		end
+when 1 then
+# line 14 "json.rl"
+		begin
+
+      if np = parse_json_array(p, pe)
+         begin p = (( np))-1; end
+
+      else
+        p = p - 1;
+        	begin
+		p += 1
+		_trigger_goto = true
+		_goto_level = _out
+		break
+	end
+
+      end
+    		end
+# line 260 "json.rb"
+			end # action switch
+		end
+	end
+	if _trigger_goto
+		next
+	end
+	end
+	if _goto_level <= _again
+	if cs == 0
+		_goto_level = _out
+		next
+	end
+	p += 1
+	if p != pe
+		_goto_level = _resume
+		next
+	end
+	end
+	if _goto_level <= _test_eof
+	end
+	if _goto_level <= _out
+		break
+	end
+	end
+	end
+
+# line 50 "json.rl"
+        end
+
+        raise_unparseable p unless p == pe
+      end
+    end
+  end
+end