cborb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a99e458cdc0e473306db192ae994eee3486b4a7368c4e61578e83b6050766786
-  data.tar.gz: 2524de034a4263811f61cb1bd9cfbbdd46c690da7e631d30e5b22f2ebd2f994c
+  metadata.gz: a9c9b7dc8ac55b507646d2a26a8b797854d62dbca6a0ebb281617ac7be3abe9c
+  data.tar.gz: a09f26e86e196f1b7e8151f52b22a74decbe8406c126d4fcd6bbd73b45b3ca2a
 SHA512:
-  metadata.gz: 28aa0c323e37738493b08fd8d662293de6264d6c553e44e07d62091f0a1084755b4d8f86d2343414694fc78ae83fa37821c480bee8646952bc218fed1f6d8b24
-  data.tar.gz: bcd65e60a0eb7d3673455d51b513832849801fbc7ffe55a4009d9fe954dc46b8f6ad9a27560d671544449400e9cfe57e8ffab8a9dd47bc93f62e379a65743d35
+  metadata.gz: ffbad4c40f8e10c3b769e4e832125b364e85e4ffac6d827a9337129e61b88f65d81ca12839028c5d19cc6e42ad0172b491c912d2aa5aefdfab0ea24b8b84c919
+  data.tar.gz: c59156aa20df82792c3d67f3080e032193f668542fb4571687b62181012b20f240ae9099a6555a7bdac792b4287fbea149c9575764101f3e96b9173e9d0b5f15

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cborb (0.1.0)
+    cborb (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,6 @@
 # Cborb
 
+[![Gem Version](https://badge.fury.io/rb/cborb.svg)](https://badge.fury.io/rb/cborb)
 [![CircleCI](https://circleci.com/gh/murakmii/cborb/tree/master.svg?style=svg)](https://circleci.com/gh/murakmii/cborb/tree/master)
 
 Cborb is a pure ruby decoder for CBOR([RFC 7049](https://tools.ietf.org/html/rfc7049))
@@ -12,10 +13,11 @@ decoder = Cborb::Decoding::Decoder.new
 decoder.decode("\x83\x01")
 decoder.finished? # => false
 
-decoder.decode("\x02\x03")
+decoder.decode("\x02\x03\x04")
 decoder.finished? # => true
 
 decoder.result # => [1, 2, 3]
+decoder.remaining_bytes # => "\x04"
 
 # Shorthand
 Cborb.decode("\x83\x01\x02\x03") # => [1, 2, 3]
@@ -61,3 +63,41 @@ That contains simple value number.
 Cborb.decode "\xEF"
 # => #<struct Cborb::Decoding::UnassignedSimpleValue number=15>
 ```
+
+## Handling concatenated CBOR
+
+By default, when decoder received concatenated CBOR, that raises error.
+
+```rb
+Cborb.decode("\x83\x01\x02\x03\x04") # => Cborb::InvalidByteSequenceError
+```
+
+If you want to decode concatenated CBOR, set `concatenated` option to `true`.  
+Decoder decodes whole of concatenated CBOR and returns instance of `Cborb::Decoding::Concatenated`.
+
+```rb
+results = Cborb.decode("\x83\x01\x02\x03\x04", concatenated: true)
+# => #<Cborb::Decoding::Concatenated:0x00007fcb1b8b2e30 @decoded=[[1, 2, 3], 4]>
+
+results.first # => [1, 2, 3]
+results.last  # => 4
+```
+
+## Development
+
+```bash
+# Clone
+git clone git@github.com:murakmii/cborb && cd cborb
+
+# Setup
+bin/setup
+
+# Edit code...
+
+# Run test
+bundle exec rspec
+```
+
+## Contribution
+
+Contributions are always welcome :kissing_heart:

data/bin/generate_fixtures

@@ -260,3 +260,23 @@ end
 generate "010" do |out|
   out << "\xF6"
 end
+
+# lack data(value of map)
+generate "011" do |out|
+  out << "\xA2"
+
+  out << generate_definite_string("abc", 0)
+  out << "\x18\x7B"
+
+  out << generate_definite_string("def", 0)
+end
+
+# big array
+generate "012" do |out|
+  out << "\x9B\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF"
+end
+
+# big map
+generate "013" do |out|
+  out << "\xBB\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF"
+end

data/lib/cborb/decoding/concatenated.rb

@@ -0,0 +1,12 @@
+module Cborb::Decoding
+  class Concatenated
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :@decoded, :each, :size, :length, :<<, :last
+
+    def initialize
+      @decoded = []
+    end
+  end
+end

data/lib/cborb/decoding/decoder.rb

@@ -2,7 +2,7 @@ module Cborb::Decoding
   class Decoder
     extend Forwardable
 
-    def_delegators :@state, :result, :finished?
+    def_delegators :@state, :result, :finished?, :remaining_bytes
 
     def initialize
       @state = Cborb::Decoding::State.new

data/lib/cborb/decoding/simple_buffer.rb

@@ -20,5 +20,10 @@ module Cborb::Decoding
       @buffer.rewind
       @buffer.truncate(0)
     end
+
+    def peek
+      pos = @buffer.pos
+      @buffer.read.to_s.tap { @buffer.pos = pos }
+    end
   end
 end

data/lib/cborb/decoding/state.rb

@@ -95,7 +95,6 @@ module Cborb::Decoding
         else
           @stack.pop
           if @stack.empty?
-            raise Cborb::InvalidByteSequenceError unless @buffer.eof?
             @result = value
             break
           end
@@ -118,6 +117,15 @@ module Cborb::Decoding
       finished? ? @result : nil
     end
 
+    # @return [String]
+    def remaining_bytes
+      if finished?
+        @buffer.peek
+      else
+        ""
+      end
+    end
+
     private
 
     def loop_consuming

data/lib/cborb/version.rb

@@ -1,3 +1,3 @@
 module Cborb
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/cborb.rb

@@ -25,6 +25,7 @@ require "cborb/decoding/types/half_precision_floating_point"
 require "cborb/decoding/types/floating_point"
 require "cborb/decoding/types/break"
 
+require "cborb/decoding/concatenated"
 require "cborb/decoding/ib_jump_table"
 require "cborb/decoding/tagged_value"
 require "cborb/decoding/unassigned_simple_value"
@@ -36,16 +37,29 @@ module Cborb
   # The shorthand to decode CBOR
   #
   # @param [String] cbor
+  # @param [Boolean] concatenated Whether "cbor" param is constructed by concatenated CBOR byte string.
+  #                               If it's true, this method returns instance of Cborb::Decoding::Concatenated
   # @return [Object] decoded data(Array, Hash, etc...)
-  def decode(cbor)
-    decoder = Decoding::Decoder.new
-    decoder.decode(cbor)
-
-    if decoder.finished?
-      decoder.result
-    else
-      raise Cborb::InvalidByteSequenceError
+  def decode(cbor, concatenated: false)
+    results = Decoding::Concatenated.new
+    loop do
+      decoder = Decoding::Decoder.new
+      decoder.decode(cbor)
+
+      raise Cborb::InvalidByteSequenceError unless decoder.finished?
+
+      results << decoder.result
+
+      if decoder.remaining_bytes.empty?
+        break
+      elsif !concatenated
+        raise Cborb::InvalidByteSequenceError
+      end
+
+      cbor = decoder.remaining_bytes
     end
+
+    concatenated ? results : results.first
   end
 
   module_function :decode

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cborb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - murakmii
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-23 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,7 @@ files:
 - bin/setup
 - cborb.gemspec
 - lib/cborb.rb
+- lib/cborb/decoding/concatenated.rb
 - lib/cborb/decoding/decoder.rb
 - lib/cborb/decoding/ib_jump_table.rb
 - lib/cborb/decoding/simple_buffer.rb