activerecord-oracle_enhanced-adapter 1.1.2 → 1.1.3

data/History.txt

@@ -1,3 +1,9 @@
+== 1.1.3 2008-07-10
+
+* Enhancements:
+  * Added support for custom create, update and delete methods when working with legacy databases where
+    PL/SQL API should be used for create, update and delete operations
+
 == 1.1.2 2008-07-08
 
 * Bug fixes:

data/README.txt

@@ -31,16 +31,39 @@ ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_integers_by_colu
   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:
+The following model class methods are available:
 * specify which table columns should be ignored by ActiveRecord
 ignore_table_columns :column1, :column2, :column3
 
+* specify custom create, update and delete methods which should be used instead of Rails generated INSERT, UPDATE and DELETE statements
+# should return ID of new record
+set_create_method do
+  plsql.employees_pkg.create_employee(
+    :p_first_name => first_name,
+    :p_last_name => last_name,
+    :p_employee_id => nil
+  )[:p_employee_id]
+end
+set_update_method do
+  plsql.employees_pkg.update_employee(
+    :p_employee_id => id,
+    :p_first_name => first_name,
+    :p_last_name => last_name
+  )
+end
+set_delete_method do
+  plsql.employees_pkg.delete_employee(
+    :p_employee_id => id
+  )
+end
+
 See History.txt for other enhancements to original Oracle adapter.
 
 == REQUIREMENTS:
 
 * 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
+* Requires ruby-plsql gem to support custom create, update and delete methods
 
 == INSTALL:
 

data/lib/active_record/connection_adapters/oracle_enhanced_adapter.rb

@@ -847,3 +847,14 @@ if defined?(CGI::Session::ActiveRecordStore::Session)
     end
   end
 end
+
+# RSI: load custom create, update, delete methods functionality
+# rescue LoadError if ruby-plsql gem cannot be loaded
+begin
+  require 'active_record/connection_adapters/oracle_enhanced_procedures'
+rescue LoadError
+  if defined?(RAILS_DEFAULT_LOGGER)
+    RAILS_DEFAULT_LOGGER.info "INFO: ActiveRecord oracle_enhanced adapter could not load ruby-plsql gem. "+
+                              "Custom create, update and delete methods will not be available."
+  end
+end

data/lib/active_record/connection_adapters/oracle_enhanced_procedures.rb

@@ -0,0 +1,105 @@
+require 'ruby_plsql'
+require 'activesupport'
+
+module ActiveRecord #:nodoc:
+  module ConnectionAdapters #:nodoc:
+    module OracleEnhancedProcedures #:nodoc:
+
+      module ClassMethods
+        def set_create_method(&block)
+          include_with_custom_methods
+          self.custom_create_method = block
+        end
+
+        def set_update_method(&block)
+          include_with_custom_methods
+          self.custom_update_method = block
+        end
+
+        def set_delete_method(&block)
+          include_with_custom_methods
+          self.custom_delete_method = block
+        end
+        
+        private
+        def include_with_custom_methods
+          unless included_modules.include? InstanceMethods
+            class_inheritable_accessor :custom_create_method, :custom_update_method, :custom_delete_method
+            include InstanceMethods
+          end
+        end
+      end
+      
+      module InstanceMethods
+        def self.included(base)
+          base.instance_eval do
+            alias_method_chain :create, :custom_method
+            # insert after dirty checking in Rails 2.1
+            if private_instance_methods.include?('update_without_dirty')
+              alias_method :update_without_custom_method, :update_without_dirty
+              alias_method :update_without_dirty, :update_with_custom_method
+            else
+              alias_method_chain :update, :custom_method
+            end
+            private :create, :update
+            alias_method_chain :destroy, :custom_method
+            public :destroy
+          end
+        end
+        
+        private
+        
+        # Creates a record with custom create method
+        # and returns its id.
+        def create_with_custom_method
+          # check if class has custom create method
+          return create_without_custom_method unless self.class.custom_create_method
+          self.class.connection.log_custom_method("custom create method", "#{self.class.name} Create") do
+            self.id = self.class.custom_create_method.bind(self).call
+          end
+          @new_record = false
+          id
+        end
+
+        # Updates the associated record with custom update method
+        # Returns the number of affected rows.
+        def update_with_custom_method(attribute_names = @attributes.keys)
+          # check if class has custom create method
+          return update_without_custom_method unless self.class.custom_update_method
+          return 0 if attribute_names.empty?
+          self.class.connection.log_custom_method("custom update method with #{self.class.primary_key}=#{self.id}", "#{self.class.name} Update") do
+            self.class.custom_update_method.bind(self).call
+          end
+          1
+        end
+
+        # Deletes the record in the database with custom delete method
+        # and freezes this instance to reflect that no changes should
+        # be made (since they can't be persisted).
+        def destroy_with_custom_method
+          # check if class has custom create method
+          return destroy_without_custom_method unless self.class.custom_delete_method
+          unless new_record?
+            self.class.connection.log_custom_method("custom delete method with #{self.class.primary_key}=#{self.id}", "#{self.class.name} Destroy") do
+              self.class.custom_delete_method.bind(self).call
+            end
+          end
+
+          freeze
+        end
+
+      end
+
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  extend ActiveRecord::ConnectionAdapters::OracleEnhancedProcedures::ClassMethods
+end
+
+ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.class_eval do
+  # public alias to log method which could be used from other objects
+  alias_method :log_custom_method, :log
+  public :log_custom_method
+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  = 2
+      TINY  = 3
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

