rubocop-magic_numbers 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12fab74132b62ca4cf123a33001e1eadc3f47b6a52c9599881b9b1cdf09861c0
-  data.tar.gz: b9e7dfba1c5fca384d64a82f77ea220393613bd594db4e60e734de29d50a4c7d
+  metadata.gz: ea6ef829ef5402bdcd314250492b87a6f734d7633c54531cfa779689b690b851
+  data.tar.gz: b59bc49fb9783017ae9aa7999984d474779b215df32ac20da1bcafdcb60ade76
 SHA512:
-  metadata.gz: 01fa64c0680e19aa431490ccc976574c56f30f5a26b20776d292e2ba01f22c481c6072e2a465dae1fccdc64d7c23653308dd550295607102160e9f4973d806cc
-  data.tar.gz: 4f6875eb58bcfcde76128da2709d7f215e986ce8a9c0c6013dc10428e1eddec0b14060b7eb8207a8f3ff0cb5fb2423b07e4f51c32409e301ddef835830c92553
+  metadata.gz: 15ca87f92adc73951779988d2a75f06ed141fe15dbde2959cfb690a70dff4addc7e5839d68745f490d715fdd73ed581390c7121f599f8c22f00220aede4eecb3
+  data.tar.gz: 7559121922795e3c71a9db0b975b83267bbe16f2aac43d1d9cb79e112235fe4ef7ae3387dc5aea1690232efc17747e84ffe2a4be77d5feb058cb0fc546f5a5a2

data/README.md

@@ -40,7 +40,74 @@ $ bundle install
 
 ## Usage
 
-After installing the gem, `rubocop` should automatically detect and raise offenses for magic numbers within your code. You can customize the behavior of the gem by adding configurations to a `.rubocop.yml` file in your project's root directory.
+After installing the gem, `rubocop` should automatically detect and raise offenses for magic numbers within your code.
+
+The gem will detect offenses of the following sorts:
+
+### MagicNumbers/NoArgument
+
+Detects when magic numbers are used as method arguments.
+
+``` ruby
+# BAD
+@user.too_many_widgets?(20) # what does 20 mean?!
+
+# GOOD
+@user.too_many_widgets?(FREE_SUBSCRIPTION_WIDGET_MAX)
+
+# BAD
+monthly_average = total / 28 # why 28?
+
+# GOOD
+monthly_average = total / FOUR_WEEK_MONTH_IN_DAYS
+```
+
+### MagicNumbers/NoAssignment
+
+``` ruby
+# BAD
+total_widget_limit = 20 # why 20?
+
+# GOOD
+total_widget_limit = FREE_SUBSCRIPTION_WIDGET_MAX
+```
+
+### MagicNumbers/NoDefault
+
+
+``` ruby
+# BAD
+def over_widget_limit?(20)
+  # ...
+end
+
+# GOOD
+def over_widget_limit?(FREE_SUBSCRIPTION_WIDGET_MAX)
+  # ...
+end
+```
+
+
+### MagicNumbers/NoReturn
+
+
+``` ruby
+# BAD
+def widget_limit_for_user(user)
+  return 20 if user.subscription_free?
+
+  return 40
+end
+
+# GOOD
+def widget_limit_for_user(user)
+  return FREE_SUBSCRIPTION_WIDGET_MAX if user.subscription_free?
+
+  PAID_SUBSCRIPTION_WIDGET_MAX
+end
+```
+
+You can customize the behavior of the gem by adding configurations to a `.rubocop.yml` file in your project's root directory.
 
 Here are some examples of configurations you can use:
 
@@ -48,8 +115,22 @@ Here are some examples of configurations you can use:
 require:
   - rubocop-magic_numbers
 
-# TODO
-# define configs here
+MagicNumbers/NoArgument:
+  ForbiddenNumerics: All/Float/Integer # default All
+  IgnoredMethods:
+    - '[]' # defaults to just the #[] method
+  PermittedValues: # defaults to []
+    - -1
+    - 1
+MagicNumbers/NoAssignment:
+  ForbiddenNumerics: All/Float/Integer # default All
+
+MagicNumbers/Default:
+  ForbiddenNumerics: All/Float/Integer # default All
+
+MagicNumbers/NoReturn:
+  AllowedReturns: Implicit/Explicit/None # default None
+  ForbiddenNumerics: All/Float/Integer # default All
 ```
 
 For more information on configuring `rubocop`, please refer to the [official documentation](https://docs.rubocop.org/rubocop/configuration.html).

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

@@ -2,16 +2,17 @@
 
 require 'rubocop'
 require 'rubocop/cop/cop'
+# rubocop:disable Lint/SuppressedException
+# This is only available in newer versions of the RuboCop gem
 begin
   require 'rubocop/cop/base'
 rescue LoadError
 end
+# rubocop:enable Lint/SuppressedException
 
 module RuboCop
   module Cop
-    module MagicNumbers
-      # Base class for all shared behaviour between these cops
-
+    module MagicNumbers # rubocop:disable Style/Documentation
       def self.best_base_class
         if ::RuboCop::Cop.const_defined?('Base')
           ::RuboCop::Cop::Base
@@ -20,6 +21,7 @@ module RuboCop
         end
       end
 
+      # Base class for all shared behaviour between these cops
       class Base < best_base_class
         CONFIG_ALL = 'All'
         CONFIG_FLOAT = 'Float'

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

@@ -18,9 +18,9 @@ module RuboCop
             {
               _
               _
-              (%<illegal_scalar_pattern>s _)
+              (%<illegal_scalar_pattern>s $_)
               | # This is a union of lhs and rhs literal
-              (%<illegal_scalar_pattern>s _)
+              (%<illegal_scalar_pattern>s $_)
               _
               _
             }
@@ -62,13 +62,18 @@ module RuboCop
         end
 
         def illegal_argument?(node)
-          node_matches_pattern?(
+          captured_value = node_matches_pattern?(
             node:,
             pattern: format(
               MAGIC_NUMBER_ARGUMENT_PATTERN,
               illegal_scalar_pattern:
             )
           )
+          captured_value && !permitted_values.include?(captured_value)
+        end
+
+        def permitted_values
+          Array(cop_config['PermittedValues'])
         end
       end
     end

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

@@ -35,7 +35,6 @@ module RuboCop
 
           add_offense(
             node,
-
             message: DEFAULT_OPTIONAL_ARGUMENT_MSG
           )
         end

data/lib/rubocop/magic_numbers/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module MagicNumbers
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/rubocop-magic_numbers.rb

@@ -1 +1,3 @@
-require 'rubocop/magic_numbers'
+# frozen_string_literal: true
+
+require 'rubocop/magic_numbers'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-magic_numbers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gavin Morrice
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser