yajl-ruby 0.5.11 → 0.5.12

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.12 (July 31st, 2009)
+* Add another option that can be passed to Yajl::Encoder's constructor (:terminator) to allow the caller some control over
+  when a full JSON string has been generated by the encoder. More information on it's use in the README
+
 ## 0.5.11 (July 14th, 2009)
 * fixing a bug Aman found with to_json on non-primitive Ruby objects and double-quoting in the JSON compat API
 

data/README.rdoc

@@ -1,6 +1,6 @@
 = YAJL C Bindings for Ruby
 
-This gem (although not in gem form just yet) is a C binding to the excellent YAJL JSON parsing and generation library.
+This gem is a C binding to the excellent YAJL JSON parsing and generation library.
 
 You can read more info at the projects website http://lloydforge.org/projects/yajl or check out it's codes at http://github.com/lloyd/yajl.
 
@@ -27,6 +27,8 @@ Install it like any other gem hosted at the Githubs like so:
 
 == Example of use
 
+NOTE: I'm building up a collection of small examples in the examples (http://github.com/brianmario/yajl-ruby/tree/master/examples) folder.
+
 First, you're probably gonna want to require it:
 
  require 'yajl'
@@ -77,6 +79,11 @@ only had access to chunks of it at a time. No problem!
    @parser << data
  end
 
+Or if you don't need to stream it, it'll just return the built object from the parse when it's done.
+ NOTE: if there are going to be multiple JSON strings in the input, you *must* specify a block or callback as this
+ is how yajl-ruby will hand you (the caller) each object as it's parsed off the input.
+
+ obj = Yajl::Parser.parse(str_or_io)
 
 Or how about a JSON API HTTP request?
 This actually makes a request using a raw TCPSocket, then parses the JSON body right off the socket. While it's being received over the wire!
@@ -150,6 +157,42 @@ This example will encode and send 50 JSON objects over the same stream, continuo
    encoder.encode(hash, socket)
  end
 
+Using EventMachine and you want to encode and send in chunks?
+(Assume we're in an EventMachine::Connection instance)
+
+ def post_init
+    # Passing a :terminator character will let us determine when the encoder
+    # is done encoding the current object
+    @encoder = Yajl::Encoder.new(:terminator => nil)
+    motd_contents = File.read("/path/to/motd.txt")
+    status = File.read("/path/to/huge/status_file.txt")
+    @motd = {:motd => motd_contents, :system_status => status}
+ end
+  
+ def connection_completed
+   # The encoder will do it's best to hand you data in chunks that
+   # are around 8kb (but you may see some that are larger)
+   #
+   # It should be noted that you could have also assigned the _on_progress_ callback
+   # much like you can assign the _on_parse_complete_ callback with the parser class.
+   # Passing a block (like below) essentially tells the encoder to use that block
+   # as the callback normally assigned to _on_progress_.
+   #
+   # Send our MOTD and status
+   @encoder.encode(@motd) do |chunk|
+     if chunk.nil?
+       close_connection_after_writing
+     else
+       send_data(chunk)
+     end
+   end
+ end
+
+But to make things simple, you might just want to let yajl-ruby do all the hard work for you and just hand back
+a string when it's finished. In that case, just don't provide and IO or block (or assign the on_progress callback).
+
+ str = Yajl::Encoder.encode(obj)
+
 You can also use Yajl::Bzip2::StreamWriter and Yajl::Deflate::StreamWriter. So you can pick whichever fits your CPU/bandwidth sweet-spot.
 
 == JSON gem Compatibility API
@@ -174,7 +217,7 @@ There are a lot more possibilities that I'd love to see other gems/plugins for s
 Some ideas are:
 * parsing logs in JSON format
 * a Rails plugin (http://github.com/technoweenie/yajl-rails)
-* builtin Rails 3 support?
+* builtin support in Rails 3?
 * Rack middleware (ideally the JSON body could be handed to the parser while it's still being received)
 * use with ohai (http://github.com/brianmario/ohai)
 * JSON API clients (http://github.com/brianmario/crack, http://github.com/brianmario/freckle-api)

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 11
-:major: 0
 :minor: 5
+:patch: 12
+:major: 0

data/ext/yajl_ext.c

@@ -69,6 +69,7 @@ static void yajl_encoder_wrapper_free(void * wrapper) {
 static void yajl_encoder_wrapper_mark(void * wrapper) {
     struct yajl_encoder_wrapper * w = wrapper;
     rb_gc_mark(w->on_progress_callback);
+    rb_gc_mark(w->terminator);
 }
 
 void yajl_encode_part(void * wrapper, VALUE obj, VALUE io) {
@@ -445,11 +446,17 @@ static VALUE rb_yajl_parser_set_complete_cb(VALUE self, VALUE callback) {
 /*
  * Document-method: new
  *
- * call-seq: new([:pretty => false[, :indent => '  ']])
- *
- * :pretty will enable/disable beautifying or "pretty priting" the output string.
- *
- * :indent is the character(s) used to indent the output string.
+ * call-seq: initialize([:pretty => false[, :indent => '  '][, :terminator => "\n"]])
+  *
+  * :pretty will enable/disable beautifying or "pretty priting" the output string.
+  *
+  * :indent is the character(s) used to indent the output string.
+  *
+  * :terminator allows you to specify a character to be used as the termination character after a full JSON string has been generated by
+  * the encoder. This would be especially useful when encoding in chunks (via a block or callback during the encode process), to be able to
+  * determine when the last chunk of the current encode is sent.
+  * If you specify this option to be nil, it will be ignored if encoding directly to an IO or simply returning a string. But if a block is used,
+  * the encoder will still pass it - I hope that makes sense ;).
  */
 static VALUE rb_yajl_encoder_new(int argc, VALUE * argv, VALUE klass) {
     struct yajl_encoder_wrapper * wrapper;
@@ -476,6 +483,11 @@ static VALUE rb_yajl_encoder_new(int argc, VALUE * argv, VALUE klass) {
     obj = Data_Make_Struct(klass, struct yajl_encoder_wrapper, yajl_encoder_wrapper_mark, yajl_encoder_wrapper_free, wrapper);
     wrapper->encoder = yajl_gen_alloc(&cfg, NULL);
     wrapper->on_progress_callback = Qnil;
+    if (opts != Qnil && rb_funcall(opts, intern_has_key, 1, ID2SYM(sym_terminator)) == Qtrue) {
+        wrapper->terminator = rb_hash_aref(opts, ID2SYM(sym_terminator));
+    } else {
+        wrapper->terminator = 0;
+    }
     rb_obj_call_init(obj, 0, 0);
     return obj;
 }
@@ -483,11 +495,17 @@ static VALUE rb_yajl_encoder_new(int argc, VALUE * argv, VALUE klass) {
 /*
  * Document-method: initialize
  *
- * call-seq: initialize([:pretty => false[, :indent => '  ']])
+ * call-seq: initialize([:pretty => false[, :indent => '  '][, :terminator => "\n"]])
  *
  * :pretty will enable/disable beautifying or "pretty priting" the output string.
  *
  * :indent is the character(s) used to indent the output string.
+ *
+ * :terminator allows you to specify a character to be used as the termination character after a full JSON string has been generated by
+ * the encoder. This would be especially useful when encoding in chunks (via a block or callback during the encode process), to be able to
+ * determine when the last chunk of the current encode is sent.
+ * If you specify this option to be nil, it will be ignored if encoding directly to an IO or simply returning a string. But if a block is used,
+ * the encoder will still pass it - I hope that makes sense ;).
  */
 static VALUE rb_yajl_encoder_init(int argc, VALUE * argv, VALUE self) {
     return self;
@@ -530,13 +548,23 @@ static VALUE rb_yajl_encoder_encode(int argc, VALUE * argv, VALUE self) {
     yajl_gen_get_buf(wrapper->encoder, &buffer, &len);
     outBuff = rb_str_new((const char *)buffer, len);
     yajl_gen_clear(wrapper->encoder);
+    
     if (io != Qnil) {
         rb_io_write(io, outBuff);
+        if (wrapper->terminator != 0 && wrapper->terminator != Qnil) {
+            rb_io_write(io, wrapper->terminator);
+        }
         return Qnil;
     } else if (blk != Qnil) {
         rb_funcall(blk, intern_call, 1, outBuff);
+        if (wrapper->terminator != 0) {
+            rb_funcall(blk, intern_call, 1, wrapper->terminator);
+        }
         return Qnil;
     } else {
+        if (wrapper->terminator != 0 && wrapper->terminator != Qnil) {
+            rb_str_concat(outBuff, wrapper->terminator);
+        }
         return outBuff;
     }
     return Qnil;
@@ -787,5 +815,7 @@ void Init_yajl_ext() {
     sym_check_utf8 = rb_intern("check_utf8");
     sym_pretty = rb_intern("pretty");
     sym_indent = rb_intern("indent");
+    sym_terminator = rb_intern("terminator");
     sym_symbolize_keys = rb_intern("symbolize_keys");
+    intern_has_key = rb_intern("has_key?");
 }

data/ext/yajl_ext.h

@@ -6,8 +6,8 @@
 #define WRITE_BUFSIZE 8092
 
 static VALUE cParseError, cEncodeError, mYajl, cParser, cEncoder;
-static ID intern_io_read, intern_eof, intern_call, intern_keys, intern_to_s, intern_to_json,
-          sym_allow_comments, sym_check_utf8, sym_pretty, sym_indent, sym_symbolize_keys;
+static ID intern_io_read, intern_eof, intern_call, intern_keys, intern_to_s, intern_to_json, intern_has_key,
+          sym_allow_comments, sym_check_utf8, sym_pretty, sym_indent, sym_terminator, sym_symbolize_keys;
 
 #define GetParser(obj, sval) (sval = (struct yajl_parser_wrapper*)DATA_PTR(obj));
 #define GetEncoder(obj, sval) (sval = (struct yajl_encoder_wrapper*)DATA_PTR(obj));
@@ -53,6 +53,7 @@ struct yajl_parser_wrapper {
 
 struct yajl_encoder_wrapper {
     VALUE on_progress_callback;
+    VALUE terminator;
     yajl_gen encoder;
 };
 

data/lib/yajl.rb

@@ -13,7 +13,7 @@ require 'yajl_ext'
 #
 # Ruby bindings to the excellent Yajl (Yet Another JSON Parser) ANSI C library.
 module Yajl
-  VERSION = "0.5.11"
+  VERSION = "0.5.12"
   
   class Parser
     # A helper method for parse-and-forget use-cases

data/spec/encoding/encoding_spec.rb

@@ -187,4 +187,40 @@ describe "Yajl JSON encoder" do
   it "should encode a hash where the key and value can be symbols" do
     Yajl::Encoder.encode({:foo => :bar}).should eql('{"foo":"bar"}')
   end
+  
+  it "should encode using a newline or nil terminator" do
+    Yajl::Encoder.new(:terminator => "\n").encode({:foo => :bar}).should eql("{\"foo\":\"bar\"}\n")
+    Yajl::Encoder.new(:terminator => nil).encode({:foo => :bar}).should eql("{\"foo\":\"bar\"}")
+  end
+  
+  it "should encode using a newline or nil terminator, to an IO" do
+    s = StringIO.new
+    Yajl::Encoder.new(:terminator => "\n").encode({:foo => :bar}, s)
+    s.rewind
+    s.read.should eql("{\"foo\":\"bar\"}\n")
+    
+    s = StringIO.new
+    Yajl::Encoder.new(:terminator => nil).encode({:foo => :bar}, s)
+    s.rewind
+    s.read.should eql("{\"foo\":\"bar\"}")
+  end
+  
+  it "should encode using a newline or nil terminator, using a block" do
+    s = StringIO.new
+    Yajl::Encoder.new(:terminator => "\n").encode({:foo => :bar}) do |chunk|
+      s << chunk
+    end
+    s.rewind
+    s.read.should eql("{\"foo\":\"bar\"}\n")
+    
+    s = StringIO.new
+    nilpassed = false
+    Yajl::Encoder.new(:terminator => nil).encode({:foo => :bar}) do |chunk|
+      nilpassed = true if chunk.nil?
+      s << chunk
+    end
+    nilpassed.should be_true
+    s.rewind
+    s.read.should eql("{\"foo\":\"bar\"}")
+  end
 end

data/yajl-ruby.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{yajl-ruby}
-  s.version = "0.5.11"
+  s.version = "0.5.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Lopez", "Lloyd Hilaiel"]
-  s.date = %q{2009-07-14}
+  s.date = %q{2009-07-31}
   s.email = %q{seniorlopez@gmail.com}
   s.extensions = ["ext/extconf.rb"]
   s.extra_rdoc_files = [
@@ -152,7 +152,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib", "ext"]
   s.rubyforge_project = %q{yajl-ruby}
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Ruby C bindings to the excellent Yajl JSON stream-based parser library.}
   s.test_files = [
     "spec/encoding/encoding_spec.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yajl-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.5.11
+  version: 0.5.12
 platform: ruby
 authors: 
 - Brian Lopez
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-14 00:00:00 -07:00
+date: 2009-07-31 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -182,8 +182,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yajl-ruby
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
+source: 
 specification_version: 3
 summary: Ruby C bindings to the excellent Yajl JSON stream-based parser library.
 test_files: