KirbyBase 2.5.2 → 2.6

data/README

@@ -1,4 +1,4 @@
-= KirbyBase 2.5.2
+= KirbyBase 2.6
 
 A small, plain-text, dbms written in Ruby.  It can be used either embedded 
 or client/server.  
@@ -31,12 +31,6 @@ See the examples directory for examples of how to use KirbyBase.
 * images directory - images used in manual.
 
 
-== Warning
-
-KirbyBase defines #method_missing for NilClass.  This might bite you in the
-butt if you override NilClass.method_missing yourself.
-
-
 == Author
 
 Written in 2005 by Jamey Cribbs <mailto:jcribbs@twmi.rr.com>
@@ -66,7 +60,7 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 Please send any bug reports, suggestions, ideas,
 improvements, to:
 
-jcribbs@twmi.rr.com
+jcribbs@netpromi.com
 
 == Home Page
 

data/changes.txt

@@ -1,3 +1,18 @@
+2006-06-27:: Version 2.6
+* Removed NilClass#method_missing.  I have replaced it with a new class
+  called KBNilClass.  Thanks to a host of people for help on this,
+  including:  Assaph Mehr, James Edward Gray II, Matthew Desmarais,
+  Logan Capaldo, Trans, John Carter, Dave Burt and anyone else I missed.
+* Added conditional require logic so that KirbyBase will use FasterCVS if
+  it is available.  Thanks to James Edward Gray II for this.
+* You can now delay index creation in local mode.  Thanks to Nicholas Rahn
+  for this.
+* Added ability to allow for a custom record class with no kb_create or
+  kb_defaults methods.  KirbyBase will return each result record as an
+  instance of the custom record class, and will attempt to set attributes
+  with the same names as the table's field names equal to the values of
+  the table record's fields.  Thanks to Hal Fulton for this idea.
+
 2005-12-30:: Version 2.5.2
 * Changed the behavior of KBTable#insert method.  If user specifies nil
   for a field value and there is a default value for that field, the

data/examples/aaa_try_this_first/kbtest.rb

@@ -83,6 +83,7 @@ plane_tbl.insert('P-39', 'USA', 'Fighter', nil, nil,
  nil, false)
 plane_tbl.insert('Zero', 'Japan', 'Fighter', 377, 912,
  Date.new(1937,5,15), true)
+plane_tbl.insert('B-25', 'USA', '', 320, 1340, Date.new(1940,4,4), true)
 
 #--------------------- Update Examples -------------------------------------
 # Four different ways to update existing data in KirbyBase.  In all three
@@ -195,6 +196,37 @@ puts plane_tbl.select { |r|
     r.country == plane_tbl.select { |x| x.name == 'Zero' }.first.country
 }
 
+#-------------------------- Select Example 11 -------------------------------
+print_divider('Select Example 11')
+# Select all planes.
+plane_tbl.select.each { |r| puts r }
+
+#-------------------------- Select Example 12 -------------------------------
+print_divider('Select Example 12')
+# Select all planes with a speed of nil.
+
+#**************** Note:  This example also demonstrates the change from
+# nil to kb_nil for KirbyBase's internal representation of a nil value.  You
+# should only encounter this different if you have to check for nil in your
+# query, as this example does.  Other than that, everything else should
+# be transparent, since KirbyBase converts a kb_nil back into a nil when it
+# returns a query's result set.
+#***************
+plane_tbl.select { |r| r.speed.kb_nil? }.each { |r| puts r }
+
+#-------------------------- Select Example 13 -------------------------------
+print_divider('Select Example 13')
+# Same thing, but in a slightly different way.
+
+#**************** Note:  This example also demonstrates the change from
+# nil to kb_nil for KirbyBase's internal representation of a nil value.  You
+# should only encounter this different if you have to check for nil in your
+# query, as this example does.  Other than that, everything else should
+# be transparent, since KirbyBase converts a kb_nil back into a nil when it
+# returns a query's result set.
+#***************
+plane_tbl.select { |r| r.speed == kb_nil }.each { |r| puts r }
+
 #-------------------------- Misc. Methods Examples -------------------------
 print_divider('Misc. Methods Examples')
 puts 'Total # of records in table: %d' % plane_tbl.total_recs

data/examples/indexes_test/index_test.rb

