ackbar 0.1.0 → 0.1.1

data/CHANGELOG

@@ -1,4 +1,29 @@
+
+Version 0.1.1 - Agile Web Development with Rails... and KirbyBase
+=================================================================
+
+* Issues & Patches from Jamey Cribbs:
+  * Fixed roundtrip of AR::Schema's :datetime type to Ruby's Time objects
+  * Base.find now accepts a list of IDs given as string (i.e. "1" and not
+    the integer 1).
+  * Translating NULL is now case insensitive
+  * Fixed Base.count to handle explicit nil as a parameter
+  
+  All these issues were discovered when building the sample 'Depot' app from
+  the Pragmatic Programmers' Agile Web Development with Rails
+  (http://houseonfire.wordpress.com/2006/02/18/hello-world/)
+
+* Other issues:
+  * Time values:
+    For some reason the AR::Base tests expect Time values where just the hours
+    are given (ie. no date) is then assumed to be on Jan 1st, 2000.
+    Now if the Time conversion is failing we call string_to_dummy_time.
+  * YAML fixes for #serialize
+  * Added tests for Ruby code in conditionals and nil values in conditionals
+
+
 Version 0.1.0 - Initial Release
+===============================
 
 * Override methods in AR::Base (class and instance) to support KB CRUDs
 

data/FAQ

@@ -0,0 +1,117 @@
+= Installation and Startup
+
+=== I keep getting 'unknown adapter' exceptions when I run any of the scripts
+
+If you see something like:
+
+  /usr/lib/ruby/gems/1.8/gems/activerecord-1.13.2/lib/active_record/
+  connection_adapters/abstract/connection_specification.rb:79:in
+  `establish_connection': database configuration specifies nonexistent
+  kirbybase adapter (ActiveRecord::AdapterNotFound)
+
+You need to require 'kirbybase_adpater' *before* or *in* the +Rails::Initializer.run+
+section of the config/environment.rb file of your project.
+
+=== What do I set in database.yml?
+
+The simplest thing is to specify just the adapter and the DB path:
+
+  development:
+    adapter: kirbybase
+    database: db/dev
+
+The +database+ parameter should point to a directory in which KirbyBase will
+store the .tbl files. There are a few other parameters which will be passed to
+the +KirbyBase.new+ method, but these are untested.
+
+= Usage
+
+=== How do I use code blocks?
+
+You can specify Ruby code blocks instead of SQL fragments to the +find+ method
+(and +count+, +delete_all+ and +update_all+ methods) like so:
+  Book.find :all, :conditions => lambda{|rec| rec.title =~ /ruby/i}
+
+Things to watch out for:
+* The code is run against the KirbyBase row (struct) and not against the Rails
+  ActiveRecord::Base object.
+* If you want to do multi-db development you have to wrap this with the 
+  appropriate checks (+ActiveRecord::Base.connection.adapter_name == 'KirbyBase'+).
+
+=== Is there a big difference between code blocks and translating SQL fragments?
+
+We haven't tested relative performance. These are the considerations for each
+approach:
+
+==== Code Blocks
+* Are more Rubyish
+* Are always correct
+* SQL's LIKE operator isn't supported, so you'd have to use blocks and regexps
+* They don't play as nice with multi-dbs
+* Are run against the KirbyBase row (struct), not the ActiveRecord object
+
+==== SQL Fragments
+* Are a better fir for Rails
+* Are easier to handle in multi-db projects (no ugly +if+s)
+* Are translated, and there's always a chance of something getting missed
+* Don't support SQL's LIKE operator
+
+=== Are there more online places I can read about Ackbar/KirbyBase on Rails?
+
+Sure. 
+
+==== Official sites with docos: 
+Ackbar: http://ackbar.rubyforge.org
+
+KirbyBase: http://netpromi.com/kirbybase_ruby.html
+
+==== Blogs:
+Assaph's blog: http://www.bloglines.com/blog/AssaphMehr
+
+Jamey's Blog: http://houseonfire.wordpress.com
+
+==== Sample projects:
+Jamey's blog has a run of the Depot sample app from Agile Web Development with 
+Rails. Pimki (http://pimki.rubyforge.org) is currently undergoing extreme
+makeover to run on both KirbyBase and SQLite.
+
+= Multi Database Development
+
+=== Can I use KirbyBase for some tables and an SQL dbms for others?
+
+No. To work with KB, the adapter overrides certain methods
+in ActiveRecords::Base and the various Associations to bypass SQL generation.
+These make it not work with other databases.
+
+=== Where do I start?
+
+You should make sure you require +kirbybase_adapter+ *only if using KirbyBase*.
+This is important because of the reasons stated above. You should require the 
+adapter when you know it's going to be used, but before the +establish_connection+
+call, i.e. *inside* the +Rails::Initializer.run+ call. You should also create
+a different +database.yml+ file. For example:
+
+  if ENV['SQLITE3']
+    config.database_configuration_file = 'config/sqlite3_db.yml'
+  else
+    config.database_configuration_file = 'config/kirbybase_db.yml'
+    require 'kirbybase_adapter'
+  end
+
+=== What's the comparable method to MySQL's +now+ / Oracle's +sysdate+ calls?
+
+Use +Time.now+ or +Date.today+. For example, change:
+   :conditions => "date_available <= now()"
+to:
+   :conditions => "date_available <= Time.now"
+
+=== I want to support multiple databases, how do I still do the above?
+
+Define a +now+ method for +Object+:
+
+  class Object
+    def now() Time.now() end
+  end
+
+Now, depending on who is evaluating the conditions (MySQL or KirbyBase),
+different functions will be called... but give the same results.

data/README

@@ -11,6 +11,8 @@ Ackbar: http://ackbar.rubyforge.org
 
 KirbyBase: http://www.netpromi.com/kirbybase_ruby.html
 
+Building a sample app with Rails/KirbyBase: http://houseonfire.wordpress.com/2006/02/18/hello-world/
+
 Rails: http://www.rubyonrails.com
 
 Pimki: http://pimki.rubyforge.org
@@ -32,7 +34,7 @@ a Rails project for end-user distribution.
 = What's Covered
 
 Ackbar currently passes through a small bootstrap test suite, and through about
-80% of the ActiveRecord test suite. I will never pass 100% of the tests because
+80% of the ActiveRecord test suite. It will never pass 100% of the tests because
 KirbyBase does not support all required functionality.
 
 Ackbar includes a SQL fragment translator, so that simple cross-database code 
@@ -44,9 +46,10 @@ Additionally, you can also provide blocks:
 or even:
   Book.find(:all) {|rec| rec.name == 'Pickaxe'}
 
-Most of these changes are around the #find method, bit some apply to #update and
-associations. Basic SQL translation should work the same, but you can always 
-provide custom code to be used. See the CHANGELOG and the tests for examples.
+Most of these changes are around the #find method for the :conditions parameter,
+but some apply to #update and associations. Basic SQL translation should work
+the same, but you can always provide custom code to be used. See the CHANGELOG
+and the tests for examples.
 
 
 = What's Not Covered
@@ -54,7 +57,8 @@ provide custom code to be used. See the CHANGELOG and the tests for examples.
 * Transactions
 * Joins, and therefore Eager Associations
 * Mixins
-* Other plugins
+* All the *_by_sql methods
+* Other plugins that do custom SQL
 
 On the todo list is support for mixins. It might even be possible to rig something
 to simulate joins and eager associations, but that is for a later stage. Transactions
@@ -86,3 +90,7 @@ This is because Ackbar overrides certain methods in ActiveRecord::Base and other
 These methods translate the standard SQL generation to method calls on KirbyBase,
 and obviously should not be overridden for regular DBs.
 
+See the FAQ file for more information. Additional information can be found on
+Jamey Cribbs blog on building through the Agile Web Development with Rails Depot
+application with Ackbar/KirbyBase at: http://houseonfire.wordpress.com/
+

data/Rakefile

@@ -11,7 +11,7 @@ task :default => [:basic_tests, :ar_tests]
 desc 'Run the unit tests in test directory'
 Rake::TestTask.new('basic_tests') do |t|
   t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.pattern = 'test/*_test.rb'
   t.verbose = true
 end
 
@@ -22,11 +22,11 @@ Rake::TestTask.new('ar_tests') do |t|
   t.verbose = true
 end
 
-
+require 'kirbybase_adapter'
 ackbar_spec = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name = 'ackbar'
-  s.version = "0.1.0"
+  s.version = ActiveRecord::ConnectionAdapters::KirbyBaseAdapter::VERSION
   s.summary = "ActiveRecord KirbyBase Adapter"
   s.description = %q{An adapter for Rails::ActiveRecord ORM to the KirbyBase pure-ruby DBMS}
 
@@ -36,7 +36,7 @@ ackbar_spec = Gem::Specification.new do |s|
   s.homepage = 'http://ackbar.rubyforge.org'
 
   s.has_rdoc = true
-  s.extra_rdoc_files = %W{README CHANGELOG TODO}
+  s.extra_rdoc_files = %W{README CHANGELOG TODO FAQ}
   s.rdoc_options << '--title' << 'Ackbar -- ActiveRecord Adapter for KirbyBase' <<
                     '--main'  << 'README' <<
                     '--exclude' << 'test' <<
@@ -51,6 +51,7 @@ ackbar_spec = Gem::Specification.new do |s|
     kirbybase_adapter.rb
     Rakefile
     CHANGELOG
+    FAQ
     README
     TODO
     test/00*.rb

data/TODO

@@ -7,6 +7,8 @@ Short Term:
 
 Mid Term:
 * Get the mixins working
+* Run KirbyBase in client/server mode
+* Run through a real web server with FCGI/SCGI etc.
 
 Long Term:
 * Use KB indexes if they exist

data/kirbybase_adapter.rb

@@ -42,7 +42,7 @@ module ActiveRecord
       def initialize(name, default, sql_type = nil, null = true)
         super
         @name = (name == 'recno' ? 'id' : @name)
-        @text = [:string, :text, 'yaml'].include? @type
+        @text = [:string, :text, :yaml].include? @type
       end
 
       def simplified_type(field_type)
@@ -56,7 +56,7 @@ module ActiveRecord
           when /timestamp/i
             :timestamp
           when /time/i
-            :time
+            :datetime
           when /date/i
             :date
           when /clob/i, /text/i
@@ -67,10 +67,16 @@ module ActiveRecord
             :string
           when /boolean/i
             :boolean
+          when /yaml/i
+            :yaml
           else
-            field_type
+            field_type.to_sym
         end
       end
+
+      def self.string_to_time(string)
+        super or string_to_dummy_time(string)
+      end
     end
 
     # The KirbyBase adapter does not need a "db driver", as KirbyBase is a
@@ -88,7 +94,7 @@ module ActiveRecord
     class KirbyBaseAdapter < AbstractAdapter
 
       # Ackbar's own version - i.e. the adapter version, not KirbyBase or Rails.
-      VERSION = '0.1.0'
+      VERSION = '0.1.1'
 
       attr_accessor :db
 
@@ -125,7 +131,7 @@ module ActiveRecord
           :date        => { :DataType => :Date },
           :binary      => { :DataType => :String },  # are KBBlobs better?
           :boolean     => { :DataType => :Boolean },
-          :YAML        => { :DataType => :YAML }
+          :yaml        => { :DataType => :YAML }
         }
       end
 
@@ -472,10 +478,10 @@ module ActiveRecord
         records
       else
         return args.first if args.first.kind_of?(Array) && args.first.empty?
-        raise RecordNotFound, "Expecting a list of IDs!" unless args.flatten.all?{|i| i.is_a? Numeric}
+        raise RecordNotFound, "Expecting a list of IDs!" unless args.flatten.all?{|i| i.is_a?(Numeric) || (i.is_a?(String) && i.match(/^\d+$/)) }
 
         expects_array = ( args.is_a?(Array) and args.first.kind_of?(Array) )
-        ids = args.flatten.compact.uniq
+        ids = args.flatten.compact.collect{ |i| i.to_i }.uniq
 
         records = filter ?
                     table.select_by_recno_index(*filter) { |r| ids.include?(r.recno) } :
@@ -633,9 +639,9 @@ module ActiveRecord
       [/(\w+)\s+IN\s+/,        'rec.\1.in'],
       [/\.id(\W)/i,            '.recno\1'],
       ['<>',                   '!='],
-      ['NULL',                 'nil'],
-      ['AND',                  'and'],
-      ['OR',                   'or'],
+      [/\bNULL\b/i,            'nil'],
+      [/\bAND\b/i,             'and'],
+      [/\bOR\b/i,              'or'],
       ["'%s'",                 '?'],
       ['%d',                   '?'],
       [/:\w+/,                 '?'],
@@ -653,7 +659,7 @@ module ActiveRecord
     # May also be called with a block, e.g.:
     #   Book.count {|rec| rec.author_id == @author.id}
     def self.count(*args)
-      if args.empty?
+      if args.compact.empty?
         if block_given?
           find(:all, :conditions => Proc.new).size
         else
@@ -689,7 +695,7 @@ module ActiveRecord
       # in the database.
       def serialize(attr_name, class_name = Object)
         __before_ackbar_serialize(attr_name, class_name)
-        connection.change_column(table_name, attr_name, :YAML)
+        connection.change_column(table_name, attr_name, :yaml)
       end
     end
   end

data/test/kb_basics_test.rb

@@ -78,6 +78,9 @@ class KBBasicsTest < Test::Unit::TestCase
     assert_equal [@andy, @dave], Author.find([1,2])
     pickaxe_id = $db.get_table(:books).select[0].recno
     assert_equal @pickaxe, Book.find_by_id(pickaxe_id)
+
+    assert_equal @andy, Author.find('1')
+    assert_equal [@andy, @dave], Author.find('1','2')
   end
 
   def test_find_with_sql_fragments
@@ -201,4 +204,69 @@ class KBBasicsTest < Test::Unit::TestCase
     Author.decrement_counter 'num_books', [1, 2]
     assert_equal [0, 1], tbl.select.map{|r| r.num_books}
   end
+
+  def test_count
+    assert_equal 2, Author.count
+    assert_equal 1, Author.count {|rec| rec.name =~ /Andy/}
+    assert_equal 1, Author.count("name = 'Dave Thomas'")
+    assert_equal 1, Author.count(["name = ?", 'Dave Thomas'])
+    assert_equal 2, Author.count(nil)
+  end
+
+  def test_ruby_code_in_conditionals
+    DateAndTimeTests.table.insert( Date.new(2005, 1, 1), 1.day.ago )
+    records = []
+    
+    assert_nothing_raised { records = DateAndTimeTests.find :all, :conditions => 'date_value > Date.today' }
+    assert_equal 0, records.length
+    
+    assert_nothing_raised { records = DateAndTimeTests.find :all, :conditions => 'date_value > Date.new(2004-1-1)' }
+    assert_equal 1, records.length
+    
+    assert_nothing_raised { records = DateAndTimeTests.find :all, :conditions => 'time_value > Time.now' }
+    assert_equal 0, records.length
+    
+    assert_nothing_raised { records = DateAndTimeTests.find :all, :conditions => 'time_value < Time.now' }
+    assert_equal 1, records.length
+
+    class << Object
+      def now() Time.now end
+    end
+
+    assert_nothing_raised { records = DateAndTimeTests.find :all, :conditions => 'time_value > now' }
+    assert_equal 0, records.length
+    
+    assert_nothing_raised { records = DateAndTimeTests.find :all, :conditions => 'time_value < now' }
+    assert_equal 1, records.length
+
+  end
+
+  def test_nil_values
+    NilTest.table.insert(nil, 100)
+    records = []
+
+    assert_nothing_raised { records = NilTest.find :all, :conditions => lambda{|rec| rec.nil_value > 100} }
+    assert_equal 0, records.length
+
+    assert_nothing_raised { records = NilTest.find :all, :conditions => lambda{|rec| rec.nil_value > 100 and rec.conditional > 100} }
+    assert_equal 0, records.length
+
+    assert_nothing_raised { records = NilTest.find :all, :conditions => lambda{|rec| rec.nil_value > 100 or rec.conditional == 100} }
+    assert_equal 1, records.length
+
+    assert_nothing_raised { records = NilTest.find :all, :conditions => 'nil_value > 100' }
+    assert_equal 0, records.length
+
+    assert_nothing_raised { records = NilTest.find :all, :conditions => 'nil_value > 100 and conditional > 100' }
+    assert_equal 0, records.length
+
+    assert_nothing_raised { records = NilTest.find :all, :conditions => 'nil_value > 100 and conditional = 100' }
+    assert_equal 0, records.length
+
+    assert_nothing_raised { records = NilTest.find :all, :conditions => 'nil_value > 100 or conditional = 100' }
+    assert_equal 1, records.length
+
+    assert_nothing_raised { records = NilTest.find :all, :conditions => 'nil_value > 100 or conditional > 100' }
+    assert_equal 0, records.length
+  end
 end

data/test/kb_schema_test.rb

@@ -15,7 +15,7 @@ class KBSchemaTest < Test::Unit::TestCase
     recreate_kb_database(true)
 
     # check that all tables are in:
-    assert_equal [:authors, :authors_books, :books, :errata, :pages, :primary_key_tests, :publishers, :schema_info], 
+    assert_equal [:authors, :authors_books, :books, :date_and_time_tests, :errata, :nil_tests, :pages, :primary_key_tests, :publishers, :schema_info], 
                  $db.tables.sort_by{|t| t.to_s }
     assert_equal $db.tables.map{|t| t.to_s}, @adapter.tables
 

data/test/model.rb

@@ -24,4 +24,10 @@ end
 
 class PrimaryKeyTest < ActiveRecord::Base
   set_primary_key :pk
+end
+
+class NilTest < ActiveRecord::Base
+end
+
+class DateAndTimeTests < ActiveRecord::Base
 end

data/test/schema.rb

@@ -38,4 +38,13 @@ ActiveRecord::Schema.define() do
     t.column 'name', :string
   end
   
+  create_table :nil_tests, :force => true do |t|
+    t.column :nil_value, :integer
+    t.column :conditional, :integer
+  end
+
+  create_table :date_and_time_tests, :force => true do |t|
+    t.column :date_value, :date
+    t.column :time_value, :time
+  end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: ackbar
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2006-02-15
+  version: 0.1.1
+date: 2006-03-19
 summary: ActiveRecord KirbyBase Adapter
 require_paths: 
   - "."
@@ -30,6 +30,7 @@ files:
   - kirbybase_adapter.rb
   - Rakefile
   - CHANGELOG
+  - FAQ
   - README
   - TODO
   - test/001_schema_migration_test.rb
@@ -63,6 +64,7 @@ extra_rdoc_files:
   - README
   - CHANGELOG
   - TODO
+  - FAQ
 executables: []
 extensions: []
 requirements: []