activerecord-oracle_enhanced-adapter 1.4.1 → 1.4.2.rc1

data/Gemfile

@@ -3,6 +3,7 @@ source 'http://rubygems.org'
 group :development do
   gem 'jeweler', '~> 1.5.1'
   gem 'rspec', '~> 2.4'
+  gem 'rdoc'
 
   if ENV['RAILS_GEM_VERSION']
     gem 'activerecord', "=#{ENV['RAILS_GEM_VERSION']}"

data/History.md

@@ -1,4 +1,19 @@
-### 1.4.1 / 2011-01-27
+### 1.4.2.rc1 / 2012-11-13
+
+* Enhancements:
+  * Wordlist option for context index [#154]
+  * Fall back to directly connecting via OracleDriver on JRuby [#163]
+  * Allow slash-prefixed database name in database.yml for using a service [#201]
+* Bug fixes:
+  * Fixed explain plans to work with JDBC and OCI8 [#146]
+  * Fixed various issues with virtual columns [#159]
+  * Fixed SQL structure dump with function indexes [#161]
+  * Fixed broken column remove inside a change_table block [#216]
+  * Dump indexes on virtual columns using the column's name instead of the column expression [#211]
+  * Don't update lobs that haven't changed or are attr_readonly [#212]
+  * Support dirty tracking with rails 3.2.9
+
+### 1.4.1 / 2012-01-27
 
 * Enhancements:
   * Support for Rails 3.2

data/README.md

@@ -25,7 +25,7 @@ If you would like to use latest adapter version from github then specify
 
 If you are using MRI 1.8 or 1.9 Ruby implementation then you need to install ruby-oci8 gem as well as Oracle client, e.g. [Oracle Instant Client](http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html). Include in Gemfile also ruby-oci8:
 
-    gem 'ruby-oci8', '~> 2.0.6'
+    gem 'ruby-oci8', '~> 2.1.0'
 
 If you are using JRuby then you need to download latest [Oracle JDBC driver](http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html) - either ojdbc6.jar for Java 6 or ojdbc5.jar for Java 5. And copy this file to one of these locations:
 
@@ -72,6 +72,15 @@ In Rails application `config/database.yml` use oracle_enhanced as adapter name,
       username: user
       password: secret
 
+If you're connecting to a service name, indicate the service with a
+leading slash on the database parameter:
+
+    development:
+      adapter: oracle_enhanced
+      database: /xe
+      username: user
+      password: secret
+
 If `TNS_ADMIN` environment variable is pointing to directory where `tnsnames.ora` file is located then you can use TNS connection name in `database` parameter. Otherwise you can directly specify database host, port (defaults to 1521) and database name in the following way:
 
     development:
@@ -248,6 +257,54 @@ And you can even create index on multiple tables by providing SELECT statements
     Post.contains(:all_text, "aaa within title")
     Post.contains(:all_text, "bbb within comment_author")
 
+### Oracle virtual collumns support
+
+Since version R11G1 Oracle database allows adding computed [Virtual Columns](http://www.oracle-base.com/articles/11g/virtual-columns-11gr1.php) to the table.
+They can be used as normal fields in the queries, in the foreign key contstraints and to partitioning data.
+
+To define virtual column you can use `virtual` method in the `create_table` block, providing column expression in the `:as` option:
+
+    create_table :mytable do |t|
+        t.decimal :price, :precision => 15, :scale => 2
+        t.decimal :quantity, :precision => 15, :scale => 2
+        t.virtual :amount, :as => 'price * quantity'
+    end
+
+Oracle tries to predict type of the virtual column, based on its expression but sometimes it is necessary to state type explicitly.
+This can be done by providing `:type` option to the `virtual` method:
+
+    ...
+    t.virtual :amount_2, :as => 'ROUND(price * quantity,2)', :type => :decimal, :precision => 15, :scale => 2
+    t.virtual :amount_str, :as => "TO_CHAR(quantity) || ' x ' || TO_CHAR(price) || ' USD = ' || TO_CHAR(quantity*price) || ' USD'",
+        :type => :string, :limit => 100
+    ...
+
+It is possible to add virtual column to existing table:
+
+    add_column :mytable, :amount_4, :virtual, :as => 'ROUND(price * quantity,4)', :precision => 38, :scale => 4
+
+You can use the same options here as in the `create_table` `virtual` method.
+
+Changing virtual columns is also possible:
+
+    change_column :mytable, :amount, :virtual, :as => 'ROUND(price * quantity,0)', :type => :integer
+
+Virtual columns allowed in the foreign key constraints.
+For example it can be used to force foreign key constraint on polymorphic association:
+
+    create_table :comments do |t|
+      t.string :subject_type
+      t.integer :subject_id
+      t.virtual :subject_photo_id, :as => "CASE subject_type WHEN 'Photo' THEN subject_id END"
+      t.virtual :subject_event_id, :as => "CASE subject_type WHEN 'Event' THEN subject_id END"
+    end
+
+    add_foreign_key :comments, :photos, :column => :subject_photo_id
+    add_foreign_key :comments, :events, :column => :subject_event_id
+
+For backward compatibility reasons it is possible to use `:default` option in the `create_table` instead of `:as` option.
+But this is deprecated and may be removed in the future version.
+
 ### Oracle specific schema statements and data types
 
 There are several additional schema statements and data types available that you can use in database migrations:
@@ -257,7 +314,6 @@ There are several additional schema statements and data types available that you
   * You can create table with primary key trigger using `:primary_key_trigger => true` option for `create_table`
   * You can define columns with `raw` type which maps to Oracle's `RAW` type
   * You can add table and column comments with `:comment` option
-  * On Oracle 11g you can define `virtual` columns with calculation formula in `:default` option
   * Default tablespaces can be specified for tables, indexes, clobs and blobs, for example:
 
         ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.default_tablespaces =
@@ -285,7 +341,7 @@ Please verify that
         require 'rubygems'
         gem 'activerecord'
         gem 'activerecord-oracle_enhanced-adapter'
-        require 'activerecord'
+        require 'active_record'
         ActiveRecord::Base.establish_connection(:adapter => "oracle_enhanced", :database => "database",:username => "user",:password => "password")
 
     and see if it is successful (use your correct database, username and password)
@@ -320,37 +376,6 @@ LINKS
 * Discuss at Oracle enhanced adapter group: http://groups.google.com/group/oracle-enhanced
 * Blog posts about Oracle enhanced adapter can be found at http://blog.rayapps.com/category/oracle_enhanced
 
-CONTRIBUTORS
-------------
-
-* Raimonds Simanovskis
-* Jorge Dias
-* James Wylder
-* Rob Christie
-* Nate Wieger
-* Edgars Beigarts
-* Lachlan Laycock
-* toddwf
-* Anton Jenkins
-* Dave Smylie
-* Alex Rothenberg
-* Billy Reisinger
-* David Blain
-* Joe Khoobyar
-* Edvard Majakari
-* Beau Fabry
-* Simon Chiang
-* Peter Nyberg
-* Dwayne Litzenberger
-* Aaron Patterson
-* Darcy Schultz
-* Alexi Rahman
-* Joeri Samson
-* Luca Bernardo Ciddio
-* Sam Baskinger
-* Benjamin Ortega
-* Yasuo Honda
-
 LICENSE
 -------
 
@@ -375,4 +400,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -33,9 +33,22 @@ RSpec::Core::RakeTask.new(:rcov) do |t|
   t.rcov_opts =  ['--exclude', '/Library,spec/']
 end
 
+desc "Clear test database"
+task :clear do
+  require "./spec/spec_helper"
+  ActiveRecord::Base.establish_connection(CONNECTION_PARAMS)
+  require "active_support/core_ext"
+  ActiveRecord::Base.connection.execute_structure_dump(ActiveRecord::Base.connection.full_drop)
+  ActiveRecord::Base.connection.execute("PURGE RECYCLEBIN") rescue nil
+end
+
+# Clear test database before running spec and rcov
+task :spec => :clear
+task :rcov => :clear
+
 task :default => :spec
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 

data/VERSION

@@ -1 +1 @@
-1.4.1
+1.4.2.rc1

data/activerecord-oracle_enhanced-adapter.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{activerecord-oracle_enhanced-adapter}
-  s.version = "1.4.1"
+  s.version = "1.4.2.rc1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Raimonds Simanovskis}]
-  s.date = %q{2012-01-27}
+  s.date = %q{2012-11-13}
   s.description = %q{Oracle "enhanced" ActiveRecord adapter contains useful additional methods for working with new and legacy Oracle databases.
 This adapter is superset of original ActiveRecord Oracle adapter.
 }

data/lib/active_record/connection_adapters/oracle_enhanced_adapter.rb

@@ -656,7 +656,11 @@ module ActiveRecord
       def explain(arel, binds = [])
         sql = "EXPLAIN PLAN FOR #{to_sql(arel)}"
         return if sql =~ /FROM all_/
-        exec_query(sql, 'EXPLAIN', binds)
+        if ORACLE_ENHANCED_CONNECTION == :jdbc
+          exec_query(sql, 'EXPLAIN', binds)
+        else
+          exec_query(sql, 'EXPLAIN')
+        end
         select_values("SELECT * FROM TABLE(DBMS_XPLAN.DISPLAY)", 'EXPLAIN').join("\n")
       end
 
@@ -855,12 +859,12 @@ module ActiveRecord
 
         klass = klass.constantize rescue nil
         if klass.respond_to?(:ancestors) && klass.ancestors.include?(ActiveRecord::Base)
-          write_lobs(table_name, klass, fixture)
+          write_lobs(table_name, klass, fixture, klass.lob_columns)
         end
       end
 
-      # Writes LOB values from attributes, as indicated by the LOB columns of klass.
-      def write_lobs(table_name, klass, attributes) #:nodoc:
+      # Writes LOB values from attributes for specified columns
+      def write_lobs(table_name, klass, attributes, columns) #:nodoc:
         # is class with composite primary key>
         is_with_cpk = klass.respond_to?(:composite?) && klass.composite?
         if is_with_cpk
@@ -868,7 +872,7 @@ module ActiveRecord
         else
           id = quote(attributes[klass.primary_key])
         end
-        klass.columns.select { |col| col.sql_type =~ /LOB$/i }.each do |col|
+        columns.each do |col|
           value = attributes[col.name]
           # changed sequence of next two lines - should check if value is nil before converting to yaml
           next if value.nil?  || (value == '')
@@ -930,11 +934,14 @@ module ActiveRecord
             SELECT LOWER(i.table_name) AS table_name, LOWER(i.index_name) AS index_name, i.uniqueness,
               i.index_type, i.ityp_owner, i.ityp_name, i.parameters,
               LOWER(i.tablespace_name) AS tablespace_name,
-              LOWER(c.column_name) AS column_name, e.column_expression
+              LOWER(c.column_name) AS column_name, e.column_expression,
+              atc.virtual_column
             FROM all_indexes#{db_link} i
               JOIN all_ind_columns#{db_link} c ON c.index_name = i.index_name AND c.index_owner = i.owner
               LEFT OUTER JOIN all_ind_expressions#{db_link} e ON e.index_name = i.index_name AND
                 e.index_owner = i.owner AND e.column_position = c.column_position
+              LEFT OUTER JOIN all_tab_cols#{db_link} atc ON i.table_name = atc.table_name AND
+                c.column_name = atc.column_name AND i.owner = atc.owner AND atc.hidden_column = 'NO'
             WHERE i.owner = '#{owner}'
                AND i.table_owner = '#{owner}'
                AND NOT EXISTS (SELECT uc.index_name FROM all_constraints uc
@@ -969,7 +976,16 @@ module ActiveRecord
                 row['tablespace_name'] == default_tablespace_name ? nil : row['tablespace_name'], [])
               current_index = row['index_name']
             end
-            all_schema_indexes.last.columns << (row['column_expression'] || row['column_name'].downcase)
+
+            # Functional index columns and virtual columns both get stored as column expressions, 
+            # but re-creating a virtual column index as an expression (instead of using the virtual column's name)
+            # results in a ORA-54018 error.  Thus, we only want the column expression value returned
+            # when the column is not virtual.
+            if row['column_expression'] && row['virtual_column'] != 'YES'
+              all_schema_indexes.last.columns << row['column_expression']
+            else
+              all_schema_indexes.last.columns << row['column_name'].downcase
+            end
           end
         end
 
@@ -1089,8 +1105,10 @@ module ActiveRecord
             row['sql_type'] += "(#{(limit || 38).to_i}" + ((scale = scale.to_i) > 0 ? ",#{scale})" : ")")
           end
 
+          is_virtual = row['virtual_column']=='YES'
+
           # clean up odd default spacing from Oracle
-          if row['data_default']
+          if row['data_default'] && !is_virtual
             row['data_default'].sub!(/^(.*?)\s*$/, '\1')
 
             # If a default contains a newline these cleanup regexes need to 
@@ -1106,7 +1124,7 @@ module ActiveRecord
                            # pass table name for table specific column definitions
                            table_name,
                            # pass column type if specified in class definition
-                           get_type_for_column(table_name, oracle_downcase(row['name'])), row['virtual_column']=='YES')
+                           get_type_for_column(table_name, oracle_downcase(row['name'])), is_virtual)
         end
       end
 

data/lib/active_record/connection_adapters/oracle_enhanced_base_ext.rb

@@ -62,23 +62,35 @@ module ActiveRecord
     # After setting large objects to empty, select the OCI8::LOB
     # and write back the data.
     if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR >= 1
+      before_update :record_changed_lobs
       after_update :enhanced_write_lobs
     else
+      before_update :record_changed_lobs
       after_save :enhanced_write_lobs
     end
     def enhanced_write_lobs #:nodoc:
       if connection.is_a?(ConnectionAdapters::OracleEnhancedAdapter) &&
           !(self.class.custom_create_method || self.class.custom_update_method)
-        connection.write_lobs(self.class.table_name, self.class, attributes)
+        connection.write_lobs(self.class.table_name, self.class, attributes, @changed_lob_columns || self.class.lob_columns)
       end
     end
+    def record_changed_lobs
+      @changed_lob_columns = self.class.lob_columns.select{|col| self.send(:"#{col.name}_changed?") && !self.class.readonly_attributes.to_a.include?(col.name)}
+    end
     private :enhanced_write_lobs
+    private :record_changed_lobs
 
     # Get table comment from schema definition.
     def self.table_comment
       connection.table_comment(self.table_name)
     end
 
+    def self.lob_columns
+      columns.select do |column|
+        column.respond_to?(:lob?) && column.lob?
+      end
+    end
+
     def self.virtual_columns
       columns.select do |column|
         column.respond_to?(:virtual?) && column.virtual?

data/lib/active_record/connection_adapters/oracle_enhanced_column.rb

@@ -3,13 +3,14 @@ module ActiveRecord
     class OracleEnhancedColumn < Column
 
       attr_reader :table_name, :forced_column_type, :nchar, :virtual_column_data_default #:nodoc:
-      
+
       def initialize(name, default, sql_type = nil, null = true, table_name = nil, forced_column_type = nil, virtual=false) #:nodoc:
         @table_name = table_name
         @forced_column_type = forced_column_type
         @virtual = virtual
-        super(name, default, sql_type, null)
         @virtual_column_data_default = default.inspect if virtual
+        default = nil if virtual
+        super(name, default, sql_type, null)
         # Is column NCHAR or NVARCHAR2 (will need to use N'...' value quoting for these data types)?
         # Define only when needed as adapter "quote" method will check at first if instance variable is defined.
         @nchar = true if @type == :string && sql_type[0,1] == 'N'
@@ -25,6 +26,10 @@ module ActiveRecord
         @virtual
       end
 
+      def lob?
+        self.sql_type =~ /LOB$/i
+      end
+
       # convert something to a boolean
       # added y as boolean value
       def self.value_to_boolean(value) #:nodoc:

data/lib/active_record/connection_adapters/oracle_enhanced_context_index.rb

@@ -21,6 +21,7 @@ module ActiveRecord
       # * <tt>:tablespace</tt>
       # * <tt>:sync</tt> - 'MANUAL', 'EVERY "interval-string"' or 'ON COMMIT' (defaults to 'MANUAL').
       # * <tt>:lexer</tt> - Lexer options (e.g. <tt>:type => 'BASIC_LEXER', :base_letter => true</tt>).
+      # * <tt>:wordlist</tt> - Wordlist options (e.g. <tt>:type => 'BASIC_WORDLIST', :prefix_index => true</tt>).
       # * <tt>:transactional</tt> - When +true+, the CONTAINS operator will process inserted and updated rows.
       #
       # ===== Examples
@@ -64,6 +65,9 @@ module ActiveRecord
       # ====== Creating index using lexer
       #  add_context_index :posts, :title, :lexer => { :type => 'BASIC_LEXER', :base_letter => true, ... }
       #
+      # ====== Creating index using wordlist
+      #  add_context_index :posts, :title, :wordlist => { :type => 'BASIC_WORDLIST', :prefix_index => true, ... }
+      #
       # ====== Creating transactional index (will reindex changed rows when querying)
       #  add_context_index :posts, :title, :transactional => true
       #
@@ -106,6 +110,12 @@ module ActiveRecord
           create_lexer_preference(lexer_name, lexer_type, lexer_options)
           parameters << "LEXER #{lexer_name}"
         end
+        if options[:wordlist] && (wordlist_type = options[:wordlist][:type])
+          wordlist_name = default_wordlist_name(index_name)
+          (wordlist_options = options[:wordlist].dup).delete(:type)
+          create_wordlist_preference(wordlist_name, wordlist_type, wordlist_options)
+          parameters << "WORDLIST #{wordlist_name}"
+        end
         if options[:transactional]
           parameters << "TRANSACTIONAL"
         end
@@ -246,6 +256,23 @@ module ActiveRecord
         execute sql
       end
 
+      def create_wordlist_preference(wordlist_name, wordlist_type, options)
+        drop_ctx_preference(wordlist_name)
+        sql = "BEGIN\nCTX_DDL.CREATE_PREFERENCE('#{wordlist_name}', '#{wordlist_type}');\n"
+        options.each do |key, value|
+          plsql_value = case value
+          when String; "'#{value}'"
+          when true; "'YES'"
+          when false; "'NO'"
+          when nil; 'NULL'
+          else value
+          end
+          sql << "CTX_DDL.SET_ATTRIBUTE('#{wordlist_name}', '#{key}', #{plsql_value});\n"
+        end
+        sql << "END;\n"
+        execute sql
+      end
+
       def drop_ctx_preference(preference_name)
         execute "BEGIN CTX_DDL.DROP_PREFERENCE('#{preference_name}'); END;" rescue nil
       end
@@ -288,6 +315,10 @@ module ActiveRecord
         "#{index_name}_lex"
       end
 
+      def default_wordlist_name(index_name)
+        "#{index_name}_wl"
+      end
+
       module BaseClassMethods
         # Declare that model table has context index defined.
         # As a result <tt>contains</tt> class scope method is defined.

data/lib/active_record/connection_adapters/oracle_enhanced_dirty.rb

@@ -5,7 +5,7 @@ module ActiveRecord #:nodoc:
       module InstanceMethods #:nodoc:
         private
         
-        def field_changed?(attr, old, value)
+        def _field_changed?(attr, old, value)
           if column = column_for_attribute(attr)
             # Added also :decimal type
             if (column.type == :integer || column.type == :decimal) && column.null && (old.nil? || old == 0) && value.blank?
@@ -35,5 +35,10 @@ end
 if ActiveRecord::Base.method_defined?(:changed?)
   ActiveRecord::Base.class_eval do
     include ActiveRecord::ConnectionAdapters::OracleEnhancedDirty::InstanceMethods
+    # Starting with rails 3.2.9 the method #field_changed?
+    # was renamed to #_field_changed?
+    if private_method_defined?(:field_changed?)
+      alias_method :field_changed?, :_field_changed?
+    end
   end
 end