activerecord-oracle_enhanced-adapter 1.1.0 → 1.1.1

data/History.txt

@@ -1,3 +1,13 @@
+== 1.1.1 2008-06-28
+
+* Enhancements:
+  * Added ignore_table_columns option
+  * Added support for TIMESTAMP columns (without fractional seconds)
+  * NLS_DATE_FORMAT and NLS_TIMESTAMP_FORMAT independent DATE and TIMESTAMP columns support
+* Bug fixes:
+  * Checks if CGI::Session::ActiveRecordStore::Session does not have enhanced_write_lobs callback before adding it
+    (Rails 2.0 does not add this callback, Rails 2.1 does)
+
 == 1.1.0 2008-05-05
 
 * Forked from original activerecord-oracle-adapter-1.0.0.9216
@@ -11,6 +21,3 @@
   * Added emulate_dates_by_column_name option
   * Added emulate_integers_by_column_name option
   * Added emulate_booleans_from_strings option
-
-
-

data/README.txt

@@ -27,14 +27,19 @@ ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_dates_by_column_
 * set to true if columns with ID at the end of column name should be emulated as Fixnum (and not as BigDecimal which is default)
 ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_integers_by_column_name = true
 
-* set to true if CHAR(1), VARCHAR2(1) columns or or VARCHAR2 columns with FLAG or YN at the end of their name
+* set to true if CHAR(1), VARCHAR2(1) columns or VARCHAR2 columns with FLAG or YN at the end of their name
   should be emulated as booleans (and do not use NUMBER(1) as type for booleans which is default)
 ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_booleans_from_strings = true
 
+The following model class definitions are available:
+* specify which table columns should be ignored by ActiveRecord
+ignore_table_columns :column1, :column2, :column3
+
+See History.txt for other enhancements to original Oracle adapter.
 
 == REQUIREMENTS:
 
-* Works with ActiveRecord version 2.0 (which is included in Rails 2.0)
+* Works with ActiveRecord version 2.0 and 2.1 (which is included in Rails 2.0 and 2.1)
 * Requires ruby-oci8 library to connect to Oracle
 
 == INSTALL:

data/lib/active_record/connection_adapters/oracle_enhanced_adapter.rb

@@ -39,6 +39,12 @@ end if defined?(RAILS_ROOT)
 begin
   require_library_or_gem 'oci8' unless self.class.const_defined? :OCI8
 
+  # RSI: added mapping for TIMESTAMP / WITH TIME ZONE / LOCAL TIME ZONE types
+  # currently Ruby-OCI8 does not support fractional seconds for timestamps
+  OCI8::BindType::Mapping[OCI8::SQLT_TIMESTAMP] = OCI8::BindType::OraDate
+  OCI8::BindType::Mapping[OCI8::SQLT_TIMESTAMP_TZ] = OCI8::BindType::OraDate
+  OCI8::BindType::Mapping[OCI8::SQLT_TIMESTAMP_LTZ] = OCI8::BindType::OraDate
+
   module ActiveRecord
     class Base
       def self.oracle_enhanced_connection(config) #:nodoc:
@@ -46,6 +52,11 @@ begin
         ConnectionAdapters::OracleEnhancedAdapter.new OCI8EnhancedAutoRecover.new(config), logger
       end
 
+      # RSI: specify table columns which should be ifnored
+      def self.ignore_table_columns(*args)
+        connection.ignore_table_columns(table_name,*args)
+      end
+
       # After setting large objects to empty, select the OCI8::LOB
       # and write back the data.
       after_save :enhanced_write_lobs
@@ -87,6 +98,7 @@ begin
             when /date/i
               return :date if OracleEnhancedAdapter.emulate_dates_by_column_name && OracleEnhancedAdapter.is_date_column?(name)
               :datetime
+            when /timestamp/i then :timestamp
             when /time/i then :datetime
             when /decimal|numeric|number/i
               return :integer if extract_scale(field_type) == 0
@@ -187,7 +199,9 @@ begin
             :float       => { :name => "NUMBER" },
             :decimal     => { :name => "DECIMAL" },
             :datetime    => { :name => "DATE" },
-            :timestamp   => { :name => "DATE" },
+            # RSI: changed to native TIMESTAMP type
+            # :timestamp   => { :name => "DATE" },
+            :timestamp   => { :name => "TIMESTAMP" },
             :time        => { :name => "DATE" },
             :date        => { :name => "DATE" },
             :binary      => { :name => "BLOB" },
@@ -221,8 +235,20 @@ begin
         end
 
         def quote(value, column = nil) #:nodoc:
