umts-custom-cops 0.1.0 → 0.2.0

checksums.yaml

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Metrics/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/umts-custom-cops/version.rb'
+
+Style/FileName:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,24 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-01-14 16:44:47 -0500 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 25
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 10

data/README.md

@@ -24,7 +24,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Instructions on adding custom cops.
+Add to your `rubocop.yml`:
+
+    $ require: umts-custom-cops
+
+Or on the command line:
+
+    $ rubocop --require=umts-custom-cops
+
+You may enable/disable them just as with any other cop.
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
 task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "custom/cops"
+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.
@@ -10,5 +10,5 @@ require "custom/cops"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/umts-custom-cops.rb

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

data/lib/umts-custom-cops/{be_for_singleton.rb → be_matcher_for_non_duplicable_types.rb}

@@ -1,8 +1,13 @@
 module RuboCop
   module Cop
     module UmtsCustomCops
-      class BeForSingleton < Cop
-        MSG = 'Prefer `be` matcher to `eq` or `eql` for singleton types.'
+      # Prefer the easier-to-read be matcher for non-duplicable types.
+      #
+      # See the specs for examples.
+
+      # rubocop:disable Metrics/AbcSize
+      class BeMatcherForNonDuplicableTypes < Cop
+        MSG = 'Prefer `be` matcher to `eq` or `eql` for non-duplicable types.'
 
         OFFENSE_TYPE_CHECKS = %i(true_type?
                                  false_type?
@@ -21,14 +26,11 @@ module RuboCop
           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
+          return unless OFFENSE_TYPE_CHECKS.find { |check| args.send check }
+          add_offense node, :expression, MSG
         end
       end
     end

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

@@ -3,32 +3,28 @@ require 'pry-byebug'
 module RuboCop
   module Cop
     module UmtsCustomCops
+      # See the specs for examples.
       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)
 
-
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
         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
+          else return unless BOOLEAN_EQUALITY_MATCHERS.include? matcher.method_name
           end
-
-
           add_offense node, :expression, MSG
         end
       end

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

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

data/umts-custom-cops.gemspec

@@ -4,34 +4,33 @@ $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.name          = 'umts-custom-cops'
   spec.version       = UmtsCustomCops::VERSION
-  spec.authors       = ["UMass Transit Services"]
-  spec.email         = ["transit-it@admin.umass.edu"]
+  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"
+  spec.summary       = '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."
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else fail '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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rspec", "~> 3.0"
+  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 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'pry-byebug'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: umts-custom-cops
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - UMass Transit Services
@@ -104,6 +104,8 @@ files:
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
@@ -113,7 +115,7 @@ files:
 - bin/console
 - bin/setup
 - lib/umts-custom-cops.rb
-- lib/umts-custom-cops/be_for_singleton.rb
+- lib/umts-custom-cops/be_matcher_for_non_duplicable_types.rb
 - lib/umts-custom-cops/predicate_method_matcher.rb
 - lib/umts-custom-cops/version.rb
 - umts-custom-cops.gemspec