@@ -37,18 +37,23 @@ address_book_tbl = db.create_table(:address_book,
  :street_address, :String,
  :city, :String,
  :phone, :String,
- :category, {:DataType=>:String, :Index=>2}
+ :category, {:DataType=>:String, :Index=>2},
+ :age, {:DataType=>:Integer, :Index=>3}
 )
 
 # Insert some contact info records.
 address_book_tbl.insert('Bruce', 'Wayne', '1234 Bat Cave', 'Gotham City',
- '111-111-1111', 'Super Hero')
+ '111-111-1111', 'Super Hero', 39)
 address_book_tbl.insert('Bugs', 'Bunny', '1234 Rabbit Hole', 'The Forest',
- '222-222-2222', 'Cartoon Character')
+ '222-222-2222', 'Cartoon Character', 12)
 address_book_tbl.insert('George', 'Bush', '1600 Pennsylvania Ave',
- 'Washington', '333-333-3333', 'President')
+ 'Washington', '333-333-3333', 'President', 2)
 address_book_tbl.insert('Silver', 'Surfer', '1234 Galaxy Way',
- 'Any City', '444-444-4444', 'Super Hero')
+ 'Any City', '444-444-4444', 'Super Hero', 199)
+address_book_tbl.insert('John', 'Doe', '1234 Robin Lane', 'Detroit',
+ '999-999-9999', nil, 54)
+address_book_tbl.insert(nil, 'NoFirstName', 'Nowhere Road', 'Notown',
+ '000-000-0000', 'Nothing', nil)
 
 # Select all super heros without using the index.
 address_book_tbl.select { |r| r.category == 'Super Hero' }.each { |r|
@@ -68,4 +73,22 @@ address_book_tbl.select_by_firstname_lastname_index { |r|
     r.firstname == 'Bugs' and r.lastname == 'Bunny'
 }.each { |r| puts '%s %s %s' % [r.firstname, r.lastname, r.phone] }
 
+puts;puts
+# Select the guy with no first name using the firstname+lastname index.
+address_book_tbl.select_by_firstname_lastname_index { |r|
+    r.lastname == 'NoFirstName'
+}.each { |r| puts '%s %s %s' % [r.firstname, r.lastname, r.phone] }
+
+puts;puts
+# Select the guy with no first name using the firstname+lastname index.
+# This time we will explicitly say firstname should be nil
+address_book_tbl.select_by_firstname_lastname_index { |r|
+    r.firstname.nil? and r.lastname == 'NoFirstName'
+}.each { |r| puts '%s %s %s' % [r.firstname, r.lastname, r.phone] }
+
+puts;puts
+address_book_tbl.select_by_age_index { |r| r.age > 30 }.each { |r|
+ puts '%s %s %d' % [r.firstname, r.lastname, r.age] }
+ 
+puts;puts
 p address_book_tbl.field_indexes

data/examples/record_class_test/record_class_test2.rb

@@ -0,0 +1,38 @@
+#Test of returning result set composed of instances of user class.  This
+#example differs from the first in that there is no kb_create method, so
+#KirbyBase will default to create a new instance of the record's custom
+#class and setting each instance attribute to each field's value.
+
+require 'kirbybase'
+
+class Foobar
+    attr_accessor(:recno, :name, :country, :role, :speed, :range,
+     :began_service, :still_flying)
+end 
+        
+# To run local, single-user, uncomment next line.
+db = KirbyBase.new 
+
+# If table exists, delete it.
+db.drop_table(:plane) if db.table_exists?(:plane)
+
+# Create a table.  Notice how you set record_class equal to your class.
+plane_tbl = db.create_table do |t|
+    t.name = :plane
+    t.field_defs = [:name, :String, :country, :String, :role, :String, 
+     :speed, :Integer, :range, :Integer, :began_service, :Date, 
+     :still_flying, :Boolean]
+    t.encrypt = false
+    t.record_class = Foobar
+end 
+
+plane_tbl = db.get_table(:plane)
+
+# Insert a record.
+plane_tbl.insert('Spitfire','Great Britain','Fighter',333,454,
+ Date.new(1936, 1, 1),true)
+
+# Notice how select returns instances of Foobar, even there is no 
+# kb_create method.
+recs = plane_tbl.select
+p recs.first

data/examples/yaml_field_test/yaml_field_test.rb

@@ -25,7 +25,7 @@ pet_tbl.insert('Kirby', 'dog', Date.new(2002, 06, 01),
 pet_tbl.insert('Mojo', 'cat', Date.new(2000, 04, 01),
  ['cute', 'soft', '6', 12.25])
 pet_tbl.insert('Goldy', 'fish', Date.new(2004, 10, 10),
- nil)
+ [])
 
 pet_tbl.select.each { |r|
     puts '%s %s' % [r.name, r.characteristics[1]]

data/kirbybaserubymanual.html

@@ -261,8 +261,8 @@ div.exampleblock-content {
 <div id="header">
 <h1>KirbyBase Manual (Ruby Version)</h1>
 <span id="author">Jamey Cribbs</span><br />
-<span id="email"><tt>&lt;<a href="mailto:jcribbs@twmi.rr.com">jcribbs@twmi.rr.com</a>&gt;</tt></span><br />
-v2.5.2 December 2005
+<span id="email"><tt>&lt;<a href="mailto:jcribbs@netpromi.com">jcribbs@netpromi.com</a>&gt;</tt></span><br />
+v2.6 June 2006
 </div>
 <div id="preamble">
 <div class="sectionbody">
@@ -270,7 +270,7 @@ v2.5.2 December 2005
 <div class="content">
 <img src="images/kirby1.jpg" alt="images/kirby1.jpg"/>
 </div>
-<div class="image-title">Figure: Kirby pictured here in attack mode.</div>
+<div class="image-title">Figure: Kirby, pictured here in attack mode.</div>
 </div>
 </div>
 </div>
@@ -386,6 +386,11 @@ v2.5.2 December 2005
 <a href="#selects-involving-lookups-or-link-manys">Selects involving Lookups or Link_manys</a>
 </p>
 </li>
+<li>
+<p>
+<a href="#a-note-about-nil-values">A note about nil values</a>
+</p>
+</li>
 </ol>
 </li>
 <li>
@@ -708,9 +713,10 @@ MySQL.</p>
 <div class="sidebarblock">
 <div class="sidebar-content">
 <div class="sidebar-title">Drop me a line!</div>
-<p>If you find a use for KirbyBase, please send an email
-telling me how you use it. I find that hearing how people have
-put KirbyBase to use is one of the biggest rewards I get for working on it.</p>
+<p>If you find a use for KirbyBase, please send me an email telling how you
+use it, whether it is ok for me to mention your application on the
+"KirbyBase Applications" webpage, and possibly a link to your application's
+webpage (if you have one).</p>
 </div></div>
 </div>
 <h2><a id="connecting-to-a-database"></a>Connecting to a database</h2>
@@ -750,14 +756,14 @@ a different extension, pass this as an argument, like so:</p>
 memo/blob files, you need to pass the location as an argument, like so:</p>
 <div class="listingblock">
 <div class="content">
-<pre><tt>db = KirbyBase.new(:local, nil, './', '.tbl', './memos')</tt></pre>
+<pre><tt>db = KirbyBase.new(:local, nil, nil, './', '.tbl', './memos')</tt></pre>
 </div></div>
 <p>If you don't want KirbyBase to spend time initially creating all of the
 indexes for the tables in the database, you can pass true as the
 delay_index_creation argument:</p>
 <div class="listingblock">
 <div class="content">
-<pre><tt>db = KirbyBase.new(:local, nil, './', '.tbl', './', true)</tt></pre>
+<pre><tt>db = KirbyBase.new(:local, nil, nil, './', '.tbl', './', true)</tt></pre>
 </div></div>
 <p>KirbyBase will skip initial index creation and will create a table's
 indexes when the table is first referenced.</p>
@@ -828,8 +834,12 @@ end</tt></pre>
 <p>You can also specify that you want records of the table to be returned to
 you as instances of a class. To do this, simply define a class before you
 call #create_table. This class needs to have an accessor for each fieldname
-in the table. Also, this class needs to have a class method, called
-#kb_create, that returns a new class instance. Here is an example class:</p>
+in the table.</p>
+<p>If this class has a class method, called #kb_create, KirbyBase, when
+creating each record of the result set, will call that method and pass it
+the field values of the result record.  #kb_create will need to handle
+creating an instance of the record class itself.</p>
+<p>Here is an example of #kb_create in action:</p>
 <div class="listingblock">
 <div class="content">
 <pre><tt>class Foobar
@@ -870,6 +880,8 @@ end</tt></pre>
 Foobar, instead of the default, which is instances of Struct. This also
 works the other way. You can now specify instances of Foobar as input to
 the #insert, #update and #set methods. More on those methods below.</p>
+<p>If the custom record class does not respond to #kb_create, KirbyBase will
+call the class's #new method instead, passing it all of the field values.</p>
 <div class="sidebarblock">
 <div class="sidebar-content">
 <div class="admonitionblock">
@@ -1372,6 +1384,35 @@ result.items.each { |item| puts '%d %d' % [item.item_no, item.qty] }</tt></pre>
 <p>Notice how the items attribute in the ResultSet is itself a ResultSet
 containing all of the :order_items records that belong to the selected
 order.</p>
+<h3><a id="a-note-about-nil-values"></a>A Note About nil Values</h3>
+<p>Beginning in version 2.6 of KirbyBase, nil values are no longer stored as
+the singleton instance of NilClass in the database.  Now, they are stored
+as references to the singleton instance, kb_nil, of KBNilClass.  KBNilClass
+is as similar to NilClass as possible, but since NilClass cannot
+be sub-classed, there are a few minor differences.</p>
+<p>However, this should all be transparent to you because KirbyBase converts
+kb_nil values to Ruby nil values before returning the results of a query.
+The only time you will need to be worried about kb_nil is when you need to
+explicitly test for a nil value in a query.  For example:</p>
+<div class="listingblock">
+<div class="content">
+<pre><tt>plane_tbl.select {|r| r.speed == kb_nil}</tt></pre>
+</div></div>
+<p>which is the same as:</p>
+<div class="listingblock">
+<div class="content">
+<pre><tt>plane_tbl.select {|r| r.speed.kb_nil?}</tt></pre>
+</div></div>
+<p>Notice how it is very similar to how you would test for nil?</p>
+<p>The only other difference you will now notice, is if you open up a table in
+a text editor.  Now, nil values are stored as "kb_nil", instead of being
+stored as an empty string (i.e. "").  This has the added advantage that
+KirbyBase can now distinguish between empty strings and nil values.  In the
+past, if you saved an empty string as a field value, the next time you
+selected that record, KirbyBase would return that field's value as nil.</p>
+<p>The main reason for making this change was to eliminate the need to
+override NilClass#method_missing, which was cause for concern for some
+users.</p>
 </div>
 <h2><a id="kbresultset"></a>KBResultSet</h2>
 <div class="sectionbody">
@@ -1677,6 +1718,14 @@ lines:</p>
 <div class="content">
 <pre><tt>result = plane_tbl.pack</tt></pre>
 </div></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/important.png" alt="Important" />
+</td>
+<td class="content">You can only call this method when connect_type==:local.</td>
+</tr></table>
+</div>
 <div class="sidebarblock">
 <div class="sidebar-content">
 <div class="admonitionblock">
@@ -1854,6 +1903,8 @@ than one recno.</p>
 KirbyBase will attempt to convert the values in the csv file into their
 corresponding KirbyBase field types, based upon the field types you
 designated when you created the table.</p>
+<p>If you have FasterCSV installed KirbyBase will use it instead of CSV from
+the standard library.</p>
 <p>Returns an Integer specifying the total number of records imported.</p>
 </div></div>
 <div class="sidebarblock">
@@ -2165,10 +2216,10 @@ text-file. Here is an example:</p>
 first field in the header is the record counter. It is incremented by
 KirbyBase to create new record numbers when records are inserted.</p>
 <p>The second field in the header is the deleted-records counter. Every time a
-line in the file is blanked-out (see "The pack method"), this number is
-incremented. You can use this field in a maintenance script so that the
-table is packed whenever the deleted-records counter reaches, say, 5,000
-records.</p>
+line in the file is blanked-out (see <a href="#pack-method">The pack method</a>), this
+number is incremented. You can use this field in a maintenance script so
+that the table is packed whenever the deleted-records counter reaches, say,
+5,000 records.</p>
 <p>The third field in the header is the record_class field. If you specified a
 class when you created the table, its name will show up here and records
 returned from a #select will be instances of this class. The default is
@@ -2266,7 +2317,7 @@ an Array like all of the regular indexes.  So selects are even faster.</p>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 30-Dec-2005 10:16:41 Eastern Daylight Time
+Last updated 26-Jun-2006 14:36:38 EDT
 </div>
 </div>
 </body>

data/lib/kirbybase.rb

@@ -1,9 +1,14 @@
 require 'date'
 require 'time'
 require 'drb'
-require 'csv'
 require 'fileutils'
 require 'yaml'
+
+begin             # first choice--for speed
+  require 'faster_csv'
+rescue LoadError  # second choice--slower but standard
+  require 'csv'
+end
 
 #
 # :main:KirbyBase
@@ -152,11 +157,32 @@ require 'yaml'
 #   field, the default value will no longer override the user specified nil
 #   value.  Thanks to Assaph Mehr for suggesting this.
 #
+# 2006-06-27:: Version 2.6
+# * Removed NilClass#method_missing.  I have replaced it with a new class
+#   called KBNilClass.  Thanks to a host of people for help on this,
+#   including:  Assaph Mehr, James Edward Gray II, Matthew Desmarais,
+#   Logan Capaldo, Trans, John Carter, Dave Burt and anyone else I missed.
+# * Added conditional require logic so that KirbyBase will use FasterCVS if
+#   it is available.  Thanks to James Edward Gray II for this.
+# * You can now delay index creation in local mode.  Thanks to Nicholas Rahn
+#   for this.
+# * Added ability to allow for a custom record class with no kb_create or
+#   kb_defaults methods.  KirbyBase will return each result record as an
+#   instance of the custom record class, and will attempt to set attributes
+#   with the same names as the table's field names equal to the values of
+#   the table record's fields.  Thanks to Hal Fulton for this idea.
 #
 #---------------------------------------------------------------------------
 # KBTypeConversionsMixin
 #---------------------------------------------------------------------------
 module KBTypeConversionsMixin
+    # Constant that will represent a kb_nil in the physical table file.
+    # If you think you might need to write the value 'kb_nil' to a field
+    # yourself, comment out the following line and un-comment the line
+    # below that to use an alternative representation for kb_nil.
+    KB_NIL = 'kb_nil'
+    #KB_NIL = '&kb_nil;'
+
     # Regular expression used to determine if field needs to be un-encoded.
     UNENCODE_RE = /&(?:amp|linefeed|carriage_return|substitute|pipe);/
 
@@ -170,7 +196,11 @@ module KBTypeConversionsMixin
     # Return value converted from storage string to native field type.
     #
     def convert_to_native_type(data_type, s)
-        return nil if s.empty? or s.nil?
+        return kb_nil if s == KB_NIL
+
+        # I added this line to keep KBTable#import_csv working after I made
+        # the kb_nil changes.
+        return nil if s.nil?
 
         case data_type
         when :String
@@ -236,6 +266,8 @@ module KBTypeConversionsMixin
     # Return value converted to encoded String object suitable for storage.
     #
     def convert_to_encoded_string(data_type, value)
+        return KB_NIL if value.nil?
+
         case data_type
         when :YAML
             y = value.to_yaml
@@ -342,7 +374,7 @@ class KirbyBase
     include DRb::DRbUndumped
     include KBTypeConversionsMixin
 
-    VERSION = "2.5.2"
+    VERSION = "2.6"
 
     attr_reader :engine
 
@@ -422,13 +454,9 @@ class KirbyBase
         # happens when the table instance is first created, I go ahead and
         # create table instances right off the bat.
         #
-        # Also, I let the server create table instances also.  This is
-        # strictly to get the indexes created, there is no other use for
-        # the table instances on the server side as they will never be used.
-        # Everything should and does go through the table instances created
-        # on the client-side.  You can turn this off by specifying true for
-        # the delay_index_creation argument.
-        if server? and @delay_index_creation
+        # You can delay index creation until the first time the index is
+        # used.
+        if @delay_index_creation
         else    
             @engine.tables.each do |tbl|
                 @table_hash[tbl] = \
@@ -2121,11 +2149,7 @@ class KBTable
 
         new_recno = @db.engine.insert_record(self, @field_names.zip(
          @field_types).collect do |fn, ft|
-            if input_rec[fn].nil?
-                ''
-            else
-                convert_to_encoded_string(ft, input_rec[fn])
-            end
+            convert_to_encoded_string(ft, input_rec[fn])
         end)
 
         # If there are any associated memo/blob fields, save their values.
@@ -2751,7 +2775,9 @@ class KBTable
         records_inserted = 0
         tbl_rec = @table_class.new(self)
 
-        CSV.open(csv_filename, 'r') do |row|
+        # read with FasterCSV if loaded, or the standard CSV otherwise
+        (defined?(FasterCSV) ? FasterCSV : CSV).foreach(csv_filename
+         ) do |row|
             tbl_rec.populate([nil] + row)
             insert(tbl_rec)
             records_inserted += 1
@@ -2923,12 +2949,12 @@ class KBTable
 
                 get_meth_upd_res_str = <<-END_OF_STRING
                 def #{field_name}_upd_res
-                    return nil
+                    return kb_nil
                 end
                 END_OF_STRING
                 set_meth_str = <<-END_OF_STRING
                 def #{field_name}=(s)
-                    @#{field_name} = nil
+                    @#{field_name} = kb_nil
                 end
                 END_OF_STRING
             end
@@ -2944,12 +2970,12 @@ class KBTable
                 END_OF_STRING
                 get_meth_upd_res_str = <<-END_OF_STRING
                 def #{field_name}_upd_res()
-                    return nil
+                    return kb_nil
                 end
                 END_OF_STRING
                 set_meth_str = <<-END_OF_STRING
                 def #{field_name}=(s)
-                    @#{field_name} = nil
+                    @#{field_name} = kb_nil
                 end
                 END_OF_STRING
             end
@@ -3081,9 +3107,17 @@ class KBTable
     # Read header record and update instance variables.
     #
     def update_header_vars
-        @encrypted, @last_rec_no, @del_ctr, @record_class, @field_names, \
-         @field_types, @field_indexes, @field_defaults, @field_requireds, \
-         @field_extras = @db.engine.get_header_vars(self)
+        @encrypted, @last_rec_no, @del_ctr, @record_class, @col_names, \
+         @col_types, @col_indexes, @col_defaults, @col_requireds, \
+         @col_extras = @db.engine.get_header_vars(self)
+
+        # These are deprecated.
+        @field_names = @col_names
+        @field_types = @col_types
+        @field_indexes = @col_indexes
+        @field_defaults = @col_defaults
+        @field_requireds = @col_requireds
+        @field_extras = @col_extras
     end
 
     #-----------------------------------------------------------------------
@@ -3118,30 +3152,51 @@ class KBTable
             result_rec = result_struct.new(*filter.collect { |f|
              tbl_rec.send("#{f}_upd_res".to_sym) })
         elsif @record_class == 'Struct'
-            result_rec = result_struct.new(*filter.collect { |f|
-             tbl_rec.send(f) })
+            result_rec = result_struct.new(*filter.collect do |f|
+                if tbl_rec.send(f).kb_nil?
+                    nil
+                else
+                    tbl_rec.send(f)
+                end
+            end)
         else
             if Object.full_const_get(@record_class).respond_to?(:kb_create)
                 result_rec = Object.full_const_get(@record_class
-                 ).kb_create(*@field_names.collect { |f|
-                     # Just a warning here:  If you specify a filter on
-                     # a select, you are only going to get those fields
-                     # you specified in the result set, EVEN IF
-                     # record_class is a custom class instead of Struct.
-                     if filter.include?(f)
-                         tbl_rec.send(f)
-                     else
-                         nil
-                     end
-                 })
+                 ).kb_create(*@field_names.collect do |f|
+                    # Just a warning here:  If you specify a filter on
+                    # a select, you are only going to get those fields
+                    # you specified in the result set, EVEN IF
+                    # record_class is a custom class instead of Struct.
+                    if filter.include?(f)
+                        if tbl_rec.send(f).kb_nil?
+                            nil
+                        else
+                            tbl_rec.send(f)
+                        end
+                    else
+                        nil
+                    end
+                end)
             elsif Object.full_const_get(@record_class).respond_to?(
              :kb_defaults)
                 result_rec = Object.full_const_get(@record_class).new(
-                 *@field_names.collect { |f|
-                     tbl_rec.send(f) || Object.full_const_get(
-                      @record_class).kb_defaults[@field_names.index(f)]
-                 }
-                )
+                 *@field_names.collect do |f|
+                    if tbl_rec.send(f).kb_nil?
+                        nil
+                    else
+                        tbl_rec.send(f) || Object.full_const_get(
+                         @record_class).kb_defaults[@field_names.index(f)]
+                    end
+                end)
+            else
+                result_rec = Object.full_const_get(@record_class).allocate
+                @field_names.each do |fn|
+                    if tbl_rec.send(fn).kb_nil?
+                        result_rec.send("#{fn}=", nil)
+                    else
+                        result_rec.send("#{fn}=", tbl_rec.send(fn))
+                    end
+                end
             end
         end
 
@@ -3413,30 +3468,12 @@ class KBIndex
                 # Split the line up into fields.
                 rec = line.split('|', @col_poss.max+2)
 
-                # Create the index record by pulling out the record fields
-                # that make up this index and converting them to their
-                # native types.
-                idx_rec = []
-                @col_poss.zip(@col_types).each do |col_pos, col_type|
-                    idx_rec << convert_to_native_type(col_type,
-                     rec[col_pos])
-                end
-
-                # Were all the index fields for this record equal to NULL?
-                # Then don't add this index record to index array; skip to
-                # next record.
-                next if idx_rec.compact.empty?
-
-                # Add recno to the end of this index record.
-                idx_rec << rec.first.to_i
-
-                # Add index record to index array.
-                @idx_arr << idx_rec
+                append_new_rec_to_index_array(rec)
             end
         # Here's how we break out of the loop...
         rescue EOFError
         end
-        
+    
         @last_update = Time.new
     end
     
@@ -3444,11 +3481,7 @@ class KBIndex
     # add_index_rec
     #-----------------------------------------------------------------------
     def add_index_rec(rec)
-        @idx_arr << @col_poss.zip(@col_types).collect do |col_pos, col_type|
-            convert_to_native_type(col_type, rec[col_pos])
-         end + [rec.first.to_i]
-         
-        @last_update = Time.new 
+        @last_upddate = Time.new if append_new_rec_to_index_array(rec)
     end
 
     #-----------------------------------------------------------------------
@@ -3467,6 +3500,22 @@ class KBIndex
         delete_index_rec(rec.first.to_i)
         add_index_rec(rec)
     end
+
+    #-----------------------------------------------------------------------
+    # append_new_rec_to_index_array
+    #-----------------------------------------------------------------------
+    def append_new_rec_to_index_array(rec)
+        idx_rec = []
+        @col_poss.zip(@col_types).each do |col_pos, col_type|
+            idx_rec << convert_to_native_type(col_type, rec[col_pos])
+         end
+
+        return false if idx_rec.uniq == [kb_nil]
+
+        idx_rec << rec.first.to_i
+        @idx_arr << idx_rec
+        return true
+    end
 end
 
 
@@ -3573,7 +3622,7 @@ class KBTableRec
 
     def clear
         @tbl.field_names.each do |fn|
-            send("#{fn}=", nil)
+            send("#{fn}=", kb_nil)
         end
     end
 end
@@ -3680,6 +3729,7 @@ class KBResultSet < Array
                     y << b_value
                 end
             end
+
             x <=> y
         }
     end
