umts-custom-cops 0.2.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b3f10c56d08bacec50c43fa2244120f3247896b0
-  data.tar.gz: 81465aa93b24c577a4f10c359fc7af483b1dbf29
+SHA256:
+  metadata.gz: 36171c1c65fdaa89d9f51ac853054bdfb1b70fba4c7cc45703558601e6cb15fa
+  data.tar.gz: 242a501b29292aa62c2f9164d318de11366585d59ed7f219e27dbb882c5a2726
 SHA512:
-  metadata.gz: c5c6fbaf56ab748a55412364234c5d92aab4a6cf4cecee45028b247f42f30b889f3b2d38775cf5fb56cc4d39b1e807befdbf25b04307c9ddc11cb53a1e62152e
-  data.tar.gz: 741e057de97f12880eaebedead827efcfb986e61b88d3c92201bc214feddabc38dbdd24ddef2bbd8d73e7a60b276b5b1a30b367700956976b77d6f73c1fd0b98
+  metadata.gz: 9beee0751e12708e8b8929304525859a083cf730efbab77a709c7af054403156c5a920b8d9d80536670d338470438f896fe752a6fc03097bcb32f0f0febd9ed9
+  data.tar.gz: e1cdd4323024aa66c17ce2c0d0bce44dfdcc4165cd3a4d7e66f7ea713dd18809522ac6b94a5459fa919a60d759b231868623c297cda530aa98b5d7f059c8b961

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,12 +1,24 @@
 language: ruby
 rvm:
-  - 2.1.7
-  - 2.2.4
-  - 2.3.0
+  - 2.5.8
+  - 2.6.5
+  - 2.7.2
+  - 3.0.0
 env: CODECLIMATE_REPO_TOKEN=c356c22cc5b342d3cba9a1fb9d71b63b52de9b9daa1f54c07f959f90da05c8ff
-before_install: gem install bundler
-script: bundle exec rake
+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,60 +1,37 @@
 # UmtsCustomCops
 
-Custom Rubocops, currently all related to RSpec, used for UMass Transit's internal Rails development purposes.
+**This gem is no longer under development.** All of the cops contained in this
+gem are also available in the [rubocop-rspec][rr] gem.
 
-Primary contributor is @dfaulken.
+## Migrating to rubocop-rspec
 
-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.
+* Remove `gem 'umts-custom-cops'` from your Gemfile
+* Add `gem 'rubocop-rspec'` to your Gemfile
+* Remove `require: umts-custom-cops` from your `.rubocop.yml` file
+* Add `require: rubocop-rspec` to your `.rubocop.yml` file
 
-[![Build Status](https://travis-ci.org/umts/custom-cops.svg?branch=master)](https://travis-ci.org/umts/custom-cops)
-[![Test Coverage](https://codeclimate.com/github/umts/custom-cops/badges/coverage.svg)](https://codeclimate.com/github/umts/custom-cops/coverage)
-[![Code Climate](https://codeclimate.com/github/umts/custom-cops/badges/gpa.svg)](https://codeclimate.com/github/umts/custom-cops)
-[![Issue Count](https://codeclimate.com/github/umts/custom-cops/badges/issue_count.svg)](https://codeclimate.com/github/umts/custom-cops)
+If you _only_ want a version of the two cops provided by this gem, you can
+add the following to your `.rubocop.yml` file:
 
-## Installation
+```yml
+RSpec:
+  Enabled: false
 
-Add this line to your application's Gemfile:
+RSpec/BeEql:
+  Enabled: true
 
-```ruby
-gem 'umts-custom-cops'
+RSpec/PredicateMatcher:
+  Enabled: true
 ```
 
-And then execute:
+Also, if you have a custom `.yml` file to get this gem to work under
+CodeClimate, you will not need to do that with `rubocop-rspec`. It is included
+in the CodeClimate engine.
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install umts-custom-cops
-
-## Usage
-
-Add to your `rubocop.yml`:
-
-```xml
-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
-
-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).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+
+[rr]: https://github.com/rubocop/rubocop-rspec

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,4 +1,8 @@
+# frozen_string_literal: true
+
 require 'umts-custom-cops/version'
 
 require 'umts-custom-cops/be_matcher_for_non_duplicable_types'
 require 'umts-custom-cops/predicate_method_matcher'
+
+warn "'umts-custom-cops' is deprecated. Use 'rubocop-rspec' instead"

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

@@ -1,18 +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?)
+        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|
@@ -22,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.1'
+  VERSION = '1.0.1'
 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'
 
@@ -14,24 +15,34 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/umts/custom-cops'
   spec.license       = 'MIT'
 
+  spec.post_install_message = <<~PIM
+    umts-custom-cops is no longer under development, and all functionality
+    provided by this gem can also be found in the `rubocop-rspec` gem. See
+    the README file:
+
+    https://github.com/umts/custom-cops/blob/master/README.md
+
+    for migration instructions.
+  PIM
+
   # 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.37.2'
+  spec.required_ruby_version = '>= 2.5.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'codeclimate-test-reporter'
-  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,59 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: umts-custom-cops
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.1
 platform: ruby
 authors:
 - UMass Transit Services
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-02-19 00:00:00.000000000 Z
+date: 2021-04-16 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'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.37.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        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: '1.11'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -72,30 +64,30 @@ dependencies:
     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:
     - - ">="
@@ -136,7 +128,14 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message: |
+  umts-custom-cops is no longer under development, and all functionality
+  provided by this gem can also be found in the `rubocop-rspec` gem. See
+  the README file:
+
+  https://github.com/umts/custom-cops/blob/master/README.md
+
+  for migration instructions.
 rdoc_options: []
 require_paths:
 - lib
@@ -144,15 +143,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.2.2
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Custom Rails-specific Rubocop cops for our internal development purposes