-          if value && column && [:text, :binary].include?(column.type)
-            %Q{empty_#{ column.sql_type.downcase rescue 'blob' }()}
+          if value && column
+            case column.type
+            when :text, :binary
+              %Q{empty_#{ column.sql_type.downcase rescue 'blob' }()}
+            # RSI: TIMESTAMP support
+            when :timestamp
+              # add up to 9 digits of fractional seconds to inserted time
+              "TO_TIMESTAMP('#{value.to_s(:db)}.#{("%.9f"%value.to_f).split('.')[1]}','YYYY-MM-DD HH24:MI:SS:FF9')"
+            # RSI: NLS_DATE_FORMAT independent DATE support
+            when :date, :time, :datetime
+              "TO_DATE('#{value.to_s(:db)}','YYYY-MM-DD HH24:MI:SS')"
+            else
+              super
+            end
           else
             super
           end
@@ -384,8 +410,24 @@ begin
 
           indexes
         end
-
+        
+        # RSI: set ignored columns for table
+        def ignore_table_columns(table_name, *args)
+          @ignore_table_columns ||= {}
+          @ignore_table_columns[table_name] ||= []
+          @ignore_table_columns[table_name] += args.map{|a| a.to_s.downcase}
+          @ignore_table_columns[table_name].uniq!
+        end
+        
+        def ignored_table_columns(table_name)
+          @ignore_table_columns ||= {}
+          @ignore_table_columns[table_name]
+        end
+        
         def columns(table_name, name = nil) #:nodoc:
+          # RSI: get ignored_columns by original table name
+          ignored_columns = ignored_table_columns(table_name)
+
           (owner, table_name) = @connection.describe(table_name)
 
           table_cols = <<-SQL
@@ -402,7 +444,10 @@ begin
              order by column_id
           SQL
 
-          select_all(table_cols, name).map do |row|
+          # RSI: added deletion of ignored columns
+          select_all(table_cols, name).delete_if do |row|
+            ignored_columns && ignored_columns.include?(row['name'].downcase)
+          end.map do |row|
             limit, scale = row['limit'], row['scale']
             if limit || scale
               row['sql_type'] << "(#{(limit || 38).to_i}" + ((scale = scale.to_i) > 0 ? ",#{scale})" : ")")
@@ -794,7 +839,8 @@ end
 
 # RSI: Added LOB writing callback for sessions stored in database
 # Otherwise it is not working as Session class is defined before OracleAdapter is loaded in Rails 2.0
-if defined?(CGI::Session::ActiveRecordStore::Session)
+if defined?(CGI::Session::ActiveRecordStore::Session) &&
+            CGI::Session::ActiveRecordStore::Session.after_save_callback_chain.detect{|cb| cb.method == :enhanced_write_lobs}.nil?
   class CGI::Session::ActiveRecordStore::Session
     after_save :enhanced_write_lobs
   end

data/lib/active_record/connection_adapters/oracle_enhanced_version.rb

@@ -3,7 +3,7 @@ module ActiveRecord #:nodoc:
     module OracleEnhancedVersion #:nodoc:
       MAJOR = 1
       MINOR = 1
-      TINY  = 0
+      TINY  = 1
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

data/spec/active_record/connection_adapters/oracle_enhanced_adapter_spec.rb

@@ -63,6 +63,7 @@ describe "OracleEnhancedAdapter database session store" do
         id          NUMBER(38,0) NOT NULL,
         session_id  VARCHAR2(255) DEFAULT NULL,
         data        CLOB DEFAULT NULL,
+        created_at  DATE DEFAULT NULL,
         updated_at  DATE DEFAULT NULL,
         PRIMARY KEY (ID)
       )
@@ -83,12 +84,27 @@ describe "OracleEnhancedAdapter database session store" do
   end
 
   it "should save session data" do
-    @session = CGI::Session::ActiveRecordStore::Session.new :session_id => "123456", :data  => "something", :updated_at => Time.now
+    @session = CGI::Session::ActiveRecordStore::Session.new :session_id => "111111", :data  => "something" #, :updated_at => Time.now
     @session.save!
-    @session = CGI::Session::ActiveRecordStore::Session.find_by_session_id("123456")
+    @session = CGI::Session::ActiveRecordStore::Session.find_by_session_id("111111")
     @session.data.should == "something"
   end
 
+  it "should change session data when partial updates enabled" do
+    CGI::Session::ActiveRecordStore::Session.partial_updates = true
+    @session = CGI::Session::ActiveRecordStore::Session.new :session_id => "222222", :data  => "something" #, :updated_at => Time.now
+    @session.save!
+    @session = CGI::Session::ActiveRecordStore::Session.find_by_session_id("222222")
+    @session.data = "other thing"
+    @session.save!
+    @session = CGI::Session::ActiveRecordStore::Session.find_by_session_id("222222")
+    @session.data.should == "other thing"
+  end
+
+  it "should have one enhanced_write_lobs callback" do
+    CGI::Session::ActiveRecordStore::Session.after_save_callback_chain.select{|cb| cb.method == :enhanced_write_lobs}.should have(1).record
+  end
+
 end
 
 describe "OracleEnhancedAdapter date type detection based on column names" do
@@ -448,3 +464,239 @@ describe "OracleEnhancedAdapter boolean type detection based on string column ty
 
 end
 
+
+describe "OracleEnhancedAdapter ignore specified table columns" do
+  before(:all) do
+    ActiveRecord::Base.establish_connection(:adapter => "oracle_enhanced",
+                                            :database => "xe",
+                                            :username => "hr",
+                                            :password => "hr")
+    @conn = ActiveRecord::Base.connection
+    @conn.execute <<-SQL
+      CREATE TABLE test_employees (
+        id            NUMBER,
+        first_name    VARCHAR2(20),
+        last_name     VARCHAR2(25),
+        email         VARCHAR2(25),
+        phone_number  VARCHAR2(20),
+        hire_date     DATE,
+        job_id        NUMBER,
+        salary        NUMBER,
+        commission_pct  NUMBER(2,2),
+        manager_id    NUMBER(6),
+        department_id NUMBER(4,0),
+        created_at    DATE
+      )
+    SQL
+    @conn.execute <<-SQL
+      CREATE SEQUENCE test_employees_seq  MINVALUE 1
+        INCREMENT BY 1 START WITH 1 CACHE 20 NOORDER NOCYCLE
+    SQL
+  end
+  
+  after(:all) do
+    @conn.execute "DROP TABLE test_employees"
+    @conn.execute "DROP SEQUENCE test_employees_seq"
+  end
+
+  after(:each) do
+    Object.send(:remove_const, "TestEmployee")
+  end
+
+  it "should ignore specified table columns" do
+    class TestEmployee < ActiveRecord::Base
+      ignore_table_columns  :phone_number, :hire_date
+    end
+    TestEmployee.connection.columns('test_employees').select{|c| ['phone_number','hire_date'].include?(c.name) }.should be_empty
+  end
+
+  it "should ignore specified table columns specified in several lines" do
+    class TestEmployee < ActiveRecord::Base
+      ignore_table_columns  :phone_number
+      ignore_table_columns  :hire_date
+    end
+    TestEmployee.connection.columns('test_employees').select{|c| ['phone_number','hire_date'].include?(c.name) }.should be_empty
+  end
+
+  it "should not ignore unspecified table columns" do
+    class TestEmployee < ActiveRecord::Base
+      ignore_table_columns  :phone_number, :hire_date
+    end
+    TestEmployee.connection.columns('test_employees').select{|c| c.name == 'email' }.should_not be_empty
+  end
+
+
+end
+
+
+describe "OracleEnhancedAdapter timestamp with timezone support" do
+  before(:all) do
+    ActiveRecord::Base.establish_connection(:adapter => "oracle_enhanced",
+                                            :database => "xe",
+                                            :username => "hr",
+                                            :password => "hr")
+    @conn = ActiveRecord::Base.connection
+    @conn.execute <<-SQL
+      CREATE TABLE test_employees (
+        employee_id   NUMBER(6,0),
+        first_name    VARCHAR2(20),
+        last_name     VARCHAR2(25),
+        email         VARCHAR2(25),
+        phone_number  VARCHAR2(20),
+        hire_date     DATE,
+        job_id        NUMBER(6,0),
+        salary        NUMBER(8,2),
+        commission_pct  NUMBER(2,2),
+        manager_id    NUMBER(6,0),
+        department_id NUMBER(4,0),
+        created_at    TIMESTAMP,
+        created_at_tz   TIMESTAMP WITH TIME ZONE,
+        created_at_ltz  TIMESTAMP WITH LOCAL TIME ZONE
+      )
+    SQL
+    @conn.execute <<-SQL
+      CREATE SEQUENCE test_employees_seq  MINVALUE 1
+        INCREMENT BY 1 CACHE 20 NOORDER NOCYCLE
+    SQL
+  end
+  
+  after(:all) do
+    @conn.execute "DROP TABLE test_employees"
+    @conn.execute "DROP SEQUENCE test_employees_seq"
+  end
+
+  it "should set TIMESTAMP columns type as datetime" do
+    columns = @conn.columns('test_employees')
+    ts_columns = columns.select{|c| c.name =~ /created_at/}
+    ts_columns.each {|c| c.type.should == :timestamp}
+  end
+
+  describe "/ TIMESTAMP WITH TIME ZONE values from ActiveRecord model" do
+    before(:all) do
+      class TestEmployee < ActiveRecord::Base
+        set_primary_key :employee_id
+      end
+    end
+
+    after(:all) do
+      Object.send(:remove_const, "TestEmployee")
+    end
+
+    it "should return Time value from TIMESTAMP columns" do
+      # currently fractional seconds are not retrieved from database
+      @now = Time.local(2008,5,26,23,11,11,0)
+      @employee = TestEmployee.create(
+        :created_at => @now,
+        :created_at_tz => @now,
+        :created_at_ltz => @now
+      )
+      @employee.reload
+      [:created_at, :created_at_tz, :created_at_ltz].each do |c|
+        @employee.send(c).class.should == Time
+        @employee.send(c).to_f.should == @now.to_f
+      end
+    end
+
+    it "should return Time value without fractional seconds from TIMESTAMP columns" do
+      # currently fractional seconds are not retrieved from database
+      @now = Time.local(2008,5,26,23,11,11,10)
+      @employee = TestEmployee.create(
+        :created_at => @now,
+        :created_at_tz => @now,
+        :created_at_ltz => @now
+      )
+      @employee.reload
+      [:created_at, :created_at_tz, :created_at_ltz].each do |c|
+        @employee.send(c).class.should == Time
+        @employee.send(c).to_f.should == @now.to_f.to_i.to_f # remove fractional seconds
+      end
+    end
+
+  end
+
+end
+
+
+describe "OracleEnhancedAdapter date and timestamp with different NLS date formats" do
+  before(:all) do
+    ActiveRecord::Base.establish_connection(:adapter => "oracle_enhanced",
+                                            :database => "xe",
+                                            :username => "hr",
+                                            :password => "hr")
+    @conn = ActiveRecord::Base.connection
+    @conn.execute <<-SQL
+      CREATE TABLE test_employees (
+        employee_id   NUMBER(6,0),
+        first_name    VARCHAR2(20),
+        last_name     VARCHAR2(25),
+        email         VARCHAR2(25),
+        phone_number  VARCHAR2(20),
+        hire_date     DATE,
+        job_id        NUMBER(6,0),
+        salary        NUMBER(8,2),
+        commission_pct  NUMBER(2,2),
+        manager_id    NUMBER(6,0),
+        department_id NUMBER(4,0),
+        created_at    DATE,
+        created_at_ts   TIMESTAMP
+      )
+    SQL
+    @conn.execute <<-SQL
+      CREATE SEQUENCE test_employees_seq  MINVALUE 1
+        INCREMENT BY 1 CACHE 20 NOORDER NOCYCLE
+    SQL
+    class TestEmployee < ActiveRecord::Base
+      set_primary_key :employee_id
+    end
+    # @conn.execute %q{alter session set nls_date_format = 'YYYY-MM-DD HH24:MI:SS'}
+    @conn.execute %q{alter session set nls_date_format = 'DD-MON-YYYY HH24:MI:SS'}
+    # @conn.execute %q{alter session set nls_timestamp_format = 'YYYY-MM-DD HH24:MI:SS'}
+    @conn.execute %q{alter session set nls_timestamp_format = 'DD-MON-YYYY HH24:MI:SS'}
+  end
+  
+  after(:all) do
+    Object.send(:remove_const, "TestEmployee")
+    @conn.execute "DROP TABLE test_employees"
+    @conn.execute "DROP SEQUENCE test_employees_seq"
+  end
+
+  before(:each) do
+    @today = Date.new(2008,6,28)
+    @now = Time.local(2008,6,28,13,34,33)
+    @employee = TestEmployee.create(
+      :first_name => "First",
+      :last_name => "Last",
+      :hire_date => @today,
+      :created_at => @now,
+      :created_at_ts => @now
+    )
+  end
+
+  it "should return Time value from DATE column if emulate_dates_by_column_name is false" do
+    ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_dates_by_column_name = false
+    @employee.reload
+    @employee.hire_date.class.should == Time
+    @employee.hire_date.should == @today.to_time
+  end
+
+  it "should return Date value from DATE column if column name contains 'date' and emulate_dates_by_column_name is true" do
+    ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_dates_by_column_name = true
+    @employee.reload
+    @employee.hire_date.class.should == Date
+    @employee.hire_date.should == @today
+  end
+
+  it "should return Time value from DATE column if column name does not contain 'date' and emulate_dates_by_column_name is true" do
+    ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_dates_by_column_name = true
+    @employee.reload
+    @employee.created_at.class.should == Time
+    @employee.created_at.should == @now
+  end
+
+  it "should return Time value from TIMESTAMP columns" do
+    @employee.reload
+    @employee.created_at_ts.class.should == Time
+    @employee.created_at_ts.should == @now
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: activerecord-oracle_enhanced-adapter
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Raimonds Simanovskis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-13 00:00:00 +03:00
+date: 2008-06-28 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: oracle-enhanced
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Oracle enhaced adapter for Active Record