rubocop-shopify 2.14.0 → 2.15.1

data/lib/rubocop/shopify/gem_version_string_comparable_backport.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# This is true for Ruby 3.2+, so once support for 3.1 is dropped, we can remove this.
+# Until then, some installations may have a recent enough version of RubyGems, but it is not guaranteed.
+return if Gem::Version.new(Gem::VERSION) >= Gem::Version.new("3.5.6")
+
+module RuboCop
+  module Shopify
+    # Backport rubygems/rubygems#5275, so we can compare `Gem::Version`s directly against `String`s.
+    #
+    #     Gem::Version.new("1.2.3") > "1.2"
+    #
+    # Without this, to support Ruby < 3.2, we would have to create a new `Gem::Version` instance ourselves.
+    #
+    #     Gem::Version.new("1.2.3") > Gem::Version.new("1.2")
+    #
+    # This would get very verbose in our RuboCop config files.
+    module GemVersionStringComparableBackport
+      def <=>(other)
+        return self <=> self.class.new(other) if (String === other) && self.class.correct?(other)
+
+        super
+      end
+
+      Gem::Version.prepend(self)
+    end
+  end
+end

data/lib/tasks/config.rake

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+namespace :config do
+  desc "Dump the full RuboCop config as a YAML file for testing"
+  task :dump, [:target] do |_task, args|
+    file = "rubocop.yml"
+    target = args.fetch(:target, "test/fixtures/full_config.yml")
+
+    file_config = RuboCop::ConfigLoader.load_file(file)
+    config = RuboCop::ConfigLoader.merge_with_default(file_config, file)
+    output = config.to_h.to_yaml.gsub(config.base_dir_for_path_parameters, "")
+
+    # Removing trailing whitespaces from each line due to older libyaml versions
+    # converting nil hash values into whitespaces. GitHub actions is still stuck
+    # with libyaml < 0.2.5. This line can be removed once it is upgraded. Psych
+    # can be used to check for the running libyaml version:
+    #
+    # ```ruby
+    # require "psych"
+    # puts Psych::LIBYAML_VERSION
+    # ```
+    #
+    # For more info, see: https://github.com/yaml/libyaml/pull/186
+    output.gsub!(/\s\n/, "\n")
+
+    File.write(target, output)
+  end
+end

data/rubocop.yml

@@ -1,3 +1,9 @@
+<%
+  require "rubocop/shopify/gem_version_string_comparable_backport"
+
+  rubocop_version = Gem.loaded_specs.fetch("rubocop").version
+%>
+
 inherit_mode:
   merge:
   - Exclude
@@ -5,6 +11,7 @@ inherit_mode:
 
 AllCops:
   StyleGuideBaseURL: https://shopify.github.io/ruby-style-guide/
+  NewCops: disable # New cops will be triaged by style guide maintainers instead.
 
 Bundler/OrderedGems:
   Enabled: false
@@ -54,10 +61,10 @@ Layout/HashAlignment:
   EnforcedLastArgumentHashStyle: ignore_implicit
 
 Layout/LineContinuationLeadingSpace:
-  Enabled: false
+  Enabled: true
 
 Layout/LineContinuationSpacing:
-  Enabled: false
+  Enabled: true
 
 Layout/LineEndStringConcatenationIndentation:
   Enabled: true
@@ -182,9 +189,24 @@ Lint/IncompatibleIoSelectWithFiberScheduler:
 Lint/InterpolationCheck:
   Enabled: false
 
+<% if rubocop_version >= "1.59" %>
+Lint/ItWithoutArgumentsInBlock:
+  Enabled: true
+<% end %>
+
 Lint/LambdaWithoutLiteralBlock:
   Enabled: false
 
+<% if rubocop_version >= "1.58" %>
+Lint/LiteralAssignmentInCondition:
+  Enabled: true
+<% end %>
+
+<% if rubocop_version >= "1.53" %>
+Lint/MixedCaseRange:
+  Enabled: true
+<% end %>
+
 Lint/MixedRegexpCaptureTypes:
   Enabled: false
 
@@ -218,6 +240,11 @@ Lint/RaiseException:
 Lint/RedundantDirGlobSort:
   Enabled: false
 
+<% if rubocop_version >= "1.53" %>
+Lint/RedundantRegexpQuantifiers:
+  Enabled: true
+<% end %>
+
 Lint/RedundantRequireStatement:
   Enabled: false
 
@@ -375,8 +402,7 @@ Naming/InclusiveLanguage:
         - !ruby/regexp /\w*:\/\/\S+/ # URLs (e.g. https://github.com/org/repo/blob/master/README.md)
         - !ruby/regexp '/(?:blob|tree)/master/' # e.g. github.com/org/repo/blob/master/README.md, without https://
         - !ruby/regexp '/origin[ \/]master/' # Legacy default git branch name
