postgres-migration-cops 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71e94e1d2931b2029aa8efa2ffec426c90dd9d22d50233ab6dbcf7c5dce6722c
+  data.tar.gz: 73425f5019bf182bf60131f9de10b6358be8662ec023f58af8e5089806e8ecb8
+SHA512:
+  metadata.gz: f517ef527f1b720d7ffe2c96810307ec1b3ba8aadbbcf62adc991a917551fd40c7c9909c121b48acf598d663b2fc29ba4ba0a84ddb7d4cc481bce597bda7d8f3
+  data.tar.gz: 368d5c3717c91ffdd109f166e97bba146d7b93c70d1c90f6b41a889bbd726468af8bbbc9c403ef576a4240a7badce46caca96d273b13f6fa3cb8da01f1375a6f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gbatterbee1@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+ruby '2.3.7'
+gem 'rubocop'
+
+group :development do
+  gem 'rspec'
+  gem 'rspec-core'
+  gem 'rubocop-rspec'
+  gem 'solargraph'
+end
+
+# Specify your gem's dependencies in postgres-migration-cops.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    postgres-migration-cops (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    backport (0.3.0)
+    diff-lcs (1.3)
+    htmlentities (4.3.4)
+    jaro_winkler (1.5.2)
+    kramdown (1.17.0)
+    mini_portile2 (2.1.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.4.2)
+    reverse_markdown (1.1.0)
+      nokogiri
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    solargraph (0.31.3)
+      backport (~> 0.3)
+      htmlentities (~> 4.3, >= 4.3.4)
+      jaro_winkler (~> 1.5)
+      kramdown (~> 1.16)
+      parser (~> 2.3)
+      reverse_markdown (~> 1.0, >= 1.0.5)
+      rubocop (~> 0.52)
+      thor (~> 0.19, >= 0.19.4)
+      tilt (~> 2.0)
+      yard (~> 0.9)
+    thor (0.20.0)
+    tilt (2.0.9)
+    unicode-display_width (1.4.1)
+    yard (0.9.18)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  postgres-migration-cops!
+  rake (~> 10.0)
+  rspec
+  rspec-core
+  rubocop
+  rubocop-rspec
+  solargraph
+
+RUBY VERSION
+   ruby 2.3.7p456
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 G Batterbee
+
+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,43 @@
+# Postgres::Migration::Cops
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/postgres/migration/cops`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'postgres-migration-cops'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postgres-migration-cops
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/postgres-migration-cops. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Postgres::Migration::Cops project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/postgres-migration-cops/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'postgres/migration/cops'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples.txt

@@ -0,0 +1,12 @@
+example_id                                                | status | run_time        |
+--------------------------------------------------------- | ------ | --------------- |
+./spec/lib/cops/add_indexes_concurrently_spec.rb[1:1:1:1] | passed | 0.03992 seconds |
+./spec/lib/cops/add_indexes_concurrently_spec.rb[1:1:2:1] | passed | 0.00308 seconds |
+./spec/lib/cops/add_indexes_concurrently_spec.rb[1:1:3:1] | passed | 0.00307 seconds |
+./spec/lib/cops/add_indexes_concurrently_spec.rb[1:2:1:1] | passed | 0.00261 seconds |
+./spec/lib/cops/add_indexes_concurrently_spec.rb[1:2:2:1] | passed | 0.00272 seconds |
+./spec/lib/cops/add_indexes_concurrently_spec.rb[1:2:3:1] | passed | 0.00143 seconds |
+./spec/lib/cops/use_add_index_spec.rb[1:1:1]              | passed | 0.00276 seconds |
+./spec/lib/cops/use_add_index_spec.rb[1:2:1]              | passed | 0.00454 seconds |
+./spec/lib/cops/use_add_index_spec.rb[1:3:1]              | passed | 0.00166 seconds |
+./spec/lib/cops/use_add_index_spec.rb[1:4:1]              | passed | 0.00154 seconds |

data/lib/cops/add_indexes_concurrently.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module PostgresMigrationCops
+      # Check that indexes are added concurrently with disable_ddl_transaction!
+      # https://thoughtbot.com/blog/how-to-create-postgres-indexes-concurrently-in
+      #
+      # @example
+      #  # bad
+      #   class SomeTableMigrations < ActiveRecord::Migration
+      #     def change
+      #       add_column :table, :some_column_1, :integer, default: 0, null: false
+      #       add_column :table, :other_column, :string
+      #       add_column :table, :doneit_at, :datetime
+      #       add_index  :table,
+      #                  :other_column,
+      #                  unique: true
+      #     end
+      #   end
+      #
+      #  # good
+      #   class SomeTableMigrations < ActiveRecord::Migration
+      #     disable_ddl_transaction!
+      #     def change
+      #       add_column :table, :some_column_1, :integer, default: 0, null: false
+      #       add_column :table, :other_column, :string
+      #       add_column :table, :doneit_at, :datetime
+      #       add_index  :table,
+      #                  :other_column,
+      #                  unique: true,
+      #                  algorithm: :concurrently
+      #       end
+      #   end
+      class AddIndexesConcurrently < Cop
+        IGNORE_DDL = 'Concurrent indexes require "disable_ddl_transaction!"'
+        CONCURRENTLY = "Indexes should be added with 'algorithm: :concurrently'"
+
+        def on_class(class_node)
+          is_migration = class_node.children.any? { |n| is_migration?(n) }
+          return unless is_migration
+
+          index_nodes = find_index_methods(class_node)
+          return unless creating_indexes?(index_nodes)
+
+          ensure_disable_dll_transaction_offense(class_node, index_nodes)
+          ensure_indexes_added_non_concurrently_offenses(index_nodes)
+        end
+
+        private
+
+        def creating_indexes?(index_nodes)
+          index_nodes.count.positive?
+        end
+
+        def ensure_disable_dll_transaction_offense(class_node, index_nodes)
+          return if disable_ddl_transaction_declared?(class_node)
+
+          has_concurrent = concurrent_indexes?(index_nodes)
+          add_offense(class_node, message: IGNORE_DDL) if has_concurrent
+        end
+
+        def disable_ddl_transaction_declared?(node)
+          begins = find__begin node
+          begins.any? { |b| b.children.any? { |n| has_disable_ddl?(n) } }
+        end
+
+        def concurrent_indexes?(index_nodes)
+          index_nodes
+            .select { |n| n.source.include?('concurrent') }
+            .count
+            .positive?
+        end
+
+        def ensure_indexes_added_non_concurrently_offenses(index_nodes)
+          index_nodes
+            .reject { |n| n.source.include?('concurrently') }
+            .to_a.each { |n| add_offense(n, message: CONCURRENTLY) }
+        end
+
+        def find_index_methods(node)
+          sends = find__send node
+          sends.select { |n| n.source.include?('add_index') }
+        end
+
+        def_node_matcher :is_migration?, <<-PATTERN
+          (const ... :Migration)
+        PATTERN
+
+        def_node_search :find__send, <<-PATTERN
+          send
+        PATTERN
+
+        def_node_matcher :is_add_index?, <<-PATTERN
+          (send nil :add_index ... )
+        PATTERN
+
+        def_node_search :find__begin, <<-PATTERN
+          begin
+        PATTERN
+
+        def_node_matcher :has_disable_ddl?, <<-PATTERN
+          (... :disable_ddl_transaction!)
+        PATTERN
+      end
+    end
+  end
+end

data/lib/cops/add_indexes_concurrently_spec.rb

@@ -0,0 +1,221 @@
+require './lib/cops/add_indexes_concurrently'
+
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::PostgresMigrationCops::AddIndexesConcurrently do
+  subject(:cop) { described_class.new }
+
+  context 'when disable_ddl_transaction! is not declared' do
+    context 'and it is not a migration' do
+      it 'does not register an ignore ddl offence' do
+        expect_no_offenses(<<-RUBY)
+        class SomeTableMigrations
+            def change
+              add_column :table, :some_column_1, :integer, default: 0, null: false
+              add_column :table, :other_column, :string
+              add_column :table, :doneit_at, :datetime
+              add_index  :table,
+                         :other_column,
+                         unique: true,
+                         algorithm: :concurrently
+            end
+          end
+        RUBY
+      end
+    end
+
+    context 'and an index is not created concurrently' do
+      it 'registers an concurrent index offence' do
+        expect_offense(<<-RUBY)
+        class SomeTableMigrations < ActiveRecord::Migration
+            def change
+              add_column :table, :some_column_1, :integer, default: 0, null: false
+              add_column :table, :other_column, :string
+              add_column :table, :doneit_at, :datetime
+              add_index  :table,
+              ^^^^^^^^^^^^^^^^^^ Indexes should be added with 'algorithm: :concurrently'
+                         :other_column,
+                         unique: true
+            end
+          end
+        RUBY
+      end
+    end
+
+    context 'and an index is created concurrently' do
+      it 'registers an ignore ddl offence' do
+        expect_offense(<<-RUBY)
+        class SomeTableMigrations < ActiveRecord::Migration
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Concurrent indexes require "disable_ddl_transaction!"
+            def change
+              add_column :table, :some_column_1, :integer, default: 0, null: false
+              add_column :table, :other_column, :string
+              add_column :table, :doneit_at, :datetime
+              add_index  :table,
+                         :other_column,
+                         unique: true,
+                         algorithm: :concurrently
+            end
+          end
+        RUBY
+      end
+    end
+  end
+
+  context 'when disable_ddl_transaction! is declared' do
+    context 'when not a migration' do
+      it 'does not register an offense ' do
+        expect_no_offenses(<<-RUBY)
+          class SomeTableMigrations
+            disable_ddl_transaction!
+            def change
+              add_column :table, :doneit_at, :datetime, :index
+              add_index  :table,
+                         :other_column,
+                         unique: true,
+                         algorithm: :concurrently
+            end
+          end
+        RUBY
+      end
+    end
+
+    context 'and an index is registered concurrently' do
+      it 'does not register an offense' do
+        expect_no_offenses(<<-RUBY)
+          class SomeTableMigrations < ActiveRecord::Migration
+            disable_ddl_transaction!
+            def change
+              add_column :table, :doneit_at, :datetime
+              add_index  :table,
+                         :other_column,
+                         unique: true,
+                         algorithm: :concurrently
+            end
+          end
+        RUBY
+      end
+    end
+
+    context 'and an index is not registered concurrently' do
+      it 'registers an concurrency offense' do
+        expect_offense(<<-RUBY)
+          class SomeTableMigrations < ActiveRecord::Migration
+            disable_ddl_transaction!
+            def change
+              add_column :table, :doneit_at, :datetime, :index
+              add_index  :table,
+              ^^^^^^^^^^^^^^^^^^ Indexes should be added with 'algorithm: :concurrently'
+                         :other_column,
+                         unique: true
+            end
+          end
+        RUBY
+      end
+    end
+  end
+end
+
+# code = '!something.empty?'
+# source = RuboCop::ProcessedSource.new(code, RUBY_VERSION.to_f)
+# node = source.ast
+# # => s(:send, s(:send, s(:send, nil, :something), :empty?), :!)
+# The node has a few attributes that can be useful in the journey:
+
+# node.type # => :send
+# node.children # => [s(:send, s(:send, nil, :something), :empty?), :!]
+# node.source # => "!something.empty?"
+
+# xit 'registers an offense when index is added concurrently' do
+#   expect_offense(<<-RUBY)
+#   class SomeTableMigrations < ActiveRecord::Migration
+#   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Concurrent indexes require "disable_ddl_transaction!" at the top of the class
+#     disable_ddl_transaction!
+#     def change
+#       add_column :table, :some_column_1, :integer, default: 0, null: false
+#       add_column :table, :other_column, :string
+#       add_column :table, :doneit_at, :datetime
+#       add_index  :table,
+#                 :other_column,
+#                 unique: true,
+#                 algorithm: :concurrently
+#     end
+#   end
+#   RUBY
+# # end
+
+# xit 'xxxregisters an offense when index not added concurrently' do
+#   expect_offense(<<-RUBY)
+#   class SomeTableMigrations < ActiveRecord::Migration
+#     disable_ddl_transaction!
+#     ^^^^^^^^^^^^^^^^^^^^^^^^ Concurrent indexes require "disable_ddl_transaction!" at the top of the class
+
+#     def change
+#       add_column :table, :some_column_1, :integer, default: 0, null: false
+#       add_column :table, :other_column, :string
+#       add_column :table, :doneit_at, :datetime
+#       add_index  :table,
+#                 :other_column,
+#                 unique: true,
+#                 algorithm: :concurrently
+#     end
+#   end
+#   RUBY
+# end
+# xit 'does not register an offense when index not added concurrently' do
+#   expect_no_offenses(<<-RUBY)
+#   class SomeTableMigrations < ActiveRecord::Migration
+#       disable_ddl_transaction!
+#       def change
+#         add_column :table, :some_column_1, :integer, default: 0, null: false
+#         add_column :table, :other_column, :string
+#         add_column :table, :doneit_at, :datetime
+#         add_index  :table,
+#                   :other_column,
+#                   unique: true
+#       end
+#     end
+#   RUBY
+# end
+
+# xit 'does not register an offense when index not a migration' do
+#   expect_no_offenses(<<-RUBY)
+#   class SomeTableMigrations < ActiveRecord::Migration
+#       disable_ddl_transaction!
+#       def change
+#         add_column :table, :some_column_1, :integer, default: 0, null: false
+#         add_column :table, :other_column, :string
+#         add_column :table, :doneit_at, :datetime
+#         add_index  :table,
+#                   :other_column,
+#                   unique: true
+#       end
+#     end
+#   RUBY
+# end
+
+# xit 'does not register an offense when not a migration' do
+#   expect_no_offenses(<<-RUBY)
+#   class SomeTableMigrations
+#       def change
+#         add_column :table, :doneit_at, :datetime, :index
+#         add_index  :table,
+#                   :other_column,
+#                   unique: true
+#       end
+#     end
+#   RUBY
+# end
+# end
+
+# class SomeTableMigrations < ActiveRecord::Migration
+#       def change
+#         add_column :table, :some_column_1, :integer, default: 0, null: false
+#         add_column :table, :other_column, :string
+#         add_column :table, :doneit_at, :datetime
+#         add_index  :table,
+#                    :other_column,
+#                    unique: true,
+#                    algorithm: :concurrently
+#       end
+#     end

data/lib/cops/use_add_index.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module PostgresMigrationCops
+      # Check that indexes are added explicitly with add_index
+      # to ensure concurrency can be enabled
+      #
+      # @example
+      #  # bad
+      #   class SomeTableMigrations < ActiveRecord::Migration
+      #     def change
+      #       add_column :table, :some_column_1, :integer, :index
+      #       add_column :table, :other_column, :string, index: true
+      #     end
+      #   end
+      #
+      #  # good
+      #   class SomeTableMigrations < ActiveRecord::Migration
+      #     disable_ddl_transaction!
+      #     def change
+      #       add_column :table, :some_column_1, :integer
+      #       add_column :table, :other_column, :string
+      #       add_column :table, :doneit_at, :datetime
+      #       add_index  :table,
+      #                  :some_column_1,
+      #                  algorithm: :concurrently
+      #       add_index  :table,
+      #                  :other_column,
+      #                  algorithm: :concurrently
+
+      #       end
+      #   end
+      class UseAddIndex < Cop
+        MSG = "Add indexes using 'add_index ... algorithm: :concurrently'"
+
+        def on_class(class_node)
+          @is_migration = class_node.children.any? { |n| is_migration?(n) }
+        end
+
+        def on_send(send_node)
+          return unless @is_migration
+
+          add_offense(send_node) if contains_index?(send_node)
+        end
+
+        private
+
+        def_node_matcher :is_migration?, <<-PATTERN
+          (const ... :Migration)
+        PATTERN
+
+        def contains_index?(node)
+          return true if node.children.any? { |n| is_index_symbol?(n) }
+
+          contains_hash_index?(node)
+        end
+
+        def contains_hash_index?(node)
+          opts_node = node.children.last
+          return unless opts_node.class == RuboCop::AST::HashNode
+
+          opts_node.children.any? { |n| is_index_pair? n }
+        end
+
+        def_node_matcher :is_index_symbol?, <<-PATTERN
+          (sym :index)
+        PATTERN
+
+        def_node_matcher :is_index_pair?, <<-PATTERN
+        (pair
+          (sym :index)
+          (true))
+        PATTERN
+      end
+    end
+  end
+end

data/lib/cops/use_add_index_spec.rb

@@ -0,0 +1,89 @@
+require './lib/cops/use_add_index'
+
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::PostgresMigrationCops::UseAddIndex do
+  subject(:cop) { described_class.new }
+
+  context 'when index is declared as an option' do
+    it 'it registers an offence' do
+      expect_offense(<<-RUBY)
+        class SomeTableMigrations < ActiveRecord::Migration
+            def change
+              add_column :table, :some_column_1, :integer, :index
+              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add indexes using 'add_index ... algorithm: :concurrently'
+              add_column :table, :other_column, :string
+              add_column :table, :doneit_at, :datetime
+              add_index  :table,
+                         :other_column,
+                         unique: true
+
+              create_table :examples do |t|
+                t.references :category, :index
+                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add indexes using 'add_index ... algorithm: :concurrently'
+                t.integer :number_of_participants, :index
+                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add indexes using 'add_index ... algorithm: :concurrently'
+              end
+            end
+          end
+      RUBY
+    end
+  end
+
+  context 'when index is declared as a hash value option' do
+    it 'it registers an offence' do
+      expect_offense(<<-RUBY)
+        class SomeTableMigrations < ActiveRecord::Migration
+            def change
+              add_column :table, :some_column_1, :integer, index: true
+              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add indexes using 'add_index ... algorithm: :concurrently'
+              add_column :table, :other_column, :string
+              add_column :table, :doneit_at, :datetime
+              add_index  :table,
+                         :other_column,
+                         unique: true
+
+              create_table :examples do |t|
+                t.references :category, index: true
+                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add indexes using 'add_index ... algorithm: :concurrently'
+                t.integer :number_of_participantsr, index: true
+                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add indexes using 'add_index ... algorithm: :concurrently'
+              end
+            end
+          end
+      RUBY
+    end
+  end
+
+  context 'when it is not a migration' do
+    it 'does not register an offence' do
+      expect_no_offenses(<<-RUBY)
+        class SomeTableMigrations
+            def change
+              add_column :table, :some_column_1, :integer, index: true
+              add_column :table, :other_column, :string, :index
+              add_column :table, :doneit_at, :datetime
+              add_index  :table,
+                         :other_column,
+                         unique: true
+            end
+          end
+      RUBY
+    end
+  end
+
+  context 'when disable_ddl_transaction! is sepcified' do
+    it 'does not register an offence' do
+      expect_no_offenses(<<-RUBY)
+        class SomeTableMigrations < ActiveRecord::Migration
+          disable_ddl_transaction!
+          def change
+            add_column :table, :some_column_1, :integer
+            add_column :table, :other_column, :string
+            add_column :table, :doneit_at, :datetime
+          end
+          end
+      RUBY
+    end
+  end
+end

data/lib/postgres-migration-cops.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+# cops
+require_relative './cops/add_indexes_concurrently'
+require_relative './cops/use_add_index'

data/postgres-migration-cops.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# require 'postgres/migration/cops/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'postgres-migration-cops'
+  spec.version       = '1.0.0' # Postgres::Migration::Cops::VERSION
+  spec.authors       = ['G Batterbee']
+  spec.email         = ['gbatterbee1@gmail.com']
+
+  spec.summary       = 'Write a short summary, because RubyGems requires one.'
+  spec.description   = 'Write a longer description or delete this line.'
+  # spec.homepage      = "Put your gem's website or public repo URL here."
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "Set to 'http://mygemserver.com'"
+
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/rubocop.yml

@@ -0,0 +1,2 @@
+require:  ./lib/cops/add-indexes-concurrently
+          ./lib/cops/require_disable_ddl_transaction

data/spec_helper.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'rubocop/rspec/support'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.include RuboCop::RSpec::ExpectOffense
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  # config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  # config.default_formatter = 'doc'
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: postgres-migration-cops
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- G Batterbee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Write a longer description or delete this line.
+email:
+- gbatterbee1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples.txt
+- lib/cops/add_indexes_concurrently.rb
+- lib/cops/add_indexes_concurrently_spec.rb
+- lib/cops/use_add_index.rb
+- lib/cops/use_add_index_spec.rb
+- lib/postgres-migration-cops.rb
+- postgres-migration-cops.gemspec
+- rubocop.yml
+- spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []