bitfield 0.9.2 → 0.9.3

data/README.rdoc

@@ -1,6 +1,6 @@
 = BitField
 
- This C extension wraps boost::dynamic_bitset and makes it available
+This C extension wraps boost::dynamic_bitset and makes it available
 as a native Ruby class. The bitset behaves like an an array allowing
 only values of 0 and 1. Using this extension is easy:
 

data/Rakefile

@@ -1,22 +1,30 @@
 require 'rake/extensiontask'
 
-spec = Gem::Specification.new do |s|
-  s.name              = 'bitfield'
-  s.platform          = Gem::Platform::RUBY
-  s.extensions        = FileList["ext/**/extconf.rb"]
-  s.version           = '0.9.2'
-  s.date              = "2011-10-26"
-  s.author            = 'Fabian Becker'
-  s.email             = 'halfdan@xnorfz.de'
-  s.homepage          = 'https://github.com/halfdan/ruby-bitfield/'
-  s.summary           = "Wraps boost::dynamic_bitset and makes it available as a Ruby class 
+spec = Gem::Specification.new do |spec|
+  spec.name              = 'bitfield'
+  spec.platform          = Gem::Platform::RUBY
+  spec.extensions        = FileList["ext/**/extconf.rb"]
+  spec.version           = '0.9.3'
+  spec.date              = Time.now.strftime "%Y-%m-%d"
+  spec.author            = 'Fabian Becker'
+  spec.email             = 'halfdan@xnorfz.de'
+  spec.homepage          = 'https://github.com/halfdan/ruby-bitfield/'
+  spec.summary           = "Wraps boost::dynamic_bitset and makes it available as a Ruby class 
                          for fast operations on a bitset"
 
-  s.description       = 'This C extension wraps boost::dynamic_bitset and makes it available
+  spec.description       = 'This C extension wraps boost::dynamic_bitset and makes it available
                          as a native Ruby class. The bitset behaves like an an array allowing
                          only values of 0 and 1.'
-  
-  s.files = FileList["LICENSE", "README.rdoc", "Rakefile", "ext/**/*.cpp", "ext/**/*.hpp"]
+
+  spec.required_ruby_version = '>= 1.8.1'
+
+  spec.files = FileList["LICENSE", "README.rdoc", "Rakefile", "ext/**/*.cpp", "ext/**/*.hpp", "spec/*"]
+
+  spec.add_development_dependency 'rspec'
+  spec.test_files = ["spec/bitfield_spec.rb"]
+
+  spec.extra_rdoc_files = %w( README.rdoc ext/bitfield/bitfield.cpp )
+  spec.rdoc_options.concat ['--main','README.rdoc', '-E cpp=c']
 end
 
 # add your default gem packing task

data/ext/bitfield/bitfield.cpp

@@ -35,6 +35,13 @@ static VALUE bf_init(VALUE self, VALUE size)
     return self;
 }
 
+/*
+ * Document-method: new
+ *
+ * call-seq: new(size)
+ *
+ * Creates a new BitField with the _size_ that was given.
+ */
 static VALUE bf_new(VALUE self, VALUE size)
 {
     VALUE *argv;
@@ -45,9 +52,12 @@ static VALUE bf_new(VALUE self, VALUE size)
     return self;
 }
 
-/**
- * Returns the size of the BitField
+/*
+ * Document-method: size
  *
+ * call-seq: size()
+ *
+ * Returns the size of the BitField
  */
 static VALUE bf_size(VALUE self)
 {
@@ -56,10 +66,13 @@ static VALUE bf_size(VALUE self)
     return INT2NUM(ptr->data.size());
 }
 
