jsanders-bitfields 0.2.4

data/Rakefile

@@ -0,0 +1,38 @@
+begin
+  require 'rubygems'
+rescue Exception
+  puts 'RubyGems is not installed. See http://www.rubygems.org/read/chapter/3 for instructions.'
+end
+
+begin
+  require 'spec/rake/spectask'
+
+  Spec::Rake::SpecTask.new do |t|
+    t.spec_opts = ['-c']
+    t.libs << 'lib'
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true 
+  end
+rescue Exception 
+  puts 'RSpec not available. Install it with: sudo gem install rspec'
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "bitfields"
+    s.summary = "Simple named bit fields"
+    s.description = "A very simple library for building binary data by declaring named bit fields"
+    s.email = 'sanderjd@gmail.com'
+    s.homepage = 'http://github.com/jsanders/bitfields'
+    s.authors = ['James Sanders']
+    s.has_rdoc = true
+    s.files = ["README",
+               "Rakefile",
+               "demo.rb",
+               "lib/bitfields.rb", 
+               "lib/bits.rb"]
+  end
+rescue LoadError
+  puts 'Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com'
+end

data/demo.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/lib/bitfields'
+
+# Make a template
+BitFields.template :demo do |m|
+  m.bits :beginning, :length => 10, :value => 0b1010101010
+  m.bits :middle, :length => 5
+  m.bits :end, :length => 10, :value => 1
+end
+
+# Create an object with that template
+message = BitFields.create(:demo)
+
+# 1010101010000000000000001
+puts message.bit_string
+
+# Create an object with that template and give it parameters
+message = BitFields.create(:demo, :middle => 0b11111)
+
+# 1010101010111110000000001
+puts message.bit_string
+# 1557c01
+puts message.hex_string
+# 125276001
+puts message.oct_string
+# 22379521
+puts message.integer
+
+# Compose another message using this object as one of its fields
+new_message = BitFields.compose do |m|
+  m.bits :before, :length => 1, :value => 1
+  m.add :demo__message, message
+  m.bits :after, :length => 1, :value => 0
+end
+
+# 110101010101111100000000010
+puts new_message.bit_string
+
+# Compose another message without creating the original message
+newer_message = BitFields.compose do |m|
+  m.bits :before, :length => 1, :value => 1
+  m.bring :demo, :middle => 0
+  m.bits :after, :length => 1, :value => 0
+end
+
+# 110101010100000000000000010
+puts newer_message.bit_string

data/lib/bitfields.rb

@@ -0,0 +1,127 @@
+require File.dirname(__FILE__) + '/bits'
+
+class BitFields
+  
+  # Class methods
+  
+  def self.template(template_name, &block)
+    template_name = symbol_if_string(template_name)
+    templates[template_name] = block
+    nil
+  end
+ 
+  def self.create(template_name, params = {})
+    template_name = symbol_if_string(template_name)
+    if templates[template_name]
+      instance = self.new
+      templates[template_name].call(instance)
+      params.each_pair { | field_name, value | instance[field_name] = value }
+      instance
+    else
+      warn "BitFields: No template named #{template_name}"
+      nil
+    end
+  end
+
+  def self.decode(template_name, value)
+    template_name = symbol_if_string(template_name)
+    if templates[template_name]
+      instance = self.new
+      templates[template_name].call(instance)
+      bit_string = Bits.new(value, instance.total_length).bit_string
+      current_index = 0
+      instance.field_names.each_with_index do |field_name, index|
+        length = instance.field_lengths[index]
+        instance[field_name] = bit_string[current_index, length].to_i(2)
+        current_index += length
+      end
+      instance
+    else
+      warn "BitFields: No template named #{template_name}"
+      nil
+    end
+  end
+
+  def self.compose(&block)
+    composition = self.new
+    yield composition
+    composition
+  end
+
+  # Object methods
+  
+  def integer; get_bits.integer end
+  def bit_string; get_bits.bit_string end
+  def hex_string; get_bits.hex_string end
+  def oct_string; get_bits.oct_string end
+
+  def total_length
+    field_lengths.inject { |total, length| total + length }
+  end
+
+  def add(field_name, instance)
+    field_name = BitFields.symbol_if_string(field_name)
+    if instance
+      field_names << field_name
+      field_values << instance.get_bits
+    end
+  end
+
+  def bring(template_name, params = {})
+    template_name = BitFields.symbol_if_string(template_name)
+    instance = BitFields.create(template_name, params)
+    if instance
+      field_names << template_name
+      field_values << instance.get_bits
+    end
+  end
+
+  def bits(field_name, params = {})
+    field_name = BitFields.symbol_if_string(field_name)
+    value = params.key?(:value) ? params[:value] : 0
+    length = params.key?(:length) ? params[:length] : 0
+    field_names << field_name
+    field_values << Bits.new(value, length)
+    field_lengths << length
+  end
+
+  def get_bits
+    field_values.inject(nil) do |final, value|
+      final ? final + value : value
+    end
+  end
+
+  def [](field_name)
+    field_name = BitFields.symbol_if_string(field_name)
+    field_values[field_names.index(field_name)] if field_names.index(field_name)
+  end
+
+  def []=(field_name, value)
+    self[field_name].set(value) if self[field_name]
+  end
+
+  def field_names
+    @field_names ||= Array.new
+  end
+
+  def field_values
+    @field_values ||= Array.new
+  end
+
+  def field_lengths
+    @field_lengths ||= Array.new
+  end
+
+  private
+
+  def self.templates
+    @@templates ||= Hash.new
+  end
+
+  # Helpers
+
+  def self.symbol_if_string(name)
+    name.kind_of?(String) ? name.to_sym : name
+  end
+end
+

data/lib/bits.rb

@@ -0,0 +1,60 @@
+# Bits provides an easy way to store and access sequences of bits, 
+# allowing input and output in multiple formats
+
+class Bits
+
+  # +bits+:: The bit field to store
+  # +length+:: Length of the bit field - default to calculated length, 0-pad on
+  # MSB
+
+  def initialize(bits, length = 0)
+    @length = length
+    @bits = bit_string_from_input(bits, length)
+  end
+
+  def +(bits)
+    Bits.new("0b#{@bits}" + bit_string_from_input(bits))
+  end
+
+  def bit_string
+    @bits
+  end
+
+  def hex_string
+    @bits.to_i(2).to_s(16)
+  end
+
+  def oct_string
+    @bits.to_i(2).to_s(8)
+  end
+
+  def integer
+    @bits.to_i(2)
+  end
+
+  def set(bits)
+    @bits = bit_string_from_input(bits, @length)
+  end
+  
+  protected
+
+  attr_reader :bits
+
+  private
+
+  def bit_string_from_input(bits, length = 0)
+    case bits
+    when Integer, Fixnum, Bignum
+      "%0#{length}b" % bits
+    when String
+      "%0#{length}b" % Integer(bits)
+    when Bits
+      bits.bits
+    when BitFields
+      bits.get_bits.bits
+    else
+      warn "Unsupported data #{bits} (#{bits.class}) - defaulting to #{length} length zero field"
+      "%0#{length}b" % 0
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: jsanders-bitfields
+version: !ruby/object:Gem::Version 
+  version: 0.2.4
+platform: ruby
+authors: 
+- James Sanders
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-23 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A very simple library for building binary data by declaring named bit fields
+email: sanderjd@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Rakefile
+- demo.rb
+- lib/bitfields.rb
+- lib/bits.rb
+has_rdoc: true
+homepage: http://github.com/jsanders/bitfields
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple named bit fields
+test_files: []
+