salsify_rubocop 0.78.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 021126eb4684d5cc7bebabbdd04136abe1e958c03f34926f845199b1f799fef8
-  data.tar.gz: fa1be69a53c426f1345bb14e319b304603ad95a75c9646438eabcda572f9f404
+  metadata.gz: bf4488cacf9244dcc1eef749f7e8be0aec426462bbdd97bba63f2585d9e341fa
+  data.tar.gz: 7c804cbcb3576fd3ba2852a667f0db842eb5b2393a7e775101930488eb2b97d4
 SHA512:
-  metadata.gz: 97e764bf2aec15ec8fc01e265723151154d2bafa0027f7eee228b76e0ef5a02c2d71acb2f1726f0c194cbfb8a6c1452c5e0ce405ffd952f811524934296700a0
-  data.tar.gz: 25b77acd0d7ef91a46c4fb6bb3a2d44472ae4d0611a6f8337bee11f2de345a181d4809e76e5bf909ef440f6c3381d251f4b508926b9bca4151c6225767641911
+  metadata.gz: a19b74a0b2600a044f45ae9203a4115cf8dc66b8422c7cf3424d9028d81e273e9cd474dc2f518c5d1f6b39c48b8b95ffb28ec534f56ce14f5bf1ac8f4973689a
+  data.tar.gz: 30b89b5377a2a32895e26947cee22985a17221334519e26bf7e0e3b63e37becd2616c1856626350a5123d51958254beebb5fdde7e1fd1bb16f4d67d8c1bffef5

data/.circleci/config.yml

@@ -0,0 +1,34 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: salsify/ruby_ci:2.5.8
+    environment:
+      CIRCLE_TEST_REPORTS: "test-results"
+    working_directory: ~/salsify_rubocop
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-gems-ruby-2.5.8-{{ checksum "salsify_rubocop.gemspec" }}-{{ checksum "Gemfile" }}
+            - v1-gems-ruby-2.5.8-
+      - 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.5.8-{{ checksum "salsify_rubocop.gemspec" }}-{{ checksum "Gemfile" }}
+          paths:
+            - "vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+      - 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"

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # salsify_rubocop
 
+## 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
+- Upgrade to `rubocop` v0.85.0
+- Enable enforcement of Gem comments when specifying versions or sources 
+- Drop support for Ruby 2.3, as rubocop v0.81+ doesn't support it anymore
+- Add `FrozenStringLiteralComment` and `LineLength` (max 120) rules.
+
+## v0.78.1
+- Fix "`Style/SymbolArray` is concealed by line 190" warning
+
 ## v0.78.0
 - Upgrade to `rubocop` v0.78.0
 - Upgrade to `rubocop_rspec` v1.37.0

data/Gemfile

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

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/Rakefile

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

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,5 @@
 AllCops:
+  NewCops: disable
   DisplayCopNames: true
   Exclude:
     - 'bin/**/*'
@@ -9,6 +10,19 @@ AllCops:
     - 'tmp/**/*'
     - 'vendor/**/*'
 
+Bundler/GemComment:
+  Enabled: true
+  OnlyFor:
+    - 'version_specifiers'
+    - '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
@@ -67,7 +81,7 @@ Naming/FileName:
     - 'Appraisals'
 
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: true
 
 Style/GuardClause:
   Enabled: false
@@ -134,10 +148,6 @@ Style/StringLiterals:
   Exclude:
     - 'spec/**/*'
 
-# We don't require %i() for an array of symbols.
-Style/SymbolArray:
-  Enabled: false
-
 Naming/VariableNumber:
   Enabled: false
 
@@ -156,10 +166,12 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-# Disabling line length enforcement since annotate generates
-# some pretty long lines
 Layout/LineLength:
-  Enabled: false
+  Enabled: true
+  Max: 120
+  IgnoreCopDirectives: true
+  IgnoredPatterns:
+    - ^#
 
 Metrics/MethodLength:
   Enabled: false
@@ -189,3 +201,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/rails_application_mailer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module Salsify
@@ -19,9 +21,9 @@ module RuboCop
 
         minimum_target_rails_version 5.0
 
-        MSG = 'Mailers should subclass `ApplicationMailer`.'.freeze
-        SUPERCLASS = 'ApplicationMailer'.freeze
-        BASE_PATTERN = '(const (const nil? :ActionMailer) :Base)'.freeze
+        MSG = 'Mailers should subclass `ApplicationMailer`.'
+        SUPERCLASS = 'ApplicationMailer'
+        BASE_PATTERN = '(const (const nil? :ActionMailer) :Base)'
 
         include RuboCop::Cop::EnforceSuperclass
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module Salsify
@@ -19,9 +21,9 @@ module RuboCop
 
         minimum_target_rails_version 5.0
 
-        MSG = 'Serializers should subclass `ApplicationSerializer`.'.freeze
-        SUPERCLASS = 'ApplicationSerializer'.freeze
-        BASE_PATTERN = '(const (const nil? :ActiveModel) :Serializer)'.freeze
+        MSG = 'Serializers should subclass `ApplicationSerializer`.'
+        SUPERCLASS = 'ApplicationSerializer'
+        BASE_PATTERN = '(const (const nil? :ActiveModel) :Serializer)'
 
         include RuboCop::Cop::EnforceSuperclass
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module Salsify
@@ -11,7 +13,7 @@ module RuboCop
       #  # bad
       #  User.unscoped
       class RailsUnscoped < Cop
-        MSG = 'Explicitly remove scopes instead of using `unscoped`.'.freeze
+        MSG = 'Explicitly remove scopes instead of using `unscoped`.'
 
         def_node_matcher :unscoped?, <<-PATTERN
           (send _ :unscoped)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module Salsify
@@ -17,45 +19,47 @@ 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 =
-          'Example Group/Example doc strings must be single-quoted.'.freeze
+          'Example Group/Example doc strings must be single-quoted.'
         DOUBLE_QUOTE_MSG =
-          'Example Group/Example doc strings must be double-quoted.'.freeze
+          '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::ConfigLoader.default_configuration.for_department('RSpec')
+                               .fetch('Language')
+                               .values_at('ExampleGroups', 'Examples', 'SharedGroups', 'Includes')
+                               .flat_map { |element| element.values.flatten }
+                               .map(&:to_sym)
 
-        DOCUMENTED_METHODS = (RuboCop::RSpec::Language::ExampleGroups::ALL +
-          RuboCop::RSpec::Language::Examples::ALL +
-          RuboCop::RSpec::Language::SharedGroups::ALL +
-          SHARED_EXAMPLES).freeze
+        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
-          end
+          return unless wrong_quotes?(doc_node)
+
+          add_offense(doc_node,
+                      message: style == :single_quotes ? SINGLE_QUOTE_MSG : DOUBLE_QUOTE_MSG,
+                      &StringLiteralCorrector.correct(doc_node, style))
         end
 
         def wrong_quotes?(node)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module Salsify
@@ -15,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.'.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 =~ 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module Salsify
@@ -16,9 +18,9 @@ module RuboCop
         DOCUMENTED_METHODS = RuboCop::Cop::Salsify::RspecDocString::DOCUMENTED_METHODS
 
         SINGLE_QUOTE_MSG = 'Prefer single-quoted strings unless you need ' \
-          'interpolation or special symbols.'.freeze
+          'interpolation or special symbols.'
         DOUBLE_QUOTE_MSG = 'Prefer double-quoted strings unless you need ' \
-          'single quotes to avoid extra backslashes for escaping.'.freeze
+          'single quotes to avoid extra backslashes for escaping.'
 
         def autocorrect(node)
           StringLiteralCorrector.correct(node, style)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This may be added in the near future to rubocop, see https://github.com/bbatsov/rubocop/issues/5332
 
 module RuboCop
@@ -21,7 +23,7 @@ module RuboCop
 
         minimum_target_ruby_version 2.3
 
-        MSG = 'Use `dig` for nested access.'.freeze
+        MSG = 'Use `dig` for nested access.'
 
         def_node_matcher :nested_access_match, <<-PATTERN
           (send (send (send _receiver !:[]) :[] !{irange erange}) :[] !{irange erange})

data/lib/salsify_rubocop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'salsify_rubocop/version'
 require 'rubocop-performance'
 require 'rubocop-rails'

data/lib/salsify_rubocop/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SalsifyRubocop
-  VERSION = '0.78.0'.freeze
+  VERSION = '1.0.1'
 end

data/salsify_rubocop.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'salsify_rubocop/version'
@@ -28,12 +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.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter'
 
-  spec.add_runtime_dependency 'rubocop', '~> 0.78.0'
+  spec.add_runtime_dependency 'rubocop', '~> 1.0.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.78.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Salsify, Inc
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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.78.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 1.0.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
@@ -147,7 +160,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,15 +168,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Shared shared RuboCop configuration
 test_files: []

data/.travis.yml

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

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

@@ -1,13 +0,0 @@
-# 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