-
-/**
- * Flips the n-th bit if position is given
- * flips all bits otherwise (TODO)
+/*
+ * Document-method: flip
+ *
+ * call-seq: flip(n=nil) -> nil
+ *
+ * Flips all bits in the BitField if _n_ is nil
+ * Flips n if n <> nil
  */
 static VALUE bf_flip(int argc, VALUE *argv, VALUE self)
 {
@@ -68,7 +81,12 @@ static VALUE bf_flip(int argc, VALUE *argv, VALUE self)
     if(argc == 1)
     {
         Check_Type(argv[0], T_FIXNUM);
-        ptr->data[FIX2INT(argv[0])].flip();
+        long pos = FIX2INT(argv[0]);
+        if(pos < 0 || pos >= ptr->data.size()) {
+          return Qfalse;
+        } else {
+            ptr->data[pos].flip();
+        }
     }
     else if(argc == 0)
     {
@@ -81,9 +99,12 @@ static VALUE bf_flip(int argc, VALUE *argv, VALUE self)
     return Qnil;
 }
 
-/**
- * Returns the number of bits that are set
+/*
+ * Document-method: count
  *
+ * call-seq: count()
+ *
+ * Returns the number of bits that are set
  */
 static VALUE bf_count(VALUE self)
 {
@@ -92,6 +113,18 @@ static VALUE bf_count(VALUE self)
     return INT2NUM(ptr->data.count());
 }
 
+/*
+ * Document-method: []=
+ *
+ * call-seq:
+ *   [index]= value
+ *   [range]= value-array
+ *
+ * Element Assignment - Sets the element at _index_ or replaces the subset
+ * specified by _range_. Values can be only be positive numerics. Even
+ * values will be set to 0 (n % 2 = 0) and uneven values will be set to 1
+ * (n % 2 = 1).
+ */
 static VALUE bf_bit_set(VALUE self, VALUE position, VALUE value)
 {
     BitField *ptr;
@@ -140,6 +173,17 @@ static VALUE bf_bit_set(VALUE self, VALUE position, VALUE value)
     return Qnil;
 }
 
+/*
+ * Document-method: []
+ *
+ * call-seq:
+ *   [index] -> value
+ *   [range] -> new_ary
+ *
+ * Element Reference - Returns the element at _index_ or the subset
+ * specified by _range_. Negative or indices greater than the size of
+ * the BitField will be nil.
+ */
 static VALUE bf_bit_get(VALUE self, VALUE position)
 {
     BitField *ptr;
@@ -180,6 +224,15 @@ static VALUE bf_bit_get(VALUE self, VALUE position)
     }
 }
 