@@ -3737,6 +3787,70 @@ class KBResultSet < Array
 end
 
 
+#---------------------------------------------------------------------------
+# KBNilClass
+#---------------------------------------------------------------------------
+class KBNilClass 
+    include Comparable
+
+    class << self
+        def new
+            @kb_nil ||= KBNilClass.allocate
+        end
+    end
+
+    def inspect
+        'kb_nil'
+    end
+
+    def kb_nil?
+        true
+    end
+
+    def to_s
+        ""
+    end
+
+    def to_i
+        0
+    end
+
+    def to_f
+        0.0
+    end
+
+    def to_a
+        []
+    end
+
+    def <=>(other)
+        return 0 if other.kb_nil?
+        return -1
+    end
+
+    def coerce(other)
+        return [other, to_i] if other.kind_of? Fixnum
+        return [other, to_f] if other.kind_of? Float
+
+        raise "Didn't know how to coerce kb_nil to a #{other.class}"
+    end
+
+    def method_missing(sym, *args)
+        kb_nil
+    end
+end
+
+
+#---------------------------------------------------------------------------
+# Kernel
+#---------------------------------------------------------------------------
+module Kernel
+    def kb_nil
+        KBNilClass.new
+    end
+end
+
+
 #---------------------------------------------------------------------------
 # Object
 #---------------------------------------------------------------------------
