binary_parser 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d5b2692b4a9c6b2bb5be201074f80779039f881
-  data.tar.gz: 0e6c1da7ab3aa2ca1f8e79150c34262ec08a4772
+  metadata.gz: 329750cafce1313147ce33ce73a6ead4622c7463
+  data.tar.gz: 810050523f1e4f013877ce96cca963424501b048
 SHA512:
-  metadata.gz: 1c59d35586e0f044ebdef155ef191169a4cf3dd65ba2743d9c19974759aefd55e27d93bb1121443a81c350617b7b75ca17cc9b6d9e05de522f4e9e300f650e7b
-  data.tar.gz: def0d9f155a7af845d78ce08b87555acca72c11e1f63ae41b716c0fcbc94536e8d66148d1946d2be9e174ec648b0948ebe67df2216be9199d0c9d2a727aa9259
+  metadata.gz: a1dd40df83f438b9ca90c6bc15ad056868d1f62d5523e0209a3b71d4122a9b661748bdba897f24a75c72edaf8b94e6894b983b56ff7117c213bfa928e8d9b55b
+  data.tar.gz: 4f20fb77279fc8caac2d3512647dfefd17f597cc8a7e7b03886a982476fe24c6d4c23b85b0ca78a589f47a89161d1c6a5190d30c6c8c36876ad425f77f435a57

data/README.md

@@ -218,7 +218,7 @@ And then, get structures from the stream as follows.
       stream.get_next.show(true)
     end
 
-StreamTemplateBase has many useful method to choose structures from the stream.
+StreamTemplateBase has many useful methods to choose structures from the stream.
 If you want to know detail of these methods, please read documentation or concerned source-files.
 
 

data/binary_parser.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["rokugats(u)"]
   spec.email         = ["sasasawada@gmail.com"]
   spec.summary       = "An elegant DSL library for parsing binary-data."
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/rokugats/ruby-binary-parser"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0.0'
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 

data/lib/binary_parser/version.rb

@@ -1,3 +1,3 @@
 module BinaryParser
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/scope.rb

@@ -23,6 +23,7 @@ module BinaryParser
       raise UndefinedError, "Undefined data-name '#{name}'." unless @definition[name]
     end
 
+    # * Unsatisfactory memorized method (little obfuscated? : need refactoring?)
     def load_var(name)
       return @parent_scope.load_var(name) if !@definition[name] && @parent_scope
       check_name_defined(name)
@@ -49,6 +50,7 @@ module BinaryParser
       end
     end
 
+    # * memorized method (little obfuscated? : need refactoring?)
     def eval_bit_position(name)
       check_name_defined(name)
       return @ebs[name] ||= @definition[name].bit_position.eval do |name|
@@ -56,6 +58,7 @@ module BinaryParser
       end
     end
 
+    # * memorized method (little obfuscated? : need refactoring?)
     def eval_bit_length(name)
       check_name_defined(name)
       return @ebl[name] if @ebl[name]
@@ -63,10 +66,8 @@ module BinaryParser
         cond.eval{|name| load_var(name)}
       end
       return @ebl[name] ||= @definition[name].bit_length.eval do |var_name|
-        if var_name == :__rest
-          length = @abstract_binary.bit_length - eval_bit_position(name)
-          raise ParsingError, "Binary is too short. (So, 'rest' is failed.)" if length < 0
-          length
+        if var_name[0..1] == "__"
+          bit_length_control_variable_resolution(name, var_name)
         else
           val = load_var(var_name)
           unless val
@@ -77,6 +78,20 @@ module BinaryParser
         end
       end
     end
+
+    def bit_length_control_variable_resolution(name, var_name)
+      if var_name == :__rest
+        length = @abstract_binary.bit_length - eval_bit_position(name)
+        raise ParsingError, "Binary is too short. (So, 'rest' is failed.)" if length < 0
+        return length
+      elsif var_name == :__position
+        return eval_bit_position(name)
+      elsif var_name[0..6] == "__LEN__"
+        return eval_bit_length(var_name[7..(var_name.length - 1)].to_sym)
+      else
+        raise ProgramAssertionError, "Unknown Control-Variable '#{var_name}'."
+      end
+    end
     
     def eval_entire_bit_length
       return @definition.bit_at.eval do |name|

data/lib/structure_definition.rb

@@ -92,11 +92,26 @@ module BinaryParser
     end
 
     def var(name)
-      return @var[name] ||= Expression.new([name])
+      unless name_solvable?(name)
+        raise DefinitionError, "Unsolvable variable #{name} is used."
+      end
+      return Expression.new([name])
+    end
+
+    def len(name)
+      unless name_solvable?(name)
+        raise DefinitionError, "Unsolvable variable #{name} is used."
+      end
+      symbol = ("__LEN__" + name.to_s).to_sym
+      return Expression.new([symbol])
+    end
+
+    def position
+      return Expression.new([:__position])
     end
 
     def rest
-      return var(:__rest)
+      return Expression.new([:__rest])
     end
 
     def [](name)

data/unit_test/test_scope.rb

@@ -181,6 +181,38 @@ module BinaryParser
         end
       end
 
+      # TEST CASE STRUCTURE 6
+      # * len test
+      class ST6 < TemplateBase
+        Def do
+          data :id,           UInt,   8
+          data :whole_length, UInt,   8
+          data :rest_binary,  Binary, var(:whole_length) - len(:id) - len(:whole_length)
+        end
+      end
+
+      def test_ST6_CASE1
+        i = ST6.new(gen_bin(0, 32, 0x41, 0x42, 0x43))
+        assert_equal(16, i.rest_binary.binary_bit_length)
+        assert_equal("AB", i.rest_binary.to_s)
+      end
+
+      # TEST CASE STRUCTURE 7
+      # * position
+      class ST7 < TemplateBase
+        Def do
+          data :id,           UInt,   8
+          data :whole_length, UInt,   8
+          data :rest_binary,  Binary, var(:whole_length) - position
+        end
+      end
+
+      def test_ST7_CASE1
+        i = ST7.new(gen_bin(0, 32, 0x41, 0x42, 0x43))
+        assert_equal(16, i.rest_binary.binary_bit_length)
+        assert_equal("AB", i.rest_binary.to_s)
+      end
+
       # helpers
       def gen_bin(*chars)
         return AbstractBinary.new(chars.pack("C*"))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binary_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - rokugats(u)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-06 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,7 @@ files:
 - unit_test/test_stream_template_base.rb
 - unit_test/test_structure_definition.rb
 - unit_test/test_template_base.rb
-homepage: ''
+homepage: https://github.com/rokugats/ruby-binary-parser
 licenses:
 - MIT
 metadata: {}
@@ -93,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='