boss-protocol 0.1.3 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48d7d49095b00c5a6c7c1fc9c349e623cb52bc62
+  data.tar.gz: e15a3c17f710e7e07af4922ab85a70a01990e6a9
+SHA512:
+  metadata.gz: 5d8586643c80b3bf34e73e624ca496733ad7e3c5e659f8021d59a42f4c4cb936f4e5385aaaeb0a874197febd98c31a0d56a13b1f7fce1624eb5eecc017de812b
+  data.tar.gz: d4835694296bd13626adaaeb10bc5cc1d950e53f1a1c71d9a5d868f38028f7bdc4f1baf8a8e97c1df511767c6dae49f7afbbdad9259329f332f3e2656e178248

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0

data/README.md

@@ -1,8 +1,8 @@
 # Boss Protocol
 
-BOSS is acronym for Binary Object Streamable Storage.
+BOSS is an acronym for Binary Object Streaming Specification.
 
-The very space-effective, platform-independent^ streamable and traversable
+The bit-effective, platform-independent streamable and traversable
 typed binary protocol. Allow to effectively store small or any sized integers,
 strings or binary data of any size, floats and doubles, arrays and hashes in a
 very effective way. It caches repeating objects and stores/restores links to
@@ -13,7 +13,7 @@ size, signed integers of absolutely any size, arrays and hashes with no limit
 on items and overall gross size. It is desirable to use build-in compression when
 appropriate.
 
-Streamable means that you can use a pipe (tcp/ip, wahtever), put the object at
+Streamable means that you can use a pipe (for example tcp/ip), put the object at
 one side and load it on other, one-by-one, and caching and links will be
 restored properly.
 
@@ -23,6 +23,14 @@ json/boss/whatever. For example, typical JSON reduces in size twice with Boss.
 
 Boss protocol also allow to transparently compress its representations.
 
+Boss also supports "stream mode" that lacks tree reconstruction but could be
+effectively use when implementing long-living streams (e.g. stream protocols).
+In regular mode it causes unlimited cache grows as Boss would try to reconstruct
+all possible references to already serialized objects. In the stream mode only
+strings are cached, and cache size and capacity are dynamically limited.
+Boss writes stream mode marker and handles stream mode on receiving end
+automatically.
+
 Supported types:
 
  * Signed integers of any length
@@ -86,7 +94,7 @@ To use the transparent compression:
 ## Streaming sample
 
 This sample shows boss object hierarchies passing between 2 forked processes
-using a pipe:
+using a pipe (see samples/):
 
     if fork
       wr.close

data/lib/boss-protocol/version.rb

@@ -1,3 +1,3 @@
 module Boss
-  VERSION = "0.1.3"
+  VERSION = "1.3.0"
 end

data/lib/boss-protocol.rb

@@ -36,6 +36,8 @@ require 'zlib'
 # Attn! We removed Bzip2 compression for the sake of compatibility. We may add it back when situation
 # with bz2 implementations on various platforms will be eased
 #
+# 1.3 Stream mode added
+#
 # 1.2 version adds support for booelans and removes support for python __reduce__ - based objects
 #       as absolutely non portable. It also introduces
 #
@@ -51,8 +53,9 @@ require 'zlib'
 
 module Boss
 
-  class NotSupportedException < StandardError; end
-                # Basic types
+  class NotSupportedException < StandardError;
+  end
+  # Basic types
   TYPE_INT   = 0
   TYPE_EXTRA = 1
   TYPE_NINT  = 2
@@ -85,7 +88,9 @@ module Boss
   TFALSE = 13
 
   TCOMPRESSED = 14
-  TTIME = 15
+  TTIME       = 15
+
+  XT_STREAM_MODE = 16
 
   def checkArg(cond, msg=nil)
     raise ArgumentError unless cond
@@ -94,7 +99,6 @@ module Boss
   class UnknownTypeException < Exception;
   end
 
-  ##
   # Formats ruby object hierarchies with BOSS
   # notation
   #
@@ -112,6 +116,20 @@ module Boss
       @cache = { nil => 0 }
     end
 
+
+    # Switch to stream mode. Stream mode limits cache using to strings only in LRU
+    # mode using specified parameters. Stream mode writes a marker into output so
+    # decoder knows it.
+    # @param max_string_size maximum allowed size of the string to be cached.
+    #        longer strings will not be cached
+    # @param max_cache_entries
+    def stream_mode max_cache_entries, max_string_size
+      @max_cache_entries, @max_string_size = max_cache_entries, max_string_size
+      whdr TYPE_EXTRA, XT_STREAM_MODE
+      self << max_cache_entries.to_i << max_string_size.to_i
+      @cache = { nil => 0 }
+    end
+
     ##
     # same as put but automatically select and use proper compression. Parser.get
     # will automatically decompress.
