sanderjd-bitch 0.0.2 → 0.1.0

data/Rakefile

@@ -0,0 +1,38 @@
+begin
+  require 'rubygems'
+rescue Exception
+  puts 'RubyGems is not install. 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 = "bitch"
+    s.summary = "Bitch - A simple binary message building helper"
+    s.description = "A very simple library for building binary data in a declarative manner"
+    s.email = 'sanderjd@gmail.com'
+    s.homepage = 'http://github.com/sanderjd/bitch'
+    s.authors = ['James Sanders']
+    s.has_rdoc = true
+    s.files = ["README",
+               "Rakefile",
+               "demo.rb",
+               "lib/bitch.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

@@ -1,21 +1,46 @@
 require File.dirname(__FILE__) + '/lib/bitch'
 
-message = Bitch.compose do |m|
+# Make a template
+Bitch.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 = Bitch.create(:demo)
+
 # 1010101010000000000000001
-puts message.get_bits.bit_string
+puts message.bit_string
 
-message[:middle] = 31
+# Create an object with that template and give it parameters
+message = Bitch.create(:demo, :middle => 0b11111)
 
 # 1010101010111110000000001
-puts message.get_bits.bit_string
+puts message.bit_string
 # 1557c01
-puts message.get_bits.hex_string
+puts message.hex_string
 # 125276001
-puts message.get_bits.oct_string
+puts message.oct_string
 # 22379521
-puts message.get_bits.integer
+puts message.integer
+
+# Compose another message using this object as one of its fields
+new_message = Bitch.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 = Bitch.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/bitch.rb

@@ -1,54 +1,73 @@
 require File.dirname(__FILE__) + '/bits'
 
 class Bitch
-  def self.fields(name, &block)
-    formats[name] = self.new
-    yield formats[name]
-  end
   
+  # Class methods
+  
+  def self.template(name, &block)
+    templates[name] = self.new
+    yield templates[name]
+    nil
+  end
+ 
+  def self.create(name, params = {})
+    params.each_pair { |k,v| templates[name][k] = v }
+    templates[name]
+  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 add(name, object)
+    fields << { name => object.get_bits }
+  end
+
   def bring(name, params = {})
-    format = Bitch.formats[name]
-    params.each_pair { |field, value| format[field] = value }
-    field_array << { name => format.get_bits }
+    object = Bitch.create(name, params)
+    fields << { name => object.get_bits }
   end
 
-  def bits(name, params)
+  def bits(name, params = {})
     value = params.key?(:value) ? params[:value] : 0
     length = params.key?(:length) ? params[:length] : 0
-    field_array << { name => Bits.new(value, length) }
+    fields << { name => Bits.new(value, length) }
   end
 
   def get_bits
-    field_array.inject(nil) do |fields, field|
+    fields.inject(nil) do |composed, field|
       bits = field.values.first
-      fields ? fields + bits : bits
+      composed ? composed + bits : bits
     end
   end
 
   def [](name)
-    field_array.select { |field| field.key?(name) }.first.values.first
+    fields.select { |field| field.key?(name) }.first.values.first
   end
 
   def []=(name, value)
-    element_array = field_array.select { |field| field.key?(name) }
+    element_array = fields.select { |field| field.key?(name) }
     element = element_array.first.values.first unless element_array.empty?
     element.set(value) unless element.nil?
   end
 
   private
 
-  def field_array
-    @field_array ||= Array.new
+  def fields
+    @fields ||= Array.new
   end
 
-  def self.formats
-    @@formats ||= Hash.new
+  def self.templates
+    @@templates ||= Hash.new
   end
 end
 

data/lib/bits.rb

@@ -50,6 +50,8 @@ class Bits
       "%0#{length}b" % Integer(bits)
     when Bits
       bits.bits
+    when Bitch
+      bits.get_bits.bits
     else
       raise TypeError, "Unsupported data type #{bits.class}"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sanderjd-bitch
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - James Sanders
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-02 00:00:00 -08:00
+date: 2009-01-18 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: Spurred by unneeded complexity in projects such as BinData, Bitch provides dead-simple composition and naming of bit fields
+description: A very simple library for building binary data in a declarative manner
 email: sanderjd@gmail.com
 executables: []
 
@@ -23,10 +23,10 @@ extra_rdoc_files: []
 
 files: 
 - README
-- bitch.gemspec
+- Rakefile
 - demo.rb
-- lib/bits.rb
 - lib/bitch.rb
+- lib/bits.rb
 has_rdoc: true
 homepage: http://github.com/sanderjd/bitch
 post_install_message: 
@@ -52,6 +52,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Bitch provides simple composition of bit fields
+summary: Bitch - A simple binary message building helper
 test_files: []
 

data/bitch.gemspec

@@ -1,16 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = "bitch"
-  s.version = "0.0.2"
-  s.date = "2009-01-02"
-  s.authors = ["James Sanders"]
-  s.email = "sanderjd@gmail.com"
-  s.summary = "Bitch provides simple composition of bit fields"
-  s.homepage = "http://github.com/sanderjd/bitch"
-  s.description = "Spurred by unneeded complexity in projects such as BinData, Bitch provides dead-simple composition and naming of bit fields"
-  s.has_rdoc = true
-  s.files = ["README",
-             "bitch.gemspec",
-             "demo.rb",
-             "lib/bits.rb", 
-             "lib/bitch.rb"]
-end