wankel 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6571c0e2472dab431e07ca8ee912e4a88b5319d
-  data.tar.gz: 50aeba78c777dd142181126b1fefba3480a200e1
+  metadata.gz: a2a9555df2d54b524e29a89321699384d49e0613
+  data.tar.gz: 1e924383e839c3bda6f31b8a316ad2d55b67bd17
 SHA512:
-  metadata.gz: 7d49e4dc10b8a3cccdfec412531226b5e4ccbba35a30c9b148edda091c42ef7c54aa7b368aef8930f46bd6b1fbf4214f1e29414e459d8078ae17ae7756b00433
-  data.tar.gz: 8e0a6915521e4d9c7d5d27f580324a60074fe17d3e38078b2c9225e33b188c7abe4b88668fa8021d7827e4474f4afd67ef920847d65c34c44e101daab40fdcd4
+  metadata.gz: 24847eb3f44ffd7c2eb6eebd205f96ee6e155e68b22aea2e64d826aaf3fe4ec9d5d7df485653f86034205bbf0cd5a07c19e8fe7055e2eccc9e9b7d4551abe62f
+  data.tar.gz: 9efcc10ef6c1169cbadce7c63c27b3db150794666e4aeb0b69556699afe5800ca092fb4908e9868bdd3577a750ac5a089aa4b342476504767390b2723e60f71c

data/.gitignore

@@ -10,3 +10,4 @@ coverage
 Makefile
 tmp
 .DS_Store
+doc

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 2.0.0
   - 2.1.2
-  - 2.2.0-rc1
+  - 2.2.0
 cache: bundler
 install:
   - wget 'https://github.com/lloyd/yajl/archive/2.1.0.tar.gz'

data/CHANGELOG.md

@@ -8,6 +8,12 @@ Minor Changes:
 
 Bugfixes:
 
+## 0.6.0
+
+New Features:
+
+ - Added `:mode` option for the `Wankel::StreamEncoder`
+
 ## 0.5.0 (December 24th, 2014)
 
 - Renaming of `Wankel::SaxEncoder` and `Wankel::SaxParser` to
@@ -29,4 +35,4 @@ Major Changes:
 
 Major Changes:
 
-  - `Wankel::SaxEncoder#bool` changed to `Wankel::SaxEncoder#boolean`
+  - `Wankel::SaxEncoder#bool` changed to `Wankel::SaxEncoder#boolean`

data/README.md

@@ -1,5 +1,4 @@
-<a href="http://wanklerb.com">![Wankel](/logo.png)</a>
-
+[![Wankel](logo.png)](http://wanklerb.org)
 
 Wankel [![Build Status](https://travis-ci.org/malomalo/wankel.svg?branch=master)](https://travis-ci.org/malomalo/wankel)
 --------
@@ -238,4 +237,82 @@ The test description (ie. Small: 100,000 parses of a 255 byte JSON):
 
 #### Streaming Encoder
 
+    class Wankel::SaxEncoder
+
+      def number
+      end
+  
+      def string
+      end
+  
+      def null
+      end
+  
+      def bool
+      end
+  
+      def map_open
+      end
+  
+      def map_close
+      end
+  
+      def array_open
+      end
+  
+      def array_close
+      end
+  
+      def value
+      end
+  
+      def complete
+      end
+
+    end
+
 #### Streaming Decoder
+
+    class Wankel::SaxParser
+
+      def on_map_start
+        puts 'start map'
+      end
+
+      def on_map_end
+        puts 'end map'
+      end
+
+      def on_map_key(key)
+        puts 'key'
+      end
+  
+      def on_null
+        puts "null"
+      end
+
+      def on_boolean(value)
+        puts value
+      end
+
+      def on_integer(i)
+        puts "integer"
+      end
+
+      def on_double(d)
+        puts "double"
+      end
+
+      def on_string(s)
+        puts "string"
+      end
+
+      def on_array_start
+        puts "start array"
+      end
+
+      def on_array_end
+        puts "end array"
+      end
+
+    end

data/Rakefile

@@ -5,7 +5,7 @@ Bundler.require(:development)
 require "rake/extensiontask"
 require "rake/testtask"
 require "rubygems/package_task"
-require "rdoc/task"
+require "sdoc"
 require 'fileutils'
 
 if ENV['COVERALLS_REPO_TOKEN']
@@ -65,3 +65,20 @@ task :c_coverage do
     SimpleCov::ResultMerger.store_result(data)
   end
 end
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.title = 'Wankel API'
+  rdoc.rdoc_dir = 'doc'
+  
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('logo.png')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('ext/**/*.{h,c}')
+
+  rdoc.options << '-f' << 'sdoc'
+  rdoc.options << '-T' << '42floors'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.options << '--line-numbers'
+  rdoc.options << '--github'
+end

data/ext/wankel/wankel.c

@@ -4,7 +4,34 @@ static ID intern_new, intern_parse, intern_encode;
 
 static VALUE c_wankel, c_wankelParser, c_wankelEncoder, e_parseError, e_encodeError;
 
-// Class Methods =============================================================
+/*
+ * Document-method: dump
+ * call-seq:
+ *   dump(obj, io=nil, opts=nil)
+ */
+
+/*
+ * Document-method: load
+ * call-seq:
+ *   load(io, opts=nil, &block)
+ */
+
+/*
+ * Document-method: parse
+ * call-seq:
+ *   parse(io, opts=nil, &block=nil)
+ *
+ * [io]     The +IO+ object parse JSON from.
+ * [opts]   An optional hash of options to override the default parsing options.
+ *          See DEFAULTS.
+ * [&block] An optional callback used with the +multiple_values+ option. For
+ *          example:
+ *              results = []
+ *              p = Wankel::Parser.new(:multiple_values => true)
+ *              p.parse('[{"abc": 123},{"def": 456}][{"abc": 123},{"def": 456}]') do |data|
+ *                result << data
+ *              end
+ */
 static VALUE wankel_parse(int argc, VALUE * argv, VALUE klass) {
     VALUE parser, input, options, callback;
     rb_scan_args(argc, argv, "11&", &input, &options, &callback);
@@ -13,6 +40,18 @@ static VALUE wankel_parse(int argc, VALUE * argv, VALUE klass) {
     return rb_funcall(parser, intern_parse, 2, input, callback);
 }
 
+/* call-seq:
+ *   encode(obj, io=nil, opts=nil)
+ *
+ * Returns the obj encoded as a JSON string.
+ * 
+ * [obj] The object to be encoded as JSON
+ * [io]  Either an +IO+ object to which the encoded JSON is written or the
+ *       options (opts) hash.
+ * [ops] An optional hash to override the encoding options. See DEFAULTS. If
+ *       there is no +IO+ object this is the second argument. If there is an
+ *       +IO+ object it is the third argument.
+ */
 static VALUE wankel_encode(int argc, VALUE * argv, VALUE klass) {
     VALUE encoder, input, output, options;
     rb_scan_args(argc, argv, "12", &input, &output, &options);
@@ -39,9 +78,10 @@ void Init_wankel() {
     rb_define_singleton_method(c_wankel, "parse", wankel_parse, -1);
     rb_define_singleton_method(c_wankel, "encode", wankel_encode, -1);
 	
-    rb_define_singleton_method(c_wankel, "load", wankel_parse, -1);
-    rb_define_singleton_method(c_wankel, "dump", wankel_encode, -1);
-    
+    VALUE c_wankel_singleton = rb_singleton_class(c_wankel);
+    rb_define_alias(c_wankel_singleton, "load", "parse");
+    rb_define_alias(c_wankel_singleton, "dump", "encode");
+
     c_wankelParser = Init_wankel_parser();
     c_wankelEncoder = Init_wankel_encoder();
     Init_wankel_stream_parser();

data/ext/wankel/yajl_helpers.h

@@ -5,8 +5,9 @@
 #include <yajl/yajl_common.h>
 #include <yajl/yajl_parse.h>
 #include <yajl/yajl_gen.h>
-	
+
 // Yajl Helpers ==============================================================
+void Init_yajl_helpers();
 void yajl_helper_check_status(yajl_handle handle, yajl_status status, int verbose, const unsigned char * jsonText, size_t jsonTextLength);
 void yajl_helper_check_gen_status(yajl_gen_status status);
 

data/lib/wankel/stream_encoder.rb

@@ -0,0 +1,35 @@
+class Wankel
+  class StreamEncoder
+  
+    def value(val)
+      case val
+      when NilClass
+        null
+      when TrueClass, FalseClass
+        boolean(val)
+      when Numeric
+        number(val)
+      when String
+        string(val)
+      when Array
+        array_open
+        val.each {|v| value(v) }
+        array_close
+      when Hash
+        map_open
+        val.each {|k, v| string(k.to_s); value(v) }
+        map_close
+      else
+        case @options[:mode]
+        when :strict
+          raise Wankel::EncodeError, "Unkown JSON type #{val.class}"
+        when :nil
+          null
+        else
+          value(val.send(@options[:mode]))
+        end
+      end
+    end
+    
+  end
+end

data/lib/wankel.rb

@@ -1,44 +1,59 @@
 require 'wankel/wankel'
 
 class Wankel
-    DEFAULTS = {
-      :read_buffer_size => 8092,
-      :symbolize_keys => false,
-      :allow_comments => false,
-      :validate_utf8 => false,
-      :allow_trailing_garbage => false,
-      :multiple_values => false,
-      :allow_partial_values => false,
+
+  # [read_buffer_size]       The size of the read buffer in bytes. Deafults to
+  #                          +8092+.
+  # [symbolize_keys]         Set the keys of hashes to symbols instead of
+  #                          strings. Defaults to +false+.
+  # [allow_comments]         Ignore JavaScript style comments present in JSON
+  #                          input. Defaults to +false+.
+  # [validate_utf8]          Verify that all strings in the JSON input is valid
+  #                          UTF-8. Defaults to +false+.
+  # [allow_trailing_garbage] Don't raise an error there is content after the end
+  #                          of the JSON document. Defaults to +false+.
+  # [multiple_values]        Allow multiple JSON documents to be parsed. Every
+  #                          document must be valid and seperated by whitespace
+  #                          of any kind. The parser will continue to operate
+  #                          on input rather going into a completed state.
+  #                          Useful for parsing multiple values from an input
+  #                          stream. Defaults to +false+.
+  # [allow_partial_values]   The parser will check the top level value was
+  #                          completely consumed by default, setting this allows
+  #                          partial JSON values. Defaults to +false+.
+  # [mode]                   The mode used for generate JSON. Setting mode to 
+  #                          +:strict+ mode only allows the 7 basic JSON types.
+  #                          Setting the mode to +:nil+ replaces an object that is
+  #                          not a basic JSON type with null. If any other value
+  #                          is passed it will call the object method with the
+  #                          same name to serialize it to JSON. Defaults to
+  #                          +:strict+
+  # [write_buffer_size]      The size of the write buffer in bytes. Defaults to
+  #                          +8092+.
+  # [beautify]               Generate indented (beautiful) output. Defaults to
+  #                          +false+.
+  # [indent_string]          The indent string used when beautify is set.
+  #                          Defaults to +'    '+ (4 spaces).
+  # [validate_utf8]          Verify that all strings in JSON input are valid
+  #                          UTF-8. Defaults to +false+.
+  # [escape_solidus]         Alway escape the forward solidus ('/'), even though
+  #                          it is not required in JSON strings. Defaults to +false+.
+  DEFAULTS = {
+    :read_buffer_size => 8092,
+    :symbolize_keys => false,
+    :allow_comments => false,
+    :validate_utf8 => false,
+    :allow_trailing_garbage => false,
+    :multiple_values => false,
+    :allow_partial_values => false,
       
-      :write_buffer_size => 8092,
-      :beautify => false,
-      :indent_string => '    ',
-      :validate_utf8 => false,
-      :escape_solidus => false
-    }
+    :mode => :strict,
+    :write_buffer_size => 8092,
+    :beautify => false,
+    :indent_string => '    ',
+    :validate_utf8 => false,
+    :escape_solidus => false
+  }
 end
 
-class Wankel::StreamEncoder
-  
-  def value(val)
-    case val
-    when NilClass
-      null
-    when TrueClass, FalseClass
-      boolean(val)
-    when Numeric
-      number(val)
-    when String
-      string(val)
-    when Array
-      array_open
-      val.each {|v| value(v) }
-      array_close
-    when Hash
-      map_open
-      val.each {|k, v| string(k.to_s); value(v) }
-      map_close
-    end
-  end
-  
-end
+require 'wankel/stream_encoder'

data/test/encoding/sax_encoder_test.rb

@@ -142,6 +142,28 @@ class Wankel::StreamEncoderTest < Minitest::Test
     assert_output('{"one":"one","two":2,"three":true,"four":null,"5":[45.21]}')
   end
   
+  test "value(Object) :mode => :strict" do
+    assert_raises Wankel::EncodeError do
+      @encoder.value(StringIO.new)
+    end
+  end
+
+  test "value(Object) :mode => :nil" do
+    @encoder = Wankel::StreamEncoder.new(@output, :mode => :nil)
+    @encoder.value(StringIO.new)
+    @encoder.flush
+
+    assert_output("null")
+  end
+
+  test "value(Object) :mode => :string" do
+    @encoder = Wankel::StreamEncoder.new(@output, :mode => :string)
+    @encoder.value(StringIO.new("string method"))
+    @encoder.flush
+
+    assert_output('"string method"')
+  end
+
   test 'flush' do
     output = StringIO.new
     

data/wankel.gemspec

@@ -1,22 +1,27 @@
 Gem::Specification.new do |s|
   s.name        = 'wankel'
-  s.version     = '0.5.0'
+  s.version     = '0.6.0'
   s.licenses    = ['MIT']
   s.authors     = ['Jon Bracy']
   s.email       = ['jonbracy@gmail.com']
   s.homepage    = 'http://wankelrb.com'
   s.summary     = 'Streaming JSON parser and encoder'
   s.description = 'A JSON parser that enables streaming parsing and encoding of JSON'
-  
+
+  s.extra_rdoc_files = %w(README.md)
+  s.rdoc_options.concat ['--main', 'README.md']
+
   s.files = `git ls-files`.split("\n")
   s.extensions = ['ext/wankel/extconf.rb']
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ['lib']
 
   s.required_ruby_version = '>= 2.0.0'
-  
+
   s.add_development_dependency 'rake-compiler',       '~> 0.9'
   s.add_development_dependency 'minitest',            '~> 5.3'
   s.add_development_dependency 'minitest-reporters',  '~> 1.0'
   s.add_development_dependency 'mocha',               '~> 1.1'
-end
+  s.add_development_dependency 'sdoc',                '~> 0.4'
+  s.add_development_dependency 'sdoc-templates-42floors', '~> 0.3'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wankel
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jon Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-25 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -66,13 +66,42 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: sdoc-templates-42floors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: A JSON parser that enables streaming parsing and encoding of JSON
 email:
 - jonbracy@gmail.com
 executables: []
 extensions:
 - ext/wankel/extconf.rb
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - ".gitignore"
 - ".tm_properties"
@@ -100,6 +129,7 @@ files:
 - ext/wankel/yajl_helpers.c
 - ext/wankel/yajl_helpers.h
 - lib/wankel.rb
+- lib/wankel/stream_encoder.rb
 - logo.png
 - test/encoding/encoding_test.rb
 - test/encoding/sax_encoder_test.rb
@@ -174,7 +204,9 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--main"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -189,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Streaming JSON parser and encoder