jansson 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c598ba8c9095b975416770702210cf3b4a9ff2e8
+  data.tar.gz: caae966170fd3e8bb687bd3760360a6b5b7e907f
+SHA512:
+  metadata.gz: 87dd4fc546d63a84193bbb4ec0640764dd17cbffc5f3daa34c75907fd62808e99ad9425e81d5e08ae0a313cf77ec59e916fd1d2c507ef618cfc207813dd8e16e
+  data.tar.gz: 94016e54878b8d3eaae2c683a5c9c0551876e81d341a0def49ea18586a7c228ca24e6b6e1e4356f22b6e0d5b5d9cb248a7e7e5af973fad6002b26db3d2152964

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Joe McIlvain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,9 @@
+# jansson
+
+[![Build Status](https://circleci.com/gh/jemc/ruby-jansson/tree/master.svg?style=svg)](https://circleci.com/gh/jemc/ruby-jansson/tree/master) 
+[![Gem Version](https://badge.fury.io/rb/jansson.png)](http://badge.fury.io/rb/jansson) 
+[![Join the chat at https://gitter.im/jemc/ruby-jansson](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jemc/ruby-jansson?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+A Ruby JSON library based on [FFI](https://github.com/ffi/ffi/wiki) bindings for [libjansson](https://github.com/akheron/jansson).
+
+##### `$ gem install jansson`

data/ext/jansson/Rakefile

@@ -0,0 +1,47 @@
+
+require 'rake/clean'
+require 'ffi'
+
+FILES = {}
+
+task :default => :build
+
+def self.file_task(filename, opts, &block)
+  name, dep = opts.is_a?(Hash) ? opts.to_a.first : [opts, nil]
+  
+  FILES[name] = filename
+  CLEAN.include filename
+  task name => filename
+  
+  if dep
+    file filename => FILES[dep], &block
+  else
+    file filename, &block
+  end
+end
+
+def cmd(string)
+  fail "Command failed: #{string}" unless system(string)
+end
+
+file_task 'jansson.tar.gz', :download_tarball do
+  version = "2.7"
+  release = "https://github.com/akheron/jansson/archive/v#{version}.tar.gz"
+  cmd "wget #{release}"
+  cmd "mv #{File.basename(release)} #{FILES[:download_tarball]}"
+end
+
+file_task 'jansson', :download => :download_tarball do
+  cmd "tar -xf #{FILES[:download_tarball]}"
+  cmd "mv jansson-* #{FILES[:download]}"
+end
+
+file_task 'config.status', :configure => :download do
+  cmd "bash -c 'cd #{FILES[:download]} && autoreconf -fi && ./configure'"
+  cmd "cp #{FILES[:download]}/#{FILES[:configure]} ./"
+end
+
+file_task "libjansson.#{::FFI::Platform::LIBSUFFIX}", :build => :configure do
+  cmd "bash -c 'cd #{FILES[:download]} && make'"
+  cmd "cp #{FILES[:download]}/src/.libs/#{FILES[:build]} ."
+end

data/lib/jansson.rb

@@ -0,0 +1,32 @@
+
+require_relative 'jansson/ffi'
+require_relative 'jansson/ffi/ext'
+
+module Jansson
+  class DumpError < RuntimeError; end
+  
+  def self.dump(value)
+    res = Jansson::FFI::Entity.from(value)
+    raise Jansson::DumpError, "can't encode #{value}" unless res
+    string = res.to_s
+    res.free!
+    string
+  end
+  
+  class LoadError < RuntimeError; end
+  
+  def self.load(string)
+    res = Jansson::FFI::Entity.from_s(string)
+    case res
+    when Jansson::FFI::Entity
+      value = res.to_ruby
+      res.free!
+      value
+    when Jansson::FFI::Error
+      raise Jansson::LoadError, res.description(string)
+    else
+      raise Jansson::LoadError
+    end
+  end
+  
+end

data/lib/jansson/ffi.rb

@@ -0,0 +1,169 @@
+
+require 'ffi'
+
+
+module Jansson
+  
+  # Bindings and wrappers for the native functions and structures exposed by
+  # the libjansson C library. This module is for internal use only so that
+  # all dependencies on the implementation of the C library are abstracted.
+  # @api private
+  module FFI
+    extend ::FFI::Library
+    
+    libfile = "libjansson.#{::FFI::Platform::LIBSUFFIX}"
+    
+    ffi_lib ::FFI::Library::LIBC
+    ffi_lib \
+      File.expand_path("../../ext/jansson/#{libfile}", File.dirname(__FILE__))
+    
+    opts = {
+      blocking: true  # only necessary on MRI to deal with the GIL.
+    }
+    
+    attach_function :free,   [:pointer], :void,    **opts
+    attach_function :malloc, [:size_t],  :pointer, **opts
+    
+    EntityType = enum [
+      :object,
+      :array,
+      :string,
+      :integer,
+      :real,
+      :true,
+      :false,
+      :null,
+    ]
+    
+    class Entity < ::FFI::Struct
+      layout :type,     EntityType,
+             :refcount, :size_t
+    end
+    
+    INTEGER_IS_LONG_LONG = true
+    typedef (INTEGER_IS_LONG_LONG ? :long_long : :long), :json_int
+    
+    ##
+    # Construction, destruction, reference counting
+    
+    attach_function :json_object,          [],                 Entity.ptr, **opts
+    attach_function :json_array,           [],                 Entity.ptr, **opts
+    attach_function :json_string,          [:string],          Entity.ptr, **opts
+    attach_function :json_stringn,         [:string, :size_t], Entity.ptr, **opts
+    attach_function :json_string_nocheck,  [:string],          Entity.ptr, **opts
+    attach_function :json_stringn_nocheck, [:string, :size_t], Entity.ptr, **opts
+    attach_function :json_integer,         [:json_int],        Entity.ptr, **opts
+    attach_function :json_real,            [:double],          Entity.ptr, **opts
+    attach_function :json_true,            [],                 Entity.ptr, **opts
+    attach_function :json_false,           [],                 Entity.ptr, **opts
+    attach_function :json_null,            [],                 Entity.ptr, **opts
+    
+    attach_function :json_delete, [Entity.ptr], :void, **opts
+    
+    ##
+    # Error reporting
+    
+    ERROR_SOURCE_LENGTH = 160
+    ERROR_TEXT_LENGTH   =  80
+    
+    class Error < ::FFI::Struct
+      layout :line,     :int,
+             :column,   :int,
+             :position, :int,
+             :source,  [:char, ERROR_SOURCE_LENGTH],
+             :text,    [:char, ERROR_TEXT_LENGTH]
+    end
+    
+    ##
+    # Getters, setters, manipulation
+    
+    attach_function :json_object_seed,            [:size_t],                          :void,      **opts
+    attach_function :json_object_size,            [Entity.ptr],                       :size_t,    **opts
+    attach_function :json_object_get,             [Entity.ptr, :string],              Entity.ptr, **opts
+    attach_function :json_object_set_new,         [Entity.ptr, :string, Entity.ptr],  :int,       **opts
+    attach_function :json_object_set_new_nocheck, [Entity.ptr, :string, Entity.ptr],  :int,       **opts
+    attach_function :json_object_del,             [Entity.ptr, :string],              :int,       **opts
+    attach_function :json_object_clear,           [Entity.ptr],                       :int,       **opts
+    attach_function :json_object_update,          [Entity.ptr, Entity.ptr],           :int,       **opts
+    attach_function :json_object_update_existing, [Entity.ptr, Entity.ptr],           :int,       **opts
+    attach_function :json_object_update_missing,  [Entity.ptr, Entity.ptr],           :int,       **opts
+    attach_function :json_object_iter,            [Entity.ptr],                       :pointer,   **opts
+    attach_function :json_object_iter_at,         [Entity.ptr, :string],              :pointer,   **opts
+    attach_function :json_object_key_to_iter,     [:string],                          :pointer,   **opts
+    attach_function :json_object_iter_next,       [Entity.ptr, :pointer],             :pointer,   **opts
+    attach_function :json_object_iter_key,        [:pointer],                         :string,    **opts
+    attach_function :json_object_iter_value,      [:pointer],                         Entity.ptr, **opts
+    attach_function :json_object_iter_set_new,    [Entity.ptr, :pointer, Entity.ptr], :int,       **opts
+    
+    attach_function :json_array_size,       [Entity.ptr],                      :size_t,    **opts
+    attach_function :json_array_get,        [Entity.ptr, :size_t],             Entity.ptr, **opts
+    attach_function :json_array_set_new,    [Entity.ptr, :size_t, Entity.ptr], :int,       **opts
+    attach_function :json_array_append_new, [Entity.ptr, Entity.ptr],          :int,       **opts
+    attach_function :json_array_insert_new, [Entity.ptr, :size_t, Entity.ptr], :int,       **opts
+    attach_function :json_array_remove,     [Entity.ptr, :size_t],             :int,       **opts
+    attach_function :json_array_clear,      [Entity.ptr],                      :int,       **opts
+    attach_function :json_array_extend,     [Entity.ptr, Entity.ptr],          :int,       **opts
+    
+    attach_function :json_string_value,  [Entity.ptr], :pointer,  **opts
+    attach_function :json_string_length, [Entity.ptr], :size_t,   **opts
+    attach_function :json_integer_value, [Entity.ptr], :json_int, **opts
+    attach_function :json_real_value,    [Entity.ptr], :double,   **opts
+    attach_function :json_number_value,  [Entity.ptr], :double,   **opts
+    
+    attach_function :json_string_set,          [Entity.ptr, :string],           :int, **opts
+    attach_function :json_string_setn,         [Entity.ptr, :pointer, :size_t], :int, **opts
+    attach_function :json_string_set_nocheck,  [Entity.ptr, :string],           :int, **opts
+    attach_function :json_string_setn_nocheck, [Entity.ptr, :pointer, :size_t], :int, **opts
+    attach_function :json_integer_set,         [Entity.ptr, :json_int],         :int, **opts
+    attach_function :json_real_set,            [Entity.ptr, :double],           :int, **opts
+    
+    ##
+    # Pack, unpack
+    
+    PACK_VALIDATE_ONLY = 0x1
+    PACK_STRICT        = 0x2
+    
+    attach_function :json_pack,     [:string, :varargs],                     Entity.ptr, **opts
+    attach_function :json_pack_ex,  [Error.ptr, :size_t, :string, :varargs], Entity.ptr, **opts
+    
+    attach_function :json_unpack,    [Entity.ptr, :string, :varargs],                     :int, **opts
+    attach_function :json_unpack_ex, [Entity.ptr, Error.ptr, :size_t, :string, :varargs], :int, **opts
+    
+    ##
+    # Equality
+    
+    attach_function :json_equal, [Entity.ptr, Entity.ptr], :int
+    
+    ##
+    # Copying
+    
+    attach_function :json_copy,      [Entity.ptr], Entity.ptr
+    attach_function :json_deep_copy, [Entity.ptr], Entity.ptr
+    
+    ##
+    # Decoding
+    
+    LOAD_REJECT_DUPLICATES  = 0x1
+    LOAD_DISABLE_EOF_CHECK  = 0x2
+    LOAD_DECODE_ANY         = 0x4
+    LOAD_DECODE_INT_AS_REAL = 0x8
+    LOAD_ALLOW_NUL          = 0x10
+    
+    attach_function :json_loads, [:string, :size_t, Error.ptr], Entity.ptr
+    
+    ##
+    # Encoding
+    
+    def self.DUMP_INDENT(n)          n & 0x1F end
+    DUMP_COMPACT                       = 0x20
+    DUMP_ENSURE_ASCII                  = 0x40
+    DUMP_SORT_KEYS                     = 0x80
+    DUMP_PRESERVE_ORDER                = 0x100
+    DUMP_ENCODE_ANY                    = 0x200
+    DUMP_ESCAPE_SLASH                  = 0x400
+    def self.DUMP_REAL_PRECISION(n) (n & 0x1F) << 11 end
+    
+    attach_function :json_dumps, [Entity.ptr, :size_t], :pointer
+    
+  end
+end

data/lib/jansson/ffi/ext.rb

@@ -0,0 +1,3 @@
+
+require_relative 'ext/entity'
+require_relative 'ext/error'

data/lib/jansson/ffi/ext/entity.rb

@@ -0,0 +1,93 @@
+
+module Jansson
+  module FFI
+    class Entity
+      
+      def free!
+        FFI.json_delete(self) if 0 >= (self[:refcount] -= 1)
+      end
+      
+      def to_s(flags = DUMP_ENCODE_ANY | DUMP_PRESERVE_ORDER)
+        ptr = FFI.json_dumps(self, flags)
+        str = ptr.read_string
+        FFI.free(ptr)
+        str
+      end
+      
+      def self.from_s(string, flags = LOAD_DECODE_ANY | LOAD_ALLOW_NUL)
+        error  = FFI::Error.new
+        entity = FFI.json_loads(string, flags, error)
+        entity.pointer.null? ? error : entity
+      end
+      
+      def type
+        self[:type]
+      end
+      
+      def to_ruby
+        case type
+        when :null
+          nil
+        when :true
+          true
+        when :false
+          false
+        when :integer
+          FFI.json_integer_value(self)
+        when :real
+          FFI.json_real_value(self)
+        when :string
+          FFI.json_string_value(self).read_string(FFI.json_string_length(self))
+        when :array
+          FFI.json_array_size(self).times.map do |index|
+            FFI.json_array_get(self, index).to_ruby
+          end
+        when :object
+          object = {}
+          iter = FFI.json_object_iter(self)
+          while (key = FFI.json_object_iter_key(iter)) && \
+              (value = FFI.json_object_iter_value(iter))
+            object[key] = value.to_ruby
+            iter = FFI.json_object_iter_next(self, iter)
+          end
+          object
+        else raise NotImplementedError
+        end
+      end
+      
+      def self.from(value)
+        case value
+        when NilClass
+          FFI.json_null
+        when TrueClass
+          FFI.json_true
+        when FalseClass
+          FFI.json_false
+        when Integer
+          FFI.json_integer(value)
+        when Float
+          FFI.json_real(value)
+        when String
+          value = value.force_encoding(Encoding::UTF_8)
+          FFI.json_stringn_nocheck(value, value.bytesize)
+        when Symbol
+          value = value.to_s.force_encoding(Encoding::UTF_8)
+          FFI.json_stringn_nocheck(value, value.bytesize)
+        when Array
+          array = FFI.json_array
+          value.each do |item|
+            FFI.json_array_append_new(array, from(item))
+          end
+          array
+        when Hash
+          object = FFI.json_object
+          value.each do |key, value|
+            FFI.json_object_set_new(object, key.to_s, from(value))
+          end
+          object
+        end
+      end
+      
+    end
+  end
+end

data/lib/jansson/ffi/ext/error.rb

@@ -0,0 +1,29 @@
+
+module Jansson
+  module FFI
+    class Error
+      
+      def description(source_string)
+        row = self[:line]
+        col = self[:column]
+        msg = self[:text].to_s
+        
+        source = source_string.each_line.to_a[row - 1].strip
+        arrow  = ' ' * (col - 1) + '^'
+        
+        if source.length > 40
+          if col >= 20
+            source = '... ' + source.slice(col - 20, 40) + ' ...'
+            arrow  = '    ' + arrow .slice(col - 20, 40)
+          else
+            source = source.slice(0, 40) + ' ...'
+            arrow  = arrow .slice(0, 40)
+          end
+        end
+        
+        "near line: #{row}, column: #{col}: #{msg}\n#{source}\n#{arrow}"
+      end
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: jansson
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joe McIlvain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  name: ffi
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.8
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.8
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: bundler
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rake
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: pry
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rspec-its
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: fivemat
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: A Ruby JSON library based on FFI bindings for libjansson.
+email: joe.eli.mac@gmail.com
+executables: []
+extensions:
+- ext/jansson/Rakefile
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- ext/jansson/Rakefile
+- lib/jansson.rb
+- lib/jansson/ffi.rb
+- lib/jansson/ffi/ext.rb
+- lib/jansson/ffi/ext/entity.rb
+- lib/jansson/ffi/ext/error.rb
+homepage: https://github.com/jemc/ruby-jansson
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: jansson
+test_files: []