jiffy 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bc1a30ffa4bb53cb826e029643ec2572da25375
-  data.tar.gz: a7c79105994a82bbb12d5525148d6c9696b0f921
+  metadata.gz: e0b24cab682865e66e57fcef137dbb16492158d5
+  data.tar.gz: bf680796b8fec83793ed3f781b60d2108f5cf41f
 SHA512:
-  metadata.gz: 12374f963d089e7c772371f93aecd3f4a7959659a3b2be8e36ec2917d4c79cc20ceac0b7db78bb73083895b3b3059afcd5e9656e9667eebfc109667dd9d3ce3c
-  data.tar.gz: 7841afcdcf39e0cb7ec6bac9499a36fa0e6924d85084afa0422b1ed0e064958552d74698bc3b334fbe7b160f9308729066d20797722c6a2bd2cca92f9762f973
+  metadata.gz: cd4319b4bb0d99edfed8d5836487a15759fa8800ee01edc196532a13e230b84a1311634fcadb7b21da25aff57647f49eeabb3f6ded723d9a84fe6b4b7e6c8791
+  data.tar.gz: 8dac509b4f86bd815a51f84b5e4a9877fdcf3d6f12b032e4d37886e6206265623a3b606fbc6a7160f534f0ad28fd96711dceaf0149e827b1e58e9638d0fec96f

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - 2.1.3
+  - 2.1.4
+  - 2.1.5
+  - 2.2.0
+script:
+  - bundle exec rake test

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jiffy (1.0.4)
+    jiffy (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,6 +2,8 @@ Jiffy
 =====
 
 [![Build Status](https://travis-ci.org/badeball/jiffy.png)](https://travis-ci.org/badeball/jiffy)
+[![Test Coverage](https://codeclimate.com/github/badeball/jiffy/badges/coverage.svg)](https://codeclimate.com/github/badeball/jiffy)
+[![Code Climate](https://codeclimate.com/github/badeball/jiffy/badges/gpa.svg)](https://codeclimate.com/github/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
@@ -34,46 +36,33 @@ $ yaourt -S ruby-jiffy
 ```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()"
-#         }
-#       ]
-#     }
-#   }
-# }
+Jiffy.new(in: StringIO.new('[false, true, null]')).tokenize.to_a # => [:begin_array, :false, :value_separator, :true, :value_separator, :null, :end_array]
 ```
 
-One can also chose to specify an IO object as input stream.
+Any IO object that responds to `readpartial` can be used as an input source.
 
 ```ruby
-Jiffy.new(in: File.open('some.json')).format
+Jiffy.new(in: File.open('some.json'))
 ```
 
-It is also possible to specify an IO object as output stream.
+One can also chose to specify a file path instead of an IO object as input source.
+
+```ruby
+Jiffy.new(in: 'some.json')
+```
+
+`Jiffy#format` can be used to format the input source instead of just tokenizing it.
 
 ```ruby
 require 'stringio'
 
+in = StringIO.new('[false, true, null]')
 out = StringIO.new
+outputter = Jiffy::Outputters::Json.new(out: out)
 
-Jiffy.new(in: 'some.json', out: out).format
+Jiffy.new(in: in).format(outputter: outputter)
+
+out.string # => "[\n  false,\n  true,\n  null\n]"
 ```
 
 ### Command line usage
@@ -94,6 +83,7 @@ $ cat incredibly-large.json | jiffy | less
 
 Tested against the following Ruby versions.
 
+* 1.9.3
 * 2.0.0
 * 2.1.0
 * 2.1.1
@@ -101,9 +91,18 @@ Tested against the following Ruby versions.
 * 2.1.3
 * 2.1.4
 * 2.1.5
+* 2.2.0
 
 ## Changelog
 
+### 1.1.0
+
+* Fixing an issue where the first digit in numbers was tokenized to :char.
+* Add numerous extra tokens to represent things that was previously emitted as :chars.
+* Add an option to colorize output.
+* Add an option to output Ruby objects instead of Json.
+* Different refactorings, which unfortunately breaks API compatibility.
+
 ### 1.0.4
 
 * SIGPIPE is handled by exiting (with exit code 141).

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+desc 'Compile every parser using Ragel'
+
+task :compile do
+  Dir.chdir 'lib/jiffy/parsers/' do
+    (Dir['*.rl'] - ['json_common.rl']).each do |parser|
+      system "ragel -R #{parser}"
+    end
+  end
+end

data/bin/jiffy

@@ -4,17 +4,35 @@ require 'optparse'
 require 'jiffy'
 require 'jiffy/version'
 
+options = {
+  indent_size: 2,
+  outputter: "json",
+  color: STDOUT.tty?
+}
+
 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("-iSIZE", "--indent=SIZE", Integer, "how many spaces to use for indenting") do |size|
+    options[:indent_size] = size
+  end
+
+  opts.on_tail("-oNAME", "--output=NAME", ["json", "ruby"], "which format to output (json, ruby)") do |outputter|
+    options[:outputter] = outputter
+  end
+
+  opts.on_tail("-c", "--[no-]color", "colorize the output") do |color|
+    options[:color] = color
+  end
+
   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
+  opts.on_tail("-v", "--version", "Print the version number of jiffy") do
     puts "jiffy #{Jiffy::VERSION}"
     exit
   end
@@ -36,10 +54,17 @@ Signal.trap("PIPE") do
   exit 141
 end
 
+outputter = case options[:outputter]
+            when "json"
+              Jiffy::Outputters::Json
+            when "ruby"
+              Jiffy::Outputters::Ruby
+            end
+
 result = if ARGV.empty?
-           Jiffy.new(in: STDIN).cl_format(err: STDERR)
+           Jiffy.new(in: STDIN).cl_format(outputter: outputter.new(options))
          else
-           Jiffy.new(in: ARGF).cl_format(err: STDERR)
+           Jiffy.new(in: ARGF).cl_format(outputter: outputter.new(options))
          end
 
 exit 1 unless result

data/jiffy.gemspec

@@ -16,7 +16,20 @@ Gem::Specification.new do |s|
   s.executables = 'jiffy'
 
   s.files       = %w[
+    .travis.yml
+    Gemfile
+    Gemfile.lock
+    LICENSE
+    README.md
+    Rakefile
     bin/jiffy
+    jiffy.gemspec
+    lib/jiffy.rb
+    lib/jiffy/array_mimicking_io.rb
+    lib/jiffy/outputter.rb
+    lib/jiffy/outputters/json.rb
+    lib/jiffy/outputters/ruby.rb
+    lib/jiffy/parser.rb
     lib/jiffy/parsers/json.rb
     lib/jiffy/parsers/json.rl
     lib/jiffy/parsers/json_array.rb
@@ -30,74 +43,10 @@ Gem::Specification.new do |s|
     lib/jiffy/parsers/json_string.rl
     lib/jiffy/parsers/json_value.rb
     lib/jiffy/parsers/json_value.rl
-    lib/jiffy/array_mimicking_io.rb
-    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
+    test/outputter_test.rb
+    test/outputters/json_test.rb
   ]
 
   s.add_development_dependency('minitest')

data/lib/jiffy.rb

@@ -1,32 +1,19 @@
+require 'jiffy/array_mimicking_io'
+require 'jiffy/outputter'
+require 'jiffy/outputters/json'
+require 'jiffy/outputters/ruby'
+require 'jiffy/parser'
 require 'jiffy/parsers/json'
 require 'jiffy/parsers/json_array'
 require 'jiffy/parsers/json_float'
 require 'jiffy/parsers/json_object'
 require 'jiffy/parsers/json_string'
 require 'jiffy/parsers/json_value'
-require 'jiffy/array_mimicking_io'
-require 'jiffy/json_outputter'
 
 class Jiffy
   class UnparseableError < StandardError; end
   class UnexpectedEndError < StandardError; end
 
-  class << self
-    attr_accessor :json_start
-  end
-
-  prepend Parsers::Json
-  prepend Parsers::JsonArray
-  prepend Parsers::JsonFloat
-  prepend Parsers::JsonObject
-  prepend Parsers::JsonString
-  prepend Parsers::JsonValue
-
-  attr_accessor :io, :data, :outputter
-
-  alias_method :o, :outputter
-  alias_method :format, :parse_json
-
   def initialize(options = {})
     if options[:in].is_a?(String)
       @io = File.open(options[:in])
@@ -37,14 +24,33 @@ class Jiffy
     end
 
     @data = ArrayMimickingIO.new(@io)
+  end
 
-    @outputter = JsonOutputter.new(options)
+  def tokenize
+    Enumerator.new do |yielder|
+      begin
+        parser = Parsers::Json.new(p: 0, data: @data, yielder: yielder)
+        parser.parse
+      rescue EOFError
+        if parser.p < @data.bytes_read || @data.bytes_read == 0
+          raise UnexpectedEndError, 'Unexpected end of input'
+        end
+      end
+    end
+  end
+
+  def format(options = {})
+    enumerator = tokenize
+
+    loop do
+      options[:outputter].process_token *enumerator.next
+    end
   end
 
   def cl_format(options = {})
-    format
+    format options
 
-    @outputter.t :char, "\n"
+    options[:outputter].process_token :char, "\n"
 
     true
   rescue Errno::EACCES
@@ -84,10 +90,4 @@ class Jiffy
 
     false
   end
-
-  private
-
-  def raise_unparseable(p)
-    raise UnparseableError, "Unexpected token at position #{p}"
-  end
 end

data/lib/jiffy/array_mimicking_io.rb

@@ -29,7 +29,7 @@ class Jiffy
     end
 
     def read_chunk
-      @chunk = @io.readpartial(CHUNK_SIZE).codepoints
+      @chunk = @io.readpartial(CHUNK_SIZE).each_codepoint.to_a
 
       @bytes_read += @chunk.length
     end

data/lib/jiffy/outputter.rb

@@ -0,0 +1,85 @@
+class Jiffy
+  class Outputter
+    class << self
+      attr_accessor :rules
+
+      def rule(token, options = {}, &block)
+        if options[:break_before] && options[:break_after]
+          raise ArgumentError, "Cannot specify both :break_before and :break_after"
+        end
+
+        options[:format] ||= block
+        @rules ||= {}
+        @rules[token] = options
+      end
+    end
+
+    COLOR_SEQUENCES = {
+      reset: "\e[0m",
+      black: "\e[0;30m",
+      gray: "\e[0;37m",
+      red: "\e[0;31m",
+      green: "\e[0;32m",
+      yellow: "\e[0;33m",
+      blue: "\e[0;34m",
+      purple: "\e[0;35m",
+      light_purple: "\e[38;5;174m",
+      cyan: "\e[0;36m",
+      white: "\e[0;37m"
+    }
+
+    attr_accessor :out, :cur_indent, :indent_size, :last_color
+
+    def initialize(options = {})
+      @out = options[:out] || $stdout
+      @color = options[:color]
+      @last_color = options[:last_color]
+      @cur_indent = options[:cur_indent] || 0
+      @indent_size = options[:indent_size] || 2
+
+      raise ArgumentError, "Invalid output source, must respond to #print" unless @out.respond_to? :print
+      raise ArgumentError, "Invalid current indent, expected fixnum" unless @cur_indent.is_a? Fixnum
+      raise ArgumentError, "Invalid indent size, expected fixnum" unless @indent_size.is_a? Fixnum
+    end
+
+    def process_token(token, payload = nil)
+      unless self.class.rules.has_key? token
+        raise ArgumentError, "No rule exists for token #{token.inspect}"
+      end
+
+      apply_rule self.class.rules[token], payload
+    end
+
+    def apply_rule(rule, payload = nil)
+      @cur_indent += rule[:indent] if rule[:indent]
+
+      if rule[:break_before]
+        @out.print "\n" << " " * @cur_indent * @indent_size
+      end
+
+      if @color
+        if rule[:color]
+          if @last_color.nil? || @last_color != rule[:color]
+            @last_color = rule[:color]
+            @out.print COLOR_SEQUENCES[rule[:color]]
+          end
+        elsif !@last_color.nil?
+          @last_color = nil
+          @out.print COLOR_SEQUENCES[:reset]
+        end
+      end
+
+      payload ||= rule[:payload]
+
+      if rule[:format]
+        @out.print rule[:format].call payload
+      else
+        @out.print payload.to_s
+      end
+
+      if rule[:break_after]
+        @out.print "\n" << " " * @cur_indent * @indent_size
+      end
+    end
+  end
+end