rubocop-shopify 2.18.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dddd1327e7d3e886554f75c638bf6a24438b7e4aba85f2a9699d6af2996adfa7
-  data.tar.gz: 16bd88185fd2a44319ace9ad9fe36930264c2d5435104d6b0fe8bdaa680c4605
+  metadata.gz: e556fcc69352f0ea6f28c674e755744cfa1528cb708972965c35f6b7c4e6aec4
+  data.tar.gz: 90b84c650e1c7e816edf3118d5887a8bb3ec78232477739f4282cb40d2c1c42b
 SHA512:
-  metadata.gz: '059db60b9702df428fcee09dacbf3465cf8a42c20d8f98d8a01de31b466ac4e7907075ff0d906850eacb1d0edbcd299161ae72f30875145a59671c6f749e9412'
-  data.tar.gz: e215d44264ed51ce52a0fecaf43d89b6bfb8b0ec36484d15495836b5fdd17dc1225edd72937b338eae4feb021b1fc3d4bdab911b28bea10234601797d33c5aab
+  metadata.gz: 61db41be4f6dd5e976ac40f94c387ccbf7fda96ba08764d4e1e3ff32146bf72961d6d20f9cb6c095d0794b63cbe0567bed9abf58de4be18401c386bef3f81b58
+  data.tar.gz: b4fce6c8574e99ff9dfbc84f7db8a67ad82535dc5743a95ff5808369b088b59965240bf50e94c31fa208f5be007b828772eeb0b686a72c2ec973d9304b4a7c42

data/README.md

@@ -1,5 +1,5 @@
 ---
-layout: base
+layout: default
 title: Ruby Style Guide
 permalink: '/'
 ---
@@ -31,16 +31,16 @@ documentation](https://docs.rubocop.org/rubocop/).
 We offer a default RuboCop configuration you can inherit from and be in sync
 with this Style Guide. To use it, you can add this to your `Gemfile`:
 
-  ~~~ruby
-  gem "rubocop-shopify", require: false
-  ~~~
+~~~ruby
+gem "rubocop-shopify", require: false
+~~~
 
 And add to the top of your project's RuboCop configuration file:
 
-  ~~~yml
-  inherit_gem:
-    rubocop-shopify: rubocop.yml
-  ~~~
+~~~yml
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+~~~
 
 Any `Include` or `Exclude` configuration provided will be merged with RuboCop's defaults.
 

data/config/default.yml

@@ -0,0 +1,4 @@
+Lint/NoReturnInMemoization:
+  Enabled: true
+  VersionAdded: "3.0.0"
+  Description: "Checks for the use of a `return` with a value in `begin..end` blocks in the context of instance variable assignment such as memoization."

data/lib/rubocop/cop/lint/no_return_in_memoization.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Lint
+      # Checks for the use of a `return` with a value in `begin..end` blocks
+      # in the context of instance variable assignment such as memoization.
+      # Using `return` with a value in these blocks can lead to unexpected behavior
+      # as the `return` will exit the method that contains and not set the values
+      # of the instance variable.
+      #
+      # @example
+      #
+      #   # bad
+      #   def foo
+      #     @foo ||= begin
+      #       return 1 if bar
+      #       2
+      #     end
+      #   end
+      #
+      #   # bad
+      #   def foo
+      #     @foo = begin
+      #       return 1 if bar
+      #       2
+      #     end
+      #   end
+      #
+      #   # bad
+      #   def foo
+      #     @foo += begin
+      #       return 1 if bar
+      #       2
+      #     end
+      #   end
+      #
+      #   # bad - using return in rescue blocks still exits the method
+      #   def foo
+      #     @foo ||= begin
+      #       bar
+      #     rescue
+      #       return 2 if baz
+      #     end
+      #   end
+      #
+      #   # good
+      #   def foo
+      #     @foo ||= begin
+      #       if bar
+      #         1
+      #       else
+      #         2
+      #       end
+      #     end
+      #   end
+      #
+      #   # good - not an assignment to an instance variable
+      #   def foo
+      #     foo = begin
+      #       return 1 if bar
+      #       2
+      #     end
+      #   end
+      #
+      #   # good - proper exception handling without return
+      #   def foo
+      #     @foo ||= begin
+      #       bar
+      #     rescue
+      #       baz ? 2 : 3
+      #     end
+      #   end
+      class NoReturnInMemoization < ::RuboCop::Cop::Base
+        MSG = "Do not `return` in `begin..end` blocks in instance variable assignment contexts."
+
+        def on_or_asgn(node)
+          node.each_node(:kwbegin) do |kwbegin_node|
+            kwbegin_node.each_node(:return) do |return_node|
+              add_offense(return_node)
+            end
+          end
+        end
+
+        def on_op_asgn(node)
+          return unless node.assignment_node.ivasgn_type?
+
+          on_or_asgn(node)
+        end
+
+        alias on_ivasgn on_or_asgn
+        alias on_and_asgn on_or_asgn
+      end
+    end
+  end
+end

data/lib/rubocop/shopify/plugin.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+
+module RuboCop
+  module Shopify
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: "rubocop-shopify",
+          version: RuboCop::Shopify::VERSION,
+          homepage: "https://github.com/Shopify/rubocop-shopify",
+          description: "A plugin for RuboCop to enforce Shopify-specific coding standards."
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: File.expand_path("../../../config/default.yml", __dir__)
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/shopify/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Shopify
+    VERSION = "3.0.0"
+  end
+end

data/lib/rubocop-shopify.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "rubocop/shopify/version"
+require "rubocop/shopify/plugin"
+
+require "rubocop/cop/lint/no_return_in_memoization"