ffi-yajl 2.2.2 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8d07aff0a45df417a5b0fe9fa0fef6f5fd26ee68
-  data.tar.gz: d9e8e77d8ee6d8259acab2aeb21a261d32ca7fc0
+SHA256:
+  metadata.gz: 76fe64b23846be3b66388c5f02e112bc0eb251aafb6d156a3a0a8f3713e5f767
+  data.tar.gz: a21516e45320e4c4c9709b88861870b20f1fd1a0c35635ba829fb80941f78cca
 SHA512:
-  metadata.gz: 036fb796941adbf951a11fdbf82d1c6e7de4fbfee8cce3ec497b7eed09b084436082fcc7acc7a8f360b1a800eeb648d0cbabeeedf6c2953a55a8cc60b10ae8bd
-  data.tar.gz: c980a1037e3fa00a18189d3d440e80c48716ce1cd229f8f817e49d943c8d386fee43a721970f25bf635d1fa98c379113c7e70ed41c3d9b5b8a11d9992e804a31
+  metadata.gz: 5080637e354171751c1637b6588bbb539a49fe865abdc8dcc19a01090e1d79bc1d60de9ed67f4fa9ffc10d4d3e3c1d653e27f748a0f3b9fc9c72e32d0a74808e
+  data.tar.gz: a40f1457c1b702250af8d6cea3db608e6113d790a383a557d0af55ef12e0d90bdf23ccc6a4445b5a6a74cf3e973cb3da29a90bf96296a5720907f291ab01fb94

data/README.md

@@ -1,13 +1,17 @@
+# FFI YAJL
 
