nstrct 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e06a8f8d192ef2bfd7ef1b08ac24a51673c70d59
-  data.tar.gz: 96188fdf46de1a6d1d010c50da43ad1806c183a4
+  metadata.gz: 7a26c54c7028ec20750d4ee5e4d88509c7f74616
+  data.tar.gz: 2a89f910a4b0e226174536167c1efa1c05d0309a
 SHA512:
-  metadata.gz: a47bdd20de56a8417d0800f3a0c206c6f4d34ca0f26413403a23166a42a4d739c5d09054a53f20dee3d662944ced8ba47c90010a805fa657715085a9c57f8455
-  data.tar.gz: d063f5752aa2297dd706c10690f01a122eebaf1fe97e238a4ef4b7d22ac7febaf18d047036b2cb7cbb4b889f9ce0935e5969c6b1b0306c83a5441c78754b6fce
+  metadata.gz: 6f3e1716890fb3a47fe4506fb6db39fb18f256e0a7fe3ef2f855ff2a1b9eeacba5366b03ea5384234da7c752c9dd7682a11083cad09443f7e0bbec25b31c0b44
+  data.tar.gz: e7044f1ef72deb00c9502e555f560cd5aae395122b13060baf41145a3149c538a35cb2ffe4b02fbf765a2c8593e464254fe41fcbc472720a8ce17a4652df5aea

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+bundler_args: --without tool
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -1,6 +1,9 @@
 source 'http://rubygems.org'
 gemspec
 
+ruby '2.1.0'
+
 group :test do
   gem 'rspec'
+  gem 'rake'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nstrct (0.1.3)
+    nstrct (0.1.5)
       digest-crc
 
 GEM
@@ -9,18 +9,20 @@ GEM
   specs:
     diff-lcs (1.2.5)
     digest-crc (0.4.0)