-        - 'mastercard'
-        - 'webmaster'
+        - !ruby/regexp '/(?<=[a-z])master|master(?=[a-z])/' # "master" substring within a longer word
 
 Naming/MemoizedInstanceVariableName:
   Enabled: false
@@ -505,7 +531,7 @@ Style/Encoding:
   Enabled: false
 
 Style/EndlessMethod:
-  Enabled: false
+  Enabled: true
 
 Style/EnvHome:
   Enabled: false
@@ -542,6 +568,7 @@ Style/FormatStringToken:
 
 Style/FrozenStringLiteralComment:
   SafeAutoCorrect: true
+  EnforcedStyle: always_true
   Details: 'Add `# frozen_string_literal: true` to the top of the file. Frozen string
     literals will become the default in a future Ruby version, and we want to make
     sure we''re ready.'
@@ -577,7 +604,7 @@ Style/IfUnlessModifier:
   Enabled: false
 
 Style/IfWithBooleanLiteralBranches:
-  Enabled: false
+  Enabled: true
 
 Style/InPatternThen:
   Enabled: true
@@ -703,6 +730,11 @@ Style/RandomWithOffset:
 Style/RedundantArgument:
   Enabled: false
 
+<% if rubocop_version >= "1.52" %>
+Style/RedundantArrayConstructor:
+  Enabled: true
+<% end %>
+
 Style/RedundantAssignment:
   Enabled: false
 
@@ -715,6 +747,11 @@ Style/RedundantConditional:
 Style/RedundantConstantBase:
   Enabled: true
 
+<% if rubocop_version >= "1.53" %>
+Style/RedundantCurrentDirectoryInPath:
+  Enabled: true
+<% end %>
+
 Style/RedundantDoubleSplatHashBraces:
   Enabled: true
 
@@ -727,6 +764,11 @@ Style/RedundantFetchBlock:
 Style/RedundantFileExtensionInRequire:
   Enabled: false
 
+<% if rubocop_version >= "1.52" %>
+Style/RedundantFilterChain:
+  Enabled: true
+<% end %>
+
 Style/RedundantHeredocDelimiterQuotes:
   Enabled: true
 
@@ -736,9 +778,19 @@ Style/RedundantInitialize:
 Style/RedundantLineContinuation:
   Enabled: true
 
+<% if rubocop_version >= "1.53" %>
+Style/RedundantRegexpArgument:
+  Enabled: true
+<% end %>
+
 Style/RedundantRegexpCharacterClass:
   Enabled: false
 
+<% if rubocop_version >= "1.52" %>
+Style/RedundantRegexpConstructor:
+  Enabled: true
+<% end %>
+
 Style/RedundantRegexpEscape:
   Enabled: false
 
@@ -763,12 +815,22 @@ Style/RescueStandardError:
 Style/ReturnNil:
   Enabled: true
 
+<% if rubocop_version >= "1.53" %>
+Style/ReturnNilInPredicateMethodDefinition:
+  Enabled: true
+<% end %>
+
 Style/SelectByRegexp:
   Enabled: false
 
 Style/SingleArgumentDig:
   Enabled: false
 
+<% if rubocop_version >= "1.57" %>
+Style/SingleLineDoEndBlock:
+  Enabled: true
+<% end %>
+
 Style/SlicingWithRange:
   Enabled: false
 
@@ -793,6 +855,11 @@ Style/StringLiteralsInInterpolation:
 Style/StructInheritance:
   Enabled: false
 
+<% if rubocop_version >= "1.58" %>
+Style/SuperWithArgsParentheses:
+  Enabled: true
+<% end %>
+
 Style/SwapValues:
   Enabled: false
 
@@ -823,5 +890,10 @@ Style/UnpackFirst:
 Style/WordArray:
   EnforcedStyle: brackets
 
+<% if rubocop_version >= "1.53" %>
+Style/YAMLFileRead:
+  Enabled: true
+<% end %>
+
 Style/YodaCondition:
   Enabled: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-shopify
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.1
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2024-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -32,13 +32,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.md
+- README.md
+- lib/rubocop/shopify/gem_version_string_comparable_backport.rb
+- lib/tasks/config.rake
 - rubocop-cli.yml
 - rubocop.yml
 homepage: https://shopify.github.io/ruby-style-guide/
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/ruby-style-guide/tree/v2.14.0
+  source_code_uri: https://github.com/Shopify/ruby-style-guide/tree/v2.15.1
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -55,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: Shopify's style guide for Ruby.