pmacs-activerecord-oracle_enhanced-adapter 1.5.6.1 → 1.6.2.1

data/Rakefile

@@ -54,7 +54,7 @@ Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'doc'
-  rdoc.title = "activerecord-oracle_enhanced-adapter #{version}"
+  rdoc.title = "pmacs-activerecord-oracle_enhanced-adapter #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-1.5.6
+1.6.2.1

data/lib/active_record/connection_adapters/{oracle_enhanced_column.rb → oracle_enhanced/column.rb}

@@ -2,11 +2,13 @@ module ActiveRecord
   module ConnectionAdapters #:nodoc:
     class OracleEnhancedColumn < Column
 
-      attr_reader :table_name, :forced_column_type, :nchar, :virtual_column_data_default, :returning_id #:nodoc:
+      attr_reader :table_name, :nchar, :virtual_column_data_default, :returning_id #:nodoc:
 
-      def initialize(name, default, sql_type = nil, null = true, table_name = nil, forced_column_type = nil, virtual=false, returning_id=false) #:nodoc:
+      FALSE_VALUES << 'N'
+      TRUE_VALUES << 'Y'
+
+      def initialize(name, default, cast_type, sql_type = nil, null = true, table_name = nil, virtual=false, returning_id=false) #:nodoc:
         @table_name = table_name
-        @forced_column_type = forced_column_type
         @virtual = virtual
         @virtual_column_data_default = default.inspect if virtual
         @returning_id = returning_id
@@ -15,32 +17,20 @@ module ActiveRecord
         else
           default_value = self.class.extract_value_from_default(default)
         end
-        super(name, default_value, sql_type, null)
+        super(name, default_value, cast_type, 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'
-        @object_type = sql_type.include? '.'
-      end
-
-      def type_cast(value) #:nodoc:
-        case type
-        when :raw
-          OracleEnhancedColumn.string_to_raw(value)
-        when :datetime
-          OracleEnhancedAdapter.emulate_dates ? guess_date_or_time(value) : super
-        when :float
-          !value.nil? ? self.class.value_to_decimal(value) : super
-        else
-          super
+        if sql_type 
+          @nchar = true if cast_type.class == ActiveRecord::Type::String && sql_type[0,1] == 'N'
+          @object_type = sql_type.include? '.'
         end
+        # TODO: Need to investigate when `sql_type` becomes nil
       end
 
-      def type_cast_code(var_name)
-        type == :float ? "#{self.class.name}.value_to_decimal(#{var_name})" : super
-      end
-
-      def klass
-        type == :float ? BigDecimal : super
+      def type_cast(value) #:nodoc:
+        return OracleEnhancedColumn::string_to_raw(value) if type == :raw
+        return guess_date_or_time(value) if type == :datetime && OracleEnhancedAdapter.emulate_dates
+        super
       end
 
       def virtual?
@@ -96,45 +86,6 @@ module ActiveRecord
       
       private
 
-      def simplified_type(field_type)
-        forced_column_type ||
-        case field_type
-        when /decimal|numeric|number/i
-          if OracleEnhancedAdapter.emulate_booleans && field_type.upcase == "NUMBER(1)"
-            :boolean
-          elsif extract_scale(field_type) == 0 ||
-                # if column name is ID or ends with _ID
-                OracleEnhancedAdapter.emulate_integers_by_column_name && OracleEnhancedAdapter.is_integer_column?(name, table_name)
-            :integer
-          elsif field_type.upcase == "NUMBER"
-            OracleEnhancedAdapter.number_datatype_coercion
-          else
-            :decimal
-          end
-        when /raw/i
-          :raw
-        when /char/i
-          if OracleEnhancedAdapter.emulate_booleans_from_strings &&
-             OracleEnhancedAdapter.is_boolean_column?(name, field_type, table_name)
-            :boolean
-          else
-            :string
-          end
-        when /date/i
-          if OracleEnhancedAdapter.emulate_dates_by_column_name && OracleEnhancedAdapter.is_date_column?(name, table_name)
-            :date
-          else
-            :datetime
-          end
-        when /timestamp/i
-          :timestamp
-        when /time/i
-          :datetime
-        else
-          super
-        end
-      end
-
       def self.extract_value_from_default(default)
         case default
           when String

data/lib/active_record/connection_adapters/oracle_enhanced/column_dumper.rb

@@ -0,0 +1,65 @@
+module ActiveRecord #:nodoc:
+  module ConnectionAdapters #:nodoc:
+    module OracleEnhanced #:nodoc:
+      module ColumnDumper #:nodoc:
+        def self.included(base) #:nodoc:
+          base.class_eval do
+            private
+            alias_method_chain :column_spec,            :oracle_enhanced
+            alias_method_chain :prepare_column_options, :oracle_enhanced
+            alias_method_chain :migration_keys,         :oracle_enhanced
+
+            def oracle_enhanced_adapter?
+            # return original method if not using 'OracleEnhanced'
+              if (rails_env = defined?(Rails.env) ? Rails.env : (defined?(RAILS_ENV) ? RAILS_ENV : nil)) &&
+                  ActiveRecord::Base.configurations[rails_env] &&
+                  ActiveRecord::Base.configurations[rails_env]['adapter'] != 'oracle_enhanced'
+                return false
+              else
+                return true
+              end
+            end
+          end
+        end
+
+        def column_spec_with_oracle_enhanced(column, types)
+          # return original method if not using 'OracleEnhanced'
+          return column_spec_without_oracle_enhanced(column, types) unless oracle_enhanced_adapter?
+
+          spec = prepare_column_options(column, types)
+          (spec.keys - [:name, :type]).each do |k|
+            key_s = (k == :virtual_type ? "type: " : "#{k.to_s}: ")
+            spec[k] = key_s + spec[k]
+          end
+          spec
+        end
+
+        def prepare_column_options_with_oracle_enhanced(column, types)
+          # return original method if not using 'OracleEnhanced'
+          return prepare_column_options_without_oracle_enhanced(column, types) unless oracle_enhanced_adapter?
+
+          spec = {}
+          spec[:name]      = column.name.inspect
+          spec[:type]      = column.virtual? ? 'virtual' : column.type.to_s
+          spec[:virtual_type] = column.type.inspect if column.virtual? && column.sql_type != 'NUMBER'
+          spec[:limit]     = column.limit.inspect if column.limit != types[column.type][:limit] && column.type != :decimal
+          spec[:precision] = column.precision.inspect if !column.precision.nil?
+          spec[:scale]     = column.scale.inspect if !column.scale.nil?
+          spec[:null]      = 'false' if !column.null
+          spec[:as]        = column.virtual_column_data_default if column.virtual?
+          spec[:default]   = schema_default(column) if column.has_default? && !column.virtual?
+          spec.delete(:default) if spec[:default].nil?
+          spec
+        end
+
+        def migration_keys_with_oracle_enhanced
+          # TODO `& column_specs.map(&:keys).flatten` should be exetuted here
+          # return original method if not using 'OracleEnhanced'
+          return migration_keys_without_oracle_enhanced unless oracle_enhanced_adapter?
+
+          [:name, :limit, :precision, :scale, :default, :null, :as, :virtual_type]
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/{oracle_enhanced_connection.rb → oracle_enhanced/connection.rb}

@@ -109,11 +109,11 @@ end
 # if MRI or YARV
 if !defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby'
   ORACLE_ENHANCED_CONNECTION = :oci
-  require 'active_record/connection_adapters/oracle_enhanced_oci_connection'
+  require 'active_record/connection_adapters/oracle_enhanced/oci_connection'
 # if JRuby
 elsif RUBY_ENGINE == 'jruby'
   ORACLE_ENHANCED_CONNECTION = :jdbc
-  require 'active_record/connection_adapters/oracle_enhanced_jdbc_connection'
+  require 'active_record/connection_adapters/oracle_enhanced/jdbc_connection'
 else
   raise "Unsupported Ruby engine #{RUBY_ENGINE}"
 end

data/lib/active_record/connection_adapters/oracle_enhanced/context_index.rb

@@ -0,0 +1,347 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module OracleEnhanced
+      module ContextIndex
+
+        # Define full text index with Oracle specific CONTEXT index type
+        #
+        # Oracle CONTEXT index by default supports full text indexing of one column.
+        # This method allows full text index creation also on several columns
+        # as well as indexing related table columns by generating stored procedure
+        # that concatenates all columns for indexing as well as generating trigger
+        # that will update main index column to trigger reindexing of record.
+        #
+        # Use +contains+ ActiveRecord model instance method to add CONTAINS where condition
+        # and order by score of matched results.
+        #
+        # Options:
+        #
+        # * <tt>:name</tt>
+        # * <tt>:index_column</tt>
+        # * <tt>:index_column_trigger_on</tt>
+        # * <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
+        #
+        # ====== Creating single column index
+        #  add_context_index :posts, :title
+        # search with
+        #  Post.contains(:title, 'word')
+        #
+        # ====== Creating index on several columns
+        #  add_context_index :posts, [:title, :body]
+        # search with (use first column as argument for contains method but it will search in all index columns)
+        #  Post.contains(:title, 'word')
+        #
+        # ====== Creating index on several columns with dummy index column and commit option
+        #  add_context_index :posts, [:title, :body], :index_column => :all_text, :sync => 'ON COMMIT'
+        # search with
+        #  Post.contains(:all_text, 'word')
+        #
+        # ====== Creating index with trigger option (will reindex when specified columns are updated)
+        #  add_context_index :posts, [:title, :body], :index_column => :all_text, :sync => 'ON COMMIT',
+        #                     :index_column_trigger_on => [:created_at, :updated_at]
+        # search with
+        #  Post.contains(:all_text, 'word')
+        #
+        # ====== Creating index on multiple tables
+        #  add_context_index :posts,
+        #   [:title, :body,
+        #   # specify aliases always with AS keyword
+        #   "SELECT comments.author AS comment_author, comments.body AS comment_body FROM comments WHERE comments.post_id = :id"
+        #   ],
+        #   :name => 'post_and_comments_index',
+        #   :index_column => :all_text, :index_column_trigger_on => [:updated_at, :comments_count],
+        #   :sync => 'ON COMMIT'
+        # search in any table columns
+        #  Post.contains(:all_text, 'word')
+        # search in specified column
+        #  Post.contains(:all_text, "aaa within title")
+        #  Post.contains(:all_text, "bbb within comment_author")
+        #
+        # ====== 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
+        #
+        def add_context_index(table_name, column_name, options = {})
+          self.all_schema_indexes = nil
+          column_names = Array(column_name)
+          index_name = options[:name] || index_name(table_name, :column => options[:index_column] || column_names,
+            # CONEXT index name max length is 25
+            :identifier_max_length => 25)
+
+          quoted_column_name = quote_column_name(options[:index_column] || column_names.first)
+          if options[:index_column_trigger_on]
+            raise ArgumentError, "Option :index_column should be specified together with :index_column_trigger_on option" \
+              unless options[:index_column]
+            create_index_column_trigger(table_name, index_name, options[:index_column], options[:index_column_trigger_on])
+          end
+
+          sql = "CREATE INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)}"
+          sql << " (#{quoted_column_name})"
+          sql << " INDEXTYPE IS CTXSYS.CONTEXT"
+          parameters = []
+          if column_names.size > 1
+            procedure_name = default_datastore_procedure(index_name)
+            datastore_name = default_datastore_name(index_name)
+            create_datastore_procedure(table_name, procedure_name, column_names, options)
+            create_datastore_preference(datastore_name, procedure_name)
+            parameters << "DATASTORE #{datastore_name} SECTION GROUP CTXSYS.AUTO_SECTION_GROUP"
+          end
+          if options[:tablespace]
+            storage_name = default_storage_name(index_name)
+            create_storage_preference(storage_name, options[:tablespace])
+            parameters << "STORAGE #{storage_name}"
+          end
+          if options[:sync]
+            parameters << "SYNC(#{options[:sync]})"
+          end
+          if options[:lexer] && (lexer_type = options[:lexer][:type])
+            lexer_name = default_lexer_name(index_name)
+            (lexer_options = options[:lexer].dup).delete(:type)
+            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
+          unless parameters.empty?
+            sql << " PARAMETERS ('#{parameters.join(' ')}')"
+          end
+          execute sql
+        end
+
+        # Drop full text index with Oracle specific CONTEXT index type
+        def remove_context_index(table_name, options = {})
+          self.all_schema_indexes = nil
+          unless Hash === options # if column names passed as argument
+            options = {:column => Array(options)}
+          end
+          index_name = options[:name] || index_name(table_name,
+            :column => options[:index_column] || options[:column], :identifier_max_length => 25)
+          execute "DROP INDEX #{index_name}"
+          drop_ctx_preference(default_datastore_name(index_name))
+          drop_ctx_preference(default_storage_name(index_name))
+          procedure_name = default_datastore_procedure(index_name)
+          execute "DROP PROCEDURE #{quote_table_name(procedure_name)}" rescue nil
+          drop_index_column_trigger(index_name)
+        end
+
+        private
+
+        def create_datastore_procedure(table_name, procedure_name, column_names, options)
+          quoted_table_name = quote_table_name(table_name)
+          select_queries, column_names = column_names.partition { |c| c.to_s =~ /^\s*SELECT\s+/i }
+          select_queries = select_queries.map { |s| s.strip.gsub(/\s+/, ' ') }
+          keys, selected_columns = parse_select_queries(select_queries)
+          quoted_column_names = (column_names+keys).map{|col| quote_column_name(col)}
+          execute compress_lines(<<-SQL)
+            CREATE OR REPLACE PROCEDURE #{quote_table_name(procedure_name)}
+              (p_rowid IN	      ROWID,
+              p_clob	IN OUT NOCOPY CLOB) IS
+              -- add_context_index_parameters #{(column_names+select_queries).inspect}#{!options.empty? ? ', ' << options.inspect[1..-2] : ''}
+              #{
+              selected_columns.map do |cols|
+                cols.map do |col|
+                  raise ArgumentError, "Alias #{col} too large, should be 28 or less characters long" unless col.length <= 28
+                  "l_#{col} VARCHAR2(32767);\n"
+                end.join
+              end.join
+              } BEGIN
+              FOR r1 IN (
+                SELECT #{quoted_column_names.join(', ')}
+                FROM	 #{quoted_table_name}
+                WHERE  #{quoted_table_name}.ROWID = p_rowid
+              ) LOOP
+                #{
+                (column_names.map do |col|
+                  col = col.to_s
+                  "DBMS_LOB.WRITEAPPEND(p_clob, #{col.length+2}, '<#{col}>');\n" <<
+                  "IF LENGTH(r1.#{col}) > 0 THEN\n" <<
+                  "DBMS_LOB.WRITEAPPEND(p_clob, LENGTH(r1.#{col}), r1.#{col});\n" <<
+                  "END IF;\n" <<
+                  "DBMS_LOB.WRITEAPPEND(p_clob, #{col.length+3}, '</#{col}>');\n"
+                end.join) <<
+                (selected_columns.zip(select_queries).map do |cols, query|
+                  (cols.map do |col|
+                    "l_#{col} := '';\n"
+                  end.join) <<
+                  "FOR r2 IN (\n" <<
+                  query.gsub(/:(\w+)/,"r1.\\1") << "\n) LOOP\n" <<
+                  (cols.map do |col|
+                    "l_#{col} := l_#{col} || r2.#{col} || CHR(10);\n"
+                  end.join) <<
+                  "END LOOP;\n" <<
+                  (cols.map do |col|
+                    col = col.to_s
+                    "DBMS_LOB.WRITEAPPEND(p_clob, #{col.length+2}, '<#{col}>');\n" <<
+                    "IF LENGTH(l_#{col}) > 0 THEN\n" <<
+                    "DBMS_LOB.WRITEAPPEND(p_clob, LENGTH(l_#{col}), l_#{col});\n" <<
+                    "END IF;\n" <<
+                    "DBMS_LOB.WRITEAPPEND(p_clob, #{col.length+3}, '</#{col}>');\n"
+                  end.join)
+                end.join)
+                }
+              END LOOP;
+            END;
+          SQL
+        end
+
+        def parse_select_queries(select_queries)
+          keys = []
+          selected_columns = []
+          select_queries.each do |query|
+            # get primary or foreign keys like :id or :something_id
+            keys << (query.scan(/:\w+/).map{|k| k[1..-1].downcase.to_sym})
+            select_part = query.scan(/^select\s.*\sfrom/i).first
+            selected_columns << select_part.scan(/\sas\s+(\w+)/i).map{|c| c.first}
+          end
+          [keys.flatten.uniq, selected_columns]
+        end
+
+        def create_datastore_preference(datastore_name, procedure_name)
+          drop_ctx_preference(datastore_name)
+          execute <<-SQL
+            BEGIN
+              CTX_DDL.CREATE_PREFERENCE('#{datastore_name}', 'USER_DATASTORE');
+              CTX_DDL.SET_ATTRIBUTE('#{datastore_name}', 'PROCEDURE', '#{procedure_name}');
+            END;
+          SQL
+        end
+
+        def create_storage_preference(storage_name, tablespace)
+          drop_ctx_preference(storage_name)
+          sql = "BEGIN\nCTX_DDL.CREATE_PREFERENCE('#{storage_name}', 'BASIC_STORAGE');\n"
+          ['I_TABLE_CLAUSE', 'K_TABLE_CLAUSE', 'R_TABLE_CLAUSE',
+          'N_TABLE_CLAUSE', 'I_INDEX_CLAUSE', 'P_TABLE_CLAUSE'].each do |clause|
+            default_clause = case clause
+            when 'R_TABLE_CLAUSE'; 'LOB(DATA) STORE AS (CACHE) '
+            when 'I_INDEX_CLAUSE'; 'COMPRESS 2 '
+            else ''
+            end
+            sql << "CTX_DDL.SET_ATTRIBUTE('#{storage_name}', '#{clause}', '#{default_clause}TABLESPACE #{tablespace}');\n"
+          end
+          sql << "END;\n"
+          execute sql
+        end
+
+        def create_lexer_preference(lexer_name, lexer_type, options)
+          drop_ctx_preference(lexer_name)
+          sql = "BEGIN\nCTX_DDL.CREATE_PREFERENCE('#{lexer_name}', '#{lexer_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('#{lexer_name}', '#{key}', #{plsql_value});\n"
+          end
+          sql << "END;\n"
+          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
+
+        def create_index_column_trigger(table_name, index_name, index_column, index_column_source)
+          trigger_name = default_index_column_trigger_name(index_name)
+          columns = Array(index_column_source)
+          quoted_column_names = columns.map{|col| quote_column_name(col)}.join(', ')
+          execute compress_lines(<<-SQL)
+            CREATE OR REPLACE TRIGGER #{quote_table_name(trigger_name)}
+            BEFORE UPDATE OF #{quoted_column_names} ON #{quote_table_name(table_name)} FOR EACH ROW
+            BEGIN
+              :new.#{quote_column_name(index_column)} := '1';
+            END;
+          SQL
+        end
+
+        def drop_index_column_trigger(index_name)
+          trigger_name = default_index_column_trigger_name(index_name)
+          execute "DROP TRIGGER #{quote_table_name(trigger_name)}" rescue nil
+        end
+
+        def default_datastore_procedure(index_name)
+          "#{index_name}_prc"
+        end
+
+        def default_datastore_name(index_name)
+          "#{index_name}_dst"
+        end
+
+        def default_storage_name(index_name)
+          "#{index_name}_sto"
+        end
+
+        def default_index_column_trigger_name(index_name)
+          "#{index_name}_trg"
+        end
+
+        def default_lexer_name(index_name)
+          "#{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.
+          def has_context_index
+            extend ContextIndexClassMethods
+          end
+        end
+
+        module ContextIndexClassMethods
+          # Add context index condition.
+          def contains(column, query, options ={})
+            score_label = options[:label].to_i || 1
+            where("CONTAINS(#{connection.quote_column_name(column)}, ?, #{score_label}) > 0", query).
+              order("SCORE(#{score_label}) DESC")
+          end
+        end
+
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  extend ActiveRecord::ConnectionAdapters::OracleEnhanced::ContextIndex::BaseClassMethods
+end