boss-protocol 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5874e8e0bafe28f14f96860d9e91ea38d0ab1783
-  data.tar.gz: ba1ce2c78a5f90e304f1e9bdc4fe7d3c4617df4e
+  metadata.gz: e4eaaed01911c7a0f9f26769286b8d16c445cede
+  data.tar.gz: 6d7e1918eff5176c1c5741e4ef49ae616353e343
 SHA512:
-  metadata.gz: 1f6d6ca3de1a97e307cafd2aef68e983d21e62d4b237849ebc181d1e83200c845d83d6ab64f1f3eb2f829eb79a0cf93e91e933f507e72ba9dcf31985ee56936c
-  data.tar.gz: 21bbd5e2bff93811da4eac812bcf01c0103a4b95f28a85c7e361731e422f6f87f840b52bf0d858ce08fee289212d4abbef5efb622202e3671c3ffa7f7fd6c4b2
+  metadata.gz: 664c0548aee50b3657b24911f7bbc9e970ddb20067652f4e0399fa9782575c020eeea423a46b33a97c398a70958262ecf3b6e87c4ecf751c589ca3f4da2140bd
+  data.tar.gz: 671744b293ace6d9d207185b6bf08d7a35e388815a503689f4d4ef746514523f35e44967b03ee05d73f2c71190e95a718da44f7e524e2023d1d449f19e95aca8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 sergeych
+
+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

@@ -1,5 +1,5 @@
 # Boss Protocol
-
+ 
 Supported version: 1.4 (stream mode with no caching, regular cached mode)
 
 BOSS is an acronym for Binary Object Streaming Specification.
@@ -47,6 +47,11 @@ Supported types:
 
 There is a working JAVA implemetation also.
 
+## Latest news:
+
+ - added 2.4+ language compatibility (no more Fixnum/Bignum)
+ - added simplified Boss.pack()/Boss.unpack() interface
+ 
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -67,14 +72,14 @@ Or install it yourself as:
      => false
     1.9.3-p327 :012 > data = { 'test' => [1, 2, -1.22, 'great!'] }
      => {"test"=>[1, 2, -1.22, "great!"]}
-    1.9.3-p327 :013 > x = Boss.dump data
+    1.9.3-p327 :013 > x = Boss.pack data
      => "\x0F#test&\b\x109\x85\xEBQ\xB8\x1E\x85\xF3\xBF3great!"
-    1.9.3-p327 :014 > Marshal.dump data
+    1.9.3-p327 :014 > Marshal.unpack data
      => "\x04\b{\x06I\"\ttest\x06:\x06ET[\ti\x06i\af\n-1.22I\"\vgreat!\x06;\x00T"
 
 Note that boss representation is smaller than ruby's Marshal one
 
-    1.9.3-p327 :015 > Boss.load(x) == data
+    1.9.3-p327 :015 > Boss.unpack(x) == data
      => true
 
 To use the transparent compression:
@@ -83,11 +88,11 @@ To use the transparent compression:
      => nil
     1.9.3-p327 :014 > data.length
      => 139264
-    1.9.3-p327 :015 > x = Boss.dump_compressed(data); nil
+    1.9.3-p327 :015 > x = Boss.pack_compress(data); nil
      => nil
     1.9.3-p327 :016 > x.length
      => 147
-    1.9.3-p327 :017 > data == Boss.load(x)
+    1.9.3-p327 :017 > data == Boss.unpack(x)
      => true
 
 ## Streaming sample

data/boss-protocol.gemspec

@@ -9,9 +9,10 @@ Gem::Specification.new do |gem|
   gem.authors       = ["sergeych"]
   gem.email         = ["real.sergeych@gmail.com"]
   gem.description   = %q{Binary streamable bit-effective protocol to effectively store object tree hierarchies}
-  gem.summary       = %q{Traversable and streamable to protocol supports lists, hashes, caching,
-compression and more}
-  gem.homepage      = ""
+  gem.summary       = %q{Traversable and streamable to protocol supports lists, hashes, caching, datetime, texts,
+unlimited integers, floats, compression and more}
+  gem.homepage      = "https://github.com/sergeych/boss_protocol"
+  gem.licenses      = ["MIT"]
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -19,5 +20,5 @@ compression and more}
   gem.require_paths = ["lib"]
 
   #gem.add_dependency 'bzip2-ruby'
-  gem.add_development_dependency "rspec", '>= 2.14.0'
+  gem.add_development_dependency "rspec", '~> 2.14'
 end

data/lib/boss-protocol.rb

@@ -56,6 +56,12 @@ require 'zlib'
 
 module Boss
 
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.0')
+    Bignum = Integer
+    Fixnum = Integer
+  end
+
+
   class NotSupportedException < StandardError;
   end
   # Basic types
@@ -96,7 +102,7 @@ module Boss
   XT_STREAM_MODE = 16
 
   def checkArg(cond, msg=nil)
-    raise ArgumentError unless cond
+    raise ArgumentError, msg unless cond
   end
 
   class UnknownTypeException < Exception;
@@ -218,7 +224,6 @@ module Boss
           wrenc ob.to_i
         else
           error = "error: not supported object: #{ob}, #{ob.class}"
-          p error
           raise NotSupportedException, error
       end
       self
@@ -544,5 +549,20 @@ module Boss
     roots.each { |r| f.put_compressed r }
     f.string
   end
+
+  # Pack object into compressed Boss representation
+  def Boss.pack_compress(object)
+    dump_compressed object
+  end
+
+  # Pack object to the BOSS binary (same as Boss#dump)
+  def Boss.pack object
+    Boss.dump object
+  end
+
+  # Unpack object from the BOSS binary (same as Boss#load(src))
+  def Boss.unpack object
+    Boss.load object
+  end
 end
 

data/lib/boss-protocol/version.rb

@@ -1,3 +1,3 @@
 module Boss
-  VERSION = "1.4.3"
+  VERSION = "1.5.0"
 end

data/spec/boss_spec.rb

@@ -298,6 +298,11 @@ describe 'Boss' do
     last['result']['foo'].should == 'bar'
   end
 
+  it 'has shortcuts' do
+    source = ['foo', 'bar', { 'hello' => 'world' }]
+    Boss.unpack(Boss.pack source).should == source
+  end
+
   def round_check(ob)
     ob.should == Boss.load(Boss.dump(ob))
   end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: boss-protocol
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - sergeych
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2017-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '2.14'
 description: Binary streamable bit-effective protocol to effectively store object
   tree hierarchies
 email:
@@ -35,6 +35,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -44,8 +45,9 @@ files:
 - samples/testp.rb
 - spec/boss_spec.rb
 - spec/spec_helper.rb
-homepage: ''
-licenses: []
+homepage: https://github.com/sergeych/boss_protocol
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -63,11 +65,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Traversable and streamable to protocol supports lists, hashes, caching, compression
-  and more
+summary: Traversable and streamable to protocol supports lists, hashes, caching, datetime,
+  texts, unlimited integers, floats, compression and more
 test_files:
 - spec/boss_spec.rb
 - spec/spec_helper.rb