-[![Build Status](https://travis-ci.org/chef/ffi-yajl.png)](https://travis-ci.org/chef/ffi-yajl)  [![Code Climate](https://codeclimate.com/github/chef/ffi-yajl.png)](https://codeclimate.com/github/chef/ffi-yajl)
+[![Build status](https://badge.buildkite.com/35c43155d637f5201a5030cd4e7d8025573c0042094e00bbb3.svg?branch=master)](https://buildkite.com/chef-oss/chef-ffi-yajl-master-verify) [![Gem Version](https://badge.fury.io/rb/ffi-yajl.svg)](https://badge.fury.io/rb/ffi-yajl)
 
-# FFI YAJL
+**Umbrella Project**: [Chef Foundation](https://github.com/chef/chef-oss-practices/blob/master/projects/chef-foundation.md)
+
+**Project State**: [Active](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md#active)
+
+**Issues [Response Time Maximum](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md)**: 14 days
 
-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.
+**Pull Request [Response Time Maximum](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md)**: 14 days
+
+
+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.
 
 ## How to Install
 
@@ -25,20 +29,16 @@ gem 'ffi-yajl'
 
 ## Supported Ruby VMs:
 
-* Ruby MRI 1.9.3/2.0.0/2.1.x/2.2.x
-* rbx 2.2.x (possibly earlier)
-* Jruby 1.7.x (possibly earlier)
-
-Ruby 1.8.7 support was dropped in 2.2.0
+- Ruby 2.2+ and compatible rbx or jruby
 
 ## Supported Distros:
 
-* Ubuntu 10.04 through 14.10
-* Debian 7.x
-* RHEL/CentOS/Oracle 5.x/6.x/7.x
-* Solaris 9/10/11 (gcc, sun compiler untested)
-* AIX 6.x/7.x (gcc or xlc)
-* Windows 2008r2/2012 (and Win2k/2k3 and consumer versions should work)
+- Ubuntu 10.04 through 14.10
+- Debian 7.x
+- RHEL/CentOS/Oracle 5.x/6.x/7.x
+- Solaris 9/10/11 (gcc, sun compiler untested)
+- AIX 6.x/7.x (gcc or xlc)
+- Windows 2008r2/2012 (and Win2k/2k3 and consumer versions should work)
 
 ## Basic Usage
 
@@ -68,81 +68,44 @@ hash = parser.parse( json )
 
 ## Parser Options
 
-* `:check_utf8`
-* `:dont_validate_strings`
-* `:symbolize_keys` (default = false):  JSON keys are parsed into symbols instead of strings.
-* `:symbolize_names` (default = false):  Alias for `:symbolize_keys`.
-* `:allow_trailing_garbage`
-* `:allow_multiple_values`
-* `:allow_partial_values`
-* `:unique_key_checking` (default = false):  Will raise an exception if keys
-   are repeated in hashes in the input JSON.  Without this, repeated keys will
-   silently replace the previous key.
+- `:check_utf8`
+- `:dont_validate_strings`
+- `:symbolize_keys` (default = false): JSON keys are parsed into symbols instead of strings.
+- `:symbolize_names` (default = false): Alias for `:symbolize_keys`.
+- `:allow_trailing_garbage`
+- `:allow_multiple_values`
+- `:allow_partial_values`
+- `:unique_key_checking` (default = false): Will raise an exception if keys are repeated in hashes in the input JSON. Without this, repeated keys will silently replace the previous key.
 
 ## Encoder Options
 
-* `:pretty` (default = false):  Produces more human readable 'pretty' output.
-* `:validate_utf8` (default = true):  Will raise an exception when trying to
-   encode strings that are invalid UTF-8.  When set to false this still will
-   produce valid UTF-8 JSON but will replace invalid characters.
+- `:pretty` (default = false): Produces more human readable 'pretty' output.
+- `:validate_utf8` (default = true): Will raise an exception when trying to encode strings that are invalid UTF-8\. When set to false this still will produce valid UTF-8 JSON but will replace invalid characters.
 
 ## Forcing FFI or C Extension
 
-You can set the environment variable `FORCE_FFI_YAJL` to `ext` or `ffi` to
-control if the C extension or FFI bindings are used.
+You can set the environment variable `FORCE_FFI_YAJL` to `ext` or `ffi` to control if the C extension or FFI bindings are used.
 
 ## Yajl Library Packaging
 
-This library prefers to use the embedded yajl 2.x C library packaged in the
-libyajl2 gem.  In order to use the operating system yajl library (which must be
-yajl 2.x) the environment variable `USE_SYSTEM_LIBYAJL2` can be set before
-installing or bundling libyajl2.  This will force the libyajl2 gem to skip
-compiling its embedded library and the ffi-yajl gem will fallback to using the
-system yajl library.
+This library prefers to use the embedded yajl 2.x C library packaged in the libyajl2 gem. In order to use the operating system yajl library (which must be yajl 2.x) the environment variable `USE_SYSTEM_LIBYAJL2` can be set before installing or bundling libyajl2\. This will force the libyajl2 gem to skip compiling its embedded library and the ffi-yajl gem will fallback to using the system yajl library.
 
 ## No JSON Gem Compatiblity layer
 
-This library does not offer a feature to patch `#to_json` methods into all
-the ruby classes similarly to the JSON gem or yajl-ruby's `yajl/json_gem`
-compatibility API.  The differences in encoding between the JSON gem and the
-Yajl C library can produce different output on different systems and makes
-testing brittle.  Such a feature will not be included.  It was removed in
-this pull request and could be easily extracted to its own gem (we have
-no interest in maintaining that gem):
+This library does not offer a feature to patch `#to_json` methods into all the ruby classes similarly to the JSON gem or yajl-ruby's `yajl/json_gem` compatibility API. The differences in encoding between the JSON gem and the Yajl C library can produce different output on different systems and makes testing brittle. Such a feature will not be included. It was removed in this pull request and could be easily extracted to its own gem (we have no interest in maintaining that gem):
 
-https://github.com/chef/ffi-yajl/pull/47/files
+<https://github.com/chef/ffi-yajl/pull/47/files>
 
 ## 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.
+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
 
-This was initially going to be a clean rewrite of an ffi ruby wrapper around
-yajl2, but as it progressed more and more code was pulled in from brianmario's
-existing yajl-ruby gem, particularly all the c extension code, lots of specs
-and the benchmarks.  And the process of writing this would have been much more
-difficult without being able to draw heavily from already solved problems in
-yajl-ruby.
+This was initially going to be a clean rewrite of an ffi ruby wrapper around yajl2, but as it progressed more and more code was pulled in from brianmario's existing yajl-ruby gem, particularly all the c extension code, lots of specs and the benchmarks. And the 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.
+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/bin/ffi-yajl-bench

@@ -2,31 +2,31 @@
 
 $LOAD_PATH << File.expand_path(File.join(File.dirname( File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__ ), "../lib"))
 
-require 'optparse'
-require 'ffi_yajl/benchmark'
+require "optparse"
+require "ffi_yajl/benchmark"
 
 opts = {}
 optparse = OptionParser.new do |o|
   o.banner = "Usage: ffi-yajl-bench"
 
   opts[:profile] = false
-  o.on( '-p', '--profile', 'Run perftools.rb profiling' ) do
+  o.on( "-p", "--profile", "Run perftools.rb profiling" ) do
     opts[:profile] = true
   end
 
-  o.on( '-F', '--ffi', 'Force using FFI' ) do
+  o.on( "-F", "--ffi", "Force using FFI" ) do
     opts[:ffi] = true
   end
 
-  o.on( '-E', '--ext', 'Force using C ext' ) do
+  o.on( "-E", "--ext", "Force using C ext" ) do
     opts[:ext] = true
   end
 end
 
 optparse.parse!
 
-ENV['FORCE_FFI_YAJL'] = 'ffi' if opts[:ffi]
-ENV['FORCE_FFI_YAJL'] = 'ext' if opts[:ext]
+ENV["FORCE_FFI_YAJL"] = "ffi" if opts[:ffi]
+ENV["FORCE_FFI_YAJL"] = "ext" if opts[:ext]
 
 if opts[:profile]
   FFI_Yajl::Benchmark::ParseProfileRubyProf.new.run

data/ext/ffi_yajl/ext/dlopen/extconf.rb

@@ -1,8 +1,8 @@
 # rubocop:disable Style/GlobalVars
-require 'mkmf'
-require 'rubygems'
+require "mkmf"
+require "rubygems"
 
-RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
+RbConfig::MAKEFILE_CONFIG["CC"] = ENV["CC"] if ENV["CC"]
 
 puts $CFLAGS
 puts $LDFLAGS
@@ -11,6 +11,6 @@ have_header("dlfcn.h")
 
 have_library("dl", "dlopen")
 
-dir_config 'dlopen'
+dir_config "dlopen"
 
-create_makefile 'ffi_yajl/ext/dlopen'
+create_makefile "ffi_yajl/ext/dlopen"

data/ext/ffi_yajl/ext/encoder/encoder.c

@@ -377,8 +377,12 @@ void Init_encoder() {
   rb_define_method(rb_cNilClass, "ffi_yajl", rb_cNilClass_ffi_yajl, 2);
   rb_define_method(rb_cTrueClass, "ffi_yajl", rb_cTrueClass_ffi_yajl, 2);
   rb_define_method(rb_cFalseClass, "ffi_yajl", rb_cFalseClass_ffi_yajl, 2);
+#ifdef rb_cFixnum /* ruby < 2.4 */
   rb_define_method(rb_cFixnum, "ffi_yajl", rb_cFixnum_ffi_yajl, 2);
   rb_define_method(rb_cBignum, "ffi_yajl", rb_cBignum_ffi_yajl, 2);
+#else
+  rb_define_method(rb_cInteger, "ffi_yajl", rb_cFixnum_ffi_yajl, 2);
+#endif
   rb_define_method(rb_cFloat, "ffi_yajl", rb_cFloat_ffi_yajl, 2);
   rb_define_method(rb_cString, "ffi_yajl", rb_cString_ffi_yajl, 2);
   rb_define_method(rb_cSymbol, "ffi_yajl", rb_cSymbol_ffi_yajl, 2);

data/ext/ffi_yajl/ext/encoder/extconf.rb

@@ -1,9 +1,9 @@
 # rubocop:disable Style/GlobalVars
-require 'mkmf'
-require 'rubygems'
-require 'libyajl2'
+require "mkmf"
+require "rubygems"
+require "libyajl2"
 
-RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
+RbConfig::MAKEFILE_CONFIG["CC"] = ENV["CC"] if ENV["CC"]
 
 # pick up the vendored libyajl2 out of the libyajl2 gem
 $CFLAGS = " -I#{Libyajl2.include_path} #{$CFLAGS}"
@@ -16,7 +16,7 @@ puts $CFLAGS
 puts $LDFLAGS
 
 # except if you're doing an unoptimized gcc install we're going to help you out a bit
-if RbConfig::MAKEFILE_CONFIG['CC'] =~ /gcc|clang/
+if RbConfig::MAKEFILE_CONFIG["CC"] =~ /gcc|clang/
   $CFLAGS << " -O3" unless $CFLAGS[/-O\d/]
   # how many people realize that -Wall is a compiler-specific flag???
   # apparently not many based on reading lots of shitty extconf.rb's out there
@@ -34,32 +34,32 @@ end
 
 # NOTE: find_library has the side effect of adding -lyajl to the flags which we are deliberately
 # avoiding doing with the libyajl2-gem (allowing it to be lazily loaded with dlopen)
-if !windows? && !find_header('yajl/yajl_tree.h')
+if !windows? && !find_header("yajl/yajl_tree.h")
   puts "libyajl2 headers not found in libyajl2-gem, searching for system libraries..."
 
   HEADER_DIRS = [
     "/opt/local/include",                   # MacPorts
     "/usr/local/include",                   # /usr/local
-    RbConfig::CONFIG['includedir'],         # Ruby
+    RbConfig::CONFIG["includedir"],         # Ruby
     "/usr/include",                         # (default)
-  ]
+  ].freeze
 
   LIB_DIRS = [
     "/opt/local/lib",                       # MacPorts
     "/usr/local/lib",                       # /usr/local + Homebrew
-    RbConfig::CONFIG['libdir'],             # Ruby
+    RbConfig::CONFIG["libdir"],             # Ruby
     "/usr/lib",                             # (default)
-  ]
+  ].freeze
 
   # add --with-yajl-dir, --with-yajl-include, --with-yajl-lib
-  dir_config('yajl', HEADER_DIRS, LIB_DIRS)
+  dir_config("yajl", HEADER_DIRS, LIB_DIRS)
 
   # here we use find_library in order to deliberately link with -lyajl as a useful side-effect
-  unless find_header('yajl/yajl_tree.h') && find_library('yajl', 'yajl_complete_parse')
+  unless find_header("yajl/yajl_tree.h") && find_library("yajl", "yajl_complete_parse")
     abort "libyajl2 is missing.  please install libyajl2"
   end
 end
 
-dir_config 'encoder'
+dir_config "encoder"
 
-create_makefile 'ffi_yajl/ext/encoder'
+create_makefile "ffi_yajl/ext/encoder"

data/ext/ffi_yajl/ext/parser/extconf.rb

@@ -1,9 +1,9 @@
 # rubocop:disable Style/GlobalVars
-require 'mkmf'
-require 'rubygems'
-require 'libyajl2'
+require "mkmf"
+require "rubygems"
+require "libyajl2"
 
-RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
+RbConfig::MAKEFILE_CONFIG["CC"] = ENV["CC"] if ENV["CC"]
 
 # pick up the vendored libyajl2 out of the libyajl2 gem
 $CFLAGS = "-I#{Libyajl2.include_path} #{$CFLAGS}"
@@ -16,7 +16,7 @@ puts $CFLAGS
 puts $LDFLAGS
 
 # except if you're doing an unoptimized gcc install we're going to help you out a bit
-if RbConfig::MAKEFILE_CONFIG['CC'] =~ /gcc|clang/
+if RbConfig::MAKEFILE_CONFIG["CC"] =~ /gcc|clang/
   $CFLAGS << " -O3" unless $CFLAGS[/-O\d/]
   # how many people realize that -Wall is a compiler-specific flag???
   # apparently not many based on reading lots of shitty extconf.rb's out there
@@ -34,32 +34,32 @@ end
 
 # NOTE: find_library has the side effect of adding -lyajl to the flags which we are deliberately
 # avoiding doing with the libyajl2-gem (allowing it to be lazily loaded with dlopen)
-if !windows? && !find_header('yajl/yajl_tree.h')
+if !windows? && !find_header("yajl/yajl_tree.h")
   puts "libyajl2 headers not found in libyajl2-gem, searching for system libraries..."
 
   HEADER_DIRS = [
     "/opt/local/include",                   # MacPorts
     "/usr/local/include",                   # /usr/local
-    RbConfig::CONFIG['includedir'],         # Ruby
+    RbConfig::CONFIG["includedir"],         # Ruby
     "/usr/include",                         # (default)
-  ]
+  ].freeze
 
   LIB_DIRS = [
     "/opt/local/lib",                       # MacPorts
     "/usr/local/lib",                       # /usr/local + Homebrew
-    RbConfig::CONFIG['libdir'],             # Ruby
+    RbConfig::CONFIG["libdir"],             # Ruby
     "/usr/lib",                             # (default)
-  ]
+  ].freeze
 
   # add --with-yajl-dir, --with-yajl-include, --with-yajl-lib
-  dir_config('yajl', HEADER_DIRS, LIB_DIRS)
+  dir_config("yajl", HEADER_DIRS, LIB_DIRS)
 
   # here we use find_library in order to deliberately link with -lyajl as a useful side-effect
-  unless find_header('yajl/yajl_tree.h') && find_library('yajl', 'yajl_complete_parse')
+  unless find_header("yajl/yajl_tree.h") && find_library("yajl", "yajl_complete_parse")
     abort "libyajl2 is missing.  please install libyajl2"
   end
 end
 
-dir_config 'parser'
+dir_config "parser"
 
-create_makefile 'ffi_yajl/ext/parser'
+create_makefile "ffi_yajl/ext/parser"

data/lib/ffi_yajl.rb

@@ -34,17 +34,17 @@
 #   dropped, so don't bother asking for that.
 # - Then we try the c-ext and rescue into ffi that fails
 #
-if ENV['FORCE_FFI_YAJL'] == "ext"
-  require 'ffi_yajl/ext'
-elsif ENV['FORCE_FFI_YAJL'] == "ffi"
-  require 'ffi_yajl/ffi'
+if ENV["FORCE_FFI_YAJL"] == "ext"
+  require_relative "ffi_yajl/ext"
+elsif ENV["FORCE_FFI_YAJL"] == "ffi"
+  require_relative "ffi_yajl/ffi"
 elsif RUBY_PLATFORM == "java"
-  require 'ffi_yajl/ffi'
+  require_relative "ffi_yajl/ffi"
 else
   begin
-    require 'ffi_yajl/ext'
+    require_relative "ffi_yajl/ext"
   rescue LoadError
     warn "failed to load the ffi-yajl c-extension, falling back to ffi interface"
-    require 'ffi_yajl/ffi'
+    require_relative "ffi_yajl/ffi"
   end
 end

data/lib/ffi_yajl/benchmark.rb

@@ -20,8 +20,8 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-require 'ffi_yajl/benchmark/encode.rb'
-require 'ffi_yajl/benchmark/encode_profile.rb'
-require 'ffi_yajl/benchmark/parse.rb'
-require 'ffi_yajl/benchmark/parse_profile.rb'
-require 'ffi_yajl/benchmark/parse_profile_ruby_prof.rb'
+require "ffi_yajl/benchmark/encode.rb"
+require "ffi_yajl/benchmark/encode_profile.rb"
+require "ffi_yajl/benchmark/parse.rb"
+require "ffi_yajl/benchmark/parse_profile.rb"
+require "ffi_yajl/benchmark/parse_profile_ruby_prof.rb"

data/lib/ffi_yajl/benchmark/encode.rb

@@ -1,26 +1,26 @@
 # Portions Originally Copyright (c) 2008-2011 Brian Lopez - http://github.com/brianmario
 # See MIT-LICENSE
 
-require 'rubygems'
-require 'benchmark'
-require 'stringio'
+require "rubygems" unless defined?(Gem)
+require "benchmark" unless defined?(Benchmark)
+require "stringio" unless defined?(StringIO)
 if !defined?(RUBY_ENGINE) || RUBY_ENGINE !~ /jruby/
   begin
-    require 'yajl'
+    require "yajl"
   rescue LoadError
     puts "INFO: yajl-ruby not installed"
   end
 else
   puts "INFO: skipping yajl-ruby on jruby"
 end
-require 'ffi_yajl'
+require_relative "../../ffi_yajl"
 begin
-  require 'json'
+  require "json" unless defined?(JSON)
 rescue LoadError
   puts "INFO: json gem not installed"
 end
 begin
-  require 'oj'
+  require "oj"
 rescue LoadError
   puts "INFO: oj gem not installed"
 end
@@ -31,7 +31,7 @@ module FFI_Yajl
       def run
         # filename = ARGV[0] || 'benchmark/subjects/ohai.json'
         filename = File.expand_path(File.join(File.dirname(__FILE__), "subjects", "ohai.json"))
-        hash = File.open(filename, 'rb') { |f| FFI_Yajl::Parser.parse(f.read) }
+        hash = File.open(filename, "rb") { |f| FFI_Yajl::Parser.parse(f.read) }
 
         times = ARGV[1] ? ARGV[1].to_i : 1000
         puts "Starting benchmark encoding #{filename} #{times} times\n\n"