binary_parser 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0307ae683d47cfe6a2525daadd6e2243ef6c243
-  data.tar.gz: 701289dee15d26ccea833011bdd85cb280153965
+  metadata.gz: a266f80f4fbcd0daa0c318a5cfaa13d167eb96e4
+  data.tar.gz: b8f1fe4f896e61d159ae5d4cdb010e01a0b6dc53
 SHA512:
-  metadata.gz: 095aedb2598057330badc1037371333fb7ca6ef5edfb37ad26747984ba95297883883a32575e151d0f66238c48c5bb04d7834c8a2383a9368c59d06e17b1cb9e
-  data.tar.gz: 28e0a0fe38de2617a8e90c900389c26bfdbea4d3bfac2413bbef888e0d3475c468bf3a1a3c695089dea47bcef41ec6a4b6a9aedd90a45f25cc0d05a8a473b101
+  metadata.gz: fcecba5a4b014c53b276ce5422f894788429bb6124ae7acaf8a4e5043f5d253ecd26a919939afd8932ba67fde298340b8c15ad26f11fe89f8de57e7727143b9e
+  data.tar.gz: de24b1e689b71dfdc407341ebb842d56ee8b819cc1c08c1ca0166a1c645bc6aa4f8ac3f77740dca8dea65611017e92914f7baaa9937910acd2c3c25d7aff5c34

data/README.md

@@ -136,7 +136,7 @@ class MyImage < BinaryParser::TemplateBase
     data :has_date, Flag, 1
 
     # Condition statement
-    # * If you want check whether variable-name is valid, alternative expression
+    # * If you want to check whether variable-name is valid, alternative expression
     #     IF cond(:has_date){|v| v.on?} do ~ end
     #   is also available.
     IF E{ has_date.on? } do
@@ -150,10 +150,11 @@ And then you can parse and read binay-data of MyImage as follows.
 
 ```ruby
 File.open('my_image.bin', 'rb') do |f|
-  print "Image size: #{image.height}x#{image.width}\n"
+  image = MyImage.new(f.read)
+  puts "Image size: #{image.height}x#{image.width}"
   ul = image.i[0].j[0]
-  print "RGB color at the first is (#{ul.R}, #{ul.G}, #{ul.B})\n"
-  print "Image date: #{image.date.to_date}\n"
+  puts "RGB color at the first is (#{ul.R}, #{ul.G}, #{ul.B})"
+  puts "Image date: #{image.date.to_date}"
 end
 ```
 
@@ -207,7 +208,8 @@ end
 You can check this definition by giving some binary-data and calling show method as follows. 
 
 ```ruby
-i = DefExample.new([0x05, 0x01, 0xff, 0x02, 0xff, 0xff, 0x01, 0x01, 0x01, 0x01].pack("C*"))
+binary = [0x05, 0x01, 0xff, 0x02, 0xff, 0xff, 0x01, 0x01, 0x01, 0x01].pack("C*")
+i = DefExample.new(binary)
 i.show(true)
 ```
 
@@ -236,7 +238,7 @@ If you want to operate Stream-data, StreamTemplateBase class is useful. Define s
 
 ```ruby
 class StreamExample < BinaryParser::StreamTemplateBase
-  # Stream which consists of every 4 byte binary-data.
+  # Stream which consists of 4bytes-binary-datas.
   Def(4) do
     data :data1, UInt,   8
     data :data2, Binary, 24
@@ -273,5 +275,5 @@ Access shown address by web browser.
 
 Versions
 --------
-1.0.0 April    6, 2014
+1.0.0 April    6, 2014  
 1.2.0 November 7, 2014

data/examples/example1.rb

@@ -31,7 +31,7 @@ class MyImage < BinaryParser::TemplateBase
     data :has_date, Flag, 1
 
     # Condition statement
-    # * If you want check whether variable-name is valid, alternative expression
+    # * If you want to check whether variable-name is valid, alternative expression
     #     IF cond(:has_date){|v| v.on?} do ~ end
     #   is also available.
     IF E{ has_date.on? } do

data/examples/example4.rb

@@ -0,0 +1,10 @@
+require File.dirname(File.expand_path(File.dirname(__FILE__))) + "/lib/binary_parser.rb"
+
+class UseUInt8 < BinaryParser::TemplateBase
+  Def do
+    SPEND 24, :spends, UInt8
+  end
+end
+
+bin = [0x01, 0x02, 0x03].pack("C*")
+UseUInt8.new(bin).show(true)

data/lib/binary_parser/built_in_template/bcd.rb

@@ -0,0 +1,52 @@
+module BinaryParser
+  module BuiltInTemplate
+    def self.bcd_make(floating_point)
+      klass = Class.new(TemplateBase) do
+        Def do
+          SPEND rest, :decimals, UInt4
+        end
+
+        def self.floating_point
+          @floating_point
+        end
+
+        def floating_point
+          self.class.floating_point
+        end
+
+        def to_i
+          decimals.inject(0){|acc, n| acc * 10 + n.to_i}
+        end
+
+        def to_s
+          return to_i.to_s if floating_point == 0
+          to_i.to_s.insert(-(floating_point + 1), ".")
+        end
+
+        def to_f
+          to_s.to_f
+        end
+
+        def content_description
+          to_s
+        end
+      end
+      
+      klass.instance_variable_set(:@floating_point, floating_point)
+      return klass
+    end
+
+
+    BCD = bcd_make(0)
+    BCD_f1 = bcd_make(1)
+    BCD_f2 = bcd_make(2)
+    BCD_f3 = bcd_make(3)
+    BCD_f4 = bcd_make(4)
+    BCD_f5 = bcd_make(5)
+    BCD_f6 = bcd_make(6)
+    BCD_f7 = bcd_make(7)
+    BCD_f8 = bcd_make(8)
+    BCD_f9 = bcd_make(9)
+    BCD_f10 = bcd_make(10)
+  end
+end

data/lib/{built_in_template → binary_parser/built_in_template}/uint.rb

@@ -5,7 +5,7 @@ module BinaryParser
       include Comparable
 
       def content_description
-        self.to_i.to_s
+        "#{self.to_i.to_s} (0x#{self.to_i.to_s(16)})"
       end
 
       def to_s(base=10)

data/lib/{built_in_template → binary_parser/built_in_template}/uint_n.rb

@@ -4,6 +4,16 @@ module BinaryParser
       def to_i
         entity.to_i
       end
+
+      def names
+        []
+      end
+    end
+
+    class UInt4 < UIntN
+      Def do
+        data :entity, UInt, 4
+      end
     end
     
     class UInt8 < UIntN

data/lib/{loop_list.rb → binary_parser/loop_list.rb}

@@ -44,7 +44,11 @@ module BinaryParser
     #   out         => Print target. Default is STDOUT.
     def show(recursively=false, out=STDOUT, depth=0)
       @list.each_with_index do |element, i|
-        out.puts sprintf(" " * (depth * 2) + "%-5s", "[#{i}]")
+        out.puts sprintf(" " * (depth * 2) + "%-5s::%20s  Len: %s Cont: %s",
+                         "[#{i}]",
+                         element.class.name ? element.class.name.split("::").last : "AnonymouseTemplate",
+                         element.structure_bit_length,
+                         element.content_description)
         element.show(true, out, depth + 1) if recursively
       end
     end

data/lib/binary_parser/version.rb

@@ -1,3 +1,3 @@
 module BinaryParser
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/lib/binary_parser.rb

@@ -5,7 +5,7 @@ module BinaryParser
   LIBRARY_ROOT_PATH = File.dirname(File.expand_path(File.dirname(__FILE__)))
 
   # load general class file
-  GENERAL_CLASS_DIR = '/lib/general_class/'
+  GENERAL_CLASS_DIR = '/lib/binary_parser/general_class/'
   GENERAL_CLASS_FILES =
     ['binary_manipulate_function.rb',
      'abstract_binary',
@@ -25,11 +25,12 @@ module BinaryParser
 
   # load built-in template file
   class TemplateBase; end
-  BUILT_IN_TEMPLATE_DIR = '/lib/built_in_template/'
+  BUILT_IN_TEMPLATE_DIR = '/lib/binary_parser/built_in_template/'
   BUILT_IN_TEMPLATE_FILES =
     ['uint.rb',
      'flag.rb',
-     'binary.rb'
+     'binary.rb',
+
     ]
 
   BUILT_IN_TEMPLATE_FILES.each do |path|
@@ -38,7 +39,7 @@ module BinaryParser
   
 
   # load library main file
-  LIB_DIR = '/lib/'
+  LIB_DIR = '/lib/binary_parser/'
   LIB_FILES =
     ['loop_list.rb',
      'while_list.rb',
@@ -59,6 +60,7 @@ module BinaryParser
   SUB_BUILT_IN_TEMPLATE_FILES =
     [
      'uint_n.rb',
+     'bcd.rb',
     ]
 
   SUB_BUILT_IN_TEMPLATE_FILES.each do |path|

data/unit_test/built_in_template/test_bcd.rb

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+$LIBRARY_ROOT_PATH = File.dirname(File.dirname(File.expand_path(File.dirname(__FILE__))))
+
+module BinaryParser
+  module UnitTest
+    require 'test/unit'
+
+    # load testing target
+    require $LIBRARY_ROOT_PATH + '/lib/binary_parser.rb'
+    
+    class BCDTemplateTest < Test::Unit::TestCase
+      
+      class TestingTemplate < TemplateBase
+        def_structure do
+          data :n1, BCD, 16
+          data :n2, BCD_f1, 16
+          data :n3, BCD_f5, 32
+        end
+      end
+
+      def test_to_i
+        t = gen(0x20, 0x14, 0x11, 0x26, 0x01, 0x23, 0x45, 0x67)
+        
+        assert_equal(2014,    t.n1.to_i)
+        assert_equal(1126,    t.n2.to_i)
+        assert_equal(1234567, t.n3.to_i)
+      end
+
+      def test_to_s
+        t = gen(0x20, 0x14, 0x11, 0x26, 0x01, 0x23, 0x45, 0x67)
+
+        assert_equal("2014",     t.n1.to_s)
+        assert_equal("112.6",    t.n2.to_s)
+        assert_equal("12.34567", t.n3.to_s)
+      end
+
+      # helper for generating binary
+      def gen(*chars)
+        return TestingTemplate.new(chars.pack("C*"))
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binary_parser
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - sawaken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,29 +59,32 @@ files:
 - binary_parser.gemspec
 - examples/example1.rb
 - examples/example2.rb
+- examples/example4.rb
 - lib/binary_parser.rb
+- lib/binary_parser/built_in_template/bcd.rb
+- lib/binary_parser/built_in_template/binary.rb
+- lib/binary_parser/built_in_template/flag.rb
+- lib/binary_parser/built_in_template/uint.rb
+- lib/binary_parser/built_in_template/uint_n.rb
+- lib/binary_parser/error.rb
+- lib/binary_parser/general_class/abstract_binary.rb
+- lib/binary_parser/general_class/binary_manipulate_function.rb
+- lib/binary_parser/general_class/bit_position.rb
+- lib/binary_parser/general_class/buffered_stream.rb
+- lib/binary_parser/general_class/condition.rb
+- lib/binary_parser/general_class/expression.rb
+- lib/binary_parser/general_class/free_condition.rb
+- lib/binary_parser/general_class/memorize.rb
+- lib/binary_parser/general_class/proxy.rb
+- lib/binary_parser/loop_list.rb
+- lib/binary_parser/nameless_template_maker.rb
+- lib/binary_parser/scope.rb
+- lib/binary_parser/stream_template_base.rb
+- lib/binary_parser/structure_definition.rb
+- lib/binary_parser/template_base.rb
 - lib/binary_parser/version.rb
-- lib/built_in_template/binary.rb
-- lib/built_in_template/flag.rb
-- lib/built_in_template/uint.rb
-- lib/built_in_template/uint_n.rb
-- lib/error.rb
-- lib/general_class/abstract_binary.rb
-- lib/general_class/binary_manipulate_function.rb
-- lib/general_class/bit_position.rb
-- lib/general_class/buffered_stream.rb
-- lib/general_class/condition.rb
-- lib/general_class/expression.rb
-- lib/general_class/free_condition.rb
-- lib/general_class/memorize.rb
-- lib/general_class/proxy.rb
-- lib/loop_list.rb
-- lib/nameless_template_maker.rb
-- lib/scope.rb
-- lib/stream_template_base.rb
-- lib/structure_definition.rb
-- lib/template_base.rb
-- lib/while_list.rb
+- lib/binary_parser/while_list.rb
+- unit_test/built_in_template/test_bcd.rb
 - unit_test/built_in_template/test_binary.rb
 - unit_test/built_in_template/test_uint.rb
 - unit_test/general_class/test_abstract_binary.rb