jiffy 1.0.1 → 1.0.3

checksums.yaml

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

data/Gemfile.lock

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

data/README.md

@@ -20,13 +20,13 @@ $ 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
+$ gem install --no-user-install -i "$(ruby -e'puts Gem.default_dir')" -n /usr/local/bin jiffy
 ```
 
 ### Arch Linux
 
 ```
-$ yaourt -Syua ruby-jiffy
+$ yaourt -S ruby-jiffy
 ```
 
 ## Usage
@@ -104,11 +104,23 @@ Tested against the following Ruby versions.
 
 ## Changelog
 
+### 1.0.3
+
+* Fixed an issue with the gemspec.
+
+### 1.0.2
+
+* Missing read permissions is now handled properly.
+* Non-existing file as argument is now handled properly.
+* Directory as argument is now handled properly.
+* Output now always ends with a newline.
+* #read is switched out in favor of #readpartial.
+
 ### 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.
+* SIGTERM and SIGINT is now handled properly and a ruby stacktrace is not shown.
 
 ### 1.0.0
 

data/bin/jiffy

@@ -32,15 +32,10 @@ Signal.trap("TERM") do
   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
+result = if ARGV.empty?
+           Jiffy.new(in: STDIN).cl_format(err: STDERR)
+         else
+           Jiffy.new(in: ARGF).cl_format(err: STDERR)
+         end
+
+exit 1 unless result

data/jiffy.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.name        = 'jiffy'
   s.version     = Jiffy::VERSION
   s.license     = 'MIT'
-  s.date        = '2014-12-03'
+  s.date        = '2014-12-14'
 
   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.'
@@ -30,6 +30,7 @@ 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

data/lib/jiffy/array_mimicking_io.rb

@@ -0,0 +1,37 @@
+class Jiffy
+  class ArrayMimickingIO
+    CHUNK_SIZE = 1_000_000 # 1 MB
+
+    attr_accessor :io, :chunk, :bytes_read
+
+    def initialize(io)
+      @io = io
+      @chunk = []
+      @bytes_read = 0
+    end
+
+    def [](nth_byte)
+      read_chunk unless has_nth_byte?(nth_byte)
+
+      fetch_nth_byte(nth_byte)
+    end
+
+    private
+
+    def fetch_nth_byte(nth_byte)
+      index = nth_byte - bytes_read + chunk.length
+
+      chunk[index]
+    end
+
+    def has_nth_byte?(nth_byte)
+      bytes_read > nth_byte
+    end
+
+    def read_chunk
+      @chunk = @io.readpartial(CHUNK_SIZE).codepoints
+
+      @bytes_read += @chunk.length
+    end
+  end
+end

data/lib/jiffy/parsers/json.rb

@@ -121,9 +121,9 @@ self.json_en_main = 1;
       def parse_json
         pe = :ignored
         eof = :ignored
-        leftover = []
 
-        
+        begin
+          
 # line 128 "json.rb"
 begin
 	p ||= 0
@@ -132,14 +132,8 @@ begin
 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"
+# line 137 "json.rb"
 begin
 	_klen, _trans, _keys, _acts, _nacts = nil
 	_goto_level = 0
@@ -256,7 +250,7 @@ when 1 then
 
       end
     		end
-# line 260 "json.rb"
+# line 254 "json.rb"
 			end # action switch
 		end
 	end
@@ -283,10 +277,14 @@ when 1 then
 	end
 	end
 
-# line 50 "json.rl"
+# line 44 "json.rl"
+        rescue EOFError
+          if p < data.bytes_read || data.bytes_read == 0
+            raise UnexpectedEndError, 'Unexpected end of input'
+          end
         end
 
-        raise_unparseable p unless p == pe
+        raise_unparseable p unless p == data.bytes_read
       end
     end
   end

data/lib/jiffy/parsers/json.rl

@@ -37,19 +37,17 @@ class Jiffy
       def parse_json
         pe = :ignored
         eof = :ignored
-        leftover = []
-
-        %% write init;
-
-        while chunk = io.read(1_000_000)
-          self.data = leftover + chunk.unpack("c*")
-          p ||= 0
-          pe = data.length
 
+        begin
+          %% write init;
           %% write exec;
+        rescue EOFError
+          if p < data.bytes_read || data.bytes_read == 0
+            raise UnexpectedEndError, 'Unexpected end of input'
+          end
         end
 
-        raise_unparseable p unless p == pe
+        raise_unparseable p unless p == data.bytes_read
       end
     end
   end

data/lib/jiffy/version.rb

@@ -1,3 +1,3 @@
 class Jiffy
-  VERSION = '1.0.1'
+  VERSION = '1.0.3'
 end

data/lib/jiffy.rb

@@ -4,6 +4,7 @@ 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
@@ -29,22 +30,64 @@ class Jiffy
   def initialize(options = {})
     if options[:in].is_a?(String)
       @io = File.open(options[:in])
-    elsif options[:in].respond_to?(:read)
+    elsif options[:in].respond_to?(:readpartial)
       @io = options[:in]
     else
       raise ArgumentError, 'Invalid input source'
     end
 
+    @data = ArrayMimickingIO.new(@io)
+
     @outputter = JsonOutputter.new(options)
   end
 
-  private
+  def cl_format(options = {})
+    format
 
-  def raise_unparseable(p)
-    if !@io.closed? && @io.eof? && @data.length == p
-      raise UnexpectedEndError, 'Unexpected end of input'
+    @outputter.t :char, "\n"
+
+    true
+  rescue Errno::EACCES
+    err = options[:err] || $stderr
+
+    if @io.respond_to? :filename
+      err.write "jiffy: #{@io.filename}: Permission denied\n"
     else
-      raise UnparseableError, "Unexpected token at position #{p}"
+      err.write "jiffy: Permission denied\n"
     end
+
+    false
+  rescue Errno::ENOENT
+    err = options[:err] || $stderr
+
+    if @io.respond_to? :filename
+      err.write "jiffy: #{@io.filename}: No such file or directory\n"
+    else
+      err.write "jiffy: No such file or directory\n"
+    end
+
+    false
+  rescue Errno::EISDIR
+    err = options[:err] || $stderr
+
+    if @io.respond_to? :filename
+      err.write "jiffy: #{@io.filename}: Is a directory\n"
+    else
+      err.write "jiffy: Is a directory\n"
+    end
+
+    false
+  rescue UnexpectedEndError, UnparseableError => e
+    err = options[:err] || $stderr
+
+    err.write e.message << "\n"
+
+    false
+  end
+
+  private
+
+  def raise_unparseable(p)
+    raise UnparseableError, "Unexpected token at position #{p}"
   end
 end

data/test/jiffy_test.rb

@@ -4,33 +4,85 @@ require 'stringio'
 require 'minitest/autorun'
 require 'jiffy'
 
+valid_json = '["Valid JSON"]'
+invalid_json = '["Invalid" "JSON"]'
+incomplete_json = '["Incomplete JSON'
+
+def it_should_properly_handle(exception, options)
+  io = Object.new.tap do |io|
+    io.define_singleton_method :readpartial do |*|
+      raise exception
+    end
+  end
+
+  it "should return false upon #{exception.inspect}" do
+    assert_equal false, Jiffy.new(in: io, out: StringIO.new).cl_format(err: StringIO.new)
+  end
+
+  it "should write #{options[:with]} to :stderr upon #{exception.inspect}" do
+    err = StringIO.new
+
+    Jiffy.new(in: io, out: StringIO.new).cl_format(err: err)
+
+    assert_includes err.string, options[:with]
+  end
+
+  it ":stderr should end with a newline upon #{exception.inspect}" do
+    err = StringIO.new
+
+    Jiffy.new(in: io, out: StringIO.new).cl_format(err: err)
+
+    assert_equal "\n", err.string[-1]
+  end
+end
+
 describe Jiffy do
   positive_examples = Dir[File.join(File.dirname(__FILE__), 'positive-examples', '*')]
 
-  positive_examples.each do |example|
-    it "should correctly format #{File.basename(example)}" do
-      out = StringIO.new
+  describe '#format' do
+    positive_examples.each do |example|
+      it "should format #{File.basename(example)} without raising an exception" do
+        out = StringIO.new
 
-      Jiffy.new(in: example, out: out).format
+        Jiffy.new(in: example, out: out).format
 
-      assert_equal(out.string, File.read(example).strip)
+        assert_equal(out.string, File.read(example).strip)
+      end
     end
-  end
 
-  negative_examples = Dir[File.join(File.dirname(__FILE__), 'negative-examples', '*')]
+    negative_examples = Dir[File.join(File.dirname(__FILE__), 'negative-examples', '*')]
 
-  negative_examples.each do |example|
-    it "should not format #{File.basename(example)}" do
-      out = StringIO.new
+    negative_examples.each do |example|
+      it "should raise an exception when formatting #{File.basename(example)}" do
+        out = StringIO.new
+
+        assert_raises Jiffy::UnexpectedEndError, Jiffy::UnparseableError do
+          Jiffy.new(in: example, out: out).format
+        end
+      end
+    end
 
-      expected_exception = if /unclosed/ =~ example
-                             Jiffy::UnexpectedEndError
-                           else
-                             Jiffy::UnparseableError
-                           end
+    it 'should raise UnexpectedEndError on valid, but incomplete JSON input' do
+      example = StringIO.new incomplete_json
 
-      assert_raises expected_exception do
-        Jiffy.new(in: example, out: out).format
+      assert_raises Jiffy::UnexpectedEndError do
+        Jiffy.new(in: example, out: StringIO.new).format
+      end
+    end
+
+    it 'should raise UnexpectedEndError on empty input' do
+      example = StringIO.new ""
+
+      assert_raises Jiffy::UnexpectedEndError do
+        Jiffy.new(in: example, out: StringIO.new).format
+      end
+    end
+
+    it 'should raise UnparseableError on invalid JSON input' do
+      example = StringIO.new invalid_json
+
+      assert_raises Jiffy::UnparseableError do
+        Jiffy.new(in: example, out: StringIO.new).format
       end
     end
   end
@@ -44,4 +96,38 @@ describe Jiffy do
       end
     end
   end
+
+  describe '#cl_format' do
+    it_should_properly_handle Jiffy::UnexpectedEndError.new('Unexpected end of input'), with: 'Unexpected end of input'
+    it_should_properly_handle Jiffy::UnparseableError.new('Unexpected token at position'), with: 'Unexpected token at position'
+    it_should_properly_handle Errno::EACCES, with: 'jiffy: Permission denied'
+    it_should_properly_handle Errno::ENOENT, with: 'jiffy: No such file or directory'
+    it_should_properly_handle Errno::EISDIR, with: 'jiffy: Is a directory'
+
+    it 'should return true upon valid input' do
+      example = StringIO.new valid_json
+
+      assert_equal true, Jiffy.new(in: example, out: StringIO.new).cl_format
+    end
+
+    it 'should not write to :stderr upon valid input' do
+      example = StringIO.new valid_json
+
+      err = StringIO.new
+
+      Jiffy.new(in: example, out: StringIO.new).cl_format(err: err)
+
+      assert_equal "", err.string
+    end
+
+    it ':stdout should end with a newline upon valid input' do
+      example = StringIO.new valid_json
+
+      out = StringIO.new
+
+      Jiffy.new(in: example, out: out).cl_format
+
+      assert_equal "\n", out.string[-1]
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jiffy
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Jonas Amundsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-03 00:00:00.000000000 Z
+date: 2014-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -54,6 +54,7 @@ files:
 - bin/jiffy
 - jiffy.gemspec
 - lib/jiffy.rb
+- lib/jiffy/array_mimicking_io.rb
 - lib/jiffy/json_outputter.rb
 - lib/jiffy/parsers/json.rb
 - lib/jiffy/parsers/json.rl