ezcater_rubocop 7.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91e99b541defc66ad56b00dc87df189f3ae1794269719f46701a44998b3438a1
-  data.tar.gz: d00dbef72d5716d0c9fc1493bc1eeaf028eb222962a2d7a2553afa6c8eb04749
+  metadata.gz: 21f4e7bbf647038e8c4908c7afd359289c8ddd66ed226c36321d19c339dc3894
+  data.tar.gz: d305ea39433fe93fc61a758743dbd3f173c61f1d1fcf182dfd50e8b444f6137d
 SHA512:
-  metadata.gz: e634c40c10c8758ff9c668be962c07e77ae28b6dc3af9b343c60414d2fe3c4b28b6ae59b84c213c9d6588c2d1d4fb6ad353717ef225e5c7896040212e167c73c
-  data.tar.gz: 0366c568bac8878bb85faa4f8b5003882efee38356b74d981bef19e7745e3b63fc6fd1accfdb9f9420036d1d9e609ef3b830121a89ab91068ee1ca304f5921bd
+  metadata.gz: c438d47953e25c7504a53b2b4d422776827df177b3a88a13e2774329c53d50f8e4554fff20b7af6cb9c4b2d1b07dba64a15baa528f13fe75c7b8455dec321950
+  data.tar.gz: 8a31b06d99e472a02ba4018405c6fafcd65786893dbb8d03b8b76e61472dc2b0a4bee0da107da02ce0994f5bb62a82414daec6fcbdc38a2098d712d6932d7c24

data/CHANGELOG.md

@@ -6,6 +6,9 @@ This gem is moving onto its own [Semantic Versioning](https://semver.org/) schem
 
 Prior to v1.0.0 this gem was versioned based on the `MAJOR`.`MINOR` version of RuboCop. The first release of the ezcater_rubocop gem was `v0.49.0`.
 
+## 7.1.0
+- Upgrade rubocop to v1 API (following guide [here](https://docs.rubocop.org/rubocop/v1_upgrade_notes.html)) to stop deprecation warnings in rubocop >=1.67.
+
 ## 7.0.0
 
 - Drop support for ruby 2.6 & 3.0

data/lib/ezcater_rubocop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EzcaterRubocop
-  VERSION = "7.0.0"
+  VERSION = "7.1.0"
 end

data/lib/rubocop/cop/ezcater/direct_env_check.rb

@@ -18,7 +18,7 @@ module RuboCop
       #   # bad
       #   enforce_foo! if ENV["FOO_ENFORCED"] == "true"
       #
-      class DirectEnvCheck < Cop
+      class DirectEnvCheck < Base
         MSG = <<~END_MESSAGE.split("\n").join(" ")
           Use `Rails.configuration.x.<foo>` for env-backed configuration instead of inspecting `ENV`. Restricting
           environment variables references to be within application configuration makes it more obvious which env vars
@@ -31,7 +31,7 @@ module RuboCop
 
         def on_const(node)
           env_ref(node) do
-            add_offense(node, location: :expression, message: MSG)
+            add_offense(node.loc.expression, message: MSG)
           end
         end
       end

data/lib/rubocop/cop/ezcater/feature_flag_active.rb

@@ -22,7 +22,7 @@ module RuboCop
       #   EzFF.active?(:symbol_name, tracking_id: "brand:12345")
       #   EzFF.active?(123, identifiers: ["user:12345"])
 
-      class FeatureFlagActive < Cop
+      class FeatureFlagActive < Base
         MSG = "`EzFF.active?` must be called with at least one of `tracking_id` or `identifiers`"
         FIRST_PARAM_MSG = "The first argument to `EzFF.active?` must be a string literal or a variable " \
         "or constant assigned to a string"
@@ -57,11 +57,11 @@ module RuboCop
           return unless method_call_matcher(node)
 
           if first_param_bad(node)
-            add_offense(node, location: :expression, message: FIRST_PARAM_MSG)
+            add_offense(node.loc.expression, message: FIRST_PARAM_MSG)
           end
 
           if ezff_active_one_arg(node) || !args_matcher(node)
-            add_offense(node, location: :expression, message: MSG)
+            add_offense(node.loc.expression, message: MSG)
           end
         end
       end

data/lib/rubocop/cop/ezcater/feature_flag_name_valid.rb

@@ -21,7 +21,7 @@ module RuboCop
       #   EzFF.at_100?("Foo::Bar && rm -rf * ")
       #   EzFF.active?("foo::bar", identifiers: ["user:1"])
       #   MY_FLAG="Foo:bar"
-      class FeatureFlagNameValid < Cop
+      class FeatureFlagNameValid < Base
         WHITESPACE = /\s/
         ISOLATED_COLON = /(?<!:):(?!:)/
         TRIPLE_COLON = /:::/
@@ -46,7 +46,7 @@ module RuboCop
           feature_flag_constant_assignment(node) do |const_name, flag_name|
             if const_name.end_with?("_FF", "_FLAG", "_FLAG_NAME", "_FEATURE_FLAG")
               errors = find_name_violations(flag_name)
-              add_offense(node, location: :expression, message: errors.join(", ")) if errors.any?
+              add_offense(node.loc.expression, message: errors.join(", ")) if errors.any?
             end
           end
         end
@@ -56,7 +56,7 @@ module RuboCop
 
           feature_flag_method_call(node) do |flag_name|
             errors = find_name_violations(flag_name)
-            add_offense(node, location: :expression, message: errors.join(", ")) if errors.any?
+            add_offense(node.loc.expression, message: errors.join(", ")) if errors.any?
           end
         end
 

data/lib/rubocop/cop/ezcater/rails_configuration.rb

@@ -3,7 +3,9 @@
 module RuboCop
   module Cop
     module Ezcater
-      class RailsConfiguration < Cop
+      class RailsConfiguration < Base
+        extend RuboCop::Cop::AutoCorrector
+
         MSG = "Use `Rails.configuration` instead of `Rails.application.config`."
         RAILS_CONFIGURATION = "Rails.configuration"
 
@@ -13,13 +15,9 @@ module RuboCop
 
         def on_send(node)
           rails_application_config(node) do
-            add_offense(node, location: :expression, message: MSG)
-          end
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.source_range, RAILS_CONFIGURATION)
+            add_offense(node.loc.expression, message: MSG) do |corrector|
+              corrector.replace(node.source_range, RAILS_CONFIGURATION)
+            end
           end
         end
       end

data/lib/rubocop/cop/ezcater/rails_env.rb

@@ -21,7 +21,7 @@ module RuboCop
       #   # bad
       #   enforce_foo! if ENV["RAILS_ENV"] == "production"
       #
-      class RailsEnv < Cop
+      class RailsEnv < Base
         MSG = <<~END_MESSAGE.split("\n").join(" ")
           Use `Rails.configuration.x.<foo>` for env-backed configuration instead of inspecting `Rails.env`, so that
           configuration is more centralized and gives finer control. https://ezcater.atlassian.net/wiki/x/ZIChNg
@@ -33,7 +33,7 @@ module RuboCop
 
         def on_send(node)
           rails_env(node) do
-            add_offense(node, location: :expression, message: MSG)
+            add_offense(node.loc.expression, message: MSG)
           end
         end
       end

data/lib/rubocop/cop/ezcater/rails_top_level_sql_execute.rb

@@ -14,7 +14,9 @@ module RuboCop
       #   # bad
       #   ActiveRecord::Base.connection.execute("...")
       #
-      class RailsTopLevelSqlExecute < Cop
+      class RailsTopLevelSqlExecute < Base
+        extend RuboCop::Cop::AutoCorrector
+
         MSG = <<~END_MESSAGE.split("\n").join(" ")
           Use `execute` instead of `ActiveRecord::Base.connection.execute` in migrations. The latter is
           redundant and can bypass safety checks.
@@ -26,19 +28,15 @@ module RuboCop
 
         def on_send(node)
           ar_connection_execute(node) do
-            add_offense(node, location: :expression, message: MSG)
-          end
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            range = Parser::Source::Range.new(
-              node.source_range.source_buffer,
-              node.source_range.begin_pos,
-              node.source_range.end_pos
-            )
+            add_offense(node.loc.expression, message: MSG) do |corrector|
+              range = Parser::Source::Range.new(
+                node.source_range.source_buffer,
+                node.source_range.begin_pos,
+                node.source_range.end_pos
+              )
 
-            corrector.replace(range, "execute(#{node.last_argument.source})")
+              corrector.replace(range, "execute(#{node.last_argument.source})")
+            end
           end
         end
       end

data/lib/rubocop/cop/ezcater/require_custom_error.rb

@@ -13,7 +13,7 @@ module RuboCop
       #   # good
       #   raise OrderActionNotAllowed
 
-      class RequireCustomError < Cop
+      class RequireCustomError < Base
         MSG = "Use a custom error class that inherits from StandardError when raising an exception"
 
         def_node_matcher :raising_standard_or_argument_error,

data/lib/rubocop/cop/ezcater/require_gql_error_helpers.rb

@@ -19,7 +19,7 @@ module RuboCop
       #   # bad
       #   GraphQL::ExecutionError.new("An error occurred")
       #   GraphQL::ExecutionError.new("You can't access this", options: { status_code: 401 })
-      class RequireGqlErrorHelpers < Cop
+      class RequireGqlErrorHelpers < Base
         MSG = "Use the helpers provided by `GQLErrors` instead of raising `GraphQL::ExecutionError` directly."
 
         def_node_matcher :graphql_const?, <<~PATTERN
@@ -29,7 +29,7 @@ module RuboCop
         def on_const(node)
           return unless graphql_const?(node)
 
-          add_offense(node, location: :expression, message: MSG)
+          add_offense(node.loc.expression, message: MSG)
         end
       end
     end

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

@@ -23,9 +23,10 @@ module RuboCop
       #     ...
       #   end
 
-      class RspecDotNotSelfDot < Cop
+      class RspecDotNotSelfDot < Base
         include RuboCop::RSpec::Language
         extend RuboCop::RSpec::Language::NodePattern
+        extend RuboCop::Cop::AutoCorrector
 
         RSPEC_EXAMPLE_PREFIXES = ["", "x", "f"].freeze
         EXAMPLE_GROUP_IDENTIFIERS = (RSPEC_EXAMPLE_PREFIXES.map do |prefix|
@@ -53,19 +54,19 @@ module RuboCop
           return unless example_group?(node)
 
           str_node = node.send_node.arguments[0]
-          if str_node.value.match?(SELF_DOT_REGEXP)
-            add_offense(str_node, location: :expression, message: SELF_DOT_MSG)
-          elsif str_node.value.match?(COLON_COLON_REGEXP)
-            add_offense(str_node, location: :expression, message: COLON_COLON_MSG)
-          end
-        end
+          message = if str_node.value.match?(SELF_DOT_REGEXP)
+                      SELF_DOT_MSG
+                    elsif str_node.value.match?(COLON_COLON_REGEXP)
+                      COLON_COLON_MSG
+                    end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            experession_end = node.source.match?("::") ? 3 : 6
-            corrector.replace(Parser::Source::Range.new(node.source_range.source_buffer,
-                                                        node.source_range.begin_pos + 1,
-                                                        node.source_range.begin_pos + experession_end), ".")
+          if message
+            add_offense(str_node.loc.expression, message: message) do |corrector|
+              expression_end = str_node.source.match?("::") ? 3 : 6
+              corrector.replace(Parser::Source::Range.new(str_node.source_range.source_buffer,
+                                                          str_node.source_range.begin_pos + 1,
+                                                          str_node.source_range.begin_pos + expression_end), ".")
+            end
           end
         end
       end

data/lib/rubocop/cop/ezcater/rspec_match_ordered_array.rb

@@ -14,7 +14,9 @@ module RuboCop
       #   # bad
       #   expect(foo).to eq([1, 2, 3])
       #   expect(foo).to eq [1, 2, 3]
-      class RspecMatchOrderedArray < Cop
+      class RspecMatchOrderedArray < Base
+        extend RuboCop::Cop::AutoCorrector
+
         MATCH_ORDERED_ARRAY = "match_ordered_array"
         MSG = "Use the `match_ordered_array` matcher from ezcater_matchers gem "\
           "instead of `eq` when comparing collections"
@@ -25,20 +27,16 @@ module RuboCop
 
         def on_send(node)
           eq_array(node) do
-            add_offense(node, location: :expression, message: MSG)
-          end
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(
-              Parser::Source::Range.new(
-                node.source_range.source_buffer,
-                node.source_range.begin_pos,
-                node.source_range.begin_pos + 2
-              ),
-              MATCH_ORDERED_ARRAY
-            )
+            add_offense(node.loc.expression, message: MSG) do |corrector|
+              corrector.replace(
+                Parser::Source::Range.new(
+                  node.source_range.source_buffer,
+                  node.source_range.begin_pos,
+                  node.source_range.begin_pos + 2
+                ),
+                MATCH_ORDERED_ARRAY
+              )
+            end
           end
         end
       end

data/lib/rubocop/cop/ezcater/rspec_require_browser_mock.rb

@@ -19,7 +19,7 @@ module RuboCop
       #   # bad
       #   allow(Browser).to receive...
       #   allow(EzBrowser).to receive...
-      class RspecRequireBrowserMock < Cop
+      class RspecRequireBrowserMock < Base
         MSG = "Use the mocks provided by `BrowserHelpers` instead of mocking `%<node_source>s`"
 
         def_node_matcher :browser_const?, <<~PATTERN
@@ -39,8 +39,7 @@ module RuboCop
 
           # Finish tree navigation to full line for highlighting
           match_node = match_node.parent while match_node.parent
-          add_offense(match_node,
-                      location: :expression,
+          add_offense(match_node.loc.expression,
                       message: format(MSG, node_source: node.source))
         end
 

data/lib/rubocop/cop/ezcater/rspec_require_feature_flag_mock.rb

@@ -15,7 +15,7 @@ module RuboCop
       #   allow(FeatureFlag).to receive(:is_active?).and_return(true)
       #   allow(FeatureFlag).to receive(:is_active?).with("MyFeatureFlag").and_return(true)
       #   allow(FeatureFlag).to receive(:is_active?).with("MyFeatureFlag", user: current_user).and_return(true)
-      class RspecRequireFeatureFlagMock < Cop
+      class RspecRequireFeatureFlagMock < Base
         MSG = "Use the `mock_feature_flag` helper instead of mocking `allow(FeatureFlag)`"
 
         def_node_matcher :feature_flag_const?, <<~PATTERN
@@ -35,7 +35,7 @@ module RuboCop
 
           # Finish tree navigation to full line for highlighting
           match_node = match_node.parent while match_node.parent
-          add_offense(match_node, location: :expression)
+          add_offense(match_node.loc.expression)
         end
 
         private

data/lib/rubocop/cop/ezcater/rspec_require_http_status_matcher.rb

@@ -14,7 +14,7 @@ module RuboCop
       #   # bad
       #   expect(response.code).to eq 201
       #   expect(response.code).to eq 400
-      class RspecRequireHttpStatusMatcher < Cop
+      class RspecRequireHttpStatusMatcher < Base
         MSG = "Use the `have_http_status` matcher, like `expect(response).to have_http_status :bad_request`, "\
           "rather than `%<node_source>s`"
 
@@ -29,8 +29,7 @@ module RuboCop
         def on_send(node)
           return if !response_status_assertion(node) && !response_code_assertion(node)
 
-          add_offense(node,
-                      location: :expression,
+          add_offense(node.loc.expression,
                       message: format(MSG, node_source: node.source))
         end
       end

data/lib/rubocop/cop/ezcater/ruby_timeout.rb

@@ -17,7 +17,7 @@ module RuboCop
       #     ...
       #   end
       #
-      class RubyTimeout < Cop
+      class RubyTimeout < Base
         MSG = <<~END_MESSAGE.split("\n").join(" ")
           `Timeout.timeout` is unsafe. Find an alternative to achieve the same goal.
            Ex. Use the timeout capabilities of a networking library.
@@ -30,7 +30,7 @@ module RuboCop
 
         def on_send(node)
           timeout(node) do
-            add_offense(node, location: :expression, message: MSG)
+            add_offense(node.loc.expression, message: MSG)
           end
         end
       end

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

@@ -16,7 +16,8 @@ module RuboCop
       #   my_hash['foo'] && my_hash['foo']['bar']
       #   my_array[0][1]
 
-      class StyleDig < Cop
+      class StyleDig < Base
+        extend RuboCop::Cop::AutoCorrector
         extend TargetRubyVersion
 
         minimum_target_ruby_version 2.3
@@ -33,22 +34,19 @@ module RuboCop
           match_node = node
           # walk to outermost access node
           match_node = match_node.parent while access_node?(match_node.parent)
-          add_offense(match_node, location: :expression, message: MSG)
-        end
 
-        def autocorrect(node)
-          access_node = node
-          source_args = [access_node.first_argument.source]
-          while access_node?(access_node.children.first)
-            access_node = access_node.children.first
-            source_args << access_node.first_argument.source
-          end
-          root_node = access_node.children.first
+          add_offense(match_node.loc.expression, message: MSG) do |corrector|
+            access_node = match_node
+            source_args = [access_node.first_argument.source]
+            while access_node?(access_node.children.first)
+              access_node = access_node.children.first
+              source_args << access_node.first_argument.source
+            end
+            root_node = access_node.children.first
 
-          lambda do |corrector|
-            range = Parser::Source::Range.new(node.source_range.source_buffer,
+            range = Parser::Source::Range.new(match_node.source_range.source_buffer,
                                               root_node.source_range.end_pos,
-                                              node.source_range.end_pos)
+                                              match_node.source_range.end_pos)
             corrector.replace(range, ".dig(#{source_args.reverse.join(', ')})")
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-25 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler