ffi-yajl 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 793837251dd5609ab348285f956c0191ee34d2c6
-  data.tar.gz: 9bba3ff9225e7e6efae97f8b87ed696853e82532
+  metadata.gz: 34f8ead0d7b0acd7c0b717d91620c434a6664e77
+  data.tar.gz: 35178ecea062849647eb0ebcdb174e70b31c3c12
 SHA512:
-  metadata.gz: 5b8a7b78b589d5086801b862f76128ca41e34d8d039c1576e7315947230b79148228f5bf66d5ee80ab22eb56aa32c7cc41831bc728ab4477bf767554a476b5be
-  data.tar.gz: 0b13b996ace1523cd8fbffcb84cc2a5f1b06132f9ec34be19643911411256d9abe1f2b8d7fffe09d6da37554077d9c6efc0ff5c28f4cb553532010a4b7297481
+  metadata.gz: fc7c2f379e5a565a278ff16723197b994c354f560364774d90c17ee491f26ba28a91bbce7655e51e2f9bce43f6ce2e4f2c17b1bb4068f17518bf4fb389b3bb78
+  data.tar.gz: 9b4137b8cd49ff37b49b474f442c350bd0ca2c4d767ae45cb39163a6c5b6a5ee59e5909d43d7e556a860ed253503ee882a21551ca46e97b18d7d65052820434f

data/README.md

@@ -1,13 +1,8 @@
-
-[![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)
-
 # 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.
+[![Build Status](https://travis-ci.org/chef/ffi-yajl.svg?branch=master)](https://travis-ci.org/chef/ffi-yajl) [![Gem Version](https://badge.fury.io/rb/ffi-yajl.svg)](https://badge.fury.io/rb/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.
 
 ## How to Install
 
@@ -25,20 +20,20 @@ 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 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
 
 ## 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 +63,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/Rakefile

@@ -1,20 +1,24 @@
 $LOAD_PATH << File.expand_path(File.join(File.dirname( __FILE__ ), "lib"))
 
-require 'rspec/core/rake_task'
-require 'rubygems/package_task'
-require 'rake/extensiontask'
-require 'ffi_yajl/version'
-require 'github_changelog_generator/task'
+require "rspec/core/rake_task"
+require "rubygems/package_task"
+require "rake/extensiontask"
+require "ffi_yajl/version"
 
 Dir[File.expand_path("../*gemspec", __FILE__)].reverse_each do |gemspec_path|
   gemspec = eval(IO.read(gemspec_path))
   Gem::PackageTask.new(gemspec).define
 end
 
-GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-  config.issues = false
-  config.since_tag = '1.0.1'
-  config.exclude_labels = %w{duplicate question invalid wontfix changelog_skip}
+begin
+  require "github_changelog_generator/task"
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.issues = false
+    config.since_tag = "1.0.1"
+    config.exclude_labels = %w{duplicate question invalid wontfix changelog_skip}
+  end
+rescue LoadError
+  puts "no github-changelog-generator"
 end
 
 desc "Build it and ship it"
@@ -42,26 +46,26 @@ task install: [:package] do
   end
 end
 
-spec = Gem::Specification.load('ffi-yajl.gemspec')
+spec = Gem::Specification.load("ffi-yajl.gemspec")
 
 Rake::ExtensionTask.new do |ext|
-  ext.name = 'encoder'
-  ext.lib_dir = 'lib/ffi_yajl/ext'
-  ext.ext_dir = 'ext/ffi_yajl/ext/encoder'
+  ext.name = "encoder"
+  ext.lib_dir = "lib/ffi_yajl/ext"
+  ext.ext_dir = "ext/ffi_yajl/ext/encoder"
   ext.gem_spec = spec
 end
 
 Rake::ExtensionTask.new do |ext|
-  ext.name = 'parser'
-  ext.lib_dir = 'lib/ffi_yajl/ext'
-  ext.ext_dir = 'ext/ffi_yajl/ext/parser'
+  ext.name = "parser"
+  ext.lib_dir = "lib/ffi_yajl/ext"
+  ext.ext_dir = "ext/ffi_yajl/ext/parser"
   ext.gem_spec = spec
 end
 
 Rake::ExtensionTask.new do |ext|
-  ext.name = 'dlopen'
-  ext.lib_dir = 'lib/ffi_yajl/ext'
-  ext.ext_dir = 'ext/ffi_yajl/ext/dlopen'
+  ext.name = "dlopen"
+  ext.lib_dir = "lib/ffi_yajl/ext"
+  ext.ext_dir = "ext/ffi_yajl/ext/dlopen"
   ext.gem_spec = spec
 end
 
@@ -80,101 +84,56 @@ end
 namespace :spec do
   desc "Run all specs against ffi extension"
   RSpec::Core::RakeTask.new(:ffi) do |t|
-    ENV['FORCE_FFI_YAJL'] = "ffi"
-    t.pattern = FileList['spec/**/*_spec.rb']
+    ENV["FORCE_FFI_YAJL"] = "ffi"
+    t.pattern = FileList["spec/**/*_spec.rb"]
   end
   if !defined?(RUBY_ENGINE) || RUBY_ENGINE !~ /jruby/
     desc "Run all specs again c extension"
     RSpec::Core::RakeTask.new(:ext) do |t|
-      ENV['FORCE_FFI_YAJL'] = "ext"
-      t.pattern = FileList['spec/**/*_spec.rb']
+      ENV["FORCE_FFI_YAJL"] = "ext"
+      t.pattern = FileList["spec/**/*_spec.rb"]
     end
   end
 end
 
-if RUBY_VERSION.to_f >= 1.9
-  namespace :integration do
-    begin
-      require 'kitchen'
-    rescue LoadError
-      task :vagrant do
-        puts "test-kitchen gem is not installed"
-      end
-      task :cloud do
-        puts "test-kitchen gem is not installed"
-      end
-    else
-      desc 'Run Test Kitchen with Vagrant'
-      task :vagrant do
-        Kitchen.logger = Kitchen.default_file_logger
-        Kitchen::Config.new.instances.each do |instance|
-          instance.test(:always)
-        end
-      end
-
-      desc 'Run Test Kitchen with cloud plugins'
-      task :cloud do
-        if ENV['TRAVIS_PULL_REQUEST'] != 'true'
-          ENV['KITCHEN_YAML'] = '.kitchen.cloud.yml'
-          sh "kitchen test --concurrency 4"
-        end
-      end
-    end
-  end
-  namespace :style do
-    desc 'Run Ruby style checks'
-    begin
-      require 'rubocop/rake_task'
-    rescue LoadError
-      task :rubocop do
-        puts "rubocop gem is not installed"
-      end
-    else
-      RuboCop::RakeTask.new(:rubocop) do |t|
-        t.fail_on_error = false
-      end
-    end
-
-    desc 'Run Ruby smell checks'
-    begin
-      require 'reek/rake/task'
-    rescue LoadError
-      task :reek do
-        puts "reek gem is not installed"
-      end
-    else
-      Reek::Rake::Task.new(:reek) do |t|
-        t.fail_on_error = false
-        #        t.config_files = '.reek.yml'
-      end
-    end
-  end
-else
-  namespace :integration do
+namespace :integration do
+  begin
+    require "kitchen"
+  rescue LoadError
     task :vagrant do
-      puts "test-kitchen unsupported on ruby 1.8"
+      puts "test-kitchen gem is not installed"
     end
-    task :cloud do
-      puts "test-kitchen unsupported on ruby 1.8"
+  else
+    desc "Run Test Kitchen with Vagrant"
+    task :vagrant do
+      Kitchen.logger = Kitchen.default_file_logger
+      Kitchen::Config.new.instances.each do |instance|
+        instance.test(:always)
+      end
     end
   end
-  namespace :style do
+end
+namespace :style do
+  desc "Run Ruby style checks"
+  begin
+    require "chefstyle"
+    require "rubocop/rake_task"
+  rescue LoadError
     task :rubocop do
-      puts "rubocop unsupported on ruby 1.8"
+      puts "chefstyle gem is not installed"
     end
-    task :reek do
-      puts "reek unsupported on ruby 1.8"
+  else
+    RuboCop::RakeTask.new(:rubocop) do |t|
+      t.fail_on_error = false
     end
   end
 end
 
-desc 'Run all style checks'
-task style: ['style:rubocop', 'style:reek']
+desc "Run all style checks"
+task style: ["style:rubocop"]
 
-desc 'Run style + spec tests by default on travis'
+desc "Run style + spec tests by default on travis"
 task travis: %w{style spec}
 
-desc 'Run style, spec and test kichen on travis'
-task travis_all: ['style', 'spec', 'integration:cloud']
-
-task default: ['style', 'spec', 'integration:vagrant']
+desc "Run style + spec tests by default"
+task default: %w{compile style spec}

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/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)
   ]
 
   LIB_DIRS = [
     "/opt/local/lib",                       # MacPorts
     "/usr/local/lib",                       # /usr/local + Homebrew
-    RbConfig::CONFIG['libdir'],             # Ruby
+    RbConfig::CONFIG["libdir"],             # Ruby
     "/usr/lib",                             # (default)
   ]
 
   # 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"