bit-packer 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+  gem "lookup-hash", ">= 0.2.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "riot", ">= 0.12.1"
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    hash-utils (0.11.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    lookup-hash (0.2.0)
+      hash-utils (>= 0.11.0)
+    rake (0.8.7)
+    riot (0.12.1)
+      rr
+      term-ansicolor
+    rr (1.0.2)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  lookup-hash (>= 0.2.0)
+  riot (>= 0.12.1)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Kozák
+
+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

@@ -0,0 +1,42 @@
+BitPacker
+=========
+
+**bit-packer** provides easy declarative way of analyzing the packed bit 
+arrays. See an example:
+        
+        require "bit-packer"
+        
+        bp = BitPacker::new(7) do
+            number (:alfa) {2}      # length of the entry in bits in block
+            boolean :beta
+        end
+        
+        p bp.data
+        # will print out #<struct alfa=3, beta=true>
+        
+You can both read from data struct and write to it:
+
+        bp.data.boolean = false
+        bp.data.number = 2
+        
+        p bp.to_i
+        # will print out 4
+
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][2] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+Copyright
+---------
+
+Copyright &copy; 2011 [Martin Kozák][3]. See `LICENSE.txt` for
+further details.
+
+[2]: http://github.com/martinkozak/bit-packer/issues
+[3]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "bit-packer"
+  gem.homepage = "http://github.com/martinkozak/bit-packer"
+  gem.license = "MIT"
+  gem.summary = 'Provides easy declarative way of analyzing the packed bit arrays.'
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hash-utils #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bit-packer.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bit-packer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Kozák"]
+  s.date = %q{2011-03-02}
+  s.email = %q{martinkozak@martinkozak.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bit-packer.gemspec",
+    "lib/bit-packer.rb",
+    "test"
+  ]
+  s.homepage = %q{http://github.com/martinkozak/bit-packer}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.3}
+  s.summary = %q{Provides easy declarative way of analyzing the packed bit arrays.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<lookup-hash>, [">= 0.2.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<riot>, [">= 0.12.1"])
+    else
+      s.add_dependency(%q<lookup-hash>, [">= 0.2.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<riot>, [">= 0.12.1"])
+    end
+  else
+    s.add_dependency(%q<lookup-hash>, [">= 0.2.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<riot>, [">= 0.12.1"])
+  end
+end
+

data/lib/bit-packer.rb

@@ -0,0 +1,242 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "lookup-hash/frozen"
+
+class BitPacker
+    
+    ##
+    # Holds types index.
+    #
+    
+    TYPES = Frozen::LookupHash[
+        :number,
+        :boolean
+    ]
+
+    ##
+    # Indicates size of one byte.
+    #
+    
+    BYTESIZE = 8
+    
+    ##
+    # Holds resultant data structure.
+    #
+    
+    @struct
+    
+    ##
+    # Holds type stack.
+    #
+    
+    @stack
+    
+    ##
+    # Holds data.
+    #
+    
+    @data
+    
+    ##
+    # Holds raw data.
+    # @return [Integer] raw (original) integer data
+    #
+    
+    attr_reader :raw
+    @raw
+    
+    ##
+    # Holds total length.
+    #
+    # @return [Integer] total length of the packed data according 
+    #   to declaration
+    #
+    
+    attr_reader :length
+    @length
+    
+    ##
+    # Constructor.
+    #
+    # @param [Integer] data raw integer for unpack
+    # @param [Proc] block block with declaration
+    # @see #declare
+    #
+    
+    def initialize(data = nil, &block)
+        @stack = [ ]
+        @length = 0
+        self.declare(&block)
+        
+        if not data.nil?
+            self << data
+        end
+    end
+    
+    ##
+    # Receives declaration.
+    # 
+    # Adds declaration of bit array items. Can be call multiple times.
+    # New delcarations are joind to end of the array.
+    #
+    # @example
+    #   packer.declare do
+    #       number (:number) {2}
+    #       boolean :boolean
+    #   end
+    #
+    # @param [Proc] block block with declaration
+    # @see TYPES
+    #
+    
+    def declare(&block)
+        self.instance_eval(&block)
+    end
+    
+    ##
+    # Handles missing methods as declarations.
+    #
+    # @param [Symbol] name data type of the entry
+    # @param [Array] args first argument is expected to be name
+    # @param [Proc] block block which returns length of the entry in bits
+    # @return [Integer] new length of the packed data
+    # @see #declare
+    #
+
+    def method_missing(name, *args, &block)
+        if not self.class::TYPES.include? name
+            raise Exception::new("Invalid type/method specified: '" << name.to_s << "'.")
+        end
+    
+        if not block.nil?
+            length = block.call()
+        else
+            length = 1
+        end
+        
+        self.add(args.first, name, length)
+    end
+    
+    ##
+    # Adds declaration.
+    # 
+    # @param [Symbol] name name of the entry
+    # @param [Symbol] type type of the entry
+    # @param [Integer] length length of the entry in bits
+    # @return [Integer] new length of the packed data
+    #
+    
+    def add(name, type, length = 1)
+        @stack << [name, type, @length, length]
+        @struct = nil
+        @length += length
+    end
+    
+    ##
+    # Fills by input data.
+    # @param [Integer] value raw integer data for unpack
+    #
+    
+    def <<(value)
+        if not value.kind_of? Integer
+            raise Exception::new("Integer is expected for BitPacker.")
+        end
+        
+        @raw = value
+        @data = nil
+    end
+    
+    ##
+    # Returns structure analyze.
+    # @return [Class] struct with the packed data
+    #
+    
+    def data
+        if @data.nil?
+            values = [ ]
+            
+            @stack.each do |name, type, position, length|
+                rel_pos = @length - position - length
+                value = @raw & __mask(rel_pos, length)
+                
+                case type
+                    when :boolean
+                        values << (value > 0)
+                    when :number
+                        values << (value >> rel_pos)
+                end
+            end
+            
+            @data = __struct::new(*values)
+        end
+        
+        return @data
+    end
+    
+    ##
+    # Converts to integer.
+    # @return [Integer] resultant integer according to current data state
+    #
+    
+    def to_i
+        result = 0
+        @stack.each do |name, type, position, length|
+            rel_pos = @length - position - length
+            value = self.data[name]
+            
+            case type
+                when :boolean
+                    mask = __mask(rel_pos, length)
+                    if value === true
+                        result |= mask
+                    else
+                        result &= ~mask
+                    end
+                when :number
+                    value &= __mask(0, length)
+                    value = value << rel_pos
+                    result |= value
+            end
+        end
+        
+        return result
+    end
+    
+    alias :to_int :to_i
+
+    
+    protected 
+    
+    ##
+    # Generates mask.
+    #
+    
+    def __mask(position, length = 1)
+    
+        # length of mask
+        mask = 0
+        length.times do |i|
+            mask += 2 ** i
+        end
+        
+        # position of mask
+        mask = mask << position
+
+        return mask
+    end
+    
+    ##
+    # Returns data struct.
+    #
+    
+    def __struct
+        if @struct.nil?
+            members = @stack.map { |i| i[0] }
+            @struct = Struct::new(*members)
+        end
+        
+        return @struct
+    end
+    
+end

data/test

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+$:.push("./lib")
+require "bit-packer"
+require "riot"
+
+context "BitPacker" do
+    setup do 
+        BitPacker::new(7) do
+            number (:number) {2}
+            boolean :boolean
+        end
+    end
+    
+    asserts("correct unpacking") do
+        (topic.data.boolean == true) and (topic.data.number == 3)
+    end
+    asserts("correct packing") do
+        topic.data.boolean = false
+        topic.data.number = 2
+        topic.to_i == 4
+    end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: bit-packer
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Martin Koz\xC3\xA1k"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-02 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: lookup-hash
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: riot
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.1
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: 
+email: martinkozak@martinkozak.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bit-packer.gemspec
+- lib/bit-packer.rb
+- test
+has_rdoc: true
+homepage: http://github.com/martinkozak/bit-packer
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1036686220775041030
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Provides easy declarative way of analyzing the packed bit arrays.
+test_files: []
+