ar-extensions 0.6.0 → 0.7.0

data/ChangeLog

@@ -1,3 +1,11 @@
+2007-07-20  zdennis  <zdennis@dhcp-22.atomicobject.localnet>
+
+	* Added patch from Michael Flester to fix bug with created_at/updated_at fields to use proper timezone. 
+
+2007-07-18  zdennis  <zdennis@dhcp-22.atomicobject.localnet>
+
+	* Added patch for Oracle support from Michael Flester.
+
 2007-05-05  zdennis  <zdennis@elijah.local>
 
 	* Added ActiveRecord::Base::AbstractAdapter#synchronize method which allows a mass re-synchronization of ActiveRecord instances. This is similar to ActiveRecord::Base#reload except that it works on multiple instances at a time rather then one. This sends one query for all instances rather then 1 per instance reloaded.

data/README

@@ -9,6 +9,15 @@ Email: zach.dennis@gmail.com
  - For How-To information see http://www.continuousthinking.com/tags/arext
  - For project information and feedback please consult http://rubyforge.org/projects/arext/
  - For release information please see below
+
+AciveRecord::Extensions 0.7.0
+-----------------------------
+July 20th, 2007
+ - Fixes timezone issue (thanks Michael Flester)
+ - Adds better finder and import support for Oracle (thanks Michael Flester)
+ - Committed patch to fix MySQL query padding, thanks to Gabe da Silveira
+ - Added functionality for MySQL to work with created_on, created_at, updated_on or updated_at fields
+ - Added more test coverage for import functionality 
  
 ActiveRecord::Extensions 0.6.0
 ------------------------------

data/Rakefile

@@ -12,7 +12,7 @@ task :boot do
   require File.expand_path( File.join( DIR, 'db/migrate/version' ) )
 end
 
-ADAPTERS = %w( mysql postgresql sqlite sqlite3 )
+ADAPTERS = %w( mysql postgresql sqlite sqlite3 oracle )
 
 namespace :db do
 

data/db/migrate/generic_schema.rb

@@ -49,6 +49,9 @@ ActiveRecord::Schema.define do
     t.column :publisher, :string, :null=>false
     t.column :author_name, :string, :null=>false
     t.column :created_at, :time
+    t.column :created_on, :datetime
+    t.column :updated_at, :time
+    t.column :updated_on, :datetime
     t.column :topic_id, :integer
   end  
 

data/db/migrate/mysql_schema.rb

@@ -20,6 +20,9 @@ ActiveRecord::Schema.define do
     t.column :publisher, :string, :null=>false
     t.column :author_name, :string, :null=>false
     t.column :created_at, :datetime
+    t.column :created_on, :datetime
+    t.column :updated_at, :datetime
+    t.column :updated_on, :datetime
     t.column :topic_id, :integer
   end
   execute "ALTER TABLE books ADD FULLTEXT( `title`, `publisher`, `author_name` )"

data/db/migrate/version.rb

@@ -1,4 +1,4 @@
 class SchemaInfo < ActiveRecord::Base
   set_table_name 'schema_info'
-  VERSION = 6
+  VERSION = 8
 end

data/lib/ar-extensions/adapters/abstract_adapter.rb

@@ -2,7 +2,8 @@ module ActiveRecord # :nodoc:
   module ConnectionAdapters # :nodoc:
     class AbstractAdapter # :nodoc:
       NO_MAX_PACKET = 0
-    
+      QUERY_OVERHEAD = 8 #This was shown to be true for MySQL, but it's not clear where the overhead is from.
+      
       # +sql+ can be a single string or an array. If it is an array all 
       # elements that are in position >= 1 will be appended to the final SQL.
       def insert_many( sql, values, *args ) # :nodoc:
@@ -15,7 +16,7 @@ module ActiveRecord # :nodoc:
           [ sql.shift, sql.join( ' ' ) ]
         end
         
-        sql_size = base_sql.size + post_sql.size 
+        sql_size = QUERY_OVERHEAD + base_sql.size + post_sql.size 
 
         # the number of bytes the requested insert statement values will take up
         values_in_bytes = self.class.sum_sizes( *values )
@@ -41,7 +42,7 @@ module ActiveRecord # :nodoc:
             insert( sql2insert, *args )
           end
         end        
-        
+
         number_of_inserts
       end
       

data/lib/ar-extensions/adapters/oracle.rb

@@ -0,0 +1,9 @@
+module ActiveRecord # :nodoc:
+  module ConnectionAdapters # :nodoc:
+    class OracleAdapter # :nodoc:
+       def supports_import?
+         true
+       end
+    end
+  end
+end

data/lib/ar-extensions/extensions.rb

@@ -72,7 +72,7 @@ require 'forwardable'
 # 
 # == Importing Lots of Data
 #
-# ActiveRecord executes a single INSERT statement for every cal to 'create'
+# ActiveRecord executes a single INSERT statement for every call to 'create'
 # and for every call to 'save' on a new model object. When you have only
 # a handful of records to create or save this is not a big deal, but when
 # you have hundreds, thousands or hundreds of thousands of records
@@ -203,8 +203,8 @@ module ActiveRecord::Extensions
   #  Model.find :all, :conditions=>{ 'number_lt'=>100 } 
   #  Model.find :all, :conditions=>{ 'number_gte'=>100 } 
   #  Model.find :all, :conditions=>{ 'number_lte'=>100 }
-  class Comparison 
- 
+  class Comparison
+
     SUFFIX_MAP = { 'eq'=>'=', 'lt'=>'<', 'lte'=>'<=', 'gt'=>'>', 'gte'=>'>=', 'ne'=>'!=', 'not'=>'!=' }
     
     def self.process( key, val, caller )
@@ -394,6 +394,19 @@ module ActiveRecord::Extensions
     end
 
   end
+
+  # ActiveRecord::Extension for implementing Regexp implementation for Oracle.
+  # See documention for RegexpBase.
+  #
+  class OracleRegexp < RegexpBase
+   
+    def self.process( key, val, caller )
+      return nil unless val.is_a?( Regexp )
+      r = field_result( key, caller )
+      return Result.new( "#{r.negate? ? ' NOT ':''} REGEXP_LIKE(#{caller.table_name}.#{r.fieldname} , ?)", val )
+    end
+
+  end
   
   
   # ActiveRecord::Extension for implementing Regexp implementation for MySQL.
@@ -473,7 +486,8 @@ end
   register MySQLRegexp, :adapters=>[ :mysql ]
   register PostgreSQLRegexp, :adapters=>[ :postgresql ]
   register SqliteRegexp, :adapters =>[ :sqlite ]
-  register DatetimeSupport, :adapters =>[ :mysql, :sqlite ]
+  register OracleRegexp, :adapters =>[ :oracle ]
+  register DatetimeSupport, :adapters =>[ :mysql, :sqlite, :oracle ]
 end
 
 

data/lib/ar-extensions/finders.rb

@@ -24,7 +24,7 @@ class ActiveRecord::Base
         arg = sanitize_sql_by_way_of_duck_typing( arg )
       elsif arg.is_a?( Hash )
         arg = sanitize_sql_from_hash( arg ) 
-      elsif arg.size == 2 and arg.first.is_a?( String ) and arg.last.is_a?( Hash )
+      elsif arg.is_a?( Array ) and arg.size == 2 and arg.first.is_a?( String ) and arg.last.is_a?( Hash )
         arg = sanitize_sql_from_string_and_hash( arg ) 
       end
       sanitize_sql_orig( arg )

data/lib/ar-extensions/import.rb

@@ -18,6 +18,16 @@ end
 
 class ActiveRecord::Base
   class << self
+
+    # use tz as set in ActiveRecord::Base
+    tproc = @@default_timezone == :utc ? lambda { Time.now.utc } : lambda { Time.now }
+    AREXT_RAILS_COLUMNS = {
+      :create => { "created_on" => tproc ,
+                   "created_at" => tproc },
+      :update => { "updated_on" => tproc ,
+                   "updated_at" => tproc }
+    }
+    AREXT_RAILS_COLUMN_NAMES = AREXT_RAILS_COLUMNS[:create].keys + AREXT_RAILS_COLUMNS[:update].keys
   
     # Returns true if the current database connection adapter
     # supports import functionality, otherwise returns false.
@@ -26,7 +36,7 @@ class ActiveRecord::Base
     rescue NoMethodError
       false
     end