data/spec/active_record/connection_adapters/oracle_enhanced_adapter_spec.rb

@@ -91,6 +91,7 @@ describe "OracleEnhancedAdapter database session store" do
   end
 
   it "should change session data when partial updates enabled" do
+    return pending("Not in this ActiveRecord version") unless CGI::Session::ActiveRecordStore::Session.respond_to?(:partial_updates=)
     CGI::Session::ActiveRecordStore::Session.partial_updates = true
     @session = CGI::Session::ActiveRecordStore::Session.new :session_id => "222222", :data  => "something" #, :updated_at => Time.now
     @session.save!
@@ -102,6 +103,7 @@ describe "OracleEnhancedAdapter database session store" do
   end
 
   it "should have one enhanced_write_lobs callback" do
+    return pending("Not in this ActiveRecord version") unless CGI::Session::ActiveRecordStore::Session.respond_to?(:after_save_callback_chain)
     CGI::Session::ActiveRecordStore::Session.after_save_callback_chain.select{|cb| cb.method == :enhanced_write_lobs}.should have(1).record
   end
 

data/spec/active_record/connection_adapters/oracle_enhanced_procedures_spec.rb

@@ -0,0 +1,268 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe "OracleEnhancedAdapter custom methods for create, update and destroy" do
+  def log_to(stream)
+    ActiveRecord::Base.logger = Logger.new(stream)
+    ActiveRecord::Base.clear_active_connections!
+    ActiveRecord::Base.colorize_logging = false
+    ActiveRecord::Base.logger.level = Logger::DEBUG
+  end
+  
+  before(:all) do
+    ActiveRecord::Base.establish_connection(:adapter => "oracle_enhanced",
+                                            :database => "xe",
+                                            :username => "hr",
+                                            :password => "hr")
+    @conn = ActiveRecord::Base.connection
+    plsql.connection = @conn.raw_connection
+    @conn.execute("DROP TABLE test_employees") rescue nil
+    @conn.execute <<-SQL
+      CREATE TABLE test_employees (
+        employee_id   NUMBER(6,0),
+        first_name    VARCHAR2(20),
+        last_name     VARCHAR2(25),
+        hire_date     DATE,
+        salary        NUMBER(8,2),
+        version       NUMBER(15,0),
+        create_time   DATE,
+        update_time   DATE
+      )
+    SQL
+    @conn.execute("DROP SEQUENCE test_employees_s") rescue nil
+    @conn.execute <<-SQL
+      CREATE SEQUENCE test_employees_s  MINVALUE 1
+        INCREMENT BY 1 CACHE 20 NOORDER NOCYCLE
+    SQL
+    @conn.execute <<-SQL
+      CREATE OR REPLACE PACKAGE test_employees_pkg IS
+        PROCEDURE create_employee(
+            p_first_name    VARCHAR2,
+            p_last_name     VARCHAR2,
+            p_hire_date     DATE,
+            p_salary        NUMBER,
+            p_employee_id   OUT NUMBER);
+        PROCEDURE update_employee(
+            p_employee_id   NUMBER,
+            p_first_name    VARCHAR2,
+            p_last_name     VARCHAR2,
+            p_hire_date     DATE,
+            p_salary        NUMBER);
+        PROCEDURE delete_employee(
+            p_employee_id   NUMBER);
+      END;
+    SQL
+    @conn.execute <<-SQL
+      CREATE OR REPLACE PACKAGE BODY test_employees_pkg IS
+        PROCEDURE create_employee(
+            p_first_name    VARCHAR2,
+            p_last_name     VARCHAR2,
+            p_hire_date     DATE,
+            p_salary        NUMBER,
+            p_employee_id   OUT NUMBER)
+        IS
+        BEGIN
+          SELECT test_employees_s.NEXTVAL INTO p_employee_id FROM dual;
+          INSERT INTO test_employees (employee_id, first_name, last_name, hire_date, salary,
+                                      version, create_time, update_time)
+          VALUES (p_employee_id, p_first_name, p_last_name, p_hire_date, p_salary,
+                                      1, SYSDATE, SYSDATE);
+        END create_employee;
+        
+        PROCEDURE update_employee(
+            p_employee_id   NUMBER,
+            p_first_name    VARCHAR2,
+            p_last_name     VARCHAR2,
+            p_hire_date     DATE,
+            p_salary        NUMBER)
+        IS
+            v_version       NUMBER;
+        BEGIN
+          SELECT version INTO v_version FROM test_employees WHERE employee_id = p_employee_id FOR UPDATE;
+          UPDATE test_employees
+          SET employee_id = p_employee_id, first_name = p_first_name, last_name = p_last_name,
+              hire_date = p_hire_date, salary = p_salary,
+              version = v_version + 1, update_time = SYSDATE;
+        END update_employee;
+        
+        PROCEDURE delete_employee(
+            p_employee_id   NUMBER)
+        IS
+        BEGIN
+          DELETE FROM test_employees WHERE employee_id = p_employee_id;
+        END delete_employee;
+      END;
+    SQL
+
+    ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_dates_by_column_name = true
+
+    class TestEmployee < ActiveRecord::Base
+      set_primary_key :employee_id
+      
+      validates_presence_of :first_name, :last_name, :hire_date
+      
+      # should return ID of new record
+      set_create_method do
+        plsql.test_employees_pkg.create_employee(
+          :p_first_name => first_name,
+          :p_last_name => last_name,
+          :p_hire_date => hire_date,
+          :p_salary => salary,
+          :p_employee_id => nil
+        )[:p_employee_id]
+      end
+
+      # return value is ignored
+      set_update_method do
+        plsql.test_employees_pkg.update_employee(
+          :p_employee_id => id,
+          :p_first_name => first_name,
+          :p_last_name => last_name,
+          :p_hire_date => hire_date,
+          :p_salary => salary
+        )
+      end
+
+      # return value is ignored
+      set_delete_method do
+        plsql.test_employees_pkg.delete_employee(
+          :p_employee_id => id
+        )
+      end
+
+    end
+  end
+  
+  after(:all) do
+    Object.send(:remove_const, "TestEmployee")
+    @conn.execute "DROP TABLE test_employees"
+    @conn.execute "DROP SEQUENCE test_employees_s"
+    @conn.execute "DROP PACKAGE test_employees_pkg"
+  end
+
+  before(:each) do
+    @today = Date.new(2008,6,28)
+    @buffer = StringIO.new
+  end
+
+  it "should create record" do
+    @employee = TestEmployee.create(
+      :first_name => "First",
+      :last_name => "Last",
+      :hire_date => @today
+    )
+    @employee.reload
+    @employee.first_name.should == "First"
+    @employee.last_name.should == "Last"
+    @employee.hire_date.should == @today
+    @employee.create_time.should_not be_nil
+    @employee.update_time.should_not be_nil
+  end
+
+  it "should update record" do
+    @employee = TestEmployee.create(
+      :first_name => "First",
+      :last_name => "Last",
+      :hire_date => @today
+    )
+    @employee.reload
+    @employee.first_name = "Second"
+    @employee.save!
+    @employee.reload
+    @employee.first_name.should == "Second"
+  end
+
+  it "should not update record if nothing is changed and partial updates are enabled" do
+    return pending("Not in this ActiveRecord version") unless TestEmployee.respond_to?(:partial_updates=)
+    TestEmployee.partial_updates = true
+    @employee = TestEmployee.create(
+      :first_name => "First",
+      :last_name => "Last",
+      :hire_date => @today
+    )
+    @employee.reload
+    @employee.save!
+    @employee.reload
+    @employee.version.should == 1
+  end
+
+  it "should update record if nothing is changed and partial updates are disabled" do
+    return pending("Not in this ActiveRecord version") unless TestEmployee.respond_to?(:partial_updates=)
+    TestEmployee.partial_updates = false
+    @employee = TestEmployee.create(
+      :first_name => "First",
+      :last_name => "Last",
+      :hire_date => @today
+    )
+    @employee.reload
+    @employee.save!
+    @employee.reload
+    @employee.version.should == 2
+  end
+
+  it "should delete record" do
+    @employee = TestEmployee.create(
+      :first_name => "First",
+      :last_name => "Last",
+      :hire_date => @today
+    )
+    @employee.reload
+    empl_id = @employee.id
+    @employee.destroy
+    @employee.should be_frozen
+    TestEmployee.find_by_employee_id(empl_id).should be_nil
+  end
+
+  it "should log create record" do
+    log_to @buffer
+    @employee = TestEmployee.create(
+      :first_name => "First",
+      :last_name => "Last",
+      :hire_date => @today
+    )
+    @buffer.string.should match(/^TestEmployee Create \(\d+\.\d+\)  custom create method$/)
+  end
+
+  it "should log update record" do
+    (TestEmployee.partial_updates = false) rescue nil
+    @employee = TestEmployee.create(
+      :first_name => "First",
+      :last_name => "Last",
+      :hire_date => @today
+    )
+    log_to @buffer
+    @employee.save!
+    @buffer.string.should match(/^TestEmployee Update \(\d+\.\d+\)  custom update method with employee_id=#{@employee.id}$/)
+  end
+
+  it "should log delete record" do
+    @employee = TestEmployee.create(
+      :first_name => "First",
+      :last_name => "Last",
+      :hire_date => @today
+    )
+    log_to @buffer
+    @employee.destroy
+    @buffer.string.should match(/^TestEmployee Destroy \(\d+\.\d+\)  custom delete method with employee_id=#{@employee.id}$/)
+  end
+
+  it "should validate new record before creation" do
+    @employee = TestEmployee.new(
+      :last_name => "Last",
+      :hire_date => @today
+    )
+    @employee.save.should be_false
+    @employee.errors.on(:first_name).should_not be_nil
+  end
+
+  it "should validate existing record before update" do
+    @employee = TestEmployee.create(
+      :first_name => "First",
+      :last_name => "Last",
+      :hire_date => @today
+    )
+    @employee.first_name = nil
+    @employee.save.should be_false
+    @employee.errors.on(:first_name).should_not be_nil
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,12 +1,14 @@
-# begin
-#   require 'spec'
-# rescue LoadError
-  require 'rubygems'
-  gem 'rspec'
-  require 'spec'
-# end
+require 'rubygems'
+gem 'rspec'
+require 'spec'
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
+# gem 'activerecord', '=2.0.2'
+# gem 'actionpack', '=2.0.2'
+# gem 'activesupport', '=2.0.2'
+gem 'activerecord', '=2.1.0'
+gem 'actionpack', '=2.1.0'
+gem 'activesupport', '=2.1.0'
 require 'activerecord'
 require 'actionpack'
 require 'action_controller/session/active_record_store'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: activerecord-oracle_enhanced-adapter
 version: !ruby/object:Gem::Version 
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors: 
 - Raimonds Simanovskis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-08 00:00:00 +03:00
+date: 2008-07-10 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
@@ -28,11 +28,13 @@ files:
 - History.txt
 - License.txt
 - README.txt
+- lib/active_record/connection_adapters/oracle_enhanced.rake
 - lib/active_record/connection_adapters/oracle_enhanced_adapter.rb
-- lib/active_record/connection_adapters/oracle_enhanced_version.rb
+- lib/active_record/connection_adapters/oracle_enhanced_procedures.rb
 - lib/active_record/connection_adapters/oracle_enhanced_tasks.rb
-- lib/active_record/connection_adapters/oracle_enhanced.rake
+- lib/active_record/connection_adapters/oracle_enhanced_version.rb
 - spec/active_record/connection_adapters/oracle_enhanced_adapter_spec.rb
+- spec/active_record/connection_adapters/oracle_enhanced_procedures_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true