+/*
+ * Document-method: to_s
+ *
+ * call-seq:
+ *   inspect -> string
+ *   to_s -> string
+ *
+ * Creates a string representation of +self+.
+ */
 static VALUE bf_to_s(VALUE self)
 {
     BitField *ptr;
@@ -229,13 +282,13 @@ extern "C" {
         rb_define_method(
             rb_cBitField,
             "initialize_clone",
-            reinterpret_cast<VALUE(*)(...)>(bf_initialize_clone),
+            RUBY_METHOD_FUNC(bf_initialize_clone),
             1
         );
         rb_define_method(
             rb_cBitField,
             "initialize_dup",
-            reinterpret_cast<VALUE(*)(...)>(bf_initialize_clone),
+            RUBY_METHOD_FUNC(bf_initialize_clone),
             1
         );
 
@@ -243,43 +296,43 @@ extern "C" {
         rb_define_method(
             rb_cBitField,
             "size",
-            reinterpret_cast<VALUE(*)(...)>(bf_size),
+            RUBY_METHOD_FUNC(bf_size),
             0
         );
         rb_define_method(
             rb_cBitField,
             "initialize",
-            reinterpret_cast<VALUE(*)(...)>(bf_init),
+            RUBY_METHOD_FUNC(bf_init),
             1
         );
         rb_define_method(
             rb_cBitField,
             "[]=",
-            reinterpret_cast<VALUE(*)(...)>(bf_bit_set),
+            RUBY_METHOD_FUNC(bf_bit_set),
             2
         );
         rb_define_method(
             rb_cBitField,
             "[]",
-            reinterpret_cast<VALUE(*)(...)>(bf_bit_get),
+            reinterpret_cast<VALUE(*)(...)>(RUBY_METHOD_FUNC(bf_bit_get)),
             1
         );
         rb_define_method(
             rb_cBitField,
             "to_s",
-            reinterpret_cast<VALUE(*)(...)>(bf_to_s),
+            RUBY_METHOD_FUNC(bf_to_s),
             0
         );
         rb_define_method(
             rb_cBitField,
             "flip",
-            reinterpret_cast<VALUE(*)(...)>(bf_flip),
+            RUBY_METHOD_FUNC(bf_flip),
             -1
         );
         rb_define_method(
             rb_cBitField,
             "count",
-            reinterpret_cast<VALUE(*)(...)>(bf_count),
+            RUBY_METHOD_FUNC(bf_count),
             0
         );
     }

data/spec/bitfield_spec.rb

@@ -0,0 +1,124 @@
+require_relative 'spec_helper'
+
+describe BitField do
+  it "can be initialized with a size" do
+    obj = BitField.new 10
+    obj.should be_a(BitField)
+  end
+
+  it "has a to_s method" do
+    BitField.new(10).should respond_to(:to_s)
+  end
+
+  it "has a clone method" do
+    BitField.new(10).should respond_to(:clone)
+  end
+
+  it "has a size method" do
+    BitField.new(10).should respond_to(:size)
+  end
+
+  it "has a flip method" do
+    BitField.new(10).should respond_to(:flip)
+  end
+
+  it "has a count method" do
+    BitField.new(10).should respond_to(:count)
+  end
+
+  it "has a [] method" do
+    BitField.new(10).should respond_to(:[])
+  end
+
+  it "has a []= method" do
+    BitField.new(10).should respond_to(:[]=)
+  end
+
+  it "has an initialize_clone method" do
+    BitField.new(10).should respond_to(:initialize_clone)
+  end
+end
+
+describe BitField, "#[]" do
+  it "returns an array for a range" do
+    b = BitField.new(10)
+    b[0..4].should == [0,0,0,0,0]
+  end
+
+  it "return a value for a position" do
+    b = BitField.new(10)
+    b[0].should == 0
+  end
+
+  it "returns nil if the position is out of bounds" do
+    b = BitField.new(10)
+    b[-1].should be_nil
+  end
+end
+
+describe BitField, "#[]=" do
+  it "sets a value n for position x" do
+    b = BitField.new(10)
+    b[5] = 1
+  end
+
+  it "assigns even values as 0" do
+    b = BitField.new(10)
+    b[5] = 2**10
+    b[5].should == 0
+  end
+
+  it "assigns uneven values as 1" do
+    b = BitField.new(10)
+    b[9] = 2**10+1
+    b[9].should == 1
+  end
+
+  it "sets a range of values if an array is assigned" do
+    b = BitField.new(10)
+    b[0..4] = Array.new(5) { 1 }
+    b[0..4].should == Array.new(5) { 1 }
+  end
+end
+
+describe BitField, "#size" do
+  it "returns the size of the bitfield" do
+    size = 10
+    obj = BitField.new size
+    obj.size.should == size
+  end
+end
+
+describe BitField, "#to_s" do
+  it "returns the bitfield as string" do
+    b = BitField.new 10
+    b[0] = 1
+    b[2] = 1
+    b[9] = 1
+    b.to_s.should eq("1000000101")
+  end
+end
+
+describe BitField, "#flip" do
+  it "flips all bits in the bitfield" do
+    obj = BitField.new 10
+    obj.flip
+    obj.to_s.should eq("1111111111")
+  end
+
+  it "flips bit n in the bitfield" do
+    obj = BitField.new 10
+    obj.flip 5
+    obj[5].should == 1
+  end
+end
+
+describe BitField, "#count" do
+  it "counts all 1s in the bitfield" do
+    obj = BitField.new 10
+    5.times do |i|
+      obj[i] = 1
+    end
+    obj.count.should == 5
+  end
+end

data/spec/rspec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'bitfield'
+require 'rspec'
+require 'rspec/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitfield
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-26 00:00:00.000000000Z
-dependencies: []
+date: 2011-10-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &83808550 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83808550
 description: ! "This C extension wraps boost::dynamic_bitset and makes it available\n
   \                        as a native Ruby class. The bitset behaves like an an array
   allowing\n                         only values of 0 and 1."
@@ -18,18 +29,26 @@ email: halfdan@xnorfz.de
 executables: []
 extensions:
 - ext/bitfield/extconf.rb
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.rdoc
+- ext/bitfield/bitfield.cpp
 files:
 - LICENSE
 - README.rdoc
 - Rakefile
 - ext/bitfield/bitfield.cpp
 - ext/bitfield/bitfield.hpp
+- spec/rspec.opts
+- spec/bitfield_spec.rb
+- spec/spec_helper.rb
 - ext/bitfield/extconf.rb
 homepage: https://github.com/halfdan/ruby-bitfield/
 licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --main
+- README.rdoc
+- -E cpp=c
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -37,7 +56,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -51,4 +70,5 @@ signing_key:
 specification_version: 3
 summary: Wraps boost::dynamic_bitset and makes it available as a Ruby class  for fast
   operations on a bitset
-test_files: []
+test_files:
+- spec/bitfield_spec.rb