-    
+
     # Returns true if the current database connection adapter
     # supports on duplicate key update functionality, otherwise
     # returns false.
@@ -132,7 +142,13 @@ class ActiveRecord::Base
     #   
     #   BlogPost.import columns, attributes, :on_duplicate_key_update=>{ :title => :title } 
     #  
+    # = Returns
+    # This returns an object which responds to +failed_instances+ and +num_inserts+.
+    # * failed_instances - an array of objects that fails validation and were not committed to the database. An empty array if no validation is performed.
+    # * num_inserts - the number of insert statements it took to import the data
     def import( *args )
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::DEBUG
       options = { :validate=>true }
       options.merge!( args.pop ) if args.last.is_a? Hash
       
@@ -144,15 +160,18 @@ class ActiveRecord::Base
         else
           models = args.first
           column_names = self.column_names.dup
-          column_names.delete( self.primary_key ) unless options[ :on_duplicate_key_update ]
         end
         
-        array_of_attributes = models.inject( [] ) do |arr,model|
-          attributes = []
-          column_names.each do |name| 
-            attributes << model.send( "#{name}_before_type_cast" ) 
-          end
-          arr << attributes
+        array_of_attributes  = []
+        models.each do |model|
+          # this next line breaks sqlite.so with a segmentation fault
+          # if model.new_record? || options[:on_duplicate_key_update]
+            attributes = []
+            column_names.each do |name| 
+              attributes << model.send( "#{name}_before_type_cast" ) 
+            end
+            array_of_attributes << attributes
+          # end
         end
         # supports 2-element array and array
       elsif args.size == 2 and args.first.is_a?( Array ) and args.last.is_a?( Array )
@@ -160,22 +179,37 @@ class ActiveRecord::Base
       else
         raise ArgumentError.new( "Invalid arguments!" )
       end
-      
+
+      # Force the primary key col into the insert if it's not
+      # on the list and we are using a sequence and stuff a nil
+      # value for it into each row so the sequencer will fire later
+      if !column_names.include?(primary_key) && sequence_name && connection.prefetch_primary_key?
+         column_names << primary_key
+         array_of_attributes.each { |a| a << nil }
+      end
+
       is_validating = options.delete( :validate )
-      
+
       # dup the passed in array so we don't modify it unintentionally
       array_of_attributes = array_of_attributes.dup
-      number_of_inserts = if is_validating
+
+      # record timestamps unless disabled in ActiveRecord::Base
+      if record_timestamps
+         add_special_rails_stamps column_names, array_of_attributes, options
+      end
+
+      return_obj = if is_validating
         import_with_validations( column_names, array_of_attributes, options )
       else
-        import_without_validations_or_callbacks( column_names, array_of_attributes, options )
+        num_inserts = import_without_validations_or_callbacks( column_names, array_of_attributes, options )
+        OpenStruct.new :failed_instances=>[], :num_inserts=>num_inserts
       end
-      
       if options[:synchronize]
         synchronize( options[:synchronize] )
       end
-      
-      number_of_inserts
+
+      return_obj.num_inserts = 0 if return_obj.num_inserts.nil?
+      return_obj
     end
     
     # TODO import_from_table needs to be implemented. 
@@ -184,7 +218,9 @@ class ActiveRecord::Base
     
     # Imports the passed in +column_names+ and +array_of_attributes+
     # given the passed in +options+ Hash with validations. Returns an
-    # array of instances that failed validations. See
+    # object with the methods +failed_instances+ and +num_inserts+. 
+    # +failed_instances+ is an array of instances that failed validations. 
+    # +num_inserts+ is the number of inserts it took to import the data. See
     # ActiveRecord::Base.import for more information on
     # +column_names+, +array_of_attributes+ and +options+.
     def import_with_validations( column_names, array_of_attributes, options={} )
@@ -192,10 +228,10 @@ class ActiveRecord::Base
       
       # create instances for each of our column/value sets
       arr = validations_array_for_column_names_and_attributes( column_names, array_of_attributes )    
-      
+
       # keep track of the instance and the position it is currently at. if this fails
       # validation we'll use the index to remove it from the array_of_attributes
-      arr.each_with_index do |hsh,i| 
+      arr.each_with_index do |hsh,i|
         instance = new( hsh )
         if not instance.valid?
           array_of_attributes[ i ] = nil
