m4dbi 0.7.3 → 0.8.0

data/README.rdoc

@@ -0,0 +1,39 @@
+== M4DBI - Models (and more) For DBI
+
+https://github.com/Pistos/m4dbi
+
+M4DBI is a Ruby library that provides ORM modelling to RDBI
+( https://github.com/RDBI/rdbi ).
+
+=== Dependencies
+
+  - rdbi
+    - rdbi-driver-* for your choice of DBs
+  - metaid (gem install metaid)
+  - bacon (optional, for running tests; gem install bacon)
+
+=== Installation
+
+==== Repository
+
+To use the repository version, you need git ( http://git-scm.com/ ).
+Chances are, there is a git package for your Linux/UNIX flavour.
+
+  cd /where/you/want/m4dbi
+  git clone git://github.com/Pistos/m4dbi.git
+
+=== Usage
+
+See the spec/ dir.
+
+(Somewhat out of date -- 2011-08-14)
+
+=== Source Code
+
+Browse source at http://github.com/Pistos/m4dbi .
+Very limited rdocs at http://rdoc.info/github/Pistos/m4dbi/master/frames .
+
+=== Feedback and Support
+
+On IRC: irc.freenode.net ##mathetes .
+Use http://webchat.freenode.net/?channels=mathetes if you don't have an IRC client.

data/lib/m4dbi/collection.rb

@@ -25,13 +25,15 @@ module M4DBI
     def delete( arg )
       case arg
         when @the_many_model
-          @the_many_model.dbh.execute(
+          stm = @the_many_model.dbh.prepare(
             %{
               DELETE FROM #{@the_many_model.table}
               WHERE
                 #{@the_one_fk} = ?
                 AND #{@the_many_model.pk_clause}
-            },
+            }
+          )
+          stm.execute(
             @the_one.pk,
             arg.pk
           ).affected_count > 0
@@ -41,13 +43,15 @@ module M4DBI
           where_subclause = keys.map { |k|
             "#{k} = ?"
           }.join( " AND " )
-          @the_many_model.dbh.execute(
+          stm = @the_many_model.dbh.prepare(
             %{
               DELETE FROM #{@the_many_model.table}
               WHERE
                 #{@the_one_fk} = ?
                 AND #{where_subclause}
-            },
+            }
+          )
+          stm.execute(
             @the_one.pk,
             *( keys.map { |k| hash[ k ] } )
           ).affected_count
@@ -56,13 +60,13 @@ module M4DBI
 
     # Returns the number of records deleted
     def clear
-      @the_many_model.dbh.execute(
+      stm = @the_many_model.dbh.prepare(
         %{
           DELETE FROM #{@the_many_model.table}
           WHERE #{@the_one_fk} = ?
-        },
-        @the_one.pk
-      ).affected_count
+        }
+      )
+      stm.execute( @the_one.pk ).affected_count
     end
   end
-end
+end

data/lib/m4dbi/database.rb

@@ -6,6 +6,10 @@ module M4DBI
       @dbh = rdbi_dbh
     end
 
+    def prepare( *args )
+      Statement.new( @dbh.prepare(*args) )
+    end
+
     def execute( *args )
       @dbh.execute *args
     end

data/lib/m4dbi/model.rb

@@ -2,12 +2,16 @@ module M4DBI
   class Model
     #attr_reader :row
     ancestral_trait_reader :dbh, :table
-    ancestral_trait_class_reader :dbh, :table, :pk, :columns
+    ancestral_trait_class_reader :dbh, :table, :pk, :columns, :st
 
     M4DBI_UNASSIGNED = '__m4dbi_unassigned__'
 
     extend Enumerable
 
+    def self.prepare( sql )
+      st[sql] ||= dbh.prepare(sql)
+    end
+
     def self.[]( first_arg, *args )
       if args.size == 0
         case first_arg
@@ -25,10 +29,9 @@ module M4DBI
         values = [ first_arg ] + args
       end
 
-      row = dbh.select_one(
-        "SELECT * FROM #{table} WHERE #{clause}",
-        *values
-      )
+      sql = "SELECT * FROM #{table} WHERE #{clause}"
+      stm = prepare(sql)
+      row = stm.select_one(*values)
 
       if row
         self.new( row )
@@ -36,9 +39,9 @@ module M4DBI
     end
 
     def self.pk_clause
-      pk.map { |col|
-        "#{col} = ?"
-      }.join( ' AND ' )
+      pk.
+        map { |col| "#{col} = ?" }.
+        join( ' AND ' )
     end
 
     def self.from_rows( rows )
@@ -55,8 +58,9 @@ module M4DBI
           sql = "SELECT * FROM #{table} WHERE #{cond}"
       end
 
+      stm = prepare(sql)
       self.from_rows(
-        dbh.select_all( sql, *params )
+        stm.select_all(*params)
       )
     end
 
@@ -70,16 +74,16 @@ module M4DBI
           sql = "SELECT * FROM #{table} WHERE #{cond} LIMIT 1"
       end
 
-      row = dbh.select_one( sql, *params )
+      stm = prepare(sql)
+      row = stm.select_one( *params )
       if row
         self.new( row )
       end
     end
 
     def self.all
-      self.from_rows(
-        dbh.select_all( "SELECT * FROM #{table}" )
-      )
+      stm = prepare("SELECT * FROM #{table}")
+      self.from_rows( stm.select_all )
     end
 
     # TODO: Perhaps we'll use cursors for Model#each.
@@ -88,14 +92,16 @@ module M4DBI
     end
 
     def self.one
-      row = dbh.select_one( "SELECT * FROM #{table} LIMIT 1" )
+      stm = prepare("SELECT * FROM #{table} LIMIT 1")
+      row = stm.select_one
       if row
         self.new( row )
       end
     end
 
     def self.count
-      dbh.select_column( "SELECT COUNT(*) FROM #{table}" ).to_i
+      stm = prepare("SELECT COUNT(*) FROM #{table}")
+      stm.select_column.to_i
     end
 
     def self.create( hash = {} )
@@ -123,7 +129,8 @@ module M4DBI
         else
           sql = "INSERT INTO #{table} ( #{cols} ) VALUES ( #{value_placeholders} )"
         end
-        num_inserted = dbh_.execute( sql, *values ).affected_count
+        stm = prepare(sql)
+        num_inserted = stm.execute(*values).affected_count
         if num_inserted > 0
           pk_hash = hash.slice( *(
             self.pk.map { |pk_col| pk_col.to_sym }
@@ -133,7 +140,7 @@ module M4DBI
               self.pk.map { |pk_col| pk_col.to_s }
             ) )
           end
-          if not pk_hash.empty?
+          if ! pk_hash.empty?
             rec = self.one_where( pk_hash )
           else
             begin
@@ -168,14 +175,16 @@ module M4DBI
       end
     end
 
-    def self.select_all( *args )
+    def self.select_all( sql, *binds )
+      stm = prepare(sql)
       self.from_rows(
-        dbh.select_all( *args )
+        stm.select_all( *binds )
       )
     end
 
-    def self.select_one( *args )
-      row = dbh.select_one( *args )
+    def self.select_one( sql, *binds )
+      stm = prepare(sql)
+      row = stm.select_one( *binds )
       if row
         self.new( row )
       end
@@ -200,20 +209,16 @@ module M4DBI
 
       set_clause, set_params = set_hash.to_set_clause
       params = set_params + where_params
-      dbh.execute(
-        "UPDATE #{table} SET #{set_clause} WHERE #{where_clause}",
-        *params
-      )
+      stm = prepare("UPDATE #{table} SET #{set_clause} WHERE #{where_clause}")
+      stm.execute( *params )
     end
 
     def self.update_one( *args )
       set_clause, set_params = args[ -1 ].to_set_clause
       pk_values = args[ 0..-2 ]
       params = set_params + pk_values
-      dbh.execute(
-        "UPDATE #{table} SET #{set_clause} WHERE #{pk_clause}",
-        *params
-      )
+      stm = prepare("UPDATE #{table} SET #{set_clause} WHERE #{pk_clause}")
+      stm.execute( *params )
     end
 
     # Example:
@@ -278,12 +283,17 @@ module M4DBI
 
     def initialize( row )
       if ! row.respond_to?( "[]".to_sym ) || ! row.respond_to?( "[]=".to_sym )
-        raise M4DBI::Error.new( "Attempted to instantiate M4DBI::Model with an invalid argument (#{row.inspect}).  (Expecting something accessible [] and []= .)" )
+        raise M4DBI::Error.new( "Attempted to instantiate M4DBI::Model with an invalid argument (#{row.inspect}).  (Expecting something accessible with [] and []= .)" )
       end
       if caller[ 1 ] !~ %r{/m4dbi/model\.rb:}
         warn "Do not call M4DBI::Model#new directly; use M4DBI::Model#create instead."
       end
       @row = row
+      @st = Hash.new
+    end
+
+    def prepare( sql )
+      @st[sql] ||= dbh.prepare(sql)
     end
 
     def method_missing( method, *args )
@@ -353,10 +363,8 @@ module M4DBI
     def set( hash )
       set_clause, set_params = hash.to_set_clause
       set_params << pk
-      num_updated = dbh.execute(
-        "UPDATE #{table} SET #{set_clause} WHERE #{pk_clause}",
-        *set_params
-      ).affected_count
+      st = prepare("UPDATE #{table} SET #{set_clause} WHERE #{pk_clause}")
+      num_updated = st.execute( *set_params ).affected_count
       if num_updated > 0
         hash.each do |key,value|
           @row[ key ] = value
@@ -367,10 +375,8 @@ module M4DBI
 
     # Returns true iff the record and only the record was successfully deleted.
     def delete
-      num_deleted = dbh.execute(
-        "DELETE FROM #{table} WHERE #{pk_clause}",
-        *pk_values
-      ).affected_count
+      st = prepare("DELETE FROM #{table} WHERE #{pk_clause}")
+      num_deleted = st.execute( *pk_values ).affected_count
       num_deleted == 1
     end
 
@@ -404,10 +410,11 @@ module M4DBI
     @models ||= Hash.new
     @models[ model_key ] ||= Class.new( M4DBI::Model ) do |klass|
       klass.trait( {
-        :dbh => h,
-        :table => table,
-        :pk => pk_,
+        :dbh     => h,
+        :table   => table,
+        :pk      => pk_,
         :columns => h.table_schema( table.to_sym ).columns,
+        :st      => Hash.new,  # prepared statements for all queries
       } )
 
       meta_def( 'pk_str'.to_sym ) do
@@ -450,8 +457,8 @@ module M4DBI
         # Column writers
 
         class_def( "#{method}=".to_sym ) do |new_value|
-          num_changed = dbh.execute(
-            "UPDATE #{table} SET #{colname} = ? WHERE #{pk_clause}",
+          stm = prepare("UPDATE #{table} SET #{colname} = ? WHERE #{pk_clause}")
+          num_changed = stm.execute(
             new_value,
             *pk_values
           ).affected_count
@@ -461,8 +468,8 @@ module M4DBI
         end
 
         class_def( '[]='.to_sym ) do |colname, new_value|
-          num_changed = dbh.execute(
-            "UPDATE #{table} SET #{colname} = ? WHERE #{pk_clause}",
+          stm = prepare("UPDATE #{table} SET #{colname} = ? WHERE #{pk_clause}")
+          num_changed = stm.execute(
             new_value,
             *pk_values
           ).affected_count

data/lib/m4dbi/statement.rb

@@ -0,0 +1,39 @@
+module M4DBI
+  class Statement
+    def initialize( rdbi_statement )
+      @st = rdbi_statement
+    end
+
+    def execute( *args )
+      @st.execute *args
+    end
+
+    def select( *bindvars )
+      @st.execute( *bindvars ).fetch( :all, RDBI::Result::Driver::Struct )
+    end
+
+    def select_one( *bindvars )
+      select( *bindvars )[0]
+    end
+
+    def select_column( *bindvars )
+      rows = @st.execute( *bindvars ).fetch( 1, RDBI::Result::Driver::Array )
+      if rows.any?
+        rows[0][0]
+      else
+        raise RDBI::Error.new( "Query returned no rows.  SQL: #{@dbh.last_query}" )
+      end
+    end
+
+    alias select_all select
+    alias s select
+    alias s1 select_one
+    alias sc select_column
+    alias update execute
+    alias u execute
+    alias insert execute
+    alias i execute
+    alias delete execute
+    alias d execute
+  end
+end

data/lib/m4dbi/version.rb

@@ -1,3 +1,3 @@
 module M4DBI
-  VERSION = '0.7.3'
+  VERSION = '0.8.0'
 end

data/lib/m4dbi.rb

@@ -11,6 +11,7 @@ require "#{__DIR__}/m4dbi/traits"
 require "#{__DIR__}/m4dbi/hash"
 require "#{__DIR__}/m4dbi/array"
 require "#{__DIR__}/m4dbi/database"
+require "#{__DIR__}/m4dbi/statement"
 require "#{__DIR__}/m4dbi/model"
 require "#{__DIR__}/m4dbi/collection"
 

data/spec/helper.rb

@@ -17,7 +17,7 @@ puts "M4DBI version: #{M4DBI::VERSION}"
 # See test-schema*.sql and test-data.sql
 def connect_to_spec_database( database = ( ENV[ 'M4DBI_DATABASE' ] || 'm4dbi' ) )
   driver = ENV[ 'M4DBI_DRIVER' ] || "PostgreSQL"
-  # puts "\nUsing RDBI driver: '#{driver}'"
+  puts "\nUsing RDBI driver: '#{driver}'"
   case driver.downcase
   when 'postgresql', 'sqlite3', 'mysql'
     require "rdbi/driver/#{driver.downcase}"

data/spec/model.rb

@@ -478,6 +478,7 @@ describe 'A M4DBI::Model subclass' do
     r.should.respond_to :time_created
     r.should.not.respond_to :no_column_by_this_name
     r.time_created.should.not.be.nil
+    r.time_created.should.be.kind_of DateTime
   end
 
   it 'returns a record via #find_or_create( Hash )' do

metadata

@@ -2,7 +2,7 @@
 name: m4dbi
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors: 
 - Pistos
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-14 00:00:00 Z
+date: 2011-09-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: metaid
@@ -41,13 +41,14 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 - CHANGELOG
 - LICENCE
 files: 
-- README
+- README.rdoc
 - CHANGELOG
 - LICENCE
+- lib/m4dbi/statement.rb
 - lib/m4dbi/database.rb
 - lib/m4dbi/model.rb
 - lib/m4dbi/version.rb

data/README

@@ -1 +0,0 @@
-Don't read ME; read HIM!