activerecord-simple_index_name 0.1.0 → 0.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fa6b9aae3727e763a002f35d1ce57aad24114fa
-  data.tar.gz: eb91da3010ce3ae2e2ca0054706da0c16d9917d8
+  metadata.gz: 0af826dbe87652a6514641bf5929772e87e253d4
+  data.tar.gz: 3024da2dcf30d5618b5970e2dfe5e24e5878944c
 SHA512:
-  metadata.gz: 1a8931aae60ddc11a440ab53c811a4d57a779c893af7902475190a0234b2fa658a8b5a3defac05e19e128509ee1368ff5287fee49ce1f19c0186b39b633bb936
-  data.tar.gz: ec67d7146748d7243b38c26b128cfd82a00ce24fe4ebcb59d494f92bbd1908edc6809fcd133c74b6499b2ad912f420a2b5ad585c5bba57e0d6cd6912cb039054
+  metadata.gz: 69a94c95b1fd18b4a87e803664ed4a342b57f3fe7ea63411e77d77b633ec43266d083d31c9a6234d83c4b5a416b562deb22a29ea85298328162387eb2892b9bc
+  data.tar.gz: b1d095044799f1355ae75fb12e26510b29444de7ee8a4c846b87072bb1ef9d5df365b04264071d5194ab41bbc819793fc51639ea64020f328f6abbb22d0ecd32

data/.travis.yml

@@ -5,8 +5,9 @@ rvm:
 - 2.3
 - ruby-head
 gemfile:
-- gemfiles/activerecord_4_1.gemfile
-- gemfiles/activerecord_4_2.gemfile
+- gemfiles/rails_4_0.gemfile
+- gemfiles/rails_4_1.gemfile
+- gemfiles/rails_4_2.gemfile
 cache: bundler
 sudo: false
 before_install: gem install bundler -v 1.10.6

data/CHANGELOG.md

@@ -1,5 +1,25 @@
+# Change Log
+
 ## Unreleased
-[full changelog](http://github.com/sue445/rubicure/compare/v0.1.0...master)
+[full changelog](http://github.com/sue445/activerecord-simple_index_name/compare/v0.1.0...master)
+
+### Enhancements
+* Add `ActiveRecord::SimpleIndexName.config.auto_shorten` configuration
+  * https://github.com/sue445/activerecord-simple_index_name/pull/13
+* Add `ActiveRecord::SimpleIndexName::EnableShorten`, `ActiveRecord::SimpleIndexName::DisableShorten`
+  * https://github.com/sue445/activerecord-simple_index_name/pull/12
 
+### Other
+* Test with Rails 4.0.x
+  * https://github.com/sue445/activerecord-simple_index_name/pull/19
+* Move files and rename module
+  * https://github.com/sue445/activerecord-simple_index_name/pull/17
+  * Move: `lib/activerecord/simple_index_name` -> `lib/active_record/simple_index_name`
+  * Rename: `Activerecord::SimpleIndexName` -> `ActiveRecord::SimpleIndexName`
+* Other tiny refactorings 
+  * https://github.com/sue445/activerecord-simple_index_name/pull/14
+  * https://github.com/sue445/activerecord-simple_index_name/pull/15
+  * https://github.com/sue445/activerecord-simple_index_name/pull/16
+  
 ## v0.1.0
 * First release

data/README.md

@@ -1,4 +1,4 @@
-# Activerecord::SimpleIndexName
+# ActiveRecord::SimpleIndexName
 
 Shorten index name
 
@@ -8,7 +8,11 @@ Shorten index name
 [![Coverage Status](https://coveralls.io/repos/sue445/activerecord-simple_index_name/badge.svg?branch=master&service=github)](https://coveralls.io/github/sue445/activerecord-simple_index_name?branch=master)
 [![Code Climate](https://codeclimate.com/github/sue445/activerecord-simple_index_name/badges/gpa.svg)](https://codeclimate.com/github/sue445/activerecord-simple_index_name)
 
-## Supported 
+## Requirements
+* Ruby 2.1+
+* activerecord 4.0+
+
+## Supported frameworks
 * [Ruby on Rails](https://github.com/rails/rails)
 * [Padrino](https://github.com/padrino/padrino-framework)
 * or plain activerecord
@@ -47,6 +51,62 @@ add_index :user_stocks, [:user_id, :article_id]
 * Index name without `activerecord-simple_index_name` : `index_user_stocks_on_user_id_and_article_id`
 * Index name with `activerecord-simple_index_name` : `user_id_and_article_id`
 
+## Configurations
+### Usage
+
+```ruby
+ActiveRecord::SimpleIndexName.config.auto_shorten = true
+```
+
+or
+
+```ruby
+ActiveRecord::SimpleIndexName.configure do |config|
+  config.auto_shorten = true
+end
+```
+
+* `auto_shorten` : Whether shorten index name
+  * `true` (default) : all index names are shorten (e.g. `user_id_and_article_id`)
+  * `false` : all index names are **not** shorten (e.g. `index_user_stocks_on_user_id_and_article_id`)
+
+
+## Opt-in/Opt-out
+When `auto_shorten` is enabled, we can disable simple index name in only specified migration.
+(or when `auto_shorten` is disabled, we can enable simple index name in only specified migration)
+
+* `ActiveRecord::SimpleIndexName::EnableShorten`
+  * When include `ActiveRecord::SimpleIndexName::EnableShorten` in any migration file, enable simple index name
+* `ActiveRecord::SimpleIndexName::DisableShorten`
+  * When include `ActiveRecord::SimpleIndexName::DisableShorten` in any migration file, disable simple index name
+
+### Opt-in Example
+```ruby
+class AddCategoryIdToArticles < ActiveRecord::Migration
+  include Activerecord::SimpleIndexName::EnableShorten
+
+  def change
+    add_column :articles, :category_id, :integer
+    add_index :articles, :category_id
+  end
+end
+```
+
+include `ActiveRecord::SimpleIndexName::EnableShorten`, use simple index name regardless of whether `auto_shorten` is `true` or `false`
+
+### Opt-out Example
+```ruby
+class AddArticleIndexToUserStocks < ActiveRecord::Migration
+  include ActiveRecord::SimpleIndexName::DisableShorten
+
+  def change
+    add_index :user_stocks, :article_id
+  end
+end
+```
+
+include `ActiveRecord::SimpleIndexName::DisableShorten`, don't use simple index name regardless of whether `auto_shorten` is `true` or `false`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/activerecord-simple_index_name.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'activerecord/simple_index_name/version'
+require 'active_record/simple_index_name/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "activerecord-simple_index_name"
-  spec.version       = Activerecord::SimpleIndexName::VERSION
+  spec.version       = ActiveRecord::SimpleIndexName::VERSION
   spec.authors       = ["sue445"]
   spec.email         = ["sue445@sue445.net"]
 
@@ -20,10 +20,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activerecord"
+  spec.add_dependency "activesupport"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rails"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-power_assert"

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "activerecord/simple_index_name"
+require "active_record/simple_index_name"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/gemfiles/rails_4_0.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+gem "activesupport", "~> 4.0.0"
+
+gemspec path: '../'

data/gemfiles/{activerecord_4_1.gemfile → rails_4_1.gemfile}

@@ -1,5 +1,6 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 4.1.0"
+gem "activesupport", "~> 4.1.0"
 
 gemspec path: '../'

data/gemfiles/{activerecord_4_2.gemfile → rails_4_2.gemfile}

@@ -1,5 +1,6 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 4.2.0"
+gem "activesupport", "~> 4.2.0"
 
 gemspec path: '../'

data/lib/active_record/simple_index_name.rb

@@ -0,0 +1,31 @@
+require "active_record"
+require "active_record/simple_index_name/version"
+require "active_record/simple_index_name/configuration"
+require "active_record/simple_index_name/disable_shorten"
+require "active_record/simple_index_name/enable_shorten"
+
+module ActiveRecord
+  module SimpleIndexName
+    def self.config
+      @config ||= Configuration.new
+    end
+
+    def self.configure
+      yield config if block_given?
+    end
+
+    def self.with_shorten(shorten)
+      Thread.current[:simple_index_name_shorten_mode] = shorten
+
+      yield if block_given?
+    ensure
+      Thread.current[:simple_index_name_shorten_mode] = nil
+    end
+  end
+end
+
+if defined?(Rails)
+  require "active_record/simple_index_name/railtie"
+else
+  require "active_record/simple_index_name/active_record_ext"
+end

data/lib/active_record/simple_index_name/active_record_ext.rb

@@ -0,0 +1,29 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module SchemaStatements
+      def index_name_with_simple(table_name, options)
+        shorten_mode =
+          case Thread.current[:simple_index_name_shorten_mode]
+          when :enable
+            true
+          when :disable
+            false
+          else
+            ActiveRecord::SimpleIndexName.config.auto_shorten
+          end
+
+        if shorten_mode
+          if Hash === options && options[:column]
+            Array.wrap(options[:column]) * "_and_"
+          else
+            index_name_without_simple(table_name, options)
+          end
+        else
+          index_name_without_simple(table_name, options)
+        end
+      end
+
+      alias_method_chain :index_name, :simple
+    end
+  end
+end

data/lib/active_record/simple_index_name/configuration.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  module SimpleIndexName
+    require "active_support/configurable"
+
+    class Configuration
+      include ActiveSupport::Configurable
+
+      config_accessor :auto_shorten
+
+      configure do |config|
+        config.auto_shorten = true
+      end
+    end
+  end
+end

data/lib/active_record/simple_index_name/disable_shorten.rb

@@ -0,0 +1,11 @@
+module ActiveRecord
+  module SimpleIndexName
+    module DisableShorten
+      def exec_migration(conn, direction)
+        ActiveRecord::SimpleIndexName.with_shorten(:disable) do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/active_record/simple_index_name/enable_shorten.rb

@@ -0,0 +1,11 @@
+module ActiveRecord
+  module SimpleIndexName
+    module EnableShorten
+      def exec_migration(conn, direction)
+        ActiveRecord::SimpleIndexName.with_shorten(:enable) do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/{activerecord → active_record}/simple_index_name/railtie.rb

@@ -1,9 +1,9 @@
-module Activerecord
+module ActiveRecord
   module SimpleIndexName
     class Railtie < ::Rails::Railtie
       initializer "simple_index_name.initializer" do
         ActiveSupport.on_load(:active_record) do
-          require "activerecord/simple_index_name/active_record_ext"
+          require "active_record/simple_index_name/active_record_ext"
         end
       end
     end

data/lib/active_record/simple_index_name/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module SimpleIndexName
+    VERSION = "0.2.0.beta1"
+  end
+end

data/lib/activerecord-simple_index_name.rb

@@ -1 +1 @@
-require "activerecord/simple_index_name"
+require "active_record/simple_index_name"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-simple_index_name
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.beta1
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-29 00:00:00.000000000 Z
+date: 2015-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -141,13 +183,17 @@ files:
 - activerecord-simple_index_name.gemspec
 - bin/console
 - bin/setup
-- gemfiles/activerecord_4_1.gemfile
-- gemfiles/activerecord_4_2.gemfile
+- gemfiles/rails_4_0.gemfile
+- gemfiles/rails_4_1.gemfile
+- gemfiles/rails_4_2.gemfile
+- lib/active_record/simple_index_name.rb
+- lib/active_record/simple_index_name/active_record_ext.rb
+- lib/active_record/simple_index_name/configuration.rb
+- lib/active_record/simple_index_name/disable_shorten.rb
+- lib/active_record/simple_index_name/enable_shorten.rb
+- lib/active_record/simple_index_name/railtie.rb
+- lib/active_record/simple_index_name/version.rb
 - lib/activerecord-simple_index_name.rb
-- lib/activerecord/simple_index_name.rb
-- lib/activerecord/simple_index_name/active_record_ext.rb
-- lib/activerecord/simple_index_name/railtie.rb
-- lib/activerecord/simple_index_name/version.rb
 homepage: https://github.com/sue445/activerecord-simple_index_name
 licenses:
 - MIT
@@ -163,9 +209,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1

data/lib/activerecord/simple_index_name.rb

@@ -1,13 +0,0 @@
-require "activerecord/simple_index_name/version"
-require "active_record"
-
-module Activerecord
-  module SimpleIndexName
-  end
-end
-
-if defined?(Rails)
-  require "activerecord/simple_index_name/railtie"
-else
-  require "activerecord/simple_index_name/active_record_ext"
-end

data/lib/activerecord/simple_index_name/active_record_ext.rb

@@ -1,15 +0,0 @@
-module ActiveRecord
-  module ConnectionAdapters
-    module SchemaStatements
-      def index_name_with_simple(table_name, options)
-        if Hash === options && options[:column]
-          Array.wrap(options[:column]) * "_and_"
-        else
-          index_name_without_simple(table_name, options)
-        end
-      end
-
-      alias_method_chain :index_name, :simple
-    end
-  end
-end

data/lib/activerecord/simple_index_name/version.rb

@@ -1,5 +0,0 @@
-module Activerecord
-  module SimpleIndexName
-    VERSION = "0.1.0"
-  end
-end