schema_plus_indexes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c53c8e9e64713769dfa034d9f28f83251553e23b
+  data.tar.gz: 56b8cc58c8e1332ed557fa75e76c3c30e01a3e78
+SHA512:
+  metadata.gz: f89e5ac13330c1e3a111fcd22c94376f362fda21d5fe52d17f909c87ff878e5a2d5fad4b7d477d96e93b84b3a77450f47c19d020296da080f0c467cadc5231ff
+  data.tar.gz: 63acf447a5afacc21fa08da17f4c9adc121dee9a16b364cdf77ec12e0012e245db3d6870ed5ef63a2bbc5851afb0631af5575bebe54b4d3202f1b2db3908b8d1

data/.gitignore

@@ -0,0 +1,8 @@
+/coverage
+/tmp
+/pkg
+
+*.lock
+*.log
+*.sqlite3
+!gemfiles/**/*.sqlite3

data/.travis.yml

@@ -0,0 +1,19 @@
+# This file was auto-generated by the schema_dev tool, based on the data in
+#                 ./schema_dev.yml
+# Please do not edit this file; any changes will be overwritten next time
+# schema_dev gets run.
+---
+sudo: false
+rvm:
+- 1.9.3
+- 2.1.5
+gemfile:
+- gemfiles/rails-4.2/Gemfile.mysql2
+- gemfiles/rails-4.2/Gemfile.postgresql
+- gemfiles/rails-4.2/Gemfile.sqlite3
+env: POSTGRESQL_DB_USER=postgres MYSQL_DB_USER=travis
+addons:
+  postgresql: '9.3'
+before_script: bundle exec rake create_databases
+after_script: bundle exec rake drop_databases
+script: bundle exec rake travis

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ronen barzel 
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,99 @@
+[![Gem Version](https://badge.fury.io/rb/schema_plus_indexes.svg)](http://badge.fury.io/rb/schema_plus_indexes)
+[![Build Status](https://secure.travis-ci.org/SchemaPlus/schema_plus_indexes.svg)](http://travis-ci.org/SchemaPlus/schema_plus_indexes)
+[![Coverage Status](https://img.shields.io/coveralls/SchemaPlus/schema_plus_indexes.svg)](https://coveralls.io/r/SchemaPlus/schema_plus_indexes)
+[![Dependency Status](https://gemnasium.com/lomba/schema_plus_indexes.svg)](https://gemnasium.com/SchemaPlus/schema_plus_indexes)
+
+# schema_plus_indexes
+
+Schema_plus_index adds various convenient capabilities to `ActiveRecord`'s index handling:
+
+* Adds shorthands to the `:index` option in migrations
+
+      create_table :parts do |t|
+        t.string :role,             index: true     # shorthand for index: {}
+        t.string :product_code,     index: :unique  # shorthand for index: { unique: true }
+        t.string :first_name
+        t.string :last_name,        index: { with: :first_name }  # multi-column index
+
+        t.string :country_code
+        t.string :area_code
+        t.string :local_number,     index: { with: [:country_code, :area_code] } # multi-column index
+      end
+
+  Of course options can be combined, such as `index: { with: :first_name, unique: true, name: "my_index"}`
+
+* Ensures that the `:index` option is respected by `Migration.add_column` and in `Migration.change_table`
+
+* Adds `:if_exists` option to `ActiveRecord::Migration.remove_index`
+
+* Provides consistent behavior regarding attempted duplicate index
+  creation: Ignore and log a warning.  Different versions of Rails with
+  different db adapters otherwise behave inconsistently: some ignore the
+  attempt, some raise an error.
+
+* `Model.indexes` returns the indexes defined for the `ActiveRecord` model.
+  Shorthand for `connection.indexes(Model.table_name)`; the value is cached
+  until the next time `Model.reset_column_information` is called
+
+* In the schema dump `schema.rb`, index definitions are included within the
+  `create_table` statements rather than added afterwards
+
+* When using SQLite3, makes sure that the definitions returned by
+  `connection.indexes` properly include the column orders (`:asc` or `:desc`)
+
+schema_plus_indexes is part of the [SchemaPlus](https://github.com/SchemaPlus/) family of Ruby on Rails extension gems.
+
+## Installation
+
+In your application's Gemfile
+
+```ruby
+gem "schema_plus_indexes"
+```
+## Compatibility
+
+schema_plus_indexes is tested on
+
+[//]: # SCHEMA_DEV: MATRIX - begin
+[//]: # These lines are auto-generated by schema_dev based on schema_dev.yml
+* ruby **1.9.3** with rails **4.2**, using **mysql2**, **sqlite3** or **postgresql**
+* ruby **2.1.5** with rails **4.2**, using **mysql2**, **sqlite3** or **postgresql**
+
+[//]: # SCHEMA_DEV: MATRIX - end
+
+
+## History
+
+### v0.1.0
+
+* Initial release
+
+## Development & Testing
+
+Are you interested in contributing to schema_plus_indexes?  Thanks!  Please follow
+the standard protocol: fork, feature branch, develop, push, and issue pull request.
+
+Some things to know about to help you develop and test:
+
+* **schema_dev**:  schema_plus_indexes uses [schema_dev](https://github.com/SchemaPlus/schema_dev) to
+  facilitate running rspec tests on the matrix of ruby, rails, and database
+  versions that the gem supports, both locally and on
+  [travis-ci](http://travis-ci.org/SchemaPlus/schema_plus_indexes)
+
+  To to run rspec locally on the full matrix, do:
+
+        $ schema_dev bundle install
+        $ schema_dev rspec
+
+  You can also run on just one configuration at a time;  For info, see `schema_dev --help` or the
+  [schema_dev](https://github.com/SchemaPlus/schema_dev) README.
+
+  The matrix of configurations is specified in `schema_dev.yml` in
+  the project root.
+
+* **schema_monkey**: schema_plus_indexes extends ActiveRecord using
+  [schema_monkey](https://github.com/SchemaPlus/schema_monkey)'s extension
+  API and protocols -- see its README for details.  If your contribution needs any additional monkey patching
+  that isn't already supported by
+  [schema_monkey](https://github.com/SchemaPlus/schema_monkey), please head
+  over there and submit a PR.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'schema_dev/tasks'
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/gemfiles/Gemfile.base

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+gemspec :path => File.expand_path('..', __FILE__)
+
+platform :ruby do
+    gem "byebug" if RUBY_VERSION > "2"
+end
+
+File.exist?(gemfile_local = File.expand_path('../Gemfile.local', __FILE__)) and eval File.read(gemfile_local), binding, gemfile_local

data/gemfiles/rails-4.2/Gemfile.base

@@ -0,0 +1,3 @@
+eval File.read File.expand_path('../../Gemfile.base', __FILE__)
+
+gem "rails", "~> 4.2.0"

data/gemfiles/rails-4.2/Gemfile.mysql2

@@ -0,0 +1,10 @@
+require "pathname"
+eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+
+platform :ruby do
+  gem "mysql2"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcmysql-adapter'
+end

data/gemfiles/rails-4.2/Gemfile.postgresql

@@ -0,0 +1,10 @@
+require "pathname"
+eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+
+platform :ruby do
+  gem "pg"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcpostgresql-adapter'
+end

data/gemfiles/rails-4.2/Gemfile.sqlite3

@@ -0,0 +1,10 @@
+require "pathname"
+eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+
+platform :ruby do
+  gem "sqlite3"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter', '>=1.3.0.beta2'
+end

data/lib/schema_plus_indexes.rb

@@ -0,0 +1,11 @@
+require 'schema_monkey'
+
+require_relative 'schema_plus_indexes/active_record/base'
+require_relative 'schema_plus_indexes/active_record/connection_adapters/abstract_adapter'
+require_relative 'schema_plus_indexes/active_record/connection_adapters/index_definition'
+require_relative 'schema_plus_indexes/middleware/dumper'
+require_relative 'schema_plus_indexes/middleware/migration'
+require_relative 'schema_plus_indexes/middleware/model'
+require_relative 'schema_plus_indexes/middleware/sqlite3'
+
+SchemaMonkey.register(SchemaPlusIndexes)

data/lib/schema_plus_indexes/active_record/base.rb

@@ -0,0 +1,29 @@
+module SchemaPlusIndexes
+  module ActiveRecord
+
+    module Base
+      def self.included(base) #:nodoc:
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods #:nodoc:
+
+        public
+
+        # Returns a list of IndexDefinition objects, for each index
+        # defind on this model's table.
+        #
+        def indexes
+          @indexes ||= connection.indexes(table_name, "#{name} Indexes")
+        end
+
+        # (reset_index_information gets called by by Middleware::Model::ResetColumnInformation)
+        def reset_index_information
+          @indexes = nil
+        end
+
+      end
+    end
+  end
+end
+

data/lib/schema_plus_indexes/active_record/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,23 @@
+module SchemaPlusIndexes
+  module ActiveRecord
+    module ConnectionAdapters
+      module AbstractAdapter
+
+        def self.included(base) #:nodoc:
+          base.alias_method_chain :remove_index, :schema_plus_indexes
+        end
+
+        # Extends rails' remove_index to include this options:
+        #   :if_exists
+        def remove_index_with_schema_plus_indexes(table_name, *args)
+          options = args.extract_options!
+          if_exists = options.delete(:if_exists)
+          args << options if options.any?
+          return if if_exists and not index_name_exists?(table_name, options[:name] || index_name(table_name, *args), false)
+          remove_index_without_schema_plus_indexes(table_name, *args)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module SchemaPlusIndexes
+  module ActiveRecord
+    module ConnectionAdapters
+      #
+      # SchemaPlusIndexes extends the IndexDefinition object to return information
+      # about partial indexes and case sensitivity (i.e. Postgresql
+      # support).
+      module IndexDefinition
+        def self.included(base)  #:nodoc:
+          base.alias_method_chain :initialize, :schema_plus_indexes
+        end
+
+        def initialize_with_schema_plus_indexes(*args) #:nodoc:
+          # same args as add_index(table_name, column_names, options)
+          if args.length == 3 and Hash === args.last
+            table_name, column_names, options = args + [{}]
+            initialize_without_schema_plus_indexes(table_name, options[:name], options[:unique], column_names, options[:length], options[:orders], options[:where], options[:type], options[:using])
+          else # backwards compatibility
+            initialize_without_schema_plus_indexes(*args)
+          end
+          unless orders.blank?
+            # fill out orders with :asc when undefined.  make sure hash ordering
+            # follows column ordering.
+            self.orders = Hash[columns.map{|column| [column, orders[column] || :asc]}]
+          end
+        end
+
+        # tests if the corresponding indexes would be the same
+        def ==(other)
+          return false if other.nil?
+          return false unless self.name == other.name
+          return false unless Array.wrap(self.columns).collect(&:to_s).sort == Array.wrap(other.columns).collect(&:to_s).sort
+          return false unless !!self.unique == !!other.unique
+          return false unless Array.wrap(self.lengths).compact.sort == Array.wrap(other.lengths).compact.sort
+          return false unless self.where == other.where
+          return false unless (self.using||:btree) == (other.using||:btree)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/schema_plus_indexes/middleware/dumper.rb

@@ -0,0 +1,43 @@
+module SchemaPlusIndexes
+  module Middleware
+    module Dumper
+
+      def self.insert
+        SchemaMonkey::Middleware::Dumper::Table.append ColumnIndexes
+      end
+
+      class ColumnIndexes < SchemaMonkey::Middleware::Base
+        def call(env)
+          continue env
+
+          # move each column's index to its column, and remove them from the
+          # 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)
+              env.table.indexes.delete(index)
+            end
+
+          end
+
+        end
+
+        def column_index(env, column, index)
+          parts = []
+          parts << "name: #{index.name.inspect}"
+          parts << "with: #{(index.columns - [column.name]).inspect}" if index.columns.length > 1
+          parts << index.options unless index.options.blank?
+          "index: {#{parts.join(', ')}}"
+        end
+      end
+    end
+  end
+end

data/lib/schema_plus_indexes/middleware/migration.rb

@@ -0,0 +1,65 @@
+module SchemaPlusIndexes
+  module Middleware
+    module Migration
+
+      def self.insert
+        SchemaMonkey::Middleware::Migration::Column.prepend Shortcuts
+        SchemaMonkey::Middleware::Migration::Column.append IndexOnAddColumn
+        SchemaMonkey::Middleware::Migration::Index.prepend NormalizeArgs
+        SchemaMonkey::Middleware::Migration::Index.prepend IgnoreDuplicates
+      end
+
+      class Shortcuts < SchemaMonkey::Middleware::Base
+        def call(env)
+          case env.options[:index]
+          when true then env.options[:index] = {}
+          when :unique then env.options[:index] = { :unique => true }
+          end
+          continue env
+        end
+      end
+
+      class IndexOnAddColumn < SchemaMonkey::Middleware::Base
+        def call(env)
+          continue env
+          return unless env.options[:index]
+
+          case env.operation
+          when :add, :record
+            env.caller.add_index(env.table_name, env.column_name, env.options[:index])
+          end
+        end
+      end
+
+      class NormalizeArgs < SchemaMonkey::Middleware::Base
+        def call(env)
+          [:length, :order].each do |key|
+            env.options[key].stringify_keys! if env.options[key].is_a? Hash
+          end
+          env.column_names = Array.wrap(env.column_names).map(&:to_s) + Array.wrap(env.options.delete(:with)).map(&:to_s)
+          continue env
+        end
+      end
+
+      class IgnoreDuplicates < SchemaMonkey::Middleware::Base
+        # SchemaPlusIndexes modifies SchemaStatements::add_index so that it ignores
+        # errors raised about add an index that already exists -- i.e. that has
+        # the same index name, same columns, and same options -- and writes a
+        # warning to the log. Some combinations of rails & DB adapter versions
+        # would log such a warning, others would raise an error; with
+        # SchemaPlusIndexes all versions log the warning and do not raise the error.
+        def call(env)
+          continue env
+        rescue => e
+          raise unless e.message.match(/["']([^"']+)["'].*already exists/)
+          name = $1
+          existing = env.caller.indexes(env.table_name).find{|i| i.name == name}
+          attempted = ::ActiveRecord::ConnectionAdapters::IndexDefinition.new(env.table_name, env.column_names, env.options.merge(:name => name))
+          raise if attempted != existing
+          ::ActiveRecord::Base.logger.warn "[schema_plus_indexes] Index name #{name.inspect}' on table #{env.table_name.inspect} already exists. Skipping."
+        end
+      end
+
+    end
+  end
+end