@@ -204,10 +240,8 @@ class ActiveRecord::Base
       end
       array_of_attributes.compact!
       
-      if not array_of_attributes.empty?
-        import_without_validations_or_callbacks( column_names, array_of_attributes, options )
-      end
-      failed_instances   
+      num_inserts = array_of_attributes.empty? ? 0 : import_without_validations_or_callbacks( column_names, array_of_attributes, options )
+      OpenStruct.new :failed_instances=>failed_instances, :num_inserts => num_inserts
     end
     
     # Imports the passed in +column_names+ and +array_of_attributes+
@@ -224,15 +258,20 @@ class ActiveRecord::Base
       if not supports_import?
         columns_sql = "(" + escaped_column_names.join( ',' ) + ")"
         insert_statements, values = [], []
+        number_inserted = 0
         array_of_attributes.each do |arr|
           my_values = []
           arr.each_with_index do |val,j|
-            my_values << connection.quote( val, columns[j] )
+            if sequence_name && column_names[j] == primary_key && val.nil?
+               my_values << "#{sequence_name}.nextval"
+            else
+               my_values << connection.quote( val, columns[j] )
+            end
           end
           insert_statements << "INSERT INTO #{self.table_name} #{columns_sql} VALUES(" + my_values.join( ',' ) + ")"
-          connection.execute( insert_statements.last )
+           number_inserted = number_inserted + connection.execute( insert_statements.last )
         end
-        return
+        return number_inserted
       else
         
         # generate the sql
@@ -255,6 +294,42 @@ class ActiveRecord::Base
 
     
     private
+
+    
+    def add_special_rails_stamps( column_names, array_of_attributes, options )
+      AREXT_RAILS_COLUMNS[:create].each_pair do |key, blk|
+        if self.column_names.include?(key)
+          value = blk.call
+          if index=column_names.index(key)
+             # replace every instance of the array of attributes with our value
+             array_of_attributes.each{ |arr| arr[index] = value }
+          else
+            column_names << key
+            array_of_attributes.each { |arr| arr << value }
+          end
+        end
+      end
+
+      AREXT_RAILS_COLUMNS[:update].each_pair do |key, blk|
+        if self.column_names.include?(key)
+          value = blk.call
+          if index=column_names.index(key)
+             # replace every instance of the array of attributes with our value
+             array_of_attributes.each{ |arr| arr[index] = value }
+          else
+            column_names << key
+            array_of_attributes.each { |arr| arr << value }
+          end
+          
+          if options[:on_duplicate_key_update]
+            options[:on_duplicate_key_update] << key.to_sym if options[:on_duplicate_key_update].is_a?(Array)
+            options[:on_duplicate_key_update][key.to_sym] = key.to_sym if options[:on_duplicate_key_update].is_a?(Hash)
+          else
+            options[:on_duplicate_key_update] = [ key.to_sym ]
+          end
+        end
+      end
+    end
     
     # Returns an Array of Hashes for the passed in +column_names+ and +array_of_attributes+.
     def validations_array_for_column_names_and_attributes( column_names, array_of_attributes ) # :nodoc:

data/lib/ar-extensions/version.rb

@@ -2,7 +2,7 @@
 module ActiveRecord # :nodoc:
   module Extensions # :nodoc: 
     module VERSION  
-      MAJOR, MINOR, REVISION = %W( 0 6 0 )
+      MAJOR, MINOR, REVISION = %W( 0 7 0 )
       STRING = [ MAJOR, MINOR, REVISION ].join( '.' )
     end
   end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: ar-extensions
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
-date: 2007-05-05 00:00:00 -04:00
+  version: 0.7.0
+date: 2007-07-21 00:00:00 -04:00
 summary: Extends ActiveRecord functionality.
 require_paths: 
 - lib
@@ -44,6 +44,7 @@ files:
 - config/postgresql.schema
 - lib/ar-extensions/adapters/abstract_adapter.rb
 - lib/ar-extensions/adapters/mysql_adapter.rb
+- lib/ar-extensions/adapters/oracle.rb
 - lib/ar-extensions/adapters/postgresql.rb
 - lib/ar-extensions/csv.rb
 - lib/ar-extensions/extensions.rb