salsify_rubocop 0.91.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7075a3184d398f5ed45dc726da7a289323eb1839dd7ecb78fe614b242b6798f
-  data.tar.gz: 70c2dfb69a48fa75e58a218e8cea848fc477dfbfd22fc50adefbac86589132f3
+  metadata.gz: ec6518eab32e91fe9d55cddeeebe45b6c894646f416489b35d124c68ca9d45b6
+  data.tar.gz: 29aae33cb64d4c8505bcc2d5bdc99bc316d82bdb6ecb0963f06993d3f856ef38
 SHA512:
-  metadata.gz: ddcd5e8975a9d35a5b5efe66e5e90d1ca4645aebca2d6b70e8084c6dda8fac05b36c27f557aebdc45fabe6458215a6bab4c06dc4acd8935a02017dc22a2131cb
-  data.tar.gz: 33e382909c34f89e5ba8f14ea1a03bb443df82fad6d2e80905d1faf7ef8950692a85e768dfa2a8bcc8bc7ef7ceac21e500c00675939ff481a5ed31dc8751f158
+  metadata.gz: aa3992654fbaa71f4cfbdab64203590153483e9a5a57718f72f64022ba65d7cea95bcb71665cfa229dd4f6283d883a20551e27139ce3fabaaaf1d19599ba69e3
+  data.tar.gz: 95aa6ec7078f655bae79f0b6a53bd0037888d2fcf20465dbad819e4ed9c9749a840dadc2b54af78857da67ffb0a390ca8b8d36f670abfdac285e227bfa45de24

data/.circleci/config.yml