+    rake (10.1.1)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
+    rspec-mocks (2.14.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   nstrct!
+  rake
   rspec

data/README.md

@@ -1,4 +1,4 @@
-# nstrct-ruby
+# nstrct-ruby [![Build Status](https://travis-ci.org/nstrct/nstrct-ruby.png?branch=master)](https://travis-ci.org/nstrct/nstrct-ruby) [![Code Climate](https://codeclimate.com/github/nstrct/nstrct-ruby.png)](https://codeclimate.com/github/nstrct/nstrct-ruby)
 
 **a multi-purpose binary protocol for instruction interchange**
 
@@ -13,7 +13,7 @@ The protcol **nstrct** is designed to be an alternative in those situations wher
 * [Obj-C (nstrct-objc)](http://github.com/nstrct/nstrct-objc)
 * [Java (nstrct-c)](http://github.com/nstrct/nstrct-java)
 
-_This software has been open sourced by [ElectricFeel Mobility Systems Gmbh](http://electricfeel.com) and is further maintained by [Joël Gähwiler](http://github.com/256dpi)._
+_This software has been open sourced by [ElectricFeel Mobility Systems GmbH](http://electricfeel.com) and is further maintained by [Joël Gähwiler](http://github.com/256dpi)._
 
 ## Instruction Composing
 

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/cross_platform_test

@@ -8,22 +8,22 @@ require 'nstrct'
 mode = nil
 
 MIN = {
-  int8: (2**7)*-1,
-  int16: (2**15)*-1,
-  int32: (2**31)*-1,
-  int64: (2**63)*-1
+  int8: (2 ** 7) * -1,
+  int16: (2 ** 15) * -1,
+  int32: (2 ** 31) * -1,
+  int64: (2 ** 63) * -1
 }
 
 MAX = {
-  uint8: (2**8)-1,
-  uint16: (2**16)-1,
-  uint32: (2**32)-1,
-  uint64: (2**64)-1,
-  float32: 3.4028234663852886*(10**38),
-  float64: 1.7976931348623157*(10**308)
+  uint8: (2 ** 8) - 1,
+  uint16: (2 ** 16) - 1,
+  uint32: (2 ** 32) - 1,
+  uint64: (2 ** 64) - 1,
+  float32: 3.4028234663852886 * (10 ** 38),
+  float64: 1.7976931348623157 * (10 ** 308)
 }
 
-def assert test, exp
+def assert(test, exp)
   unless exp
     puts test
     exit!

data/lib/nstrct/argument.rb

@@ -20,47 +20,47 @@ module Nstrct
     }
 
     # Get the datatype of a argument code
-    def self.datatype_by_for_argument_code code
-      DATATYPES.detect{ |k,v| v == code }[0]
+    def self.datatype_by_for_argument_code(code)
+      DATATYPES.detect { |k, v| v == code }[0]
     end
 
     # Parse a single value of a buffer
-    def self.parse_value datatype, data
+    def self.parse_value(datatype, data)
       case datatype
-        when :boolean
-          return data.slice!(0).unpack('C')[0] == 1
-        when :int8
-          return data.slice!(0).unpack('c')[0]
-        when :int16
-          return data.slice!(0..1).unpack('s>')[0]
-        when :int32
-          return data.slice!(0..3).unpack('l>')[0]
-        when :int64
-          return data.slice!(0..7).unpack('q>')[0]
-        when :uint8
-          return data.slice!(0).unpack('C')[0]
-        when :uint16
-          return data.slice!(0..1).unpack('S>')[0]
-        when :uint32
-          return data.slice!(0..3).unpack('L>')[0]
-        when :uint64
-          return data.slice!(0..7).unpack('Q>')[0]
-        when :float32
-          return data.slice!(0..3).unpack('g')[0]
-        when :float64
-          return data.slice!(0..7).unpack('G')[0]
-        when :string
-          length = data.slice!(0).unpack('C')[0]
-          return length > 0 ? data.slice!(0..length-1) : ''
-        when :array
-          raise 'cannot parse array value directly'
-        else
-          raise "datatype '#{datatype}' not recognized"
+      when :boolean
+        return data.slice!(0).unpack('C')[0] == 1
+      when :int8
+        return data.slice!(0).unpack('c')[0]
+      when :int16
+        return data.slice!(0..1).unpack('s>')[0]
+      when :int32
+        return data.slice!(0..3).unpack('l>')[0]
+      when :int64
+        return data.slice!(0..7).unpack('q>')[0]
+      when :uint8
+        return data.slice!(0).unpack('C')[0]
+      when :uint16
+        return data.slice!(0..1).unpack('S>')[0]
+      when :uint32
+        return data.slice!(0..3).unpack('L>')[0]
+      when :uint64
+        return data.slice!(0..7).unpack('Q>')[0]
+      when :float32
+        return data.slice!(0..3).unpack('g')[0]
+      when :float64
+        return data.slice!(0..7).unpack('G')[0]
+      when :string
+        length = data.slice!(0).unpack('C')[0]
+        return length > 0 ? data.slice!(0..length - 1) : ''
+      when :array
+        raise 'cannot parse array value directly'
+      else
+        raise "datatype '#{datatype}' not recognized"
       end
     end
 
     # Parse a single argument from a buffer
-    def self.parse data
+    def self.parse(data)
       datatype = self.datatype_by_for_argument_code(data.slice!(0).unpack('C')[0])
       if datatype == :array
         array_datatype = self.datatype_by_for_argument_code(data.slice!(0).unpack('C')[0])
@@ -78,42 +78,42 @@ module Nstrct
     attr_reader :datatype, :value, :array
 
     # Instantiate a new Argument providing its datatype, value and arrayness
-    def initialize datatype, value, array
-      @datatype, @value, @array = datatype, value, array
+    def initialize(datatype, value, array)
+      @datatype, @value, @array = datatype.to_sym, value, array
     end
 
     # Pack a single value in a buffer
-    def pack_value datatype, value, data
+    def pack_value(datatype, value, data)
       case datatype
-        when :boolean
-          data += [to_boolean(value) ? 1 : 0].pack('C')
-        when :int8
-          data += [value.to_i].pack('c')
-        when :int16
-          data += [value.to_i].pack('s>')
-        when :int32
-          data += [value.to_i].pack('l>')
-        when :int64
-          data += [value.to_i].pack('q>')
-        when :uint8
-          data += [value.to_i].pack('C')
-        when :uint16
-          data += [value.to_i].pack('S>')
-        when :uint32
-          data += [value.to_i].pack('L>')
-        when :uint64
-          data += [value.to_i].pack('Q>')
-        when :float32
-          data += [value.to_f].pack('g')
-        when :float64
-          data += [value.to_f].pack('G')
-        when :string
-          data += [value.to_s.size].pack('C')
-          data += value.to_s
-        when :array
-          raise 'cannot pack array value directly'
-        else
-          raise "datatype '#{datatype}' not recognized"
+      when :boolean
+        data += [to_boolean(value) ? 1 : 0].pack('C')
+      when :int8
+        data += [value.to_i].pack('c')
+      when :int16
+        data += [value.to_i].pack('s>')
+      when :int32
+        data += [value.to_i].pack('l>')
+      when :int64
+        data += [value.to_i].pack('q>')
+      when :uint8
+        data += [value.to_i].pack('C')
+      when :uint16
+        data += [value.to_i].pack('S>')
+      when :uint32
+        data += [value.to_i].pack('L>')
+      when :uint64
+        data += [value.to_i].pack('Q>')
+      when :float32
+        data += [value.to_f].pack('g')
+      when :float64
+        data += [value.to_f].pack('G')
+      when :string
+        data += [value.to_s.size].pack('C')
+        data += value.to_s
+      when :array
+        raise 'cannot pack array value directly'
+      else
+        raise "datatype '#{datatype}' not recognized"
       end
       data
     end

data/lib/nstrct/frame.rb

@@ -13,17 +13,17 @@ module Nstrct
     FRAME_START = 0x55
     FRAME_END = 0xAA
 
-    def self.crc32 buffer
+    def self.crc32(buffer)
       Digest::CRC32.checksum buffer
     end
 
-    def self.available? buffer
+    def self.available?(buffer)
       if buffer.size >= 1
         raise StartOfFrameInvalid unless buffer.slice(0).unpack('C')[0] == FRAME_START
         if buffer.size >= 3
           payload_length = buffer.slice(1..2).unpack('S>')[0]
-          if buffer.size >= (payload_length+FRAME_OVERHEAD)
-            raise EndOfFrameInvalid unless buffer.slice(payload_length+FRAME_OVERHEAD-1).unpack('C')[0] == FRAME_END
+          if buffer.size >= (payload_length + FRAME_OVERHEAD)
+            raise EndOfFrameInvalid unless buffer.slice(payload_length + FRAME_OVERHEAD - 1).unpack('C')[0] == FRAME_END
             return true
           end
         end
@@ -35,7 +35,7 @@ module Nstrct
       raise NoFrameAvailable unless self.available?(buffer)
       buffer.slice!(0) # remove start of frame
       length = buffer.slice!(0..1).unpack('S>')[0]
-      payload = buffer.slice!(0..length-1)
+      payload = buffer.slice!(0..length - 1)
       checksum = buffer.slice!(0..3).unpack('L>')[0]
       buffer.slice!(0) # remove end of frame
       raise ChecksumInvalid unless checksum == crc32(payload)

data/lib/nstrct/instruction.rb

@@ -5,7 +5,7 @@ module Nstrct
     attr_accessor :code, :arguments
 
     # Parse one message from the data stream.
-    def self.parse data
+    def self.parse(data)
       code = data.slice!(0..1).unpack('s>')[0]
       num_arguments = data.slice!(0).unpack('C')[0]
       data.slice!(0..1) # num_array_elements
@@ -20,31 +20,30 @@ module Nstrct
     #
     #   Message.build_instruction 54, [ :boolean, true], [[:int8], [7, 8, 9]] ]
     #
-    def self.build code, *args
-      arguments = []
-      args.each do |arg|
+    def self.build(code, *args)
+      arguments = args.map do |arg|
         if arg[0].is_a?(Array)
-          arguments << Nstrct::Argument.new(arg[0][0], arg[1], true)
+          Nstrct::Argument.new(arg[0][0], arg[1], true)
         else
-          arguments << Nstrct::Argument.new(arg[0], arg[1], false)
+          Nstrct::Argument.new(arg[0], arg[1], false)
         end
       end
       self.new(code, arguments)
     end
 
     # Instantiate a new instruction by its code and alist of arguments
-    def initialize code, arguments=[]
+    def initialize(code, arguments = [])
       @code, @arguments = code, arguments
     end
 
     # Get all the arguments values
     def argument_values
-      @arguments.map{ |arg| arg.value }
+      @arguments.map { |arg| arg.value }
     end
 
     # get all elements in arrays
     def array_elements
-      @arguments.inject(0){ |sum, a| sum + (a.array ? a.value.is_a?(Array) ? a.value.size : 0 : 0) }
+      @arguments.inject(0) { |sum, a| sum + (a.array ? a.value.is_a?(Array) ? a.value.size : 0 : 0) }
     end
 
     # Pack a single instruction in a buffer
@@ -52,10 +51,7 @@ module Nstrct
       message = [@code].pack('s>')
       message += [@arguments.size].pack('C')
       message += [array_elements].pack('s>')
-      @arguments.each do |arg|
-        message += arg.pack
-      end
-      message
+      @arguments.inject(message) { |msg, arg| msg + arg.pack }
     end
 
     # Return a comparable inspection

data/lib/nstrct/version.rb

@@ -1,3 +1,3 @@
 module Nstrct
-  VERSION = '0.1.3'
+  VERSION = '0.1.5'
 end

data/spec/protocol_spec.rb

@@ -3,13 +3,17 @@ require 'spec_helper'
 describe Nstrct::Argument do
 
   it 'should coerce string booleans' do
-    Nstrct::Argument.new(:boolean, 'true', false).pack.should == "\x01\x01"
-    Nstrct::Argument.new(:boolean, 'false', false).pack.should == "\x01\x00"
-    Nstrct::Argument.new(:boolean, true, false).pack.should == "\x01\x01"
-    Nstrct::Argument.new(:boolean, false, false).pack.should == "\x01\x00"
-    Nstrct::Argument.new(:boolean, 1, false).pack.should == "\x01\x01"
-    Nstrct::Argument.new(:boolean, 0, false).pack.should == "\x01\x00"
-    Nstrct::Argument.new(:boolean, 2, false).pack.should == "\x01\x01"
+    expect(Nstrct::Argument.new(:boolean, 'true', false).pack).to eq("\x01\x01")
+    expect(Nstrct::Argument.new(:boolean, 'false', false).pack).to eq("\x01\x00")
+    expect(Nstrct::Argument.new(:boolean, true, false).pack).to eq("\x01\x01")
+    expect(Nstrct::Argument.new(:boolean, false, false).pack).to eq("\x01\x00")
+    expect(Nstrct::Argument.new(:boolean, 1, false).pack).to eq("\x01\x01")
+    expect(Nstrct::Argument.new(:boolean, 0, false).pack).to eq("\x01\x00")
+    expect(Nstrct::Argument.new(:boolean, 2, false).pack).to eq("\x01\x01")
+  end
+
+  it 'should allow string datatypes' do
+    expect(Nstrct::Argument.new('boolean', 2, false).pack).to eq("\x01\x01")
   end
 
   it 'should treat wrong arrays' do
@@ -23,13 +27,13 @@ describe Nstrct::Instruction do
   it 'should pack and unpack an empty instruction' do
     instruction1 = Nstrct::Instruction.new(382, [])
     instruction2 = Nstrct::Instruction.parse(instruction1.pack)
-    instruction1.inspect.should == instruction2.inspect
+    expect(instruction1.inspect).to eq(instruction2.inspect)
   end
 
   it 'should pack and unpack an instructionw with arguments' do
     instruction1 = Nstrct::Instruction.build(232, [:float32, 1.0 ], [[:boolean], []], [:boolean, true], [:int8, 2], [:float32, 1.0], [[:uint16], [54, 23, 1973]])
     instruction2 = Nstrct::Instruction.parse(instruction1.pack)
-    instruction1.inspect.should == instruction2.inspect
+    expect(instruction1.inspect).to eq(instruction2.inspect)
   end
 
 end
@@ -39,7 +43,7 @@ describe Nstrct::Frame do
   it 'should pack and unpack a frame' do
     frame1 = Nstrct::Frame.new(Nstrct::Instruction.new(132, []))
     frame2 = Nstrct::Frame.parse(frame1.pack)
-    frame1.inspect.should == frame2.inspect
+    expect(frame1.inspect).to eq(frame2.inspect)
   end
 
   describe 'errors' do
@@ -47,24 +51,24 @@ describe Nstrct::Frame do
     let(:frame) { Nstrct::Frame.new(Nstrct::Instruction.new(132, [])) }
 
     it 'should raise start of frame invalid' do
-      expect{ Nstrct::Frame.parse('hello') }.to raise_error Nstrct::Frame::StartOfFrameInvalid
+      expect { Nstrct::Frame.parse('hello') }.to raise_error Nstrct::Frame::StartOfFrameInvalid
     end
 
     it 'should raise end of frame invalid' do
       data = frame.pack
       data[-1] = 'B'
-      expect{ Nstrct::Frame.parse(data) }.to raise_error Nstrct::Frame::EndOfFrameInvalid
+      expect { Nstrct::Frame.parse(data) }.to raise_error Nstrct::Frame::EndOfFrameInvalid
     end
 
     it 'should raise no frame available' do
       data = frame.pack.slice(-1..-4)
-      expect{ Nstrct::Frame.parse(data) }.to raise_error Nstrct::Frame::NoFrameAvailable
+      expect { Nstrct::Frame.parse(data) }.to raise_error Nstrct::Frame::NoFrameAvailable
     end
 
     it 'should raise checksum invalid' do
       data = frame.pack
       data[-2] = 'C'
-      expect{ Nstrct::Frame.parse(data) }.to raise_error Nstrct::Frame::ChecksumInvalid
+      expect { Nstrct::Frame.parse(data) }.to raise_error Nstrct::Frame::ChecksumInvalid
     end
 
   end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: nstrct
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Joël Gähwiler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-16 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: digest-crc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Interchange formats like json or xml are great to keep data visible,
@@ -35,11 +35,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- Rakefile
 - cross_platform_test
 - lib/nstrct.rb
 - lib/nstrct/argument.rb
@@ -59,17 +61,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: a multi-purpose binary protocol for instruction interchange