rubocop-magic_numbers 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5510596fa8384cbcc426de2aed19efdd8f4546b59b71f491b97d8627402a0ddf
-  data.tar.gz: 5da082fc1d7238202e13afcfefc5238c3c9ec289024c557716d5c2a8cbe5bde4
+  metadata.gz: 8c524463c1bd7ab5a180f5063ee27deceac29fdf0bfe9d682b03ce1f6f8a992d
+  data.tar.gz: ca98482dc543d684dad741da511de7f873ae83dd2ae714fb5115b112855b412c
 SHA512:
-  metadata.gz: b213bcb1d47aa8beae76f257adcd2e1d143155058551cd6b3ddf29117485cadbd2dc6dacb82be15cc77e517d2e7772d5187c2a8999185d7b97c7a654312a35a9
-  data.tar.gz: 6c2e696179b59f5c63aacb1150306210c94e6022f835355cdcdc607667189890d7ab510a75af8580aea93d3a2e2b3917664adb3363d50bac8ae5163bc3f47104
+  metadata.gz: 421a00bdfe1b50f2ac56d4759577dd8f77967a3a24a2111bb901563ec09fee149dc2e64cd45661ea8761ac0c8f9594ecd2e7f82aaddd78f3136651601dee7632
+  data.tar.gz: 177fca60d9af08b2d409bc1e5018f9a9d4f7a3995fc4d04fe2e9efeafa0a9ccd2863ece0b90ce8a9ddcf078f1cb8bd1a251f8ff99ff870377f21d1903ee1a7b5

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
 
 
@@ -124,8 +123,12 @@ MagicNumbers/NoArgument:
     - 1
 MagicNumbers/NoAssignment:
   ForbiddenNumerics: All/Float/Integer # default All
+  PermittedValues: # defaults to []
+    - 0
+    - 1
+    - 3.14
 
-MagicNumbers/Default:
+MagicNumbers/NoDefault:
   ForbiddenNumerics: All/Float/Integer # default All
 
 MagicNumbers/NoReturn:
@@ -133,8 +136,52 @@ MagicNumbers/NoReturn:
   ForbiddenNumerics: All/Float/Integer # default All
 ```
 
+`MagicNumbers/NoAssignment` can be configured with `PermittedValues` when some
+assigned values do not need the same explanation as other numeric values. This
+allows configured values in local variable, instance variable, property, and
+multiple assignments. Unpermitted magic numbers are still detected:
+
+```ruby
+# Allowed when MagicNumbers/NoAssignment permits 0 and 1
+count = 0
+@total = 1
+first, second = 0, 1
+
+# Still detected as an offense
+retry_limit = 3
+first, second = 2
+first, second = 0, 2
+first, second = 2, 0
+first, second = 2, 3
+```
+
 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_assignment.rb

@@ -17,14 +17,17 @@ module RuboCop
           (send
             ({send self} ...)
             $_
-            (%<illegal_scalar_pattern>s _)
+            $(%<illegal_scalar_pattern>s _)
           )
         PATTERN
 
         MAGIC_NUMBER_MULTI_ASSIGN_PATTERN = <<-PATTERN
           (masgn
             (mlhs ({lvasgn ivasgn send} ...)+)
-            (array <(%<illegal_scalar_pattern>s _) ...>)
+            {
+              $(%<illegal_scalar_pattern>s _)
+              $(array <(%<illegal_scalar_pattern>s _) ...>)
+            }
           )
         PATTERN
         LOCAL_VARIABLE_ASSIGN_MSG = 'Do not use magic number local variables'
@@ -32,7 +35,8 @@ module RuboCop
         MULTIPLE_ASSIGN_MSG = 'Do not use magic numbers in multiple assignments'
         PROPERTY_MSG = 'Do not use magic numbers to set properties'
         DEFAULT_CONFIG = {
-          'AllowedAssignments' => %w[class_variables global_variables]
+          'AllowedAssignments' => %w[class_variables global_variables],
+          'PermittedValues' => []
         }.freeze
 
         def cop_config
@@ -76,7 +80,7 @@ module RuboCop
         private
 
         def illegal_scalar_argument_to_setter?(node)
-          method = node_matches_pattern?(
+          method, value = node_matches_pattern?(
             node: node,
             pattern: format(
               MAGIC_NUMBER_ARGUMENT_TO_SETTER_PATTERN,
@@ -84,17 +88,19 @@ module RuboCop
             )
           )
 
-          method&.end_with?('=')
+          method&.end_with?('=') && illegal_scalar_expression?(value)
         end
 
         def illegal_multi_assign_right_hand_side?(node)
-          node_matches_pattern?(
+          multiple_assignment_value = node_matches_pattern?(
             node: node,
             pattern: format(
               MAGIC_NUMBER_MULTI_ASSIGN_PATTERN,
               illegal_scalar_pattern: illegal_scalar_pattern
             )
           )
+
+          illegal_scalar_expressions(multiple_assignment_value).any?
         end
 
         def illegal_scalar_value?(node)
@@ -103,7 +109,29 @@ module RuboCop
           # multiassignment nodes contain individual assignments in their AST
           # representations, but they aren't aware of their values, so we need to
           # allow for expressionless assignments
-          forbidden_numerics.include?(node.expression&.type)
+          illegal_scalar_expression?(node.expression)
+        end
+
+        def illegal_scalar_expression?(expression)
+          return false unless expression
+          return false unless forbidden_numerics.include?(expression.type)
+
+          !permitted_value?(expression.value)
+        end
+
+        def illegal_scalar_expressions(expression)
+          return [] unless expression
+
+          expressions = expression.array_type? ? expression.children : [expression]
+          expressions.select { |child_expression| illegal_scalar_expression?(child_expression) }
+        end
+
+        def permitted_value?(value)
+          permitted_values.include?(value)
+        end
+
+        def permitted_values
+          Array(cop_config['PermittedValues'])
         end
       end
     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
@@ -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.6.0'
   end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-magic_numbers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Gavin Morrice
 - Fell Sunderland
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -62,7 +61,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -77,8 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: rubocop/magic_numbers implements a rubocop cop for detecting the use of bare
   numbers when linting