beezwax 0.7.0 → 0.7.1

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.7.1

data/beezwax.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{beezwax}
-  s.version = "0.7.0"
+  s.version = "0.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Patrick Lardin"]
-  s.date = %q{2010-12-22}
+  s.date = %q{2011-03-19}
   s.description = %q{Access Btrieve database files through a ruby API.}
   s.email = %q{plardin@gmail.com}
   s.extra_rdoc_files = [

data/lib/btrieve/btrieve_extended.rb

@@ -2,16 +2,16 @@ class BtrieveSearchBuffer
   include Btrieve
   COMPARISON = {:equal=>1,:greater_than=>2,:less_than=>3, :not_equal=>4, :greater_than_or_equal=>5, :less_than_or_equal=>6}
   BOOLEAN = {:and=>1, :or=>2}
-  
+
   def initialize(table, filter, fields_to_return, records_to_fetch=10, start_point=:next_record, max_reject_count=0)
     @table=table
     @filter=filter
     @records_to_fetch=records_to_fetch
     @fields_to_return=fields_to_return
-    @start_point = start_point == :current_record ? 'UC' : 'EG'  
+    @start_point = start_point == :current_record ? 'UC' : 'EG'
     @max_reject_count=max_reject_count
   end
-    
+
   def get_encoded_buffer
     filter_buff = []
     @filter.each_with_index() do |token, i|
@@ -26,13 +26,11 @@ class BtrieveSearchBuffer
           right_operand=[@table.schema[:columns][token[2]][:offset]].pack('S')
         else
           # We're comparing against a constant in the exact same format as the column itself
-          right_operand=@table.pack_value(column, token[2]) 
+          right_operand=@table.pack_value(column, token[2])
           right_operand=right_operand.gsub("\x00",' ') if [0,11,12,21].include?(column[:datatype])
-        end 
-        #filter_buff << "DATATYPE=#{column[:datatype]} SIZE=#{column[:size]} OFFSET=#{column[:offset]} COMPARISON=#{comparison} OPERAND=#{right_operand}"
+        end
         filter_item = [column[:datatype], column[:size], column[:offset], comparison, 0].pack('CSSCC')
         filter_item << right_operand
-        #p filter_item
         filter_buff << filter_item
       else
         boolean = BOOLEAN[token]
@@ -40,31 +38,22 @@ class BtrieveSearchBuffer
       end
     end
     num_logical_expressions = filter_buff.size
-    #p "num_logical_expressions = #{num_logical_expressions}"
-    #p filter_buff
     result_descriptor=[@records_to_fetch, @fields_to_return.size].pack('SS')
-    #p "result_descriptor before = #{result_descriptor}"
     @fields_to_return.inject(result_descriptor) do |desc, field|
       column = @table.schema[:columns][field]
-      #p "#{field} => column[:size], column[:offset] = #{column[:size]}, #{column[:offset]}"
       desc << [column[:size], column[:offset]].pack('SS')
       desc
     end
-    #p "result_descriptor after = #{result_descriptor}"
     buffer_size=8+result_descriptor.size+filter_buff.join('').size
-    #p "buffer_size=#{buffer_size}"
     search_buffer=[buffer_size, @start_point, @max_reject_count, num_logical_expressions].pack('Sa2SS')
-    #p "search_buffer.size=#{search_buffer.size}"
     search_buffer << filter_buff.join('') << result_descriptor
-    #p "search_buffer.size=#{search_buffer.size}"
-    #p "buffer_size - search_buffer.size=#{buffer_size - search_buffer.size}"
     search_buffer
   end
-  
+
   private
-  
+
   def is_symbol?(arg)
     arg.object_id == arg.to_sym.object_id rescue false
   end
-  
 end
+

data/lib/btrieve/btrieve_record.rb

@@ -6,7 +6,7 @@ class BtrieveRecord
   attr_reader :data_buffer, :btrieve_table
   attr_accessor :position
 
-  # Initializes a btrieve record.  
+  # Initializes a btrieve record.
   def initialize(btrieve_table, data_buffer=nil)
     @btrieve_table = btrieve_table
     @data_buffer = data_buffer.nil? ? Btrieve.create_string_buffer(@btrieve_table.schema[:record_size]) : data_buffer
@@ -23,28 +23,28 @@ class BtrieveRecord
   def update
     new_state="#{@data_buffer}"
     @data_buffer[0..3]=@position
-    btr_op(GET_DIRECT, @btrieve_table.pos_buffer, @data_buffer, NULL_BUFFER, SYSTEM_LOG_KEY) 
+    btr_op(GET_DIRECT, @btrieve_table.pos_buffer, @data_buffer, NULL_BUFFER, SYSTEM_LOG_KEY)
     btr_op(UPDATE, @btrieve_table.pos_buffer, new_state, NULL_BUFFER, SYSTEM_LOG_KEY)
     set_physical_position
   end
-  
+
   # Deletes an existing btrieve record through the transactional BTR engine.
   def delete
     @data_buffer[0..3]=@position
-    btr_op(GET_DIRECT, @btrieve_table.pos_buffer, @data_buffer, NULL_BUFFER, SYSTEM_LOG_KEY)  
+    btr_op(GET_DIRECT, @btrieve_table.pos_buffer, @data_buffer, NULL_BUFFER, SYSTEM_LOG_KEY)
     btr_op(DELETE, @btrieve_table.pos_buffer, NULL_BUFFER, NULL_BUFFER, NULL_KEY)
     reset_physical_position
   end
 
-  # Returns hash of column-value pairs for this btrieve record, given an array of named columns. 
-  # If the array is nil, the hash will contain ALL the column-value pairs defined by the schema. 
+  # Returns hash of column-value pairs for this btrieve record, given an array of named columns.
+  # If the array is nil, the hash will contain ALL the column-value pairs defined by the schema.
   def values(column_names=nil)
     if(column_names.nil?)
       column_names=@btrieve_table.schema[:columns].keys.sort.inject([]){|array,column|array<< column;array}
-    end 
+    end
     column_names.inject({}){|vals, key| vals[key]=self[key]; vals}
   end
-  
+
   # Sets the column valuesof this record based on the values passed through the 'column_values' map.
   def values=(column_values)
     column_values.each{ |key, value| self[key]=value }
@@ -54,16 +54,16 @@ class BtrieveRecord
   def primary_key()
     values(@btrieve_table.primary_key)
   end
-  
-  # Returns this record's value of the column passed in. 
+
+  # Returns this record's value of the column passed in.
   def [](key_name)
     column = @btrieve_table.schema[:columns][key_name]
     return nil if(column.nil?)
-    val = @data_buffer.unpack(column[:unpacker])[0]  
+    val = @data_buffer.unpack(column[:unpacker])[0]
     val = val.strip if val.respond_to?('strip')
     val
   end
-  
+
   # Sets this record's value for a particular column.
   def []=(key_name, value)
     column = @btrieve_table.schema[:columns][key_name]
@@ -72,32 +72,33 @@ class BtrieveRecord
     range = (offset..offset+packed_value.size-1)
     @data_buffer[range] = packed_value
   end
-  
+
   # Determines if a record is nil.
   def nil?()
     @data_buffer.gsub("\x00", "").size==0
   end
-  
+
   # Returns a string representation of this record.
   def to_s()
     @btrieve_table.schema[:columns].keys.inject("[position=>'#{position.unpack('i')[0]}'"){|pretty_print, key| pretty_print << ", #{key}=>'#{self[key]}'"; pretty_print } << "]"
   end
 
-  # Returns this record's version as a MD5 Digest value. 
+  # Returns this record's version as a MD5 Digest value.
   def version()
     Digest::MD5.hexdigest(@data_buffer)
   end
-  
+
   # TODO - documentation
   def set_physical_position
     reset_physical_position
     btr_op(GET_POSITION, @btrieve_table.pos_buffer, @position, NULL_BUFFER, NULL_KEY)
     self
   end
-  
+
   # TODO - documentation
   def reset_physical_position
     @position = Btrieve.create_string_buffer(RECORD_POSITION_SIZE)
   end
 
 end
+

data/lib/btrieve/btrieve_table.rb

@@ -24,13 +24,13 @@ class BtrieveTable
       close()
     end
   end
-  
+
   # Finds an array of records in this table, using the specified index number and match hash.
   # If a block is passed in, the entries of this set are passed into this block one by one. Otherwise,
-  # the set is returned to the caller. 
+  # the set is returned to the caller.
   def find(match, index_number, &block)
     allows_duplicates=schema[:index_flags].map{|f|f&1==1;}[index_number]
-    set=nil 
+    set=nil
     if(allows_duplicates)
       set=find_in_index(match, index_number)
     else
@@ -46,8 +46,8 @@ class BtrieveTable
 
   # Finds an array of records in this table, using the specified index number, a key and a range of values.
   # If a block is passed in, the entries of this set are passed into this block one by one. Otherwise,
-  # the set is returned to the caller. 
-  # WARNING - NO UNIT TEST EXIST YET! 
+  # the set is returned to the caller.
+  # WARNING - NO UNIT TEST EXIST YET!
   # CONSIDER - Deprecation coming soon... Should use the 'find_extended' method instead.
   def find_in_range(index_num, key, range, &block)
     index = @schema[:indices][index_num]
@@ -55,8 +55,8 @@ class BtrieveTable
     index_values = index.inject([]){|vals,akey|vals << (akey == key ? range.first : nil); vals}
     key_packer = index.inject("") do |packer, akey|
       value_packer = BtrieveSchema.lookup(columns[akey][:datatype], columns[akey][:size])[:unpacker]
-      nil_packer = 'x'*columns[key][:size]    
-      packer << (akey == key ? value_packer : nil_packer) 
+      nil_packer = 'x'*columns[key][:size]
+      packer << (akey == key ? value_packer : nil_packer)
       packer
     end
     key_buffer = index_values.pack(key_packer)
@@ -65,7 +65,7 @@ class BtrieveTable
     batch do
       btr_op(GET_GREATER_THAN_OR_EQUAL, @pos_buffer, btr_record.data_buffer, key_buffer, index_num, [OK, EOF])
       while(range.include?(btr_record[key]))
-        if(!block.nil?) 
+        if(!block.nil?)
 	        yield btr_record
 	      else
 	        records << btr_record
@@ -74,12 +74,12 @@ class BtrieveTable
         btr_op(GET_NEXT, @pos_buffer, btr_record.data_buffer, key_buffer, index_num, [OK, EOF])
       end
     end
-    if(block.nil?) 
+    if(block.nil?)
 	    records
 	  end
   end
 
-  # Closes this btrieve table to conclude a sequence of BTR operation(s). 
+  # Closes this btrieve table to conclude a sequence of BTR operation(s).
   def close
     btr_op(CLOSE, @pos_buffer, NULL_BUFFER, NULL_BUFFER, NULL_KEY)
     @pos_buffer=Btrieve.create_string_buffer(POS_BLOCK_SIZE)
@@ -102,11 +102,11 @@ class BtrieveTable
     close
   end
 
-  # Returns this table's version as a MD5 Digest value. 
+  # Returns this table's version as a MD5 Digest value.
   def version()
     Digest::MD5.hexdigest(BtrieveSchema.sort(schema[:columns]).inject([]){|array,column|array << BtrieveSchema.readable_type(column);array}.to_s)
   end
-  
+
   # Packs a value according to the metadata of a particular column.
   def pack_value(column, value)
     packer_string = column[:unpacker]
@@ -117,10 +117,10 @@ class BtrieveTable
     array = [value]
     array.pack(packer)
   end
-  
+
   # Returns an array of hashes that match the criteria defined by the filter parameter.
   # An example of the filter parameter is given below -
-  # 
+  #
   # filter = [[:dept_name, :equal, 'Philosophy'], :and, [:name, :not_equal, 'PHI 101'], :and, [:name, :not_equal, :dept_name]]
   #
   # The following COMPARISON operators are supported in the logical comparison clauses -
@@ -143,7 +143,7 @@ class BtrieveTable
     start_point = :next_record
     searcher = BtrieveSearchBuffer.new(self, filter, fields_to_return, records_to_fetch, max_reject_count, max_reject_count)
     search_buffer = searcher.get_encoded_buffer
-    buff_diff = records_buffer - search_buffer.size 
+    buff_diff = records_buffer - search_buffer.size
     search_buffer << Btrieve.create_string_buffer(buff_diff) if(buff_diff > 0)
     tmp_buff = Btrieve.create_string_buffer(record_size)
     key_buff = Btrieve.create_string_buffer(record_size)
@@ -157,7 +157,7 @@ class BtrieveTable
       record_position = search_buffer.unpack("@#{2+record_byte_pointer}i")[0]
       record=search_buffer.unpack("@#{6+record_byte_pointer}a#{record_length}")[0]
       record_byte_pointer += 6+record_length
-      unpacker = fields_to_return.inject(["", 0]) do |arr, c| 
+      unpacker = fields_to_return.inject(["", 0]) do |arr, c|
         column = @schema[:columns][c]
         str = BtrieveSchema.unpacker(arr[1], column[:datatype], column[:size])
         arr[0] << str
@@ -167,16 +167,16 @@ class BtrieveTable
       fields = record.unpack(unpacker[0])
       records << {:position=>record_position, :values=>Hash[*fields_to_return.zip(fields).flatten]}
     end
-    records 
+    records
   end
-  
+
   private
 
   def step_next
     btr_record = BtrieveRecord.new(self)
     result = btr_op(STEP_NEXT, @pos_buffer, btr_record.data_buffer, NULL_BUFFER, NULL_KEY, [OK, EOF])
     return false if(result == EOF)
-    btr_record
+    btr_record.set_physical_position
   end
 
   def find_matching_index(match)
@@ -186,18 +186,18 @@ class BtrieveTable
     raise Exception.new("No matching index for #{keys}")
   end
 
-  INTEGER_TYPES=['TINYINT','SMALLINT','INTEGER','BIT','UTINYINT','USMALLINT','UINTEGER','UBIGINT']  
+  INTEGER_TYPES=['TINYINT','SMALLINT','INTEGER','BIT','UTINYINT','USMALLINT','UINTEGER','UBIGINT']
   FLOAT_TYPES=['REAL','DOUBLE']
   def finder(match, index_number = nil, &block)
     index_number ||= find_matching_index(match)
     index = @schema[:indices][index_number]
     columns = @schema[:columns]
-    key_components = index.inject([]) do |vals, key| 
-      datatype = BtrieveSchema.lookup(columns[key][:datatype], columns[key][:size])[:name]      
+    key_components = index.inject([]) do |vals, key|
+      datatype = BtrieveSchema.lookup(columns[key][:datatype], columns[key][:size])[:name]
       value = match[key]
       value = value.to_f if FLOAT_TYPES.include?(datatype)
       value = value.to_i if INTEGER_TYPES.include?(datatype)
-      value = value.ljust(columns[key][:size], ' ') if datatype=='CHAR' 
+      value = value.ljust(columns[key][:size], ' ') if datatype=='CHAR'
       vals << value
       vals
     end
@@ -229,12 +229,12 @@ class BtrieveTable
     finder(match, index_number) do |org_key_buffer, index|
       absolute_match = match.keys.inject({}){|vals, key| vals[key] = match[key] if(match[key] != nil); vals}
       absolute_match_keys = absolute_match.keys
-      result = []    
+      result = []
       batch do
         key_buffer="#{org_key_buffer}"
         ops_result = btr_op(GET_EQUAL_KEY, @pos_buffer, NULL_BUFFER, key_buffer, index, [OK, EOF, KEY_NOT_FOUND])
         ops=GET_EQUAL
-        while(ops_result == OK) 
+        while(ops_result == OK)
           btr_record = BtrieveRecord.new(self)
           ops_result = btr_op(ops, @pos_buffer, btr_record.data_buffer, key_buffer, index, [OK, EOF])
           break if(key_buffer!=org_key_buffer)
@@ -244,13 +244,13 @@ class BtrieveTable
       end
       result
     end
-  end  
-  
+  end
+
   def session
     s=BtrieveSession.get_session
     raise "Cannot manipulate a BtrieveTable when no BtrieveSession exists." if s.nil?
     s
   end
-  
+
 end
 

data/test/btrieve/test_beezwax.rb

@@ -5,27 +5,27 @@ class TestBeezwax < Test::Unit::TestCase
     setup do
       BtrieveSession.create_session(PSQL_DB)
     end
-    
+
     teardown do
       BtrieveSession.destroy_session
     end
-    
+
     should "not allow the creation of another session" do
       assert_raise(RuntimeError){BtrieveSession.create_session(PSQL_DB)}
     end
- 
+
     should "return a handle to the session singleton" do
       session=nil
       assert_nothing_raised{session=BtrieveSession.get_session}
-      assert_not_nil session 
+      assert_not_nil session
     end
-    
+
     should "permit the instanciation of a DB table" do
       table=nil
       assert_nothing_raised{table=BtrieveTable.new(:course)}
       assert_not_nil table
     end
-    
+
     should "permit the instanciation of multiple instances for the same DB table" do
       table0 = table1 = nil
       assert_nothing_raised do
@@ -35,18 +35,18 @@ class TestBeezwax < Test::Unit::TestCase
       assert_not_nil table0
       assert_not_nil table1
     end
-    
+
     should "allow an empty transaction to go through" do
       assert_nothing_raised{BtrieveSession.transaction{}}
     end
-    
+
     should "allow an empty transaction to go through, with explicit boundaries" do
       assert_nothing_raised do
         BtrieveSession.begin_transaction
         BtrieveSession.end_transaction
       end
     end
-    
+
     should "allow a transaction to be aborted" do
       assert_nothing_raised do
         BtrieveSession.begin_transaction
@@ -54,44 +54,55 @@ class TestBeezwax < Test::Unit::TestCase
       end
       assert_raise(RuntimeError){BtrieveSession.end_transaction}
     end
-    
+
     context "and an instance of BtrieveTable is created, it" do
       setup do
         @table=BtrieveTable.new(:course)
         @table.primary_key = [:name]
       end
-      
+
       teardown do
         @table=nil
       end
-    
+
       should "be possible to open it for operations, then close it" do
         assert_nothing_raised{ @table.open }
         assert_nothing_raised{ @table.close }
       end
-      
+
       should "be possible to have the file automatically closed when a block is passed when opening a table" do
         assert_nothing_raised{ @table.open{} }
         assert_raise(RuntimeError){ @table.close }
       end
-      
+
       should "return a version number for that table" do
         table_version=nil
         assert_nothing_raised{ table_version=@table.version }
         assert_not_nil table_version
         assert_equal 32, table_version.size
-      end  
-      
+      end
+
       should "allow looping over each of its records to count them" do
         counter = 0
         assert_nothing_raised{@table.each_record{|record|counter+=1}}
         assert_equal 145, counter
       end
-      
+
+      should "allow looping over each of its records to updated them" do
+        BtrieveSession.begin_transaction
+        i=0
+        @table.each_record do |record|
+          record[:description]="#{record[:description]} #{i}"
+          i += 1
+          record.update
+        end
+        BtrieveSession.abort_transaction
+      end
+
       should "be possible to search the table for a given index" do
         assert_nothing_raised {@table.find({:name=>'blah'}, 0)}
       end
-      
+
       should "be possible to find a particular record in a unique index" do
         name = 'PHI 101'
         record = nil
@@ -99,10 +110,10 @@ class TestBeezwax < Test::Unit::TestCase
         assert_nothing_raised{record=@table.find({:name=>name}, 0).first}
         assert_not_nil record
         assert_nothing_raised{record_name=record[:name]}
-        assert_not_nil record_name 
+        assert_not_nil record_name
         assert_equal record_name, name
       end
-      
+
       should "be possible to search for a unique key that doesn't exist and not cause an exception" do
         name = 'FRA 333'
         records=@table.find({:name=>name}, 0)
@@ -118,31 +129,31 @@ class TestBeezwax < Test::Unit::TestCase
         assert_equal 9, records.size
         assert records.inject(true){|test, record| test |= record[:dept_name]==dept_name; test}
       end
-      
+
       should "support finding records and looping over them if a block is passed in" do
         dept_name = 'Mathematics'
-        counter = 0 
+        counter = 0
         assert_nothing_raised{@table.find({:dept_name=>dept_name}, 1){counter += 1}}
         assert_equal 9, counter
       end
-      
+
       should "be possible to search for a key that doesn't exit and not cause an exception" do
         dept_name = 'Francais'
         records=@table.find({:dept_name=>dept_name}, 1)
         assert_not_nil records
         assert records.empty?, "records is NOT empty"
       end
-      
+
       context "and an instance of BtrieveRecord is fetched, it" do
         setup do
           @name = 'PHI 101'
           @record=@table.find({:name=>@name}, 0).first
         end
-        
+
         teardown do
           @record=nil
         end
-        
+
         should "be possible to get the record's primary key" do
           expected_value = {:name=>@name}
           pk = nil
@@ -150,7 +161,7 @@ class TestBeezwax < Test::Unit::TestCase
           assert_not_nil pk
           assert_equal expected_value, pk
         end
-        
+
         should "be possible retrieve all its columns" do
           expected_values={:name=>@name, :description=>'Introduction to Ethics', :credit_hours=>3, :dept_name=>'Philosophy'}
           values = nil
@@ -158,7 +169,7 @@ class TestBeezwax < Test::Unit::TestCase
           assert_not_nil values
           assert_equal expected_values, values
         end
-        
+
         should "be possible retrieve a subset of its columns" do
           expected_values={:description=>'Introduction to Ethics', :credit_hours=>3}
           values = nil
@@ -167,13 +178,13 @@ class TestBeezwax < Test::Unit::TestCase
           assert_equal expected_values, values
         end
       end
-      
+
       context "for a BtrieveRecord to be created, it" do
         setup do
           @values={:name=>'FRA 303', :description=>'Francais Avance', :credit_hours=>3, :dept_name=>"Latin".force_encoding("ASCII-8BIT")}
           @rb_values={:name=>'FRE 303', :description=>'Frenceis Evence', :credit_hours=>3, :dept_name=>'Latin'}
         end
-        
+
         teardown do
           # meh
         end
@@ -234,7 +245,7 @@ class TestBeezwax < Test::Unit::TestCase
                 assert str.size > 0
               end
             end
-          end        
+          end
           assert_nothing_raised{ new_record = @table.find({:name=>'FRA 303'}, 0).first }
           assert_not_nil new_record
           assert_nothing_raised { new_values = new_record.values }
@@ -250,20 +261,20 @@ class TestBeezwax < Test::Unit::TestCase
           assert_nil new_record
         end
       end
-    end    
+    end
   end
-  
+
   context "A destroyed BtrieveSession" do
     setup do
       BtrieveSession.create_session(PSQL_DB)
       @table = BtrieveTable.new(:course)
       BtrieveSession.destroy_session
     end
-        
+
     should "not allow the instanciation of a DB table" do
       assert_raise(RuntimeError){BtrieveTable.new(:course)}
     end
-    
+
     should "not allow exsting tables to search against the DB" do
       records=nil
       assert_raise(RuntimeError){records=@table.find({:dept_name=>'Mathematics'}, 1)}
@@ -271,3 +282,4 @@ class TestBeezwax < Test::Unit::TestCase
     end
   end
 end
+

data/test/helper.rb

@@ -18,3 +18,4 @@ class Test::Unit::TestCase
     end
   end
 end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 1
+  version: 0.7.1
 platform: ruby
 authors: 
 - Patrick Lardin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-22 00:00:00 -08:00
+date: 2011-03-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency