rubocop-migration 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85aebed56d23b5b864f2be24cff92db854c04214
+  data.tar.gz: e1d42ca0ebfea2ee641820dcaaca204d2506b0ae
+SHA512:
+  metadata.gz: 297517f1ec4b2395419075356cdc2219f10db378bf814fa143cdbfed01bfeec49e5ba168bb2d187695a428dd27e21a1a878d8de2fc06c50185a8752997c776f4
+  data.tar.gz: d4b33de1abaafb04c9e30ea2064c08ead9efc6b126ab6f013b1e9f3a1d770e83f7a7e69ecaa6f02e0ab61a98cb409ae464fe31b905b2de48e336b6d4e3a3cf99

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/vendor/rubocop
+*.gem

data/.rspec

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,38 @@
+# rubocop-migration [![CircleCI](https://circleci.com/gh/wealthsimple/rubocop-migration.svg?style=svg)](https://circleci.com/gh/wealthsimple/rubocop-migration)
+
+RuboCop extension to catch common pitfalls in ActiveRecord migrations.
+
+## Installation
+
+Add this line to your application's Gemfile and then execute `bundle`:
+
+```ruby
+group :development do
+  gem 'rubocop-migration'
+end
+```
+
+## Usage
+
+Configure RuboCop to load the extension in `.rubocop.yml`.
+
+```yaml
+require: rubocop-migration
+```
+
+## Development
+
+For running the spec files, this project depends on RuboCop's spec helpers. This means that in order to run the specs locally, you need a (shallow) clone of the RuboCop repository:
+
+```
+git clone --depth 1 git://github.com/bbatsov/rubocop.git vendor/rubocop
+```
+
+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).
+
+## TODO
+
+https://www.braintreepayments.com/blog/safe-operations-for-high-volume-postgresql/
+http://leopard.in.ua/2016/09/20/safe-and-unsafe-operations-postgresql

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocop-migration"
+
+# 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/circle.yml

@@ -0,0 +1,6 @@
+machine:
+  ruby:
+    version: 2.3.0
+dependencies:
+  pre:
+    - git clone --depth 1 git://github.com/bbatsov/rubocop.git vendor/rubocop

data/lib/rubocop-migration.rb

@@ -0,0 +1,11 @@
+require "active_support"
+require "active_support/core_ext"
+require "rubocop"
+
+require "rubocop/migration/version"
+require "rubocop/cop/migration/add_index_non_concurrently"
+
+module RuboCop
+  module Migration
+  end
+end

data/lib/rubocop/cop/migration/add_index_non_concurrently.rb

@@ -0,0 +1,66 @@
+module RuboCop
+  module Cop
+    module Migration
+      class AddIndexNonConcurrently < Cop
+        MSG = 'Use `algorithm: :concurrently` to avoid locking database.'.freeze
+
+        def_node_matcher :add_index_match, <<-PATTERN
+          (send nil :add_index _ _ (hash $...))
+        PATTERN
+
+        def_node_matcher :add_reference_match, <<-PATTERN
+          (send nil {:add_reference :add_belongs_to} _ _ (hash $...))
+        PATTERN
+
+        def_node_matcher :add_reference_index_options?, <<-PATTERN
+          (pair (sym :index) !({:nil false}))
+        PATTERN
+
+        def on_send(node)
+          if node.method_name == :add_index
+            check_add_index(node)
+          elsif [:add_reference, :add_belongs_to].include?(node.method_name)
+            check_add_reference(node)
+          end
+        end
+
+        private
+
+        def check_add_index(node)
+          pairs = add_index_match(node)
+          if !pairs_contains_algorithm_concurrently?(pairs)
+            add_offense(node, :expression, MSG)
+          end
+        end
+
+        def check_add_reference(node)
+          pairs = add_reference_match(node)
+          index_options = pairs&.find { |pair| add_reference_index_options?(pair) }&.value
+          return unless index_options
+
+          valid = true
+          if index_options.true_type?
+            # `index: true` is always invalid
+            valid = false
+          elsif index_options.hash_type?
+            # check for `algorithm: :concurrently`
+            valid = pairs_contains_algorithm_concurrently?(index_options.pairs)
+          end
+          add_offense(node, :expression, MSG) if !valid
+        end
+
+        def pairs_contains_algorithm_concurrently?(pairs)
+          return false unless pairs.is_a?(Array)
+          pairs.each do |pair|
+            next unless pair.pair_type?
+            key = pair.key
+            value = pair.value
+            next unless (key.sym_type? || key.str_type?) && key.children.first.to_s == "algorithm"
+            return true if value.children.first.to_s == "concurrently"
+          end
+          false
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/migration/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module Migration
+    VERSION = "0.1.0"
+  end
+end

data/rubocop-migration.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rubocop/migration/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-migration"
+  spec.version       = RuboCop::Migration::VERSION
+  spec.authors       = ["Peter Graham"]
+  spec.email         = ["peter@wealthsimple.com"]
+
+  spec.summary       = %q{RuboCop extension for ActiveRecord migrations.}
+  spec.description   = %q{RuboCop extension to catch common pitfalls in ActiveRecord migrations.}
+  spec.homepage      = "https://github.com/wealthsimple/rubocop-migration"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_dependency "activesupport", ">= 4"
+  spec.add_dependency "rubocop", ">= 0.48.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rspec-collection_matchers"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.2"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-migration
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Graham
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.48.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.48.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: rspec-collection_matchers
+  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: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: RuboCop extension to catch common pitfalls in ActiveRecord migrations.
+email:
+- peter@wealthsimple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/rubocop-migration.rb
+- lib/rubocop/cop/migration/add_index_non_concurrently.rb
+- lib/rubocop/migration/version.rb
+- rubocop-migration.gemspec
+- vendor/.gitkeep
+homepage: https://github.com/wealthsimple/rubocop-migration
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: RuboCop extension for ActiveRecord migrations.
+test_files: []