@@ -128,8 +146,8 @@ module Boss
                else
                  data = Zlib::Deflate.new.deflate(data, Zlib::FINISH)
                  1
-                 #data = Bzip2.compress data
-                 #2
+               #data = Bzip2.compress data
+               #2
              end
       whdr type, data.length
       wbin data
@@ -211,18 +229,39 @@ module Boss
 
     private
 
-    ##
     # Write cache ref if the object is cached, and return true
     # otherwise store object in the cache. Caller should
     # write object to @io if notCached return true, and skip
     # writing otherwise
+
     def notCached(obj)
       n = @cache[obj]
       if n
         whdr TYPE_CREF, n
         false
       else
-        @cache[obj] = @cache.length
+        # Check stream mode
+        if @max_string_size
+          if obj.is_a?(String) && obj.length <= @max_string_size
+            if @cache.length > @max_cache_entries
+              minIndex = @cache.length - @max_cache_entries
+              key      = nil
+              @cache.each { |k, v|
+                next if k == nil
+                if v == minIndex
+                  key = k
+                else
+                  @cache[k] = v - 1
+                end
+              }
+              key == nil and raise "Cache implementation failed"
+              @cache.delete key
+            end
+            @cache[obj] = @cache.length
+          end
+        else
+          @cache[obj] = @cache.length
+        end
         true
       end
     end
@@ -351,21 +390,26 @@ module Boss
               end
             when TTIME
               Time.at renc
+            when XT_STREAM_MODE
+              @cache = [nil]
+              @max_cache_entries = get + 1 # Count 0th element (always 0)
+              @max_string_size = get
+              get
             else
               raise UnknownTypeException
           end
         when TYPE_TEXT, TYPE_BIN
           s = rbin value
           s.force_encoding code == TYPE_BIN ? Encoding::BINARY : Encoding::UTF_8
-          @cache << s
+          cache_object s
           s
         when TYPE_LIST
           #        p "items", value
-          @cache << (list = [])
+          cache_object (list = [])
           value.times { list << get }
           list
         when TYPE_DICT
-          @cache << (dict = { })
+          cache_object (dict = {})
           value.times { dict[get] = get }
           dict
         when TYPE_CREF
@@ -391,6 +435,19 @@ module Boss
 
     private
 
+    def cache_object object
+      # Stream mode?
+      if @max_cache_entries
+        if object.is_a?(String) && object.length <= @max_string_size
+          # Should cache
+          @cache << object
+          @cache.delete_at(1) if @cache.length > @max_cache_entries
+        end
+      else
+        @cache << object
+      end
+    end
+
     ##
     # Read header and return code,value
     def rhdr

data/samples/testp.rb

@@ -1,14 +1,18 @@
+# The interprocess communication using BOSS through
+# pipes
+
 require '../lib/boss-protocol'
 
 rd, wr = IO.pipe
 
 if fork
   wr.close
-  if false
+  # There is more than one way:
+  if true
     # You can do it with block:
     Boss::Parser.new(rd).each { |obj| puts "Got an object: #{obj}" }
   else
-    # You can do it without block too:
+    # You can do it without block:
     input = Boss::Parser.new rd
     puts "Got an object: #{input.get}" while !input.eof?
   end

data/spec/boss_spec.rb

@@ -152,6 +152,28 @@ describe 'Boss' do
     -> { Boss.dump MyObject.new }.should raise_error(Boss::NotSupportedException)
   end
 
+  it 'should implement stream mode' do
+    out = Boss::Formatter.new
+    out.stream_mode 3, 10
+    3.times { out << "String too long" }
+    (1..6).each { |n| out << "test#{n}" }
+    (4..6).each { |n| out << "test#{n}" }
+    (4..6).each { |n| out << "test#{n}" }
+    out << "test7"
+
+    res = "\x81\x18P{String too long{String too long{String too long+test1+test2+test3+test4+test5+test6\r\x15\x1D\r\x15\x1D+test7"
+    res.force_encoding 'binary'
+    out.string.should == res
+
+    inp = Boss::Parser.new out.string
+
+    3.times { inp.get.should == "String too long" }
+    (1..6).each { |n| inp.get.should == "test#{n}" }
+    (4..6).each { |n| inp.get.should == "test#{n}" }
+    (4..6).each { |n| inp.get.should == "test#{n}" }
+    inp.get.should == "test7"
+  end
+
   def round_check(ob)
     ob.should == Boss.load(Boss.dump(ob))
   end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: boss-protocol
 version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - sergeych
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Binary streamable bit-effective protocol to effectively store object
@@ -37,6 +34,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .ruby-version
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -49,27 +47,26 @@ files:
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Traversable and streamable to protocol supports lists, hashes, caching, compression
   and more
 test_files: