object-stream 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dc85fe1bb49ec72198087e251a3d2f82236944b
-  data.tar.gz: d7b30be75c5360a6916b6d4d7108c4c20971532a
+  metadata.gz: 2012223a66102b4befa32c0aaecbc6559f46d089
+  data.tar.gz: 348120adfb1bdf1a62b439fe3f4a78a3887fce0c
 SHA512:
-  metadata.gz: 243bb0063699a7419ff4f21982351c212702e68181650886efd5f513f54d77d35d8656d54777a1c75b599983a60192d3411187bc05a3639ddeb52d0b8c8328a4
-  data.tar.gz: bbec7c970e8f0e0840185b52a8f051d9c12be78327b4b77aeb7fbd71a6bec16fac471cf9bff78ab84ccbad5991e443aa545abda637fe6948bce87e064884092b
+  metadata.gz: 03ea4758680c9209c65d178e938dc4025bbf37f09e73fd7a70955053aa09352edcf8c600b921cd5869735e4b0ce57227bd5202747fec618408786dd467f1ece0
+  data.tar.gz: 5afa9b0995c5f93e4055608202ba4a86551eb071c8415102a152cab179834b407c6e69310548a3e2421c0b99c07f6e71ae4bd932e226cf22bfde5a6dfcfd44c1

data/examples/symbolize-keys.rb

@@ -0,0 +1,38 @@
+# The marshal and yaml serializers preserve the difference between strings and
+# symbols, but msgpack and json cannot: the formats only allow strings. However,
+# sometimes we prefer to write programs that work with symbols even though the
+# serialized data contain strings. On the write end of a stream, that is already
+# possible: symbols are converted to strings as they are written.
+#
+# The symbolize keys feature solves the problem on the read end of a stream. It
+# configures msgpack and json (yajl) to de-serialize strings as symbols. This
+# can be more efficient, since it generates fewer string objects. It's also
+# efficient and convenient to avoid conversions when connecting to other
+# libraries that expect symbols, such as the Sequel database interface.
+#
+# Keep in mind that Ruby, as of version 2.1, does not garbage collect symbols
+# (though this may be coming in 2.2). So this feature can lead to unbounded
+# memory use as new, different symbols keep arriving. Only use it if (a) the set
+# of symbols is bounded (and small), or (b) the program has a short lifespan, or
+# (c) you can monitor the program's memory use and restart it as needed.
+#
+# It's safe for one end of a stream to use this option even if the other end
+# does not: the stream itself is not affected, only the interface changes.
+
+type = ARGV.shift || "msgpack"
+
+case type
+when "marshal", "yaml", "json", "msgpack"
+else
+  abort "Usage: #$0 marshal|yaml|json|msgpack"
+end
+
+require 'object-stream'
+require 'stringio'
+
+sio = StringIO.new
+stream = ObjectStream.new(sio, type: type, symbolize_keys: true)
+stream << {x: 1, y: 2, z: 3}
+
+sio.rewind
+p stream.read

data/lib/object-stream.rb

@@ -10,7 +10,7 @@
 module ObjectStream
   include Enumerable
   
-  VERSION = "0.4"
+  VERSION = "0.5"
   
   # The IO through which the stream reads and writes serialized object data.
   attr_reader :io
@@ -247,9 +247,10 @@ module ObjectStream
 
     DEFAULT_CHUNK_SIZE = 2000
 
-    def initialize io, chunk_size: DEFAULT_CHUNK_SIZE
+    # See the discussion in examples/symbolize-keys.rb.
+    def initialize io, chunk_size: DEFAULT_CHUNK_SIZE, symbolize_keys: false
       super
-      @parser = Yajl::Parser.new
+      @parser = Yajl::Parser.new(symbolize_keys: symbolize_keys)
       @encoder = Yajl::Encoder.new
       @chunk_size = chunk_size
     end
@@ -280,9 +281,11 @@ module ObjectStream
     DEFAULT_CHUNK_SIZE = 2000
     DEFAULT_MAXBUF = 4000
     
-    def initialize io, chunk_size: DEFAULT_CHUNK_SIZE, maxbuf: DEFAULT_MAXBUF
+    # See the discussion in examples/symbolize-keys.rb.
+    def initialize io, chunk_size: DEFAULT_CHUNK_SIZE, maxbuf: DEFAULT_MAXBUF,
+          symbolize_keys: false
       super
-      @unpacker = MessagePack::Unpacker.new
+      @unpacker = MessagePack::Unpacker.new(symbolize_keys: symbolize_keys)
         # don't specify io, so don't have to read all of io in one loop
       
       @packer = MessagePack::Packer.new(io)

data/test/test-symbolize-keys.rb

@@ -0,0 +1,56 @@
+require 'object-stream'
+require 'stringio'
+
+require 'minitest/autorun'
+
+module TestSymbolizeKeys
+  attr_reader :sio, :stream
+  
+  BASIC_OBJECTS = [
+    nil,
+    true,
+    false,
+    "The quick brown fox jumped over the lazy dog's back.",
+    [-5, "foo", [4]],
+    {a: 1, b: 2},
+    {top: [ {middle: [bottom: "turtle"]} ] }
+  ]
+
+  def type; self.class::TYPE; end
+  def objects; BASIC_OBJECTS + self.class::OBJECTS; end
+
+  def setup
+    @sio = StringIO.new
+    @stream = ObjectStream.new sio, type: type, symbolize_keys: true
+  end
+  
+  def test_write_read
+    objects.each do |obj|
+      sio.rewind # do not need to clear stream's buffer (if any)
+      sio.truncate 0
+      stream.write obj
+
+      sio.rewind
+      dump = sio.read
+      sio.rewind
+
+      stream.read do |obj2|
+        assert_equal(obj, obj2, "dump is #{dump.inspect}")
+      end
+    end
+  end
+end
+
+class TestSymbolizeKeysJson < Minitest::Test
+  include TestSymbolizeKeys
+
+  TYPE = ObjectStream::JSON_TYPE
+  OBJECTS = []
+end
+
+class TestSymbolizeKeysMsgpack < Minitest::Test
+  include TestSymbolizeKeys
+
+  TYPE = ObjectStream::MSGPACK_TYPE
+  OBJECTS = []
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object-stream
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Joel VanderWerf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -58,6 +58,7 @@ files:
 - examples/read-without-block.rb
 - examples/slow-sender.rb
 - examples/socket.rb
+- examples/symbolize-keys.rb
 - examples/udp.rb
 - lib/object-stream-wrapper.rb
 - lib/object-stream.rb
@@ -68,6 +69,7 @@ files:
 - test/test-maxbuf.rb
 - test/test-outbox.rb
 - test/test-slow-sender.rb
+- test/test-symbolize-keys.rb
 homepage: https://github.com/vjoel/object-stream
 licenses:
 - BSD
@@ -95,16 +97,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Stream objects over IO using Marshal, JSON, YAML, or Msgpack
 test_files:
-- test/test-basic.rb
+- test/test-maxbuf.rb
 - test/test-outbox.rb
+- test/test-basic.rb
 - test/test-consume.rb
-- test/test-maxbuf.rb
+- test/test-symbolize-keys.rb
 - test/test-inbox.rb
-- test/test-slow-sender.rb
 - test/test-expect.rb
+- test/test-slow-sender.rb
 has_rdoc: