schema_plus 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 620224f986e74b013fddffb7147eecfabe3f27bd
-  data.tar.gz: 323fdba9ed583753abfbdaee67353391356213f0
+  metadata.gz: 0c07ea7e4ac89f46fb3d3d27047c2cc2d2cbd5c0
+  data.tar.gz: 4db11b2d422195c298c344b9b150b7bac21d83a3
 SHA512:
-  metadata.gz: 8510bd7c390e12f5e4f2c113395dcde1831e46c9b525a90bb9a5cb2a4e48095840467e03dcac5229fdcab72abc11089d3d14c72ef535c6751fed159578f41bd6
-  data.tar.gz: 47df08a80fb0257e6cc1fa632005517685424af5f717ad847ef817b579288803c36e14f1cf2a96c7bb9442e288aaae08cd328e16ca0bfadda8a47f0910d8aa13
+  metadata.gz: 5c2363444635b39dc4f9bc2bc5542d670774da07fd5af5653278d7b2cf94151346594154d8161af5e727e91385f6bd66423cff05b1f6b4dc22d3bc4124929f72
+  data.tar.gz: ba2d12964f4a6ccbd02775ab2795ff94f6a93e9f0fe6a97f9e4c4a2f8c33985e629ba87f6bb47bd937b7bc626e5804c017cd42039458c10386652ab992038c50

data/.travis.yml

@@ -1,7 +1,6 @@
 rvm:
   - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.1.3
   - jruby
 gemfile:
   - gemfiles/rails-3.2/Gemfile.postgresql

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Change Log
 
+### 1.7.0
+
+* Added Postgresql index operator support (issue #184)
+
 ### 1.6.0
 
 * Added PostgreSQL enum support (thanks to [@juike](https://github.com/juike)) (issue #167)

data/README.md

@@ -10,8 +10,8 @@ For added rails DRYness see also the gems
 [schema_validations](http://rubygems.org/gems/schema_validations)
 
 [![Gem Version](https://badge.fury.io/rb/schema_plus.png)](http://badge.fury.io/rb/schema_plus)
-[![Build Status](https://secure.travis-ci.org/lomba/schema_plus.png)](http://travis-ci.org/lomba/schema_plus)
-[![Dependency Status](https://gemnasium.com/lomba/schema_plus.png)](https://gemnasium.com/lomba/schema_plus)
+[![Build Status](https://secure.travis-ci.org/SchemaPlus/schema_plus.png)](http://travis-ci.org/SchemaPlus/schema_plus)
+[![Dependency Status](https://gemnasium.com/SchemaPlus/schema_plus.png)](https://gemnasium.com/SchemaPlus/schema_plus)
 
 ## Compatibility
 
@@ -19,8 +19,8 @@ SchemaPlus supports all combinations of:
 
 *   Rails/ActiveRecord 3.2, 4.0, and 4.1
 *   PostgreSQL, MySQL (using mysql2 gem; mysql gem only supported with Rails
-    3.2), or SQLite3 (using sqlite3 >= 3.7.7 which has foreign key support)
-*   MRI Ruby 1.9.3, 2.0.0, or 2.1.0
+    3.2), or SQLite3 (using sqlite3 >= 3.7.7 for foreign key support, >= 3.8 for partial indexes)
+*   MRI Ruby >= 1.9.3
 
 And also supports:
 
@@ -92,12 +92,15 @@ which is equivalent to
     t.string :product_code,   index: { unique: true }
 
 If you're using PostgreSQL, SchemaPlus provides support for conditions,
-expressions, index methods, and case-insensitive indexes:
+expressions, index methods, operator classes, and case-insensitive indexes:
 
     t.string :last_name,  index: { conditions: 'deleted_at IS NULL' }
     t.string :last_name,  index: { expression: 'upper(last_name)' }
     t.string :last_name,  index: { kind: 'hash' }
-    t.string :last_name,  index: { case_sensitive: false }        # shorthand for expression: 'lower(last_name)'
+    t.string :last_name,  index: { operator_class: 'varchar_pattern_ops' }
+    t.string :last_name,  index: { with: :address, operator_class: {last_name: 'varchar_pattern_ops', address: 'text_pattern_ops' }
+    t.string :last_name,  index: { case_sensitive: false } # shorthand for expression: 'lower(last_name)'
+
 
 These features are available also in `ActiveRecord::Migration.add_index`.  See
 doc for [SchemaPlus::ActiveRecord::ConnectionAdapters::PostgresqlAdapter](http://rubydoc.info/gems/schema_plus/SchemaPlus/ActiveRecord/ConnectionAdapters/PostgresqlAdapter) and
@@ -180,7 +183,7 @@ Foreign keys can cause issues for Rails utilities that delete or load data
 because referential integrity imposes a sequencing requirement that those
 utilities may not take into consideration.  Monkey-patching may be required
 to address some of these issues.  The Wiki article [Making yaml_db work with
-foreign key constraints in PostgreSQL](https://github.com/lomba/schema_plus/wiki/Making-yaml_db-work-with-foreign-key-constraints-in-PostgreSQL)
+foreign key constraints in PostgreSQL](https://github.com/SchemaPlus/schema_plus/wiki/Making-yaml_db-work-with-foreign-key-constraints-in-PostgreSQL)
 has some information that may be of assistance in resolving these issues.
 
 ### Tables
@@ -322,21 +325,21 @@ of foreign key constraints, you can re-enable it:
 
 *   SchemaPlus was created in 2011 by [@mlomnicki](https://github.com/mlomnicki) and [@ronen](https://github.com/ronen)
 
-*   And [lots of contributors](https://github.com/lomba/schema_plus/graphs/contributors) since then
+*   And [lots of contributors](https://github.com/SchemaPlus/schema_plus/graphs/contributors) since then
 
 ## Development & Testing
 
 Are you interested in contributing to schema_plus?  Thanks!
 
-Schema_plus has a full set of rspec tests.  [travis-ci](http://travis-ci.org/lomba/schema_plus) runs the tests on the full matrix of supported versions of ruby, rails, and db adapters.  But you can also test all or some part of the matrix locally before you push your changes.  Here's what you need to know:
+Schema_plus has a full set of rspec tests.  [travis-ci](http://travis-ci.org/SchemaPlus/schema_plus) runs the tests on the full matrix of supported versions of ruby, rails, and db adapters.  But you can also test all or some part of the matrix locally before you push your changes.  Here's what you need to know:
 
 #### Required environment:
 
-*  You must have either [rbenv](https://github.com/sstephenson/rbenv) or [rvm](http://rvm.io) installed and working, whichever you prefer.  Within it, have available whichever ruby versions you want to test.  The default set is MRI 1.9.3, 2.0.0, 2.1.0, and jruby
+*  You must have one of [chruby](https://github.com/postmodern/chruby),) [rbenv](https://github.com/sstephenson/rbenv) or [rvm](http://rvm.io) installed and working.  Within it, have available whichever ruby versions you want to test.  The default set is MRI 1.9.3, 2.1.3, and jruby
 
 * Of course you must have installed whichever databases you want to test. The default set is: PostgreSQL, MySQL, and SQLite3.
 
-* For PostgreSQL and MySQL the tests need a db user with permissions to create and access databases: The default username used by the specs is 'postgres' for PostgreSQL and 'schema_plus' for MySQL; you can change them via:
+* For PostgreSQL and MySQL the tests need a db user with permissions to create and access databases: The default username used by the specs is 'schema_plus' for both PostgreSQL and MySQL; you can change them via:
 
         $ export POSTGRESQL_DB_USER = pgusername
         $ export MYSQL_DB_USER = mysqlusername
@@ -377,10 +380,3 @@ By default it runs on a matrix of postgresql, mysql2, and sqlite3, for all rubie
 		$ ./runspecs --quick --rspec -- spec/migration_spec.rb -e 'default name'
 
 Contributions to making the testing process itself easier and better will also be gratefully accepted!
-
-
--
-
-
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/lomba/schema_plus/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-

data/Rakefile

@@ -37,7 +37,7 @@ end
 
 DATABASES = %w[schema_plus_test]
 [ 
-  { namespace: :postgresql, uservar: 'POSTGRESQL_DB_USER', defaultuser: 'postgres', create: "createdb -U '%{user}' %{dbname}", drop: "dropdb -U '%{user}' %{dbname}" },
+  { namespace: :postgresql, uservar: 'POSTGRESQL_DB_USER', defaultuser: 'schema_plus', create: "createdb -U '%{user}' %{dbname}", drop: "dropdb -U '%{user}' %{dbname}" },
   { namespace: :mysql, uservar: 'MYSQL_DB_USER', defaultuser: 'schema_plus', create: "mysqladmin -u '%{user}' create %{dbname}", drop: "mysqladmin -u '%{user}' -f drop %{dbname}" }
 ].each do |db|
   namespace db[:namespace] do

data/lib/schema_plus/active_record/connection_adapters/index_definition.rb

@@ -10,9 +10,10 @@ module SchemaPlus
           base.alias_method_chain :initialize, :schema_plus
         end
         
-        attr_reader :conditions
+        attr_accessor :conditions
         attr_reader :expression
         attr_reader :kind
+        attr_reader :operator_classes
 
         def case_sensitive?
           @case_sensitive
@@ -27,9 +28,11 @@ module SchemaPlus
             @expression = options[:expression]
             @kind = options[:kind]
             @case_sensitive = options.include?(:case_sensitive) ? options[:case_sensitive] : true
+            @operator_classes = options[:operator_classes] || {}
           else # backwards compatibility
             initialize_without_schema_plus(*args)
             @case_sensitive = true
+            @operator_classes = {}
           end
         end
 
@@ -43,6 +46,7 @@ module SchemaPlus
           opts[:expression]     = expression unless expression.nil?
           opts[:kind]           = kind unless kind.nil?
           opts[:case_sensitive] = case_sensitive? unless @case_sensitive.nil?
+          opts[:operator_classes] = @operator_classes unless @operator_classes.nil?
           opts
         end
 
@@ -56,6 +60,7 @@ module SchemaPlus
           return false unless self.conditions == other.conditions
           return false unless self.expression == other.expression
           return false unless self.kind == other.kind
+          return false unless self.operator_classes == other.operator_classes
           return false unless !!self.case_sensitive? == !!other.case_sensitive?
           true
         end

data/lib/schema_plus/active_record/connection_adapters/postgresql_adapter.rb

@@ -73,6 +73,7 @@ module SchemaPlus
         # * +:conditions+ - SQL conditions for the WHERE clause of the index
         # * +:expression+ - SQL expression to index.  column_name can be nil or ommitted, in which case :name must be provided
         # * +:kind+ - index method for Postgresql to use
+        # * +:operator_class+ - an operator class name or a hash mapping column name to operator class name
         # * +:case_sensitive - setting to +false+ is a shorthand for :expression => 'LOWER(column_name)'
         #
         # The <tt>:case_sensitive => false</tt> option ties in with Rails built-in support for case-insensitive searching:
@@ -95,6 +96,10 @@ module SchemaPlus
           index_name = options[:name] || index_name(table_name, column_names)
           conditions = options[:conditions]
           kind       = options[:kind]
+          operator_classes = options[:operator_class]
+          if operator_classes and not operator_classes.is_a? Hash
+            operator_classes = Hash[column_names.map {|name| [name, operator_classes]}]
+          end
 
           if expression = options[:expression] then
             raise ArgumentError, "Cannot specify :case_sensitive => false with an expression.  Use LOWER(column_name)" if options[:case_sensitive] == false
@@ -106,6 +111,9 @@ module SchemaPlus
             sql = "CREATE #{index_type} INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} #{expression}"
           else
             option_strings = Hash[column_names.map {|name| [name, '']}]
+            (operator_classes||{}).each do |column, opclass|
+              option_strings[column] += " #{opclass}" if opclass
+            end
             option_strings = add_index_sort_order(option_strings, column_names, options)
 
             if options[:case_sensitive] == false
@@ -141,7 +149,8 @@ module SchemaPlus
           result = query(<<-SQL, name)
 
            SELECT distinct i.relname, d.indisunique, d.indkey, pg_get_indexdef(d.indexrelid), t.oid,
-                  m.amname, pg_get_expr(d.indpred, t.oid) as conditions, pg_get_expr(d.indexprs, t.oid) as expression
+                  m.amname, pg_get_expr(d.indpred, t.oid) as conditions, pg_get_expr(d.indexprs, t.oid) as expression,
+                  d.indclass
            FROM pg_class t
            INNER JOIN pg_index d ON t.oid = d.indrelid
            INNER JOIN pg_class i ON d.indexrelid = i.oid
@@ -153,9 +162,10 @@ module SchemaPlus
           ORDER BY i.relname
           SQL
 
-          result.map do |(index_name, is_unique, indkey, inddef, oid, kind, conditions, expression)|
+          result.map do |(index_name, is_unique, indkey, inddef, oid, kind, conditions, expression, indclass)|
             unique = (is_unique == 't' || is_unique == true) # The test against true is for JDBC which is returning a boolean and not a String.
             index_keys = indkey.split(" ")
+            opclasses = indclass.split(" ")
 
             rows = query(<<-SQL, "Columns for index #{index_name} on #{table_name}")
               SELECT CAST(a.attnum as VARCHAR), a.attname, t.typname
@@ -189,6 +199,20 @@ module SchemaPlus
               end
             end
 
+            opclass_name  = {}
+            rows = query(<<-SQL, "Op classes for index #{index_name} on #{table_name}")
+              SELECT oid, opcname FROM pg_opclass
+              WHERE (NOT opcdefault) AND oid IN (#{opclasses.join(',')})
+            SQL
+            rows.each do |oid, opcname|
+              opclass_name[oid.to_s] = opcname
+            end
+            operator_classes = {}
+            index_keys.zip(opclasses).each do |index_key, opclass|
+              operator_classes[columns[index_key]] = opclass_name[opclass]
+            end
+            operator_classes.delete_if{|k,v| v.nil?}
+
             # add info on sort order for columns (only desc order is explicitly specified, asc is the default)
             desc_order_columns = inddef.scan(/(\w+) DESC/).flatten
             orders = desc_order_columns.any? ? Hash[column_names.map {|column| [column, desc_order_columns.include?(column) ? :desc : :asc]}] : {}
@@ -200,6 +224,7 @@ module SchemaPlus
                                                                     :conditions => conditions,
                                                                     :case_sensitive => case_sensitive,
                                                                     :kind => kind.downcase == "btree" ? nil : kind,
+                                                                    :operator_classes => operator_classes,
                                                                     :expression => expression)
           end
         end

data/lib/schema_plus/active_record/connection_adapters/sqlite3_adapter.rb

@@ -34,13 +34,27 @@ module SchemaPlus
           execute('PRAGMA FOREIGN_KEYS = ON')
         end
 
+        def supports_partial_indexes? #:nodoc:
+          # unfortunately with the current setup there's no easy way to
+          # test multiple SQLite3 versions.  Currently travis-ci uses
+          # SQLite3 version 3.7 but local development on OS X uses 3.8.
+          SQLite3.libversion >= 3008000
+        end
+
         def indexes_with_schema_plus(table_name, name = nil)
           indexes = indexes_without_schema_plus(table_name, name)
           exec_query("SELECT name, sql FROM sqlite_master WHERE type = 'index'").map do |row|
-            if (desc_columns = row['sql'].scan(/['"`]?(\w+)['"`]? DESC\b/).flatten).any?
-              index = indexes.detect{ |i| i.name == row['name'] }
+            sql = row['sql']
+            index = nil
+            getindex = -> { index ||= indexes.detect { |i| i.name == row['name'] } }
+            if (desc_columns = sql.scan(/['"`]?(\w+)['"`]? DESC\b/).flatten).any?
+              getindex.call()
               index.orders = Hash[index.columns.map {|column| [column, desc_columns.include?(column) ? :desc : :asc]}]
             end
+            if (conditions = sql.match(/\bWHERE\s+(.*)/i))
+              getindex.call()
+              index.conditions = conditions[1]
+            end
           end
           indexes
         end

data/lib/schema_plus/active_record/schema_dumper.rb

@@ -139,6 +139,7 @@ module SchemaPlus
             index_lengths = index.lengths.compact if index.lengths.is_a?(Array)
             dump << ", :length => #{Hash[*index.columns.zip(index.lengths).flatten].inspect}" if index_lengths.present?
             dump << ", :order => {" + index.orders.map{|column, val| "#{column.inspect} => #{val.inspect}"}.join(", ") + "}" unless index.orders.blank?
+            dump << ", :operator_class => {" + index.operator_classes.map{|column, val| "#{column.inspect} => #{val.inspect}"}.join(", ") + "}" unless index.operator_classes.blank?
           else
             dump << ", :expression => #{index.expression.inspect}"
           end

data/lib/schema_plus/version.rb

@@ -1,3 +1,3 @@
 module SchemaPlus
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

data/runspecs

@@ -5,7 +5,7 @@ require 'ostruct'
 require 'shellwords'
 require 'tempfile'
 
-RUBY_VERSIONS = %W[jruby 1.9.3 2.0.0 2.1.0]
+RUBY_VERSIONS = %W[jruby 1.9.3 2.1.3]
 RAILS_VERSIONS = %W[3.2 4.0 4.1]
 DB_ADAPTERS = %W[postgresql mysql mysql2 sqlite3]
 
@@ -77,7 +77,13 @@ combos = o.ruby_versions.product(o.rails_versions, o.db_adapters).map{|product|
     end
 }
 
-if system("which -s rvm")
+case
+when system("which -s chruby-exec")
+    def ruby_version_selector(ruby)
+        "SHELL=`which bash` chruby-exec #{ruby} --"
+    end
+
+when system("which -s rvm")
     # using rvm
     def ruby_version_selector(ruby)
         "rvm #{ruby} do"
@@ -120,7 +126,7 @@ combos.each_with_index do |combo, n|
               "bundle exec rake #{db_adapter}:spec"
           end
 
-    command = %Q{BUNDLE_GEMFILE="#{File.join(GEMFILES_DIR, "rails-#{rails}", "Gemfile.#{db_adapter}")}" #{ruby_version_selector(ruby)} #{cmd} #{Shellwords.join(ARGV)}}
+    command = %Q{/usr/bin/env BUNDLE_GEMFILE="#{File.join(GEMFILES_DIR, "rails-#{rails}", "Gemfile.#{db_adapter}")}" #{ruby_version_selector(ruby)} #{cmd} #{Shellwords.join(ARGV)}}
 
     puts "\n\n*** ruby version #{ruby} - rails version #{rails} - db adapter: #{db_adapter}  [#{n+1} of #{combos.size}]\n\n#{command}"
 

data/schema_plus.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.9.2"
   s.authors     = ["Ronen Barzel", "Michal Lomnicki"]
   s.email       = ["ronen@barzel.org", "michal.lomnicki@gmail.com"]
-  s.homepage    = "https://github.com/lomba/schema_plus"
+  s.homepage    = "https://github.com/SchemaPlus/schema_plus"
   s.summary     = "Enhances ActiveRecord schema mechanism, including more DRY index creation and support for foreign key constraints and views."
   s.description = "SchemaPlus is an ActiveRecord extension that provides enhanced capabilities for schema definition and querying, including: enhanced and more DRY index capabilities, support and automation for foreign key constraints, and support for views."
   s.license = 'MIT'

data/spec/index_definition_spec.rb

@@ -122,7 +122,7 @@ describe "Index definition" do
   end
 
 
-  context "when index is partial and column is not downcased", :postgresql => :only do
+  context "when index is partial" do
     before(:each) do
       migration.execute "CREATE INDEX users_login_index ON users(login) WHERE deleted_at IS NULL"
       User.reset_column_information
@@ -142,10 +142,10 @@ describe "Index definition" do
     end
 
     it "defines conditions" do
-      expect(@index.conditions).to eq("(deleted_at IS NULL)")
+      expect(@index.conditions).to match %r{[(]?deleted_at IS NULL[)]?}
     end
 
-  end
+  end if ::ActiveRecord::Migration.supports_partial_indexes?
 
   context "when index contains expression", :postgresql => :only do
     before(:each) do

data/spec/index_spec.rb

@@ -13,6 +13,7 @@ describe "index" do
       define_schema(:auto_create => false) do
         create_table :users, :force => true do |t|
           t.string :login
+          t.text :address
           t.datetime :deleted_at
         end
 
@@ -104,6 +105,16 @@ describe "index" do
         expect(index_for(:login).kind).to eq('hash')
       end
 
+      it "should assign operator_class" do
+        add_index(:users, :login, :operator_class => 'varchar_pattern_ops')
+        expect(index_for(:login).operator_classes).to eq({"login" => 'varchar_pattern_ops'})
+      end
+
+      it "should assign multiple operator_classes" do
+        add_index(:users, [:login, :address], :operator_class => {:login => 'varchar_pattern_ops', :address => 'text_pattern_ops'})
+        expect(index_for([:login, :address]).operator_classes).to eq({"login" => 'varchar_pattern_ops', "address" => 'text_pattern_ops'})
+      end
+
       it "should allow to specify actual expression only" do
         add_index(:users, :expression => "upper(login)", :name => 'users_login_index')
         @index = User.indexes.detect { |i| i.name == 'users_login_index' }

data/spec/schema_dumper_spec.rb

@@ -214,6 +214,12 @@ describe "Schema dump" do
       end
     end
 
+    it "should define operator_class" do
+      with_index Post, :body, :operator_class => 'text_pattern_ops' do
+        expect(dump_posts).to match(to_regexp(%q{t.index ["body"], :name => "index_posts_on_body", :operator_class => {"body" => "text_pattern_ops"}}))
+      end
+    end
+
     it "should dump unique: true with expression (Issue #142)" do
       with_index Post, :name => "posts_user_body_index", :unique => true, :expression => "BTRIM(LOWER(body))" do
         expect(dump_posts).to match(%r{#{to_regexp(%q{t.index :name => "posts_user_body_index", :unique => true, :expression => "btrim(lower(body))"})}$})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_plus
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Ronen Barzel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -192,7 +192,7 @@ files:
 - spec/support/matchers/have_index.rb
 - spec/support/matchers/reference.rb
 - spec/views_spec.rb
-homepage: https://github.com/lomba/schema_plus
+homepage: https://github.com/SchemaPlus/schema_plus
 licenses:
 - MIT
 metadata: {}