rubocop-magic_numbers 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea6ef829ef5402bdcd314250492b87a6f734d7633c54531cfa779689b690b851
-  data.tar.gz: b59bc49fb9783017ae9aa7999984d474779b215df32ac20da1bcafdcb60ade76
+  metadata.gz: e50541096764d84680fd5253e6233a4ed8ef80250a6cb416a0431c3bd194ce66
+  data.tar.gz: 0e85a4951ca5c75ba6d097950e14bc42591eb27167a04f2d723f2093b7ffc066
 SHA512:
-  metadata.gz: 15ca87f92adc73951779988d2a75f06ed141fe15dbde2959cfb690a70dff4addc7e5839d68745f490d715fdd73ed581390c7121f599f8c22f00220aede4eecb3
-  data.tar.gz: 7559121922795e3c71a9db0b975b83267bbe16f2aac43d1d9cb79e112235fe4ef7ae3387dc5aea1690232efc17747e84ffe2a4be77d5feb058cb0fc546f5a5a2
+  metadata.gz: 6cbbc1083814d6ec1ebdcb632e6fd34d283fbea606509640382fb79e5fbdaad27a8c90daf8db7588781be54251378a05489aebdbc26c6862f82686e27ebd8f31
+  data.tar.gz: 2d707528dbe8d168ddd09838b6ca5906232a70951921744c76ae6f30fd432b3f7d7c8870ebefce5b8f8becb4e506a977cb837260d84ad4dd89fadf28270e8996

data/README.md

@@ -1,7 +1,7 @@
 # rubocop-magic_numbers
 
-![Ruby tests](https://github.com/bodacious/rubocop-magic_numbers/actions/workflows/ruby.yml/badge.svg)
-![RuboCop Lint](https://github.com/bodacious/rubocop-magic_numbers/actions/workflows/rubocop.yml/badge.svg)
+![Ruby tests](https://github.com/meetcleo/rubocop-magic_numbers/actions/workflows/ruby.yml/badge.svg)
+![RuboCop Lint](https://github.com/meetcleo/rubocop-magic_numbers/actions/workflows/rubocop.yml/badge.svg)
 
 
 `rubocop-magic_numbers` is a gem that detects the use of magic numbers within Ruby code and raises them as offenses.
@@ -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,10 +134,35 @@ 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/bodacious/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.
+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.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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

@@ -63,10 +63,10 @@ module RuboCop
 
         def illegal_argument?(node)
           captured_value = node_matches_pattern?(
-            node:,
+            node: node,
             pattern: format(
               MAGIC_NUMBER_ARGUMENT_PATTERN,
-              illegal_scalar_pattern:
+              illegal_scalar_pattern: illegal_scalar_pattern
             )
           )
           captured_value && !permitted_values.include?(captured_value)

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

@@ -77,10 +77,10 @@ module RuboCop
 
         def illegal_scalar_argument_to_setter?(node)
           method = node_matches_pattern?(
-            node:,
+            node: node,
             pattern: format(
               MAGIC_NUMBER_ARGUMENT_TO_SETTER_PATTERN,
-              illegal_scalar_pattern:
+              illegal_scalar_pattern: illegal_scalar_pattern
             )
           )
 
@@ -89,10 +89,10 @@ module RuboCop
 
         def illegal_multi_assign_right_hand_side?(node)
           node_matches_pattern?(
-            node:,
+            node: node,
             pattern: format(
               MAGIC_NUMBER_MULTI_ASSIGN_PATTERN,
-              illegal_scalar_pattern:
+              illegal_scalar_pattern: illegal_scalar_pattern
             )
           )
         end

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

@@ -44,10 +44,10 @@ module RuboCop
 
         def illegal_positional_default?(node)
           node_matches_pattern?(
-            node:,
+            node: node,
             pattern: format(
               MAGIC_NUMBER_OPTIONAL_ARGUMENT_PATTERN,
-              illegal_scalar_pattern:
+              illegal_scalar_pattern: illegal_scalar_pattern
             )
           )
         end

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
@@ -54,9 +58,13 @@ module RuboCop
           return implicit_return?(node.children.last) if is_node_begin_type
 
           pattern = format(MAGIC_NUMBER_RETURN_PATTERN, {
-                             illegal_scalar_pattern:
+                             illegal_scalar_pattern: illegal_scalar_pattern
                            })
-          node_matches_pattern?(node:, pattern:)
+          node_matches_pattern?(node: node, pattern: pattern)
+        end
+
+        def permitted_return_values
+          Array(cop_config['PermittedReturnValues'])
         end
       end
     end

data/lib/rubocop/magic_numbers/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module MagicNumbers
-    VERSION = '0.3.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.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Gavin Morrice
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-29 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -70,7 +70,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="