@@ -3747,33 +3861,9 @@ class Object
         list.each {|x| obj = obj.const_get(x) }
         obj
     end
-end
 
-
-#---------------------------------------------------------------------------
-# NilClass
-#---------------------------------------------------------------------------
-class NilClass
-    #-----------------------------------------------------------------------
-    # method_missing
-    #-----------------------------------------------------------------------
-    #
-    # This code is necessary because if, inside a select condition code
-    # block, there is a case where you are trying to do an expression
-    # against a table field that is equal to nil, I don't want a method
-    # missing exception to occur.  I just want the expression to be nil.  I
-    # initially had this method returning false, but then I had an issue
-    # where I had a YAML field that was supposed to hold an Array.  If the
-    # field was empty (i.e. nil) it was actually returning false when it
-    # should be returning nil.  Since nil evaluates to false, it works if I
-    # return nil.
-    # Here's an example:
-    # #select { |r| r.speed > 300 }
-    # What happens if speed is nil (basically NULL in DBMS terms)?  Without
-    # this code, an exception is going to be raised, which is not what we
-    # really want.  We really want this expression to return nil.
-    def method_missing(method_id, *stuff)
-        return nil
+    def kb_nil?
+        false
     end
 end
 
@@ -3802,3 +3892,5 @@ class Symbol
         ("+"+self.to_s).to_sym
     end
 end
