umts-custom-cops 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4430301fe3d124d7942336cc0ddf0b9d18a7b9a
+  data.tar.gz: 1b65dfa2a42003c2eaeaefdadeb5a6f013552961
+SHA512:
+  metadata.gz: 12647f91b2e596676b933cb1780803bd05d766902eab3f07b8a6ecfdc6f4e9e92909e2dbe37ec4bdb1ed1df8f5bb9b0cc7d5cdf4309196f97ad73cd7c97d4024
+  data.tar.gz: 65487853b78ccc60061dee5774ecf61f7c27eac7b11f5849c4efe513a918636d586a7c1d8400bd302fe8790ce888386235f95c40f25509965ae706f7131f82ab

data/.gitignore

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

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/rubocop"]
+	path = vendor/rubocop
+	url = https://github.com/bbatsov/rubocop.git

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.1.7

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm: 2.1.2
+before_install: gem install bundler -v 1.11.2
+script: bundle exec rake
+notifications:
+  email:
+    recipients:
+      - transit-it@admin.umass.edu

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David Faulkenberry
+
+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,45 @@
+# UmtsCustomCops
+
+[![Build Status](https://travis-ci.org/umts/custom-cops.svg?branch=master)](https://travis-ci.org/umts/custom-cops)
+
+Custom Rubocops, currently all related to RSpec, used for UMass Transit's internal Rails development purposes.
+
+Primary contributor is @dfaulken.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'umts-custom-cops'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install umts-custom-cops
+
+## Usage
+
+TODO: Instructions on adding custom cops.
+
+## 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).
+
+To run the spec files, you'll need Rubocop's spec support methods. In order to achieve this, set up RuboCop as a git submodule:
+
+    $ git submodule add -f https://github.com/bbatsov/rubocop
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/umts/custom-cops.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "custom/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

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/umts-custom-cops/be_for_singleton.rb

@@ -0,0 +1,36 @@
+module RuboCop
+  module Cop
+    module UmtsCustomCops
+      class BeForSingleton < Cop
+        MSG = 'Prefer `be` matcher to `eq` or `eql` for singleton types.'
+
+        OFFENSE_TYPE_CHECKS = %i(true_type?
+                                 false_type?
+                                 nil_type?
+                                 int_type?
+                                 float_type?)
+
+        def autocorrect(node)
+          lambda do |corrector|
+            matcher = node.child_nodes[1]
+            corrector.replace matcher.loc.selector, 'be'
+          end
+        end
+
+        def on_send(node)
+          return unless %i(to not_to).include? node.method_name
+          return unless node.child_nodes &&
+                        node.child_nodes.first.method_name == :expect
+
+          matcher = node.child_nodes[1]
+          return unless %i(eq eql).include? matcher.method_name
+
+          args = matcher.child_nodes.first
+          if OFFENSE_TYPE_CHECKS.find { |check| args.send check }
+            add_offense node, :expression, MSG
+          end
+        end
+      end
+    end
+  end
+end

data/lib/umts-custom-cops/predicate_method_matcher.rb

@@ -0,0 +1,37 @@
+require 'pry-byebug'
+
+module RuboCop
+  module Cop
+    module UmtsCustomCops
+      class PredicateMethodMatcher < Cop
+        MSG = 'Prefer predicate matcher over checking the return value of a predicate method.'
+
+        BOOLEAN_EQUALITY_MATCHERS = %i(be_true be_false)
+        GENERIC_EQUALITY_MATCHERS = %i(be eq eql equal)
+
+
+        def on_send(node)
+          return unless %i(to not_to).include? node.method_name
+
+          return unless node.child_nodes
+          expectation = node.child_nodes.first
+          return unless expectation.method_name == :expect
+
+          match_value = expectation.child_nodes.first
+          return unless match_value.method_name.to_s.end_with? '?'
+
+          matcher = node.child_nodes[1]
+          if GENERIC_EQUALITY_MATCHERS.include? matcher.method_name
+            matcher_arg = matcher.child_nodes.first
+            return unless matcher_arg.true_type? || matcher_arg.false_type?
+          else
+            return unless BOOLEAN_EQUALITY_MATCHERS.include? matcher.method_name
+          end
+
+
+          add_offense node, :expression, MSG
+        end
+      end
+    end
+  end
+end

data/lib/umts-custom-cops/version.rb

@@ -0,0 +1,3 @@
+module UmtsCustomCops
+  VERSION = "0.1.0"
+end

data/lib/umts-custom-cops.rb

@@ -0,0 +1,4 @@
+require 'umts-custom-cops/version'
+
+require 'umts-custom-cops/be_for_singleton'
+require 'umts-custom-cops/predicate_method_matcher'

data/umts-custom-cops.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'umts-custom-cops/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "umts-custom-cops"
+  spec.version       = UmtsCustomCops::VERSION
+  spec.authors       = ["UMass Transit Services"]
+  spec.email         = ["transit-it@admin.umass.edu"]
+
+  spec.summary       = %q{Custom Rails-specific Rubocop cops
+                          for our internal development purposes}
+  spec.homepage      = "https://github.com/umts/custom-cops"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'rubocop', '0.35.1'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'pry-byebug'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: umts-custom-cops
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- UMass Transit Services
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+- !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: simplecov
+  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: 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'
+description: 
+email:
+- transit-it@admin.umass.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/umts-custom-cops.rb
+- lib/umts-custom-cops/be_for_singleton.rb
+- lib/umts-custom-cops/predicate_method_matcher.rb
+- lib/umts-custom-cops/version.rb
+- umts-custom-cops.gemspec
+homepage: https://github.com/umts/custom-cops
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: Custom Rails-specific Rubocop cops for our internal development purposes
+test_files: []