redhillonrails_core 1.0.6 → 1.0.8

data/CHANGELOG

@@ -1,3 +1,12 @@
+1.0.8
+    * handle expressions when creating indexes
+    * relay on ActiveRecord add_index method when handling legacy API
+1.0.7
+    * support for partial indexes
+1.0.6
+    * Fixed case-sensitive indexes
+1.0.5
+    * added missing quoting
 1.0.4
     * Autoloading
 1.0.3

data/README.rdoc

@@ -1,14 +1,28 @@
-NOTE: This plugin was created by harukizaemon(http://github.com/harukizaemon) but is not supported currently by him.
+= Credits
+
+This plugin was created by harukizaemon(http://github.com/harukizaemon) but is not supported currently by him.
+I've forked it to make it edge-rails compatible and to introduce new features.
 
 = RedHill on Rails Core
 
-RedHill on Rails Core is a plugin that features to support other RedHill on Rails plugins.  Those features include:
+RedHill on Rails Core provides bunch of useful database features:
 
 * Creating and dropping views;
 * Creating and removing foreign-keys;
+* Creating partial indexes (postgresql only)
 * Obtaining indexes directly from a model class; and
 * Determining when <code>Schema.define()</code> is running.
 
+=== Installation
+
+As a gem
+    
+  gem install redhillonrails_core
+
+...or as a plugin
+
+  script/plugin install http://github.com/mlomnicki/redhillonrails_core.git
+
 === View Support
 
 The plugin provides a mechanism for creating and dropping views as well as
@@ -118,11 +132,22 @@ indexes for a given model--<code>ActiveRecord::Base</code>--class. For example:
 
 Would return all the indexes for the +invoices+ table.
 
-=== Schema Defining
+=== Partial Indexes (indexes with conditions)
 
-The plugin also adds a method--<code>defining?()</code>--to
-<code>ActiveRecord::Schema</code> to indicate when <code>define()</code> is running. This is necessary
-as some migration plugins must change their behaviour accordingly.
+Partial indexes index only a portion of the database. Only PostgreSQL supports this feature.
+
+  add_index :users, :username, :unique => true, :conditions => {:state => "active"}
+
+=== Indexing using an arbitrary expression (PostgreSQL only)
+
+Create expression-based indexes:
+
+  add_index :users, [:first_name, :last_name], :expression => 'LOWER(first_name || last_name)'
+  add_index :places, :expression => 'sin(lat) * cos(lng)', :name => 'index_places_on_something'
+  add_index :documents, :body, :expression => "USING gin (to_tsvector('english', body))" 
+
+Expression is a pass-through: no quoting, escaping is done on it. Presumably, this expression is
+part of migrations, or at least, code under your control.
 
 === Case-insensitive Indexes
 
@@ -141,14 +166,14 @@ Note also that this ties in well with Rails built-in support for case-insensitiv
 
   validates_uniqueness_of :name, :case_sensitive => false
 
-=== See Also
+=== Schema Defining
+
+The plugin also adds a method--<code>defining?()</code>--to
+<code>ActiveRecord::Schema</code> to indicate when <code>define()</code> is running. This is necessary
+as some migration plugins must change their behaviour accordingly.
 
-* Foreign Key Associations (foreign_key_associations)
-* Foreign Key Migrations (foreign_key_migrations)
-* Row Version Migrations (row_version_migrations)
-* Schema Validations (schema_validations)
+=== Contributors
 
-=== License
+* François Beausoleil - http://github.com/francois
+* Greg Barnett
 
-This plugin is copyright 2006 by RedHill Consulting, Pty. Ltd. and is released
-under the MIT license.

data/VERSION

@@ -1 +1 @@
-1.0.6
+1.0.8

data/lib/red_hill_consulting/core/active_record/base.rb

@@ -26,6 +26,7 @@ module RedHillConsulting::Core::ActiveRecord
           columns_without_redhillonrails_core
           cols = columns_hash
           indexes.each do |index|
+            next if index.columns.empty?
             column_name = index.columns.reverse.detect { |name| name !~ /_id$/ } || index.columns.last
             column = cols[column_name]
             column.case_sensitive = index.case_sensitive?

data/lib/red_hill_consulting/core/active_record/connection_adapters/abstract_adapter.rb

@@ -58,5 +58,10 @@ module RedHillConsulting::Core::ActiveRecord::ConnectionAdapters
       reverse_foreign_keys(name).each { |foreign_key| remove_foreign_key(foreign_key.table_name, foreign_key.name, options) }
       drop_table_without_redhillonrails_core(name, options)
     end
+
+    def supports_partial_indexes?
+      false
+    end
+
   end
 end

data/lib/red_hill_consulting/core/active_record/connection_adapters/index_definition.rb

@@ -1,11 +1,13 @@
 module RedHillConsulting::Core::ActiveRecord::ConnectionAdapters
-	module IndexDefinition
-		def case_sensitive?
-			@case_sensitive.nil? ? true : @case_sensitive
-		end
+  module IndexDefinition
+    attr_accessor :conditions, :expression
 
-		def case_sensitive=(case_sensitive)
-			@case_sensitive = case_sensitive
-		end
-	end
+    def case_sensitive?
+      @case_sensitive.nil? ? true : @case_sensitive
+    end
+
+    def case_sensitive=(case_sensitive)
+      @case_sensitive = case_sensitive
+    end
+  end
 end

data/lib/red_hill_consulting/core/active_record/connection_adapters/postgresql_adapter.rb

@@ -15,43 +15,74 @@ module RedHillConsulting::Core::ActiveRecord::ConnectionAdapters
     end
 
     def add_index(table_name, column_name, options = {})
+      column_name, options = [], column_name if column_name.is_a?(Hash)
       column_names = Array(column_name)
-      index_name   = index_name(table_name, :column => column_names)
+      if column_names.empty?
+        raise ArgumentError, "No columns and :expression missing from options - cannot create index" if options[:expression].blank?
+        raise ArgumentError, "Index name not given. Pass :name option" if options[:name].blank?
+      end
+        
+      index_type = options[:unique] ? "UNIQUE" : ""
+      index_name = options[:name] || index_name(table_name, column_names)
+      conditions = options[:conditions]
 
-      if Hash === options # legacy support, since this param was a string
-        index_type = options[:unique] ? "UNIQUE" : ""
-        index_name = options[:name] || index_name
+      if column_names.empty? then
+        sql = "CREATE #{index_type} INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} #{options[:expression]}"
       else
-        index_type = options
-      end
+        quoted_column_names = column_names.map { |e| options[:case_sensitive] == false && e.to_s !~ /_id$/ ? "LOWER(#{quote_column_name(e)})" : quote_column_name(e) }
 
-      quoted_column_names = column_names.map { |e| options[:case_sensitive] == false && e.to_s !~ /_id$/ ? "LOWER(#{quote_column_name(e)})" : quote_column_name(e) }
+        sql = "CREATE #{index_type} INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} (#{quoted_column_names.join(", ")})"
+        sql += " WHERE (#{ ActiveRecord::Base.send(:sanitize_sql, conditions, quote_table_name(table_name)) })" if conditions
+      end
+      execute sql
+    end
 
-      execute "CREATE #{index_type} INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} (#{quoted_column_names.join(", ")})"
+    def supports_partial_indexes?
+      true
     end
+      
+    INDEX_CASE_INSENSITIVE_REGEX = /\((.*LOWER\([^:]+(::text)?\).*)\)/i
+    INDEX_PARTIAL_REGEX = /\((.*)\)\s+WHERE (.*)$/i
+    INDEX_NON_BTREE_REGEX = /((?:gin|gist|hash).*)$/i
 
     def indexes_with_redhillonrails_core(table_name, name = nil)
       indexes = indexes_without_redhillonrails_core(table_name, name)
+      # Process indexes containg expressions and partial indexes
+      # Ie. consider 
       result = query(<<-SQL, name)
         SELECT c2.relname, i.indisunique, pg_catalog.pg_get_indexdef(i.indexrelid, 0, true)
           FROM pg_catalog.pg_class c, pg_catalog.pg_class c2, pg_catalog.pg_index i
          WHERE c.relname = '#{table_name}'
            AND c.oid = i.indrelid AND i.indexrelid = c2.oid
-           AND i.indisprimary = 'f'
-           AND i.indexprs IS NOT NULL
+           AND i.indisprimary = 'f' 
+           AND (i.indexprs IS NOT NULL OR i.indpred IS NOT NULL)
          ORDER BY 1
       SQL
 
-      result.each do |row|
-        if row[2]=~ /\((.*LOWER\([^:]+(::text)?\).*)\)/i
-          indexes.delete_if { |index| index.name == row[0] }
-          column_names = $1.split(", ").map do |name|
-            name = $1 if name =~ /^LOWER\(([^:]+)(::text)?\)$/i
-            name = $1 if name =~ /^"(.*)"$/
-            name
-          end
-          index = ActiveRecord::ConnectionAdapters::IndexDefinition.new(table_name, row[0], row[1] == "t", column_names)
-          index.case_sensitive = false
+
+      # Correctly process complex indexes, ie:
+      # CREATE INDEX test_index ON custom_pages USING btree (lower(title::text), created_at) WHERE kind = 1 AND author_id = 3
+      result.each do |(index_name, unique, index_def)|
+        case_sensitive_match = INDEX_CASE_INSENSITIVE_REGEX.match(index_def)
+        partial_index_match = INDEX_PARTIAL_REGEX.match(index_def)
+        if case_sensitive_match || partial_index_match
+          # column_definitions may be ie. 'LOWER(lower)' or 'login, deleted_at' or LOWER(login), deleted_at
+          column_definitions = case_sensitive_match ? case_sensitive_match[1] : partial_index_match[1] 
+
+          indexes.delete_if { |index| index.name == index_name } # prevent duplicated indexes
+          column_names = determine_index_column_names(column_definitions)
+
+          index = ActiveRecord::ConnectionAdapters::IndexDefinition.new(table_name, index_name, unique == "t", column_names)
+          index.case_sensitive = !!case_sensitive_match
+          # conditions may be ie. active = true AND deleted_at IS NULL. 
+          index.conditions = partial_index_match[2] if partial_index_match 
+          indexes << index
+
+        elsif non_btree_match = INDEX_NON_BTREE_REGEX.match(index_def) then
+          indexes.delete_if { |index| index.name == index_name } # prevent duplicated indexes
+
+          index = ActiveRecord::ConnectionAdapters::IndexDefinition.new(table_name, index_name, false, [])
+          index.expression = non_btree_match[1]
           indexes << index
         end
       end
@@ -127,5 +158,16 @@ module RedHillConsulting::Core::ActiveRecord::ConnectionAdapters
 
       foreign_keys
     end
+
+    # Converts form like: column1, LOWER(column2)
+    # to: column1, column2
+    def determine_index_column_names(column_definitions)
+      column_definitions.split(", ").map do |name|
+        name = $1 if name =~ /^LOWER\(([^:]+)(::text)?\)$/i
+        name = $1 if name =~ /^"(.*)"$/
+          name
+      end
+    end
+
   end
 end

data/lib/red_hill_consulting/core/active_record/schema_dumper.rb

@@ -25,9 +25,17 @@ module RedHillConsulting::Core::ActiveRecord
     def indexes_with_redhillonrails_core(table, stream)
       indexes = @connection.indexes(table)
       indexes.each do |index|
-        stream.print "  add_index #{index.table.inspect}, #{index.columns.inspect}, :name => #{index.name.inspect}"
-        stream.print ", :unique => true" if index.unique
-        stream.print ", :case_sensitive => false" unless index.case_sensitive?
+        if index.expression.blank? then
+          stream.print "  add_index #{index.table.inspect}, #{index.columns.inspect}, :name => #{index.name.inspect}"
+          stream.print ", :unique => true" if index.unique
+          stream.print ", :case_sensitive => false" unless index.case_sensitive?
+          stream.print ", :conditions => #{index.conditions.inspect}" unless index.conditions.blank?
+        else
+          stream.print "  add_index #{index.table.inspect}"
+          stream.print ", :expression => #{index.expression.inspect}"
+          stream.print ", :name => #{index.name.inspect}"
+        end
+
         stream.puts
       end
       stream.puts unless indexes.empty?

data/lib/redhillonrails_core.rb

@@ -35,5 +35,3 @@ ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, RedHillConsulti
 ActiveRecord::ConnectionAdapters::Column.send(:include, RedHillConsulting::Core::ActiveRecord::ConnectionAdapters::Column)
 ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:include, RedHillConsulting::Core::ActiveRecord::ConnectionAdapters::AbstractAdapter)
 ActiveRecord::ConnectionAdapters::SchemaStatements.send(:include, RedHillConsulting::Core::ActiveRecord::ConnectionAdapters::SchemaStatements)
-
-

data/redhillonrails_core.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{redhillonrails_core}
-  s.version = "1.0.6"
+  s.version = "1.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Micha\305\202 \305\201omnicki"]
-  s.date = %q{2010-09-24}
+  s.authors = ["Michał Łomnicki"]
+  s.date = %q{2010-10-19}
   s.description = %q{RedHill on Rails Core is a plugin that features to support other RedHill on Rails plugins. It creates and drops views and foreign-keys or obtains indexes directly from a model class.}
   s.email = %q{michal.lomnicki@gmail.com}
   s.extra_rdoc_files = [
@@ -48,14 +48,14 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/mlomnicki/redhillonrails_core}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{RedHill on Rails Core is a plugin that features to support other RedHill on Rails plugins}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 6
-  version: 1.0.6
+  - 8
+  version: 1.0.8
 platform: ruby
 authors: 
 - "Micha\xC5\x82 \xC5\x81omnicki"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 +02:00
+date: 2010-10-19 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -65,6 +65,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -72,6 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -81,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: RedHill on Rails Core is a plugin that features to support other RedHill on Rails plugins