gindex 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1e5e3c7f927af0b2abe38d61bdf3abe5c7526ff2
-  data.tar.gz: 1e0b6db1bc60dbda792afa9e1d7a516739ce7877
+SHA256:
+  metadata.gz: bdb3b0d5be3d4f72b4e2cd9c0e3469bd96980b4e1909f14bc755442d68131920
+  data.tar.gz: 551566c8043baae73b1de307a09b67759b10aac746776132c693619c450c1cb2
 SHA512:
-  metadata.gz: 5535a7424fec50d7ff8681cc3ad42142e9f0c617855db74b8c17be0e5c157a5b30dc9444da358fbe1b80ac634fc7e38268f771a5e268899e1f1bbd9d71dc59ea
-  data.tar.gz: a8e14458ec54b365a9e203fb0e89e9c4813761f93cc257a46309fac849da8baab33e7af4e6865c76e1edbfe4162ee00e99de17d93b95a5706ae352d3f9a4f9a5
+  metadata.gz: bed474abae726b41b17f0d8b773ab941a3ef43adf1223fc2d2ea39c0a66d64759746cffd615cbfd942cf99d95a909a2a2cd08f47cfa1b887653ab000633c7d58
+  data.tar.gz: 27ce4c182bdaa83d575267048beb782481e048cdb0e42516deaa804d891015171e5f5ac77d3e1afe464e8806801dc5f0d3964616744f700612e6c83d07144499

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.3.0 (2022-01-10)
+
+- Dropped support for Ruby < 2.6 and Rails < 5.2
+
+## 0.2.0 (2019-12-20)
+
+- Added support for custom migrations path
+- Improved migration for single column
+- Dropped support for Rails 4.2
+
+## 0.1.2 (2018-03-22)
+
+- Added support for Rails 5

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015-2022 Andrew Kane
+
+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

@@ -1,35 +1,47 @@
-# Gindex
+# g index
 
-:dash: Instant **concurrent indexes** for Rails
+:speedboat: Instant **concurrent** index migrations for Rails
 
-```ruby
-rails g index users email
-```
+## Installation
 
-Also works with multi-column indexes
+Add this line to your application’s Gemfile:
 
 ```ruby
-rails g index deliveries store_id delivered_at
+gem "gindex", group: :development
 ```
 
-## Installation
+## How It Works
 
-Add this line to your application’s Gemfile:
+```sh
+rails g index users email
+```
+
+generates:
 
 ```ruby
-gem 'gindex'
+class AddIndexOnEmailToUsers < ActiveRecord::Migration[6.1]
+  disable_ddl_transaction!
+
+  def change
+    add_index :users, :email, algorithm: :concurrently
+  end
+end
 ```
 
-And then execute:
+Also works with multi-column indexes
 
 ```sh
-bundle
+rails g index deliveries store_id delivered_at
 ```
 
 ## TODO
 
 - add `:name` option to long index names
 
+## History
+
+View the [changelog](https://github.com/ankane/gindex/blob/master/CHANGELOG.md)
+
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
@@ -38,3 +50,11 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/gindex/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/gindex.git
+cd gindex
+bundle install
+```

data/lib/generators/index/index_generator.rb

@@ -0,0 +1,30 @@
+require "rails/generators/active_record"
+
+class IndexGenerator < Rails::Generators::Base
+  include ActiveRecord::Generators::Migration
+  source_root File.join(__dir__, "templates")
+
+  argument :table, type: :string
+  argument :columns, type: :array
+
+  def copy_migration
+    migrate_path = ActiveRecord::Tasks::DatabaseTasks.migrations_paths.first
+    migration_template "index_migration.rb", "#{migrate_path}/add_index_on_#{columns.join('_and_')}_to_#{table}.rb"
+  end
+
+  def migration_version
+    "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+  end
+
+  def table_str
+    table.to_sym.inspect
+  end
+
+  def column_str
+    if columns.size == 1
+      columns.first.to_sym.inspect
+    else
+      columns.map(&:to_sym).inspect
+    end
+  end
+end

data/lib/generators/index/templates/index_migration.rb.tt

@@ -0,0 +1,7 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  disable_ddl_transaction!
+
+  def change
+    add_index <%= table_str %>, <%= column_str %>, algorithm: :concurrently
+  end
+end

data/lib/gindex/version.rb

@@ -1,3 +1,3 @@
 module Gindex
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,77 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: gindex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   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
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
-email:
-- andrew@chartkick.com
+        version: '5.2'
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
+- CHANGELOG.md
+- LICENSE.txt
 - README.md
-- Rakefile
-- gindex.gemspec
-- lib/generators/index_generator.rb
-- lib/generators/templates/index_migration.rb
+- lib/generators/index/index_generator.rb
+- lib/generators/index/templates/index_migration.rb.tt
 - lib/gindex.rb
 - lib/gindex/version.rb
 homepage: https://github.com/ankane/gindex
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,17 +49,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Instant concurrent indexes for Rails
 test_files: []
-has_rdoc: 

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in gindex.gemspec
-gemspec

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/gindex.gemspec

@@ -1,24 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "gindex/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "gindex"
-  spec.version       = Gindex::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-
-  spec.summary       = "Instant concurrent indexes for Rails"
-  spec.homepage      = "https://github.com/ankane/gindex"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "rails"
-
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-end

data/lib/generators/index_generator.rb

@@ -1,26 +0,0 @@
-# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
-require "rails/generators"
-require "rails/generators/migration"
-require "active_record"
-require "rails/generators/active_record"
-
-class IndexGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
-  source_root File.expand_path("../templates", __FILE__)
-  argument :table, type: :string
-  argument :columns, type: :array
-
-  # Implement the required interface for Rails::Generators::Migration.
-  def self.next_migration_number(dirname) #:nodoc:
-    next_migration_number = current_migration_number(dirname) + 1
-    if ::ActiveRecord::Base.timestamped_migrations
-      [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
-    else
-      "%.3d" % next_migration_number
-    end
-  end
-
-  def copy_migration
-    migration_template "index_migration.rb", "db/migrate/add_index_on_#{columns.join('_and_')}_to_#{table}.rb"
-  end
-end

data/lib/generators/templates/index_migration.rb

@@ -1,7 +0,0 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
-  disable_ddl_transaction!
-
-  def change
-    add_index <%= table.to_sym.inspect %>, <%= columns.map(&:to_sym).inspect %>, algorithm: :concurrently
-  end
-end