+
+

data/test/tc_local_db.rb

@@ -9,7 +9,7 @@ class TestDatabaseLocal < Test::Unit::TestCase
 	include BaseTest
 
     def test_version
-        assert_equal('2.5.2', KirbyBase::VERSION)
+        assert_equal('2.6', KirbyBase::VERSION)
     end
     
 	def test_local?

data/test/tc_local_table.rb

@@ -766,5 +766,38 @@ class TestTableLocal < Test::Unit::TestCase
         tbl.update(:one => ['two', 3]) { |r| r.recno == 1 }
         assert_equal(['two', 3], tbl[1].one)
     end
+    
+    def test_nil_values_001
+        tbl = @db.create_table(:nil_tests, :nil_value, :Integer,
+         :conditional, :Integer)
+        tbl.insert(nil, 100)
+         
+        recs = []
+         
+        assert_nothing_raised {rec = tbl.select {|r| r.nil_value > 100}}
+        assert_equal 0, recs.length
+        
+        assert_nothing_raised {recs = tbl.select {|r| r.nil_value > 100 and 
+         r.conditional > 100}}
+        assert_equal 0, recs.length
+
+        assert_nothing_raised {recs = tbl.select {|r| r.nil_value > 100 or 
+         r.conditional > 100}}
+        assert_equal 0, recs.length
+
+        assert_nothing_raised {recs = tbl.select {|r| r.nil_value > 100 and 
+         r.conditional == 100}}
+        assert_equal 0, recs.length
+
+        assert_nothing_raised {recs = tbl.select {|r| r.nil_value > 100 or 
+         r.conditional == 100}}
+        assert_equal 1, recs.length
+
+        assert_nothing_raised {recs = tbl.select {|r| r.nil_value.kb_nil?}}
+        assert_equal 1, recs.length
+
+        assert_nothing_raised {recs = tbl.select {|r| r.nil_value == kb_nil}}
+        assert_equal 1, recs.length
+    end
 end
 

