salsify_rubocop 0.63.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e3126722e0cfd738a292ca81b06494f3f1a7d11231984ef9d2275893568dd20
-  data.tar.gz: 35af08baf302fc3e077e4cac91dc134ecebc8b202909fab50122773d26c0de15
+  metadata.gz: 2056598e677c6cf0b213308613d5ab676b7eee1e97dd93534321a75ba341e2b9
+  data.tar.gz: f0053c47716a510ef4ef57c5e90465e2309a0573ab5944d92b23a42cd154ab2c
 SHA512:
-  metadata.gz: 4eb7b3432ff1a7c49194bf4c0c4f8310b749bbdcff8790aa9a77110c7498264c6cb0938d74e81f998caaf13fcaf5008b300cc7e6f2aaabb77da243ee7863e253
-  data.tar.gz: ce93adfb8de00444f300018a0404d0abc0ae138388895c76865ac55e9ebcad3ce1a5dadba8421dbb91984d9153ad43b48886f358ee7f76121b0a7b95b104b26b
+  metadata.gz: fe21f0ff75e19ef071efe283cce27a01cde095fe4918d3ef7eb10bddff6d9ca476b8b4a4263b92f871c55ec7434283b9a6812400e546012c8c3d11cb0d280b73
+  data.tar.gz: 339fc5ad332c3602d2d73106f76c6d26fc9103c398b6bee9059971b1ac97dcbbe930b7ce731d21cda5794d9fdd53f04454d6c203ba8ffe6e7dc6b67695971062

data/.rubocop.yml

@@ -2,8 +2,8 @@ inherit_from:
   - conf/rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
-Metrics/LineLength:
+Layout/LineLength:
   Exclude:
     - '*.gemspec'

data/.travis.yml

@@ -1,9 +1,9 @@
 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

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # salsify_rubocop
 
+## 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
+- Add `rubocop-rails `v2.4.0`
+- Add `rubocop-performance `v1.5.0`
+- Update names/namespaces of rules that changed between 0.62 and 0.78
+
 ## v0.62.0
 - Upgrade to `rubocop` v0.62.0
 - Upgrade to `rubocop_rspec` v1.31.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/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_without_rspec.yml

@@ -1,4 +1,5 @@
 AllCops:
+  NewCops: disable
   DisplayCopNames: true
   Exclude:
     - 'bin/**/*'
@@ -9,6 +10,15 @@ AllCops:
     - 'tmp/**/*'
     - 'vendor/**/*'
 
+Bundler/GemComment:
+  Enabled: true
+  OnlyFor:
+    - 'version_specifiers'
+    - 'source'
+    - 'git'
+    - 'github'
+    - 'gist'
+
 # This cop has poor handling for the common case of a lambda arg in a DSL
 Lint/AmbiguousBlockAssociation:
   Enabled: false
@@ -22,7 +32,7 @@ Performance/RedundantMerge:
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
-Layout/AlignHash:
+Layout/HashAlignment:
   Enabled: false
 
 Style/Documentation:
@@ -67,13 +77,13 @@ Naming/FileName:
     - 'Appraisals'
 
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: true
 
 Style/GuardClause:
   Enabled: false
 
 # does not make sense to enable this without AlignHash
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   Enabled: false
 
 Style/Lambda:
@@ -134,10 +144,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 +162,12 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-# Disabling line length enforcement since annotate generates
-# some pretty long lines
-Metrics/LineLength:
-  Enabled: false
+Layout/LineLength:
+  Enabled: true
+  Max: 120
+  IgnoreCopDirectives: true
+  IgnoredPatterns:
+    - ^#
 
 Metrics/MethodLength:
   Enabled: false
@@ -189,3 +197,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,4 +1,8 @@
+# frozen_string_literal: true
+
 require 'salsify_rubocop/version'
+require 'rubocop-performance'
+require 'rubocop-rails'
 require 'rubocop-rspec'
 
 # Because RuboCop doesn't yet support plugins, we have to monkey patch in a

data/lib/salsify_rubocop/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SalsifyRubocop
-  VERSION = '0.63.0'.freeze
+  VERSION = '1.0.0'
 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,10 +30,14 @@ 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_runtime_dependency 'rubocop', '~> 0.62.0'
-  spec.add_runtime_dependency 'rubocop-rspec', '~> 1.31.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', '~> 2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salsify_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.63.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Salsify, Inc
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-04-17 00:00:00.000000000 Z
+date: 2020-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,28 +58,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.62.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.62.0
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.31.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.31.0
+        version: 2.0.0
 description: Shared shared RuboCop configuration
 email:
 - engineering@salsify.com
@@ -110,7 +138,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
@@ -119,7 +146,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,16 +154,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: []
-rubyforge_project: 
-rubygems_version: 2.7.9
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Shared shared RuboCop configuration
 test_files: []

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