rubocop-magic_numbers 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5510596fa8384cbcc426de2aed19efdd8f4546b59b71f491b97d8627402a0ddf
-  data.tar.gz: 5da082fc1d7238202e13afcfefc5238c3c9ec289024c557716d5c2a8cbe5bde4
+  metadata.gz: e50541096764d84680fd5253e6233a4ed8ef80250a6cb416a0431c3bd194ce66
+  data.tar.gz: 0e85a4951ca5c75ba6d097950e14bc42591eb27167a04f2d723f2093b7ffc066
 SHA512:
-  metadata.gz: b213bcb1d47aa8beae76f257adcd2e1d143155058551cd6b3ddf29117485cadbd2dc6dacb82be15cc77e517d2e7772d5187c2a8999185d7b97c7a654312a35a9
-  data.tar.gz: 6c2e696179b59f5c63aacb1150306210c94e6022f835355cdcdc607667189890d7ab510a75af8580aea93d3a2e2b3917664adb3363d50bac8ae5163bc3f47104
+  metadata.gz: 6cbbc1083814d6ec1ebdcb632e6fd34d283fbea606509640382fb79e5fbdaad27a8c90daf8db7588781be54251378a05489aebdbc26c6862f82686e27ebd8f31
+  data.tar.gz: 2d707528dbe8d168ddd09838b6ca5906232a70951921744c76ae6f30fd432b3f7d7c8870ebefce5b8f8becb4e506a977cb837260d84ad4dd89fadf28270e8996

data/README.md

@@ -77,17 +77,16 @@ total_widget_limit = FREE_SUBSCRIPTION_WIDGET_MAX
 
 ``` ruby
 # BAD
-def over_widget_limit?(20)
+def over_widget_limit?(limit = 20)
   # ...
 end
 
 # GOOD
-def over_widget_limit?(FREE_SUBSCRIPTION_WIDGET_MAX)
+def over_widget_limit?(limit = FREE_SUBSCRIPTION_WIDGET_MAX)
   # ...
 end
 ```
 
-
 ### MagicNumbers/NoReturn
 
 
@@ -135,6 +134,31 @@ MagicNumbers/NoReturn:
 
 For more information on configuring `rubocop`, please refer to the [official documentation](https://docs.rubocop.org/rubocop/configuration.html).
 
+## Rails usage
+
+If using as part of a Ruby on Rails project, you may want to add the following to your RuboCop configuration:
+
+``` YAML
+MagicNumbers/NoArgument:
+  Exclude:
+    - config/application.rb
+    - db/migrate/*.rb
+```
+
+This will prevent RuboCop from complainig about Rails version numbers in your migration files and application config.
+
+``` ruby
+module Cleo
+  class Application < Rails::Application
+    config.load_defaults 7.1 # <= here
+  end
+end
+
+# If you remove `[]` from ignored methods, you might want to add this
+class AddBankCardIdToUsers < ActiveRecord::Migration[7.1]
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/meetcleo/rubocop-magic_numbers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.

data/lib/rubocop/cop/magic_numbers/no_return.rb

@@ -9,28 +9,31 @@ module RuboCop
       # Catches both explicit and implicit returns
       class NoReturn < RuboCop::Cop::MagicNumbers::Base
         MAGIC_NUMBER_RETURN_PATTERN = <<~PATTERN.chomp
-          (%<illegal_scalar_pattern>s _)
+          (%<illegal_scalar_pattern>s $_)
         PATTERN
         NO_EXPLICIT_RETURN_MSG = 'Do not return magic numbers from a method or proc'
 
         CONFIG_NAME_ALLOWED_RETURNS = 'AllowedReturns'
+        CONFIG_NAME_PERMITTED_RETURN_VALUES = 'PermittedReturnValues'
 
         RETURN_TYPE_IMPLICIT = 'Implicit'
         RETURN_TYPE_EXPLICIT = 'Explicit'
         RETURN_TYPE_NONE = 'None'
 
-        # Supported values are 'Explicit', 'Implicit', 'None'
         DEFAULT_CONFIG = {
-          CONFIG_NAME_ALLOWED_RETURNS => [RETURN_TYPE_NONE]
+          # Supported values are 'Explicit', 'Implicit', 'None'
+          CONFIG_NAME_ALLOWED_RETURNS => [RETURN_TYPE_NONE],
+          CONFIG_NAME_PERMITTED_RETURN_VALUES => []
         }.freeze
 
         def cop_config
-          super.merge(DEFAULT_CONFIG)
+          DEFAULT_CONFIG.merge(super)
         end
 
         def on_method_defined(node)
           return if allowed_returns.include?(RETURN_TYPE_IMPLICIT)
-          return unless implicit_return?(node.children.last)
+          return unless (captured_value = implicit_return?(node.children.last))
+          return if permitted_return_values.include?(captured_value)
 
           add_offense(node.children.last, message: NO_EXPLICIT_RETURN_MSG)
         end
@@ -39,6 +42,7 @@ module RuboCop
         def on_return(node)
           return if allowed_returns.include?(RETURN_TYPE_EXPLICIT)
           return unless forbidden_numerics.include?(node.children.first&.type)
+          return if permitted_return_values.include?(node.children.first&.value)
 
           add_offense(node.children.first, message: NO_EXPLICIT_RETURN_MSG)
         end
@@ -58,6 +62,10 @@ module RuboCop
                            })
           node_matches_pattern?(node: node, pattern: pattern)
         end
+
+        def permitted_return_values
+          Array(cop_config['PermittedReturnValues'])
+        end
       end
     end
   end

data/lib/rubocop/magic_numbers/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module MagicNumbers
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-magic_numbers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Gavin Morrice
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser