schema_plus_indexes 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab3b42608f51e2ebb4b7b6b21b5ad2fc6566fec2
-  data.tar.gz: a9b0166d7a50826f93825aa20a29f714e952f69e
+  metadata.gz: df1b409660d57bf87cb28e5b46ff7f4121d9b4db
+  data.tar.gz: afb439a86e897f10b6bab354f5f0643d39f3b7f8
 SHA512:
-  metadata.gz: fe17a220b606d91ef6cdc213371ef0ba018c69deda8ba67464a16171ede854b50c30423f17c404b00d622325f746ae6da254dc129641be992ab0fc050a87035b
-  data.tar.gz: 375f7b7201cae230180d7bc98fd11a980a5f2d1970b8a481ba2063019d9bc6e528c758758b747dabe8d932ff2ae35c6fe9b77e7bbd9f7b7db6d6b16398715946
+  metadata.gz: 2cf73bec7659a3e32a047fa092352ca1a9fd3de1d3fb3c78bdeba59459413b62550771aa6e7cad2198fc255ca56d995c85826a1b14f2c471e4e85fa2c3d0dc4c
+  data.tar.gz: e14c80880a1746ce6d03108b7566126682d2d570adc37144dce9b6fdab8f5aa2379d563660f91c41269f3be0b3e977db5b9b0dc2a59285bdbae894cfedd13470

data/.travis.yml

@@ -12,7 +12,7 @@ gemfile:
 - gemfiles/activerecord-4.2/Gemfile.sqlite3
 env: POSTGRESQL_DB_USER=postgres MYSQL_DB_USER=travis
 addons:
-  postgresql: '9.3'
+  postgresql: '9.4'
 before_script: bundle exec rake create_databases
 after_script: bundle exec rake drop_databases
 script: bundle exec rake travis

data/README.md

@@ -20,14 +20,6 @@ gem "schema_plus_indexes"                # in a Gemfile
 gem.add_dependency "schema_plus_indexes" # in a .gemspec
 ```
 
-To use with a rails app, also include
-
-```ruby
-gem "schema_monkey_rails"
-```
-
-which creates a Railtie to that will insert SchemaPlus::Indexes appropriately into the rails stack. To use with Padrino, see [schema_monkey_padrino](https://github.com/SchemaPlus/schema_monkey_padrino).
-
 <!-- SCHEMA_DEV: TEMPLATE INSTALLATION - end -->
 
 
@@ -101,11 +93,12 @@ The value gets cached until the next time `Model.reset_column_information` is ca
 
 * When using SQLite3, makes sure that the definitions returned by
   `connection.indexes` properly include the column orders (`:asc` or `:desc`)
-  
+
 * For the `ActiveRecord::ConnectionAdapters::IndexDefinition` class (the object that's returned by `connection.indexes`), SchemaPlus::Indexes:
   * Provides an `==` operator to compare if two objects refer to an equivalent index
   * Allows calling `new` with a signature that matches add_index: `IndexDefinition.new(table_name, column_names, options)`
   * Fleshes out the `:orders` attribute, listing `:asc` for a column instead of leaving it undefined.
+  * Prevents errors from a down :change migration attempting to remove an index that wasn't previously added (this can arise, e.g. with auto-indexing plugins).
 
 ## Compatibility
 
@@ -119,6 +112,10 @@ schema_plus_indexes is tested on
 
 ## History
 
+### v0.2.0
+
+* Prevent down :change migrations from failing due to trying to remove non-existent indexes
+
 ### v0.1.0
 
 * Initial release, extracted from schema_plus 1.x
@@ -155,8 +152,8 @@ Some things to know about to help you develop and test:
   provides middleware callback stacks to make it easy to extend
   ActiveRecord's behavior.  If that API is missing something you need for
   your contribution, please head over to
-  [schema_plus_core](https://github/SchemaPlus/schema_plus_core) and open
-  an issue or pull request.  
+  [schema_plus_core](https://github.com/SchemaPlus/schema_plus_core) and open
+  an issue or pull request.
 
 <!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_PLUS_CORE - end -->
 <!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_MONKEY - begin -->
@@ -165,6 +162,5 @@ Some things to know about to help you develop and test:
   [schema_monkey](https://github.com/SchemaPlus/schema_monkey) client,
   using [schema_monkey](https://github.com/SchemaPlus/schema_monkey)'s
   convention-based protocols for extending ActiveRecord and using middleware stacks.
-  For more information see [schema_monkey](https://github.com/SchemaPlus/schema_monkey)'s README.
 
 <!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_MONKEY - end -->

data/lib/schema_plus/indexes.rb

@@ -3,6 +3,7 @@ require 'schema_plus/core'
 require_relative 'indexes/active_record/base'
 require_relative 'indexes/active_record/connection_adapters/abstract_adapter'
 require_relative 'indexes/active_record/connection_adapters/index_definition'
+require_relative 'indexes/active_record/migration/command_recorder'
 require_relative 'indexes/middleware/dumper'
 require_relative 'indexes/middleware/migration'
 require_relative 'indexes/middleware/model'

data/lib/schema_plus/indexes/active_record/migration/command_recorder.rb

@@ -0,0 +1,16 @@
+module SchemaPlus::Indexes
+  module ActiveRecord
+    module Migration
+      module CommandRecorder
+
+        # inversion of add_index will be remove_index.  add if_exists
+        # option for cases where the index doesn't actually exist
+        def invert_add_index(args)
+          super.tap { |(command, (arg, options))|
+            options[:if_exists] = true
+          }
+        end
+      end
+    end
+  end
+end

data/lib/schema_plus/indexes/middleware/dumper.rb

@@ -9,12 +9,12 @@ module SchemaPlus::Indexes
           # list of indexes that AR would dump after the table.  Any left
           # over will still be dumped by AR.
           env.table.columns.each do |column|
-            
+
             # first check for a single-column index
             if (index = env.table.indexes.find(&its.columns == [column.name]))
               column.add_option column_index(env, column, index)
               env.table.indexes.delete(index)
-              
+
             # then check for the first of a multi-column index
             elsif (index = env.table.indexes.find(&its.columns.first == column.name))
               column.add_option column_index(env, column, index)

data/lib/schema_plus/indexes/middleware/migration.rb

@@ -3,7 +3,7 @@ module SchemaPlus::Indexes
     module Migration
 
       module Column
-       
+
         # Shortcuts
         def before(env)
           case env.options[:index]

data/lib/schema_plus/indexes/version.rb

@@ -1,5 +1,5 @@
 module SchemaPlus
   module Indexes
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

data/schema_plus_indexes.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "bundler", "~> 1.7"
   gem.add_development_dependency "rake", "~> 10.0"
   gem.add_development_dependency "rspec", "~> 3.0.0"
-  gem.add_development_dependency "schema_dev", "~> 3.1"
+  gem.add_development_dependency "schema_dev", "~> 3.3"
   gem.add_development_dependency "simplecov"
   gem.add_development_dependency "simplecov-gem-profile"
 end

data/spec/command_recorder_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module AddIndexBefore
+  module Middleware
+    module Migration
+      module Column
+        include Enableable
+
+        def before(env)
+          env.options[:index] = { name: 'whatever' } if enabled_middleware(AddIndexBefore, env)
+        end
+      end
+    end
+  end
+end
+
+SchemaMonkey.register AddIndexBefore
+
+describe "Command Recorder" do
+
+  before(:each) do
+      define_schema do
+        create_table "comments" do |t|
+          t.integer :column
+        end
+      end
+  end
+
+  context "with add-index-before middleware enabled" do
+    let(:middleware) { AddIndexBefore::Middleware::Migration::Column }
+    around(:each) do |example|
+      begin
+        example.run
+      ensure
+        middleware.disable
+      end
+    end
+
+    it "does not fail when reverting" do
+      migration = Class.new ::ActiveRecord::Migration do
+        define_method(:change) {
+          change_table("comments") do |t|
+            t.integer :column
+          end
+        }
+      end
+      middleware.enable
+      expect { migration.migrate(:down) }.not_to raise_error
+    end
+  end
+
+end

data/spec/index_definition_spec.rb

@@ -5,7 +5,7 @@ describe "Index definition" do
 
   let(:migration) { ::ActiveRecord::Migration }
 
-  before(:all) do
+  before(:each) do
     define_schema(:auto_create => false) do
       create_table :users, :force => true do |t|
         t.string :login
@@ -23,12 +23,6 @@ describe "Index definition" do
     class Post < ::ActiveRecord::Base ; end
   end
 
-  around(:each) do |example|
-    migration.suppress_messages do
-      example.run
-    end
-  end
-
   after(:each) do
     migration.remove_index :users, :name => 'users_login_index' if migration.index_name_exists? :users, 'users_login_index', true
   end

data/spec/index_spec.rb

@@ -30,9 +30,7 @@ describe "index" do
 
 
     after(:each) do
-      migration.suppress_messages do
-        migration.remove_index(:users, :name => @index.name) if (@index ||= nil)
-      end
+      migration.remove_index(:users, :name => @index.name) if (@index ||= nil)
     end
 
     it "should create index when called without additional options" do
@@ -164,16 +162,12 @@ describe "index" do
 
   protected
   def add_index(*args)
-    migration.suppress_messages do
-      migration.add_index(*args)
-    end
+    migration.add_index(*args)
     User.reset_column_information
   end
 
   def remove_index(*args)
-    migration.suppress_messages do
-      migration.remove_index(*args)
-    end
+    migration.remove_index(*args)
     User.reset_column_information
   end
 

data/spec/migration_spec.rb

@@ -159,28 +159,22 @@ describe ActiveRecord::Migration do
 
     def add_column(column_name, *args)
       table = @model.table_name
-      ActiveRecord::Migration.suppress_messages do
-        ActiveRecord::Migration.add_column(table, column_name, *args)
-        @model.reset_column_information
-        yield if block_given?
-        ActiveRecord::Migration.remove_column(table, column_name)
-      end
+      ActiveRecord::Migration.add_column(table, column_name, *args)
+      @model.reset_column_information
+      yield if block_given?
+      ActiveRecord::Migration.remove_column(table, column_name)
     end
 
   end
 
 
   def recreate_table(model, opts={}, &block)
-    ActiveRecord::Migration.suppress_messages do
-      ActiveRecord::Migration.create_table model.table_name, opts.merge(:force => true), &block
-    end
+    ActiveRecord::Migration.create_table model.table_name, opts.merge(:force => true), &block
     model.reset_column_information
   end
 
   def change_table(model, opts={}, &block)
-    ActiveRecord::Migration.suppress_messages do
-      ActiveRecord::Migration.change_table model.table_name, opts, &block
-    end
+    ActiveRecord::Migration.change_table model.table_name, opts, &block
     model.reset_column_information
   end
 

data/spec/schema_dumper_spec.rb

@@ -3,40 +3,37 @@ require 'stringio'
 
 describe "Schema dump" do
 
-  before(:all) do
-    ActiveRecord::Migration.suppress_messages do
-      ActiveRecord::Schema.define do
-        connection.tables.each do |table| drop_table table, :cascade => true end
-
-        create_table :users, :force => true do |t|
-          t.string :login
-          t.datetime :deleted_at
-          t.integer :first_post_id
-        end
-
-        create_table :posts, :force => true do |t|
-          t.text :body
-          t.integer :user_id
-          t.integer :first_comment_id
-          t.string :string_no_default
-          t.integer :short_id
-          t.string :str_short
-          t.integer :integer_col
-          t.float :float_col
-          t.decimal :decimal_col
-          t.datetime :datetime_col
-          t.timestamp :timestamp_col
-          t.time :time_col
-          t.date :date_col
-          t.binary :binary_col
-          t.boolean :boolean_col
-        end
-
-        create_table :comments, :force => true do |t|
-          t.text :body
-          t.integer :post_id
-          t.integer :commenter_id
-        end
+  before(:each) do
+    define_schema do
+
+      create_table :users, :force => true do |t|
+        t.string :login
+        t.datetime :deleted_at
+        t.integer :first_post_id
+      end
+
+      create_table :posts, :force => true do |t|
+        t.text :body
+        t.integer :user_id
+        t.integer :first_comment_id
+        t.string :string_no_default
+        t.integer :short_id
+        t.string :str_short
+        t.integer :integer_col
+        t.float :float_col
+        t.decimal :decimal_col
+        t.datetime :datetime_col
+        t.timestamp :timestamp_col
+        t.time :time_col
+        t.date :date_col
+        t.binary :binary_col
+        t.boolean :boolean_col
+      end
+
+      create_table :comments, :force => true do |t|
+        t.text :body
+        t.integer :post_id
+        t.integer :commenter_id
       end
     end
     class ::User < ActiveRecord::Base ; end
@@ -83,16 +80,12 @@ describe "Schema dump" do
   def with_index(*args)
     options = args.extract_options!
     model, columns = args
-    ActiveRecord::Migration.suppress_messages do
-      ActiveRecord::Migration.add_index(model.table_name, columns, options)
-    end
+    ActiveRecord::Migration.add_index(model.table_name, columns, options)
     model.reset_column_information
     begin
       yield
     ensure
-      ActiveRecord::Migration.suppress_messages do
-        ActiveRecord::Migration.remove_index(model.table_name, :name => determine_index_name(model, columns, options))
-      end
+      ActiveRecord::Migration.remove_index(model.table_name, :name => determine_index_name(model, columns, options))
     end
   end
 

data/spec/spec_helper.rb

@@ -17,16 +17,19 @@ Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   config.include(SchemaPlus::IndexesMatchers)
   config.warnings = true
+  config.around(:each) do |example|
+    ActiveRecord::Migration.suppress_messages do
+      example.run
+    end
+  end
 end
 
 def define_schema(config={}, &block)
-  ActiveRecord::Migration.suppress_messages do
-    ActiveRecord::Schema.define do
-      connection.tables.each do |table|
-        drop_table table, :force => :cascade
-      end
-      instance_eval &block
+  ActiveRecord::Schema.define do
+    connection.tables.each do |table|
+      drop_table table, :force => :cascade
     end
+    instance_eval &block
   end
 end
 

data/spec/support/enableable.rb

@@ -0,0 +1,34 @@
+module Enableable
+
+  def enabled_middleware(root, env)
+    middleware = self.singleton_class.ancestors.find(&it.to_s.start_with?("#{root}::Middleware"))
+    return nil unless middleware.enabled?(env)
+    middleware.disable if middleware.once?(env)
+    middleware
+  end
+
+  def self.included(base)
+    base.module_eval do
+      def self.enable(condition = true, once:true)
+        @enabled = condition
+        @once = once
+      end
+      def self.enabled?(env)
+        case @enabled
+        when Proc then @enabled.call(env)
+        else @enabled
+        end
+      end
+      def self.once?(env)
+        @once
+      end
+      def self.disable
+        @enabled = false
+      end
+
+      disable
+    end
+  end
+end
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_plus_indexes
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - ronen barzel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +144,7 @@ files:
 - lib/schema_plus/indexes/active_record/base.rb
 - lib/schema_plus/indexes/active_record/connection_adapters/abstract_adapter.rb
 - lib/schema_plus/indexes/active_record/connection_adapters/index_definition.rb
+- lib/schema_plus/indexes/active_record/migration/command_recorder.rb
 - lib/schema_plus/indexes/middleware/dumper.rb
 - lib/schema_plus/indexes/middleware/migration.rb
 - lib/schema_plus/indexes/middleware/model.rb
@@ -152,12 +153,14 @@ files:
 - lib/schema_plus_indexes.rb
 - schema_dev.yml
 - schema_plus_indexes.gemspec
+- spec/command_recorder_spec.rb
 - spec/index_definition_spec.rb
 - spec/index_spec.rb
 - spec/migration_spec.rb
 - spec/named_schema_spec.rb
 - spec/schema_dumper_spec.rb
 - spec/spec_helper.rb
+- spec/support/enableable.rb
 - spec/support/matchers/have_index.rb
 homepage: https://github.com/SchemaPlus/schema_plus_indexes
 licenses:
@@ -184,10 +187,12 @@ signing_key:
 specification_version: 4
 summary: Adds shorthands and conveniences to ActiveRecord's handling of indexes
 test_files:
+- spec/command_recorder_spec.rb
 - spec/index_definition_spec.rb
 - spec/index_spec.rb
 - spec/migration_spec.rb
 - spec/named_schema_spec.rb
 - spec/schema_dumper_spec.rb
 - spec/spec_helper.rb
+- spec/support/enableable.rb
 - spec/support/matchers/have_index.rb