metadata

@@ -1,131 +1,134 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10
+rubygems_version: 0.8.11
 specification_version: 1
 name: KirbyBase
 version: !ruby/object:Gem::Version 
-  version: 2.5.2
-date: 2006-01-03
-summary: "KirbyBase is a simple, pure-Ruby, plain-text, flat-file database management
-  system."
+  version: "2.6"
+date: 2006-06-27 00:00:00 -04:00
+summary: KirbyBase is a simple, pure-Ruby, plain-text, flat-file database management system.
 require_paths: 
-  - lib
-email: jcribbs@twmi.rr.com
+- lib
+email: jcribbs@netpromi.com
 homepage: http://www.netpromi.com/kirbybase_ruby.html
 rubyforge_project: kirbybase
-description: "KirbyBase is a class that allows you to create and manipulate simple, plain-text
-  databases. You can use it in either a single-user or client-server mode. You can
-  select records for retrieval/updating using code blocks."
+description: KirbyBase is a class that allows you to create and manipulate simple, plain-text databases. You can use it in either a single-user or client-server mode. You can select records for retrieval/updating using code blocks.
 autorequire: kirbybase
 default_executable: 
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
+signing_key: 
+cert_chain: 
 authors: 
-  - Jamey Cribbs
+- Jamey Cribbs
 files: 
-  - lib/kirbybase.rb
-  - bin/kbserver.rb
-  - README
-  - changes.txt
-  - kirbybaserubymanual.html
-  - test/base_test.rb
-  - test/tc_local_db.rb
-  - test/tc_local_table.rb
-  - test/ts_local.rb
-  - examples/aaa_try_this_first
-  - examples/add_column_test
-  - examples/calculated_field_test
-  - examples/change_column_type_test
-  - examples/column_required_test
-  - examples/crosstab_test
-  - examples/csv_import_test
-  - examples/default_value_test
-  - examples/drop_column_test
-  - examples/indexes_test
-  - examples/kbserver_as_win32_service
-  - examples/link_many_test
-  - examples/lookup_field_test
-  - examples/many_to_many_test
-  - examples/memo_test
-  - examples/record_class_test
-  - examples/rename_column_test
-  - examples/rename_table_test
-  - examples/yaml_field_test
-  - examples/aaa_try_this_first/kbtest.rb
-  - examples/add_column_test/add_column_test.rb
-  - examples/calculated_field_test/calculated_field_test.rb
-  - examples/change_column_type_test/change_column_type_test.rb
-  - examples/column_required_test/column_required_test.rb
-  - examples/crosstab_test/crosstab_test.rb
-  - examples/csv_import_test/csv_import_test.rb
-  - examples/csv_import_test/plane.csv
-  - examples/default_value_test/default_value_test.rb
-  - examples/drop_column_test/drop_column_test.rb
-  - examples/indexes_test/add_index_test.rb
-  - examples/indexes_test/drop_index_test.rb
-  - examples/indexes_test/index_test.rb
-  - examples/kbserver_as_win32_service/kbserverctl.rb
-  - examples/kbserver_as_win32_service/kbserver_daemon.rb
-  - examples/link_many_test/link_many_test.rb
-  - examples/lookup_field_test/lookup_field_test.rb
-  - examples/lookup_field_test/lookup_field_test_2.rb
-  - examples/lookup_field_test/the_hal_fulton_feature_test.rb
-  - examples/many_to_many_test/many_to_many_test.rb
-  - examples/memo_test/memos
-  - examples/memo_test/memo_test.rb
-  - examples/memo_test/memos/blank.txt
-  - examples/record_class_test/record_class_test.rb
-  - examples/rename_column_test/rename_column_test.rb
-  - examples/rename_table_test/rename_table_test.rb
-  - examples/yaml_field_test/yaml_field_test.rb
-  - images/blank.png
-  - images/callouts
-  - images/caution.png
-  - images/client_server.png
-  - images/example.png
-  - images/home.png
-  - images/important.png
-  - images/kirby1.jpg
-  - images/next.png
-  - images/note.png
-  - images/prev.png
-  - images/single_user.png
-  - images/smallnew.png
-  - images/tip.png
-  - images/toc-blank.png
-  - images/toc-minus.png
-  - images/toc-plus.png
-  - images/up.png
-  - images/warning.png
-  - images/callouts/1.png
-  - images/callouts/10.png
-  - images/callouts/11.png
-  - images/callouts/12.png
-  - images/callouts/13.png
-  - images/callouts/14.png
-  - images/callouts/15.png
-  - images/callouts/2.png
-  - images/callouts/3.png
-  - images/callouts/4.png
-  - images/callouts/5.png
-  - images/callouts/6.png
-  - images/callouts/7.png
-  - images/callouts/8.png
-  - images/callouts/9.png
+- lib/kirbybase.rb
+- bin/kbserver.rb
+- README
+- changes.txt
+- kirbybaserubymanual.html
+- test/base_test.rb
+- test/tc_local_db.rb
+- test/tc_local_table.rb
+- test/ts_local.rb
+- examples/aaa_try_this_first
+- examples/add_column_test
+- examples/calculated_field_test
+- examples/change_column_type_test
+- examples/column_required_test
+- examples/crosstab_test
+- examples/csv_import_test
+- examples/default_value_test
+- examples/drop_column_test
+- examples/indexes_test
+- examples/kbserver_as_win32_service
+- examples/link_many_test
+- examples/lookup_field_test
+- examples/many_to_many_test
+- examples/memo_test
+- examples/record_class_test
+- examples/rename_column_test
+- examples/rename_table_test
+- examples/yaml_field_test
+- examples/aaa_try_this_first/kbtest.rb
+- examples/add_column_test/add_column_test.rb
+- examples/calculated_field_test/calculated_field_test.rb
+- examples/change_column_type_test/change_column_type_test.rb
+- examples/column_required_test/column_required_test.rb
+- examples/crosstab_test/crosstab_test.rb
+- examples/csv_import_test/csv_import_test.rb
+- examples/csv_import_test/plane.csv
+- examples/default_value_test/default_value_test.rb
+- examples/drop_column_test/drop_column_test.rb
+- examples/indexes_test/add_index_test.rb
+- examples/indexes_test/drop_index_test.rb
+- examples/indexes_test/index_test.rb
+- examples/kbserver_as_win32_service/kbserverctl.rb
+- examples/kbserver_as_win32_service/kbserver_daemon.rb
+- examples/link_many_test/link_many_test.rb
+- examples/lookup_field_test/lookup_field_test.rb
+- examples/lookup_field_test/lookup_field_test_2.rb
+- examples/lookup_field_test/the_hal_fulton_feature_test.rb
+- examples/many_to_many_test/many_to_many_test.rb
+- examples/memo_test/memos
+- examples/memo_test/memo_test.rb
+- examples/memo_test/memos/blank.txt
+- examples/record_class_test/record_class_test.rb
+- examples/record_class_test/record_class_test2.rb
+- examples/rename_column_test/rename_column_test.rb
+- examples/rename_table_test/rename_table_test.rb
+- examples/yaml_field_test/yaml_field_test.rb
+- images/blank.png
+- images/callouts
+- images/caution.png
+- images/client_server.png
+- images/example.png
+- images/home.png
+- images/important.png
+- images/kirby1.jpg
+- images/next.png
+- images/note.png
+- images/prev.png
+- images/single_user.png
+- images/smallnew.png
+- images/tip.png
+- images/toc-blank.png
+- images/toc-minus.png
+- images/toc-plus.png
+- images/up.png
+- images/warning.png
+- images/callouts/1.png
+- images/callouts/10.png
+- images/callouts/11.png
+- images/callouts/12.png
+- images/callouts/13.png
+- images/callouts/14.png
+- images/callouts/15.png
+- images/callouts/2.png
+- images/callouts/3.png
+- images/callouts/4.png
+- images/callouts/5.png
+- images/callouts/6.png
+- images/callouts/7.png
+- images/callouts/8.png
+- images/callouts/9.png
 test_files: 
-  - test/ts_local.rb
+- test/ts_local.rb
 rdoc_options: []
+
 extra_rdoc_files: []
+
 executables: 
-  - kbserver.rb
+- kbserver.rb
 extensions: []
+
 requirements: 
-  - none
-dependencies: []
+- none
+dependencies: []
+