umts-custom-cops 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1df012c79bb3fa27472fe1cb80e133488b056119
-  data.tar.gz: c85c7c9e7797b13e72e8dd978eab30e3bf6a507b
+SHA256:
+  metadata.gz: 3fd3babbd34390821e6966e35cc99538218c43bceb35b5dc4dc888711d811d38
+  data.tar.gz: 439c6e906a47df2bacb02ac0f4023c96409ffa0534feb8da3e23a588ad54a678
 SHA512:
-  metadata.gz: d834ed868ac58e710d1f8d0873f3ee9c76bb3eca0b1ae43efb7d23562c9339484973dc8d7f847ac189c988805a3137fb0099c3b98de3dd7cdd54b30ac096f958
-  data.tar.gz: 0a030250913339bead54f12d73b28dc68d8178edb0cd4441d2d3d8f91942784f745cc2ad7fc8153ba94ec0789bbfecdefb3a045ecda4febda7be1b08008bba5c
+  metadata.gz: 6924bc7f455be47fe691f52418bce0550b2de075e4b8c95e6b0a2090b8d214db36f9923a4d47240f935111bb01869f6f37ebd61016163421a0fb02ed272afa51
+  data.tar.gz: c91ae1f325772c354ab34c9fcea65b13705265e62f38444824bc5156843fe01ad9056f0fb5db0655e23ec57eae760ec6433065a98dbe5750d5b5355b7c6dc1d0

data/.rubocop.yml

@@ -1,10 +1,19 @@
-Metrics/LineLength:
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
   Max: 100
 
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'lib/umts-custom-cops/version.rb'
 
-Style/FileName:
+Naming/FileName:
   Enabled: false

data/.travis.yml

@@ -1,8 +1,24 @@
 language: ruby
-rvm: 2.1.2
-before_install: gem install bundler -v 1.11.2
-script: bundle exec rake
+rvm:
+  - 2.5.8
+  - 2.6.5
+  - 2.7.2
+  - 3.0.0
+env: CODECLIMATE_REPO_TOKEN=c356c22cc5b342d3cba9a1fb9d71b63b52de9b9daa1f54c07f959f90da05c8ff
+before_install:
+  - gem update --system
+  - gem install bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 notifications:
   email:
+    on_success: change
+    on_failure: change
     recipients:
       - transit-it@admin.umass.edu

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in custom-cops.gemspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 David Faulkenberry
+Copyright (c) 2020 UMass Transit Services
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,10 +1,15 @@
 # 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.
 
-Custom Rubocops, currently all related to RSpec, used for UMass Transit's internal Rails development purposes.
+A lot of the ideas for this came from some reading of the rubocop source
+code, so thanks to the RuboCop team for making it public.
 
-Primary contributor is @dfaulken.
+[![Build Status][travis-badge]][travis]
+[![Test Coverage][coverage-badge]][codeclimate]
+[![Code Climate][gpa-badge]][codeclimate]
+[![Issue Count][issue-badge]][codeclimate]
 
 ## Installation
 
@@ -26,7 +31,9 @@ Or install it yourself as:
 
 Add to your `rubocop.yml`:
 
-    $ require: umts-custom-cops
+```xml
+require: umts-custom-cops
+```
 
 Or on the command line:
 
@@ -36,18 +43,29 @@ You may enable/disable them just as with any other cop.
 
 ## 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).
+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 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
+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/umts/custom-cops.
+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).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+
+[travis]: https://travis-ci.org/umts/custom-cops
+[codeclimate]: https://codeclimate.com/github/umts/custom-cops/coverage
+[travis-badge]: https://travis-ci.org/umts/custom-cops.svg?branch=master
+[coverage-badge]: https://codeclimate.com/github/umts/custom-cops/badges/coverage.svg
+[gpa-badge]: https://codeclimate.com/github/umts/custom-cops/badges/gpa.svg
+[issue-badge]: https://codeclimate.com/github/umts/custom-cops/badges/issue_count.svg

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

data/bin/console

@@ -1,14 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
-require 'custom/cops'
+require 'umts-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
+require 'pry'
+Pry.start

data/bin/setup

@@ -3,6 +3,5 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
+gem install bundler -v "$(cat .bundler.version)"
 bundle install
-
-# Do any other automated setup that you need to do here

data/lib/umts-custom-cops.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'umts-custom-cops/version'
 
 require 'umts-custom-cops/be_matcher_for_non_duplicable_types'

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

@@ -1,19 +1,25 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
 module RuboCop
   module Cop
     module UmtsCustomCops
       # 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?
-                                 nil_type?
-                                 int_type?
-                                 float_type?)
+        def_node_matcher :eq_on_non_duplicable_type?, <<-PATTERN
+          (send
+            _expectation {:to :not_to}
+            (send
+              _context {:eq :eql}
+              {true false nil}
+            )
+          )
+        PATTERN
 
         def autocorrect(node)
           lambda do |corrector|
@@ -23,14 +29,9 @@ module RuboCop
         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
-          return unless OFFENSE_TYPE_CHECKS.find { |check| args.send check }
-          add_offense node, :expression, MSG
+          return unless eq_on_non_duplicable_type? node
+
+          add_offense node, location: :expression, message: MSG
         end
       end
     end

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

@@ -1,31 +1,43 @@
-require 'pry-byebug'
+# frozen_string_literal: true
+
+require 'rubocop'
 
 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.'
+        MESSAGE =
+          'Prefer predicate matcher over checking the return value of a predicate method.'
+
+        def_node_matcher :generic_equality_expectation, <<-PATTERN
+        (send
+          (send _context :expect
+            (send ... $_expectation)
+          ) {:to :not_to}
+          (send _context {:be :eq :eql :equal}
+            {true false}
+          )
+        )
+        PATTERN
 
-        BOOLEAN_EQUALITY_MATCHERS = %i(be_true be_false)
-        GENERIC_EQUALITY_MATCHERS = %i(be eq eql equal)
+        def_node_matcher :boolean_equality_expectation, <<-PATTERN
+        (send
+          (send _context :expect
+            (send ... $_expectation)
+          ) {:to :not_to}
+          (send _context {:be_true :be_false})
+        )
+        PATTERN
 
-        # 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
+          ends_with_question_mark = ->(method) { method.to_s.end_with? '?' }
+
+          if generic_equality_expectation(node, &ends_with_question_mark) ||
+             boolean_equality_expectation(node, &ends_with_question_mark)
+
+            add_offense node, location: :expression, message: MESSAGE
           end
-          add_offense node, :expression, MSG
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module UmtsCustomCops
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

data/umts-custom-cops.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'umts-custom-cops/version'
 
@@ -16,21 +17,22 @@ Gem::Specification.new do |spec|
 
   # 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 fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-  end
+  raise <<~MSG unless spec.respond_to?(:metadata)
+    RubyGems 2.0 or newer is required to protect against public gem pushes.
+  MSG
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   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.required_ruby_version = '>= 2.5.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'simplecov'
+  spec.add_dependency 'rubocop', '~> 1.10'
+
+  spec.add_development_dependency 'bundler', '~> 2.1', '>= 2.1.4'
   spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,87 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: umts-custom-cops
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - UMass Transit Services
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
-  type: :runtime
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -105,8 +111,6 @@ files:
 - ".gitmodules"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -132,15 +136,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Custom Rails-specific Rubocop cops for our internal development purposes

data/.rubocop_todo.yml

@@ -1,24 +0,0 @@
-# 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/.ruby-version

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