rubocop-migrations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d3ac1850fba3f2b655f9a83fa59a2b6829f8784
+  data.tar.gz: 27977387b8ae9ad1ff2935097064ea2185e89053
+SHA512:
+  metadata.gz: 5339bb07962042774e073b4221941d0ca7e0dbb0bd7251d95ce78a6ff07c472b5b80bc78b13b1e206f786bc100df800362a9d13e552c77031b87130d1db71e0c
+  data.tar.gz: 64567f026d05c20083c86b0efaa26a33f52b3cf3b1f8c46d17538ce960de73d6f89ebb322c7f83527f0c64c5e017aae09ab58365c153fbe86e781ca534e52be7

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 enricostano
+
+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,68 @@
+# RuboCop Migrations
+
+Rails migrations analysis as a extension of [RuboCop](https://github.com/bbatsov/rubocop). Heavily inspired by [`rubocop-cask`](https://github.com/caskroom/rubocop-cask) which in turn is inspired by [`rubocop-rspec`](https://github.com/nevir/rubocop-rspec).
+
+## Installation
+
+Just install the `rubocop-migrations` gem
+
+```bash
+gem install rubocop-migrations
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```ruby
+gem 'rubocop-migrations'
+```
+
+
+## Usage
+
+You need to tell RuboCop to load the Migrations extension. There are three ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`:
+
+```yaml
+require: rubocop/migrations
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Migrations cops together with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop/migrations
+```
+
+## The Cop
+
+All cops are located under [`lib/rubocop/cop/migrations`](lib/rubocop/cop/migrations), and contain examples/documentation.
+
+In your `.rubocop.yml`, you may treat the Cask cops just like any other cop. For example:
+
+```yaml
+Migrations/RemoveIndex:
+  Enabled: false
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+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:
+
+```bash
+git submodule update --init --depth 1 vendor/rubocop
+```
+
+## License
+
+`rubocop-migrations` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
+the full text.

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/migrations"
+
+# 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

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/lib/rubocop/cop/migrations/remove_index.rb

@@ -0,0 +1,30 @@
+module RuboCop
+  module Cop
+    module Migrations
+      # Removing indexes is dangerous by nature, if the index you remove
+      # is used extensively, you could end up with database degradation.
+      #
+      # This disallow the use of remove_index at all. It is only allowed
+      # inside a down method definition. If you actually know what you are doing
+      # (usually when the index is not being used) you should explicitly disable
+      # the check by adding a ``rubocop:disable Migrations/RemoveIndex`` comment
+      # in the offending line
+      class RemoveIndex < Cop
+        MSG = 'remove_index is disallowed'.freeze
+
+        def_node_matcher :remove_index_found, '(:send _ :remove_index ...)'
+
+        def on_send(node)
+          remove_index_found(node) do
+            node.each_ancestor do |a|
+              next unless a.def_type?
+              if a.to_s =~ /def :up/ || a.to_s =~ /def :change/
+                add_offense(node, :selector, MSG)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/migrations.rb

@@ -0,0 +1,4 @@
+require 'rubocop'
+
+# cops
+require 'rubocop/cop/migrations/remove_index'

data/lib/rubocop/migrations/version.rb

@@ -0,0 +1,5 @@
+module Rubocop
+  module Migrations
+    VERSION = "0.1.0"
+  end
+end

data/rubocop-migrations.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop/migrations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-migrations'
+  spec.version       = Rubocop::Migrations::VERSION
+
+  spec.authors       = %w(enricostano magec)
+  spec.email         = %w(ocirne.onats@gmail.com joseferper@gmail.com)
+
+  spec.summary       = 'Rails migrations rubocop checks'
+  spec.description   = 'Performs some checks for migration sanity'
+  spec.homepage      = 'https://github.com/redbooth/rubocop-migrations'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } # rubocop:disable Metrics/LineLength
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rubocop', '>= 0.42.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '3.5.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-migrations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- enricostano
+- magec
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: Performs some checks for migration sanity
+email:
+- ocirne.onats@gmail.com
+- joseferper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rubocop/cop/migrations/remove_index.rb
+- lib/rubocop/migrations.rb
+- lib/rubocop/migrations/version.rb
+- rubocop-migrations.gemspec
+homepage: https://github.com/redbooth/rubocop-migrations
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Rails migrations rubocop checks
+test_files: []