beezwax 0.6.2 → 0.7.0

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.7.0

data/beezwax.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{beezwax}
-  s.version = "0.6.2"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Patrick Lardin"]
-  s.date = %q{2010-12-21}
+  s.date = %q{2010-12-22}
   s.description = %q{Access Btrieve database files through a ruby API.}
   s.email = %q{plardin@gmail.com}
   s.extra_rdoc_files = [
@@ -27,11 +27,13 @@ Gem::Specification.new do |s|
     "lib/beezwax.rb",
     "lib/btrieve/btrieve_const.rb",
     "lib/btrieve/btrieve_core.rb",
+    "lib/btrieve/btrieve_extended.rb",
     "lib/btrieve/btrieve_record.rb",
     "lib/btrieve/btrieve_schema.rb",
     "lib/btrieve/btrieve_session.rb",
     "lib/btrieve/btrieve_table.rb",
     "test/btrieve/test_beezwax.rb",
+    "test/btrieve/test_extended_beezwax.rb",
     "test/helper.rb"
   ]
   s.homepage = %q{http://github.com/plardin/beezwax}
@@ -40,6 +42,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Btrieve API wrapper.}
   s.test_files = [
     "test/btrieve/test_beezwax.rb",
+    "test/btrieve/test_extended_beezwax.rb",
     "test/helper.rb"
   ]
 

data/lib/btrieve/btrieve_const.rb

@@ -23,6 +23,8 @@ module BtrCodes
   STEP_NEXT = 24
   STOP = 25
   RESET = 28
+  GET_NEXT_EXTENDED = 36
+  STEP_NEXT_EXTENDED = 38
   GET_EQUAL_KEY = 55
   GET_NEXT_KEY = 56
   POS_BLOCK_SIZE = 128

data/lib/btrieve/btrieve_core.rb

@@ -41,3 +41,4 @@ require_relative 'btrieve_session'
 require_relative 'btrieve_table'
 require_relative 'btrieve_schema'
 require_relative 'btrieve_record'
+require_relative 'btrieve_extended'

data/lib/btrieve/btrieve_extended.rb

@@ -0,0 +1,70 @@
+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'  
+    @max_reject_count=max_reject_count
+  end
+    
+  def get_encoded_buffer
+    filter_buff = []
+    @filter.each_with_index() do |token, i|
+      is_expr = (i%2 == 0)
+      if(is_expr)
+        column = @table.schema[:columns][token[0]]
+        comparison = COMPARISON[token[1]]
+        right_operand = nil
+        if(is_symbol?(token[2]))
+          # We're comparing against a value stored in another field in this record
+          comparison += 64
+          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=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}"
+        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]
+        filter_buff.last[6..6]=[boolean].pack('C')
+      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

@@ -57,27 +57,20 @@ class BtrieveRecord
   
   # Returns this record's value of the column passed in. 
   def [](key_name)
-    column_info = get_column_info(key_name)
-    return nil if(column_info.nil?)
-    val = @data_buffer.unpack(column_info[:unpacker])[0]  
+    column = @btrieve_table.schema[:columns][key_name]
+    return nil if(column.nil?)
+    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)
-    schema_key = get_column_info(key_name)
-    packer_string = schema_key[:unpacker]
-    match = packer_string.match(/@(\d+)([a-zA-Z]+)(\d*)/)
-    offset = match[1].to_i
-    datatype = match[2]
-    thesizeof = BtrieveSchema::SIZEOF[datatype]
-    thesizeof *= match[3].empty? ? 1 : match[3].to_i
-    packer = "#{datatype}#{thesizeof}"
-    array = [value]
-    packed_value = array.pack(packer)
+    column = @btrieve_table.schema[:columns][key_name]
+    packed_value = @btrieve_table.pack_value(column, value)
+    offset = column[:offset]
     range = (offset..offset+packed_value.size-1)
-    data_buffer[range] = packed_value
+    @data_buffer[range] = packed_value
   end
   
   # Determines if a record is nil.
@@ -107,9 +100,4 @@ class BtrieveRecord
     @position = Btrieve.create_string_buffer(RECORD_POSITION_SIZE)
   end
 
-  private
-
-  def get_column_info(column_name)
-    @btrieve_table.schema[:columns][column_name]
-  end
 end

data/lib/btrieve/btrieve_schema.rb

@@ -72,7 +72,13 @@ class BtrieveSchema
     raise Exception.new("Unknown table '#{tablename}'.") if schema.nil?
     schema
   end
-
+  
+  def self.readable_type(column)
+    c=column.to_a[0]
+    btrtype = lookup(c[1][:datatype],c[1][:size])
+    [:name=>c[0], :datatype=>btrtype[:name], :size=>c[1][:size]]
+  end
+  
   private
 
   SYS_DDF = {
@@ -88,12 +94,6 @@ class BtrieveSchema
     "#{offsetter}#{btrtype[:unpacker]}#{multiplier}"
   end
 
-  def self.readable_type(column)
-    c=column.to_a[0]
-    btrtype = lookup(c[1][:datatype],c[1][:size])
-    [:name=>c[0], :datatype=>btrtype[:name], :size=>c[1][:size]]
-  end
-
   def self.sort(schema)
     schema.inject([]){|array,column|array[column[1][:offset]]={column[0]=>column[1]};array}.compact
   end

data/lib/btrieve/btrieve_table.rb

@@ -47,8 +47,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!
-  # TODO - Add a unit test for this method. 
+  # 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]
     columns = @schema[:columns]
@@ -107,6 +107,69 @@ class BtrieveTable
     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]
+    match = packer_string.match(/@(\d+)([a-zA-Z]+)(\d*)/)
+    datatype = match[2]
+    size = match[3].empty? ? BtrieveSchema::SIZEOF[datatype] : BtrieveSchema::SIZEOF[datatype]*match[3].to_i
+    packer = "#{datatype}#{size}"
+    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 -
+  #   :equal
+  #   :greater_than
+  #   :less_than
+  #   :not_equal
+  #   :greater_than_or_equal
+  #   :less_than_or_equal
+  #
+  # Logical comparison clauses can chained together using the following boolean operators -
+  #   :and
+  #   :or
+  #
+  # NOTE - The logical comparisons can compare a columns to a constant OR to another column in the same record.
+  def find_extended(index, filter, fields_to_return, records_to_fetch)
+    record_size = @schema[:record_size]
+    records_buffer = record_size*records_to_fetch
+    max_reject_count = 65535
+    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 
+    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)
+    btr_op(GET_FIRST, @pos_buffer, tmp_buff, key_buff, index, [OK])
+    ops_result = btr_op(GET_NEXT_EXTENDED, @pos_buffer, search_buffer, key_buff, index, [OK, EOF])
+    num_records = search_buffer.unpack('S')[0]
+    record_byte_pointer=2
+    records = []
+    (0...num_records).each do |index|
+      record_length = search_buffer.unpack("@#{record_byte_pointer}S")[0]
+      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| 
+        column = @schema[:columns][c]
+        str = BtrieveSchema.unpacker(arr[1], column[:datatype], column[:size])
+        arr[0] << str
+        arr[1] += column[:size]
+        arr
+      end
+      fields = record.unpack(unpacker[0])
+      records << {:position=>record_position, :values=>Hash[*fields_to_return.zip(fields).flatten]}
+    end
+    records 
+  end
+  
   private
 
   def step_next

data/test/btrieve/test_extended_beezwax.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class TestExtendedBeezwax < Test::Unit::TestCase
+  context "when a BtrieveSession is initialized" do
+    setup do
+      BtrieveSession.create_session(PSQL_DB)
+    end
+    
+    teardown do
+      BtrieveSession.destroy_session
+    end
+    
+    should "support the creation of an extended query search buffer" do
+      table=BtrieveTable.new(:course)
+      filter = [[:name, :not_equal, 'PHI 101'], :and, [:dept_name, :equal, 'Philosophy'], :and, [:name, :not_equal, :dept_name]]
+      fields_to_return = table.schema[:columns].keys
+      encoded_buffer = nil
+      assert_nothing_raised do
+        search_buffer = BtrieveSearchBuffer.new(table, filter, fields_to_return)
+        encoded_buffer = search_buffer.get_encoded_buffer
+      end
+      assert_not_nil encoded_buffer
+    end
+    
+    should "support calls to BtrieveTable.find_extended()" do
+      table = BtrieveTable.new(:course)
+      table.open do
+        index = 0
+        filter = [[:dept_name, :equal, 'Philosophy'], :and, [:name, :not_equal, 'PHI 101'], :and, [:name, :not_equal, :dept_name]]
+        fields_to_return = table.schema[:columns].keys
+        records_to_fetch = 10
+        records = nil
+        assert_nothing_raised do
+          records = table.find_extended(index, filter, fields_to_return, records_to_fetch)
+        end
+        assert_not_nil records
+        assert_equal 6, records.size
+      end
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 2
-  version: 0.6.2
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Patrick Lardin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-21 00:00:00 -08:00
+date: 2010-12-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,11 +52,13 @@ files:
 - lib/beezwax.rb
 - lib/btrieve/btrieve_const.rb
 - lib/btrieve/btrieve_core.rb
+- lib/btrieve/btrieve_extended.rb
 - lib/btrieve/btrieve_record.rb
 - lib/btrieve/btrieve_schema.rb
 - lib/btrieve/btrieve_session.rb
 - lib/btrieve/btrieve_table.rb
 - test/btrieve/test_beezwax.rb
+- test/btrieve/test_extended_beezwax.rb
 - test/helper.rb
 has_rdoc: true
 homepage: http://github.com/plardin/beezwax
@@ -92,4 +94,5 @@ specification_version: 3
 summary: Btrieve API wrapper.
 test_files: 
 - test/btrieve/test_beezwax.rb
+- test/btrieve/test_extended_beezwax.rb
 - test/helper.rb