ffi-yajl 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 010f67d48fdc7e489a8ca807819f76d4f678c7d7
-  data.tar.gz: dc3398cacd981441353db287b91fccdbf24266f3
+  metadata.gz: 7af5eee3b4627e919e66d1aea4326bdf251c4256
+  data.tar.gz: 581d8c97420c1313de961eb974b74ded07c44f2b
 SHA512:
-  metadata.gz: 06c1b64a2568cb90acada91dc9c3194b50d0fc8a671db94d1101943d77cd3fe1eed0918a02297455958b0708d456374b9affb84f4dd8c7b49a48ab25186a95f0
-  data.tar.gz: 5528506311181bc998ce071935157f74c027313fb43af831fae27253016f271c5ea8b66315959f885132dc7b1d45c5b7a1c4080b9ac9e729977df90b0b7deebe
+  metadata.gz: feb427a319145b354c0fc8f506a8b535e56b79d14abe803b9728ef3e6cd633547ed8857245bc58d15c7eeb14332f1bee32007d457afbe8ee46458ae81cfd7ad4
+  data.tar.gz: d02c0c2c853b0d6d9fad1078d32a77e1984383592623121f748249e3cf7e605802b487b258442808341ad8fc559b07d650955d24e25c63f1727e758891df4b7d

data/README.md

@@ -1,14 +1,40 @@
 
 [![Build Status](https://travis-ci.org/opscode/ffi-yajl.png)](https://travis-ci.org/opscode/ffi-yajl)  [![Code Climate](https://codeclimate.com/github/opscode/ffi-yajl.png)](https://codeclimate.com/github/opscode/ffi-yajl)
 
-## TODO
-
-
-## BUILD NOTES
-
-
-## KNOWN BUGS
-
+# FFI YAJL
+
+ffi-yajl is a Ruby adapter for the [yajl](http://lloyd.github.io/yajl/)
+JSON parser/generator library. ffi-yajl supports multiple Ruby C
+extension mechanisms, including both MRI native extensions and FFI in
+order to be compatible with as many Ruby implementations as possible
+while providing good performance where possible.
+
+## Basic Usage
+
+```ruby
+require 'ffi-yajl'
+json_out = FFI_Yajl::Encoder.encode( { "foo" => [ "bar", "baz" ] } )
+# => "{\"foo\":[\"bar\",\"baz\"]}"
+data_in = FFI_Yajl::Parser.parse( json_out )
+# => {"foo"=>["bar", "baz"]}
+```
+
+## Why This Instead of X?
+
+yajl is the only JSON library we've found that has error messages that
+meet our requirements. The stdlib json gem and oj (at the time we
+started this project) have error messages like "invalid token at byte
+1234," which are probably fine for server use, but in
+[chef](https://github.com/chef/chef) we frequently deal with
+user-written JSON documents, which means we need a good user experience
+when encountering malformed JSON.
+
+We previously used brianmario's
+[yajl-ruby](https://github.com/brianmario/yajl-ruby) project, but we
+wanted to be able to fallback to using FFI bindings to the C code (so we
+could support non-MRI rubies) and we also needed some bug fixes in
+yajl2, but the maintainer wasn't able to devote enough time to the
+project to make these updates in a timeframe that worked for us.
 
 ## Thanks
 
@@ -17,3 +43,9 @@ pulled in from brianmario's existing yajl-ruby gem, particularly all the c exten
 process of writing this would have been much more difficult without being able to draw heavily from already solved problems in
 yajl-ruby.
 
+## License
+
+Given that this draws heavily from the yajl-ruby sources, and could be considered a derivative work, the MIT License from that
+project has been preserved and this source code has deliberately not been dual licensed under Chef's typical Apache License.
+See the [LICENSE](https://github.com/chef/ffi-yajl/blob/master/LICENSE) file in this project.
+

data/lib/ffi_yajl/encoder.rb

@@ -8,7 +8,7 @@ module FFI_Yajl
       # initialization that we can do in pure ruby
       yajl_gen_opts = {}
 
-      yajl_gen_opts[:yajl_gen_validate_utf8] = true
+      yajl_gen_opts[:yajl_gen_validate_utf8] = @opts[:validate_utf8] == false ? false : true
       yajl_gen_opts[:yajl_gen_beautify] = false
       yajl_gen_opts[:yajl_gen_indent_string] = " "
 
@@ -46,8 +46,10 @@ module FFI_Yajl
         raise FFI_Yajl::EncodeError, "Invalid number: cannot encode Infinity, -Infinity, or NaN"
       when 6 # yajl_gen_no_buf
         raise FFI_Yajl::EncodeError, "YAJL internal error: yajl_gen_get_buf was called, but a print callback was specified, so no internal buffer is available"
+      when 7 # yajl_gen_invalid_string
+        raise FFI_Yajl::EncodeError, "Invalid UTF-8 string: cannot encode to UTF-8"
       else
-        raise FFI_Yajl::EncodeError, "Unknown YAJL Error, please report this as a bug"
+        raise FFI_Yajl::EncodeError, "Unknown YAJL Error (#{status}), please report this as a bug"
       end
     end
   end

data/lib/ffi_yajl/ext.rb

@@ -4,14 +4,17 @@ require 'ffi_yajl/encoder'
 require 'ffi_yajl/parser'
 require 'ffi'
 require 'libyajl2'
+require 'ffi_yajl/platform'
 
 module FFI_Yajl
+  extend FFI_Yajl::Platform
+
   # FIXME: DRY with ffi_yajl/ffi.rb
   # FIXME: extract map_library_name from FFI and stop requiring it at the top level
   #        so that the C-library can be installed without FFI
   libname = ::FFI.map_library_name("yajl")
   # awful windows patch, but there is an open issue to entirely replace FFI.map_library_name already
-  libname = "libyajl.so" if libname == "yajl.dll"
+  libname = "libyajl.so" if windows?
   libpath = File.expand_path(File.join(Libyajl2.opt_path, libname))
   libpath.gsub!(/dylib/, 'bundle')
   libpath = ::FFI.map_library_name("yajl") unless File.exist?(libpath)

data/lib/ffi_yajl/platform.rb

@@ -0,0 +1,7 @@
+module FFI_Yajl
+  module Platform
+    def windows?
+      !!(RUBY_PLATFORM =~ /mswin|mingw|cygwin|windows/)
+    end
+  end
+end

data/lib/ffi_yajl/version.rb

@@ -1,3 +1,3 @@
 module FFI_Yajl
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/spec/ffi_yajl/encoder_spec.rb

@@ -5,7 +5,9 @@ require 'date'
 
 describe "FFI_Yajl::Encoder" do
 
-  let(:encoder) { FFI_Yajl::Encoder.new }
+  let(:options) { {} }
+
+  let(:encoder) { FFI_Yajl::Encoder.new(options) }
 
   it "encodes hashes in keys as strings", :ruby_gte_193 => true do
     ruby = { {'a' => 'b'} => 2 }
@@ -146,4 +148,28 @@ describe "FFI_Yajl::Encoder" do
     end
   end
 
+  context "when encoding invalid utf-8" do
+    ruby = {
+      "automatic"=>{
+        "etc"=>{
+          "passwd"=>{
+            "root"=>{"dir"=>"/root", "gid"=>0, "uid"=>0, "shell"=>"/bin/sh", "gecos"=>"Elan Ruusam\xc3\xa4e"},
+            "glen"=>{"dir"=>"/home/glen", "gid"=>500, "uid"=>500, "shell"=>"/bin/bash", "gecos"=>"Elan Ruusam\xE4e"},
+          }
+        },
+      },
+    }
+
+    it "raises an error on invalid json" do
+      expect{ encoder.encode(ruby) }.to raise_error(FFI_Yajl::EncodeError, "Invalid UTF-8 string: cannot encode to UTF-8")
+    end
+
+    context "when validate_utf8 is off" do
+      let(:options) {  { :validate_utf8 => false } }
+
+      it "does not raise an error" do
+        expect{ encoder.encode(ruby) }.not_to raise_error
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-yajl
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Lamont Granquist
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -156,6 +156,7 @@ files:
 - lib/ffi_yajl/ffi/parser.rb
 - lib/ffi_yajl/json_gem.rb
 - lib/ffi_yajl/parser.rb
+- lib/ffi_yajl/platform.rb
 - lib/ffi_yajl/version.rb
 - spec/ffi_yajl/encoder_spec.rb
 - spec/ffi_yajl/json_gem_spec.rb
@@ -181,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Ruby FFI wrapper around YAJL 2.x