@@ -0,0 +1,71 @@
+version: 2.1
+jobs:
+  lint:
+    docker:
+      - image: salsify/ruby_ci:2.6.6
+    working_directory: ~/salsify_rubocop
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-gems-ruby-2.6.6-{{ checksum "salsify_rubocop.gemspec" }}-{{ checksum "Gemfile" }}
+            - v1-gems-ruby-2.6.6-
+      - run:
+          name: Install Gems
+          command: |
+            if ! bundle check --path=vendor/bundle; then
+              bundle install --path=vendor/bundle --jobs=4 --retry=3
+              bundle clean
+            fi
+      - save_cache:
+          key: v1-gems-ruby-2.6.6-{{ checksum "salsify_rubocop.gemspec" }}-{{ checksum "Gemfile" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop --config .rubocop.yml
+  test:
+    parameters:
+      ruby_version:
+        type: string
+    docker:
+      - image: salsify/ruby_ci:<< parameters.ruby_version >>
+    environment:
+      CIRCLE_TEST_REPORTS: "test-results"
+    working_directory: ~/salsify_rubocop
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-gems-ruby-<< parameters.ruby_version >>-{{ checksum "salsify_rubocop.gemspec" }}-{{ checksum "Gemfile" }}
+            - v1-gems-ruby-<< parameters.ruby_version >>-
+      - run:
+          name: Install Gems
+          command: |
+            if ! bundle check --path=vendor/bundle; then
+              bundle install --path=vendor/bundle --jobs=4 --retry=3
+              bundle clean
+            fi
+      - save_cache:
+          key: v1-gems-ruby-<< parameters.ruby_version >>-{{ checksum "salsify_rubocop.gemspec" }}-{{ checksum "Gemfile" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Tests
+          command: |
+            bundle exec rspec --format RspecJunitFormatter --out $CIRCLE_TEST_REPORTS/rspec/junit.xml --format progress spec
+      - store_test_results:
+          path: "test-results"
+workflows:
+  build:
+    jobs:
+      - lint
+      - test:
+          matrix:
+            parameters:
+              ruby_version:
+                - "2.6.6"
+                - "2.7.2"
+                - "3.0.0"

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_from:
   - conf/rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6
 
 Layout/LineLength:
   Exclude:

data/CHANGELOG.md

@@ -1,7 +1,26 @@
 # salsify_rubocop
 
-## 0.91.0
+## 1.1.0
+- Re-enable version specifier checks for the `Bundler/GemComment` cop, for limiting version specifiers only.
+- Upgrade to `rubocop` v1.13.0
+- Drop support for Ruby 2.5 now that's in EOL
+
+## 1.0.2
+- Disable version specifier checks for the `Bundler/GemComment` cop until https://github.com/rubocop/rubocop/pull/9358
+  is merged.
+
+## 1.0.1
+- Configure file exclusions for `Rails/RakeEnvironment` and `Gemspec/RequiredRubyVersion`
 
+## 1.0.0
+- Upgrade to `rubocop` v1.0.0
+- Upgrade to `rubocop-rspec` v2.0.0
+
+## 0.93.1
+- Upgrade to `rubocop` v0.93.1
+- Add configuration for pending 1.0 cops
+
+## 0.91.0
 - Upgrade to `rubocop` v0.91.0
 
 ## 0.85.0

data/README.md

@@ -93,6 +93,30 @@ This gem also includes a dependency on `rubocop-rspec` that will be updated to
 the latest compatible version each time that the MAJOR.MINOR version of `rubocop` 
 is updated.
 
+## Change Process
+
+This configuration is meant to represent the general opinion of Salsify's Ruby community around best practices for
+writing readable Ruby code. As a result, changes to this configuration should go through a discussion phase in the
+#rubocop-changes Slack channel to ensure the broader Salsify Ruby community is on board with the change. Non-Salsify
+developers should file an issue via GitHub with proposed changes.
+
+When enabling a cop we try to keep the following points in mind to avoid overburdening consumers:
+
+* Does the cop support safe auto-correction? If not, do we expect a large number of offenses needing manual remediation?
+* Does the cop help avoid bugs or is it merely stylistic?
+* For stylistic cops, does the enforced style reflect that of Salsify developers?
+
+### Updating RuboCop
+
+Updating to a new minor version of `rubocop` may add new "pending" cops which are not enabled until the next major
+version (see: [RuboCop Versioning](https://docs.rubocop.org/rubocop/versioning.html)). However, we may wish to eagerly
+enable or explicitly disable newly introduced cops. Any such decisions around "pending" cops should go through the
+change process described above.
+
+When updating to a new major version or updating other dependencies that don't follow the same versioning pattern, we
+should check if there are any newly enabled cops included in the update. Any new cops should go through a review process
+in #rubocop-changes to ensure we truly want to enable the 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. Run `bundle exec salsify_rubocop` to use the gem in this directory, ignoring other installed copies of this gem.

data/conf/rubocop.yml

@@ -37,3 +37,6 @@ RSpec/NestedGroups:
 
 RSpec/ContextWording:
   Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false

data/conf/rubocop_rails.yml

@@ -15,6 +15,10 @@ Rails/TimeZone:
   Exclude:
     - 'spec/**/*'
 
+Rails/RakeEnvironment:
+  Exclude:
+    - lib/tasks/auto_annotate_models.rake
+
 Rails/UniqBeforePluck:
   EnforcedStyle: aggressive
 

data/conf/rubocop_without_rspec.yml

@@ -1,4 +1,9 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
+
 AllCops:
+  NewCops: disable
   DisplayCopNames: true
   Exclude:
     - 'bin/**/*'
@@ -12,12 +17,16 @@ AllCops:
 Bundler/GemComment:
   Enabled: true
   OnlyFor:
-    - 'version_specifiers'
+    - 'restrictive_version_specificiers'
     - 'source'
     - 'git'
     - 'github'
     - 'gist'
 
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - schemas_gem/*_schemas.gemspec
+
 # This cop has poor handling for the common case of a lambda arg in a DSL
 Lint/AmbiguousBlockAssociation:
   Enabled: false
@@ -196,3 +205,33 @@ Style/WordArray:
 
 Style/SymbolArray:
   EnforcedStyle: brackets
+
+Lint/HashCompareByIdentity:
+  Enabled: false
+
+Lint/IdentityComparison:
+  Enabled: false
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: false
+
+Style/CombinableLoops:
+  Enabled: false
+
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/RedundantSelfAssignment:
+  Enabled: false
+
+Style/SingleArgumentDig:
+  Enabled: false

data/lib/rubocop/cop/salsify/rspec_doc_string.rb

@@ -19,7 +19,8 @@ module RuboCop
       #   it 'does something' do
       #     ...
       #   end
-      class RspecDocString < Cop
+      class RspecDocString < RuboCop::Cop::RSpec::Base
+        extend RuboCop::Cop::AutoCorrector
         include ConfigurableEnforcedStyle
 
         SINGLE_QUOTE_MSG =
@@ -27,36 +28,37 @@ module RuboCop
         DOUBLE_QUOTE_MSG =
           'Example Group/Example doc strings must be double-quoted.'
 
-        SHARED_EXAMPLES = RuboCop::RSpec::Language::SelectorSet.new(
-          [:include_examples, :it_behaves_like, :it_should_behave_like, :include_context]
-        ).freeze
 
-        DOCUMENTED_METHODS = (RuboCop::RSpec::Language::ExampleGroups::ALL +
-          RuboCop::RSpec::Language::Examples::ALL +
-          RuboCop::RSpec::Language::SharedGroups::ALL +
-          SHARED_EXAMPLES).freeze
+        DOCUMENTED_METHODS = RuboCop::ConfigLoader.default_configuration.for_department('RSpec')
+                               .fetch('Language')
+                               .values_at('ExampleGroups', 'Examples', 'SharedGroups', 'Includes')
+                               .flat_map { |element| element.values.flatten }
+                               .map(&:to_sym)
+
+        def_node_matcher :documented_method?,
+                         send_pattern(<<~PATTERN)
+                           {
+                             #ExampleGroups.all
+                             #Examples.all
+                             #SharedGroups.all
+                             #Includes.all
+                           }
+                         PATTERN
 
         def on_send(node)
-          _receiver, method_name, *args = *node
-          return unless DOCUMENTED_METHODS.include?(method_name) &&
-            !args.empty? && args.first.str_type?
+          _receiver, _method_name, *args = *node
+          return unless documented_method?(node) && args.first&.str_type?
 
           check_quotes(args.first)
         end
 
-        def autocorrect(node)
-          StringLiteralCorrector.correct(node, style)
-        end
-
         private
 
         def check_quotes(doc_node)
-          if wrong_quotes?(doc_node)
-            if style == :single_quotes
-              add_offense(doc_node, message: SINGLE_QUOTE_MSG)
-            else
-              add_offense(doc_node, message: DOUBLE_QUOTE_MSG)
-            end
+          return unless wrong_quotes?(doc_node)
+
+          add_offense(doc_node, message: style == :single_quotes ? SINGLE_QUOTE_MSG : DOUBLE_QUOTE_MSG) do |corrector|
+            StringLiteralCorrector.correct(corrector, doc_node, style)
           end
         end
 

data/lib/rubocop/cop/salsify/rspec_dot_not_self_dot.rb

@@ -17,26 +17,25 @@ module RuboCop
       #   describe "self.does_stuff" do
       #     ...
       #   end
-      class RspecDotNotSelfDot < Cop
+      class RspecDotNotSelfDot < RuboCop::Cop::RSpec::Base
+        extend RuboCop::Cop::AutoCorrector
 
         SELF_DOT_REGEXP = /["']self\./.freeze
         MSG = 'Use ".<class method>" instead of "self.<class method>" for example group description.'
 
         def_node_matcher :example_group_match, <<-PATTERN
-          (send _ #{RuboCop::RSpec::Language::ExampleGroups::ALL.node_pattern_union} $_ ...)
+          (send _ #ExampleGroups.all $_ ...)
         PATTERN
 
         def on_send(node)
           example_group_match(node) do |doc|
-            add_offense(doc) if SELF_DOT_REGEXP.match?(doc.source)
-          end
-        end
+            next unless SELF_DOT_REGEXP.match?(doc.source)
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.remove(Parser::Source::Range.new(node.source_range.source_buffer,
-                                                       node.source_range.begin_pos + 1,
-                                                       node.source_range.begin_pos + 5))
+            add_offense(doc) do |corrector|
+              corrector.remove(Parser::Source::Range.new(doc.source_range.source_buffer,
+                                                         doc.source_range.begin_pos + 1,
+                                                         doc.source_range.begin_pos + 5))
+            end
           end
         end
       end

data/lib/rubocop/cop/salsify/rspec_string_literals.rb

@@ -11,7 +11,8 @@ module RuboCop
       # Used together with Salsify/RspecDocString it allows one quote style to
       # be used for doc strings (`describe "foobar"`) and another style to be
       # used for all other strings in specs.
-      class RspecStringLiterals < Cop
+      class RspecStringLiterals < RuboCop::Cop::RSpec::Base
+        extend RuboCop::Cop::AutoCorrector
         include ConfigurableEnforcedStyle
         include StringLiteralsHelp
 
@@ -22,8 +23,8 @@ module RuboCop
         DOUBLE_QUOTE_MSG = 'Prefer double-quoted strings unless you need ' \
           'single quotes to avoid extra backslashes for escaping.'
 
-        def autocorrect(node)
-          StringLiteralCorrector.correct(node, style)
+        def autocorrect(corrector, node)
+          StringLiteralCorrector.correct(corrector, node, style)
         end
 
         private

data/lib/salsify_rubocop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SalsifyRubocop
-  VERSION = '0.91.0'
+  VERSION = '1.1.0'
 end

data/salsify_rubocop.gemspec

@@ -30,14 +30,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.6'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter'
 
-  spec.add_runtime_dependency 'rubocop', '~> 0.91.0'
+  spec.add_runtime_dependency 'rubocop', '~> 1.13.0'
   spec.add_runtime_dependency 'rubocop-performance', '~> 1.5.0'
   spec.add_runtime_dependency 'rubocop-rails', '~> 2.4.0'
-  spec.add_runtime_dependency 'rubocop-rspec', '~> 1.37.0'
+  spec.add_runtime_dependency 'rubocop-rspec', '~> 2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salsify_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.91.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Salsify, Inc
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2021-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ 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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: 1.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.37.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.37.0
+        version: 2.0.0
 description: Shared shared RuboCop configuration
 email:
 - engineering@salsify.com
@@ -115,10 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -138,7 +152,6 @@ files:
 - lib/rubocop/cop/salsify/rspec_dot_not_self_dot.rb
 - lib/rubocop/cop/salsify/rspec_string_literals.rb
 - lib/rubocop/cop/salsify/style_dig.rb
-- lib/rubocop/rspec/language/each_selector.rb
 - lib/salsify_rubocop.rb
 - lib/salsify_rubocop/version.rb
 - salsify_rubocop.gemspec
@@ -155,14 +168,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Shared shared RuboCop configuration

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - 2.7.0
-  - 2.6.0
-  - 2.5.3
-  - 2.4.5
-before_install:
-  - gem update --system
-  - gem install bundler
-script:
-  - bundle exec rubocop
-  - bundle exec rspec

data/lib/rubocop/rspec/language/each_selector.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-# Monkey-patch SelectorSet to allow enumeration of selectors.
-
-module RuboCop
-  module RSpec
-    module Language
-      class SelectorSet
-        def each(&blk)
-          selectors.each(&blk)
-        end
-      end
-    end
-  end
-end