schema_plus_indexes 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f4aa8a0bb209b6aefdd7ae30e47ec26c594a6e3
-  data.tar.gz: 6deee591cfa43d5a6bb3a14f5a4048647b9c0a2f
+  metadata.gz: ab3b42608f51e2ebb4b7b6b21b5ad2fc6566fec2
+  data.tar.gz: a9b0166d7a50826f93825aa20a29f714e952f69e
 SHA512:
-  metadata.gz: 73655b914ee4ff00cdc004d605e843eaa9c88268073ae1658ed6b6df0153a8b3e969b48ecdd1595e0c66237afc1e58d10cb18e526de97850dc620627f24bf465
-  data.tar.gz: c8fe49bbd8130f7562ab10b4d3caff918e2d9efbd826f16ecec40789fb6d979c47a00824df0811d52756c414b171d0a43115a0d355d623f394860a2aaa776919
+  metadata.gz: fe17a220b606d91ef6cdc213371ef0ba018c69deda8ba67464a16171ede854b50c30423f17c404b00d622325f746ae6da254dc129641be992ab0fc050a87035b
+  data.tar.gz: 375f7b7201cae230180d7bc98fd11a980a5f2d1970b8a481ba2063019d9bc6e528c758758b747dabe8d932ff2ae35c6fe9b77e7bbd9f7b7db6d6b16398715946

data/README.md

@@ -3,45 +3,11 @@
 [![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
+# SchemaPlus::Indexes
 
-SchemaPlusIndexes adds various convenient capabilities to `ActiveRecord`'s index handling:
+SchemaPlus::Indexes 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.
+SchemaPlus::Indexes is part of the [SchemaPlus](https://github.com/SchemaPlus/) family of Ruby on Rails extension gems.
 
 ## Installation
 
@@ -64,6 +30,83 @@ which creates a Railtie to that will insert SchemaPlus::Indexes appropriately in
 
 <!-- SCHEMA_DEV: TEMPLATE INSTALLATION - end -->
 
+
+## Features
+
+### Migrations:
+
+#### Shorthand to define a column with an index:
+
+```ruby
+t.string :role,             index: true     # shorthand for index: {}
+```
+
+#### Shorthand to define a column with a unique index:
+```ruby
+t.string :product_code,     index: :unique  # shorthand for index: { unique: true }
+```
+
+#### Create multi-column indexes as part of column definition
+
+Adds an option to include other columns in the index:
+
+```ruby
+t.string :first_name
+t.string :last_name,        index: { with: :first_name }
+
+t.string :country_code
+t.string :area_code
+t.string :local_number,     index: { with: [:country_code, :area_code] }
+```
+
+#### Create indexes with `add_column`, `change_table`
+
+ActiveRecord supports the `index:` option to column definitions when creating table.  SchemaPlus::Indexes extends that to work also with `add_column` and in `change_table`
+
+```ruby
+add_column "tablename", "columnname", index: { ... }
+
+change_table :tablename do |t|
+  t.integer :column,    index: true
+end
+```
+
+These of course accept the shorthands and `with:` option described above.
+
+#### Remove index :if_exsts
+
+```ruby
+remove_index "tablename", "columnname", if_exists: true
+```
+
+### Models
+
+SchemaPlus::Indexes lets you easily get the indexes of a model:
+
+```ruby
+Model.indexes  # shorthand for `connection.indexes(Model.table_name)`
+```
+
+The value gets cached until the next time `Model.reset_column_information` is called.
+
+### Other things...
+
+* 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.
+
+* 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`)
+  
+* 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.
+
 ## Compatibility
 
 schema_plus_indexes is tested on
@@ -78,7 +121,7 @@ schema_plus_indexes is tested on
 
 ### v0.1.0
 
-* Initial release
+* Initial release, extracted from schema_plus 1.x
 
 ## Development & Testing
 

data/lib/{schema_plus_indexes → schema_plus/indexes}/active_record/base.rb

@@ -1,4 +1,4 @@
-module SchemaPlusIndexes
+module SchemaPlus::Indexes
   module ActiveRecord
     module Base
       module ClassMethods

data/lib/{schema_plus_indexes → schema_plus/indexes}/active_record/connection_adapters/abstract_adapter.rb

@@ -1,4 +1,4 @@
-module SchemaPlusIndexes
+module SchemaPlus::Indexes
   module ActiveRecord
     module ConnectionAdapters
       module AbstractAdapter

data/lib/{schema_plus_indexes → schema_plus/indexes}/active_record/connection_adapters/index_definition.rb

@@ -1,10 +1,7 @@
-module SchemaPlusIndexes
+module SchemaPlus::Indexes
   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 initialize(*args) #:nodoc:

data/lib/{schema_plus_indexes → schema_plus/indexes}/middleware/dumper.rb

@@ -1,4 +1,4 @@
-module SchemaPlusIndexes
+module SchemaPlus::Indexes
   module Middleware
     module Dumper
       module Table

data/lib/{schema_plus_indexes → schema_plus/indexes}/middleware/migration.rb

@@ -1,4 +1,4 @@
-module SchemaPlusIndexes
+module SchemaPlus::Indexes
   module Middleware
     module Migration
 
@@ -34,12 +34,12 @@ module SchemaPlusIndexes
 
         # Ignore duplicates
         #
-        # SchemaPlusIndexes modifies SchemaStatements::add_index so that it ignores
+        # SchemaPlus::Indexes 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.
+        # SchemaPlus::Indexes all versions log the warning and do not raise the error.
         def around(env)
           yield env
         rescue => e

data/lib/{schema_plus_indexes → schema_plus/indexes}/middleware/model.rb

@@ -1,4 +1,4 @@
-module SchemaPlusIndexes
+module SchemaPlus::Indexes
   module Middleware
     module Model
       module ResetColumnInformation

data/lib/{schema_plus_indexes → schema_plus/indexes}/middleware/schema.rb

@@ -1,4 +1,4 @@
-module SchemaPlusIndexes
+module SchemaPlus::Indexes
   module Middleware
     module Schema
       module Sqlite3

data/lib/schema_plus/indexes/version.rb

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

data/lib/schema_plus/indexes.rb

@@ -0,0 +1,11 @@
+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/middleware/dumper'
+require_relative 'indexes/middleware/migration'
+require_relative 'indexes/middleware/model'
+require_relative 'indexes/middleware/schema'
+
+SchemaMonkey.register SchemaPlus::Indexes

data/lib/schema_plus_indexes.rb

@@ -1,11 +1 @@
-require 'schema_plus/core'
-
-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/schema'
-
-SchemaMonkey.register SchemaPlusIndexes
+require_relative 'schema_plus/indexes'

data/schema_plus_indexes.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'schema_plus_indexes/version'
+require 'schema_plus/indexes/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "schema_plus_indexes"
-  gem.version       = SchemaPlusIndexes::VERSION
+  gem.version       = SchemaPlus::Indexes::VERSION
   gem.authors       = ["ronen barzel"]
   gem.email         = ["ronen@barzel.org"]
   gem.summary       = %q{Adds shorthands and conveniences to ActiveRecord's handling of indexes}

data/spec/spec_helper.rb

@@ -15,7 +15,7 @@ SchemaDev::Rspec.setup
 Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  config.include(SchemaPlusIndexesMatchers)
+  config.include(SchemaPlus::IndexesMatchers)
   config.warnings = true
 end
 

data/spec/support/matchers/have_index.rb

@@ -1,4 +1,4 @@
-module SchemaPlusIndexesMatchers
+module SchemaPlus::IndexesMatchers
 
   class HaveIndex
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_plus_indexes
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - ronen barzel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -140,15 +140,16 @@ files:
 - gemfiles/activerecord-4.2/Gemfile.mysql2
 - gemfiles/activerecord-4.2/Gemfile.postgresql
 - gemfiles/activerecord-4.2/Gemfile.sqlite3
+- lib/schema_plus/indexes.rb
+- 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/middleware/dumper.rb
+- lib/schema_plus/indexes/middleware/migration.rb
+- lib/schema_plus/indexes/middleware/model.rb
+- lib/schema_plus/indexes/middleware/schema.rb
+- lib/schema_plus/indexes/version.rb
 - lib/schema_plus_indexes.rb
-- 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/middleware/dumper.rb
-- lib/schema_plus_indexes/middleware/migration.rb
-- lib/schema_plus_indexes/middleware/model.rb
-- lib/schema_plus_indexes/middleware/schema.rb
-- lib/schema_plus_indexes/version.rb
 - schema_dev.yml
 - schema_plus_indexes.gemspec
 - spec/index_definition_spec.rb

data/lib/schema_plus_indexes/version.rb

@@ -1,3 +0,0 @@
-module SchemaPlusIndexes
-  VERSION = "0.1.2"
-end