rubocop-magic_numbers 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4db321fec029b7e924bda74c35c9f9dcfdd902173d31965fad3ca07507ef606b
-  data.tar.gz: f477370605f885adfd7a1353a6065c637226ff4b637001546b4b2e4109787bde
+  metadata.gz: ea6ef829ef5402bdcd314250492b87a6f734d7633c54531cfa779689b690b851
+  data.tar.gz: b59bc49fb9783017ae9aa7999984d474779b215df32ac20da1bcafdcb60ade76
 SHA512:
-  metadata.gz: 408cb1f1488a6e57063a57b7422dc74145334c3c296e7d3dd129e1e7447c5e309df13040b7aae1d258294b21026e81ff586e4c9754f7af2be31b916343690a10
-  data.tar.gz: 4020f1a2891c85d1f0ed3c13acffb47e10a3213d073335d907a1d53f2faeaf912b631a80b332a443b3e2e6fc8da93f54a6958ca5e72590c34dd66d2ef00bcf50
+  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

@@ -1,12 +1,28 @@
 # frozen_string_literal: true
 
+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
+    module MagicNumbers # rubocop:disable Style/Documentation
+      def self.best_base_class
+        if ::RuboCop::Cop.const_defined?('Base')
+          ::RuboCop::Cop::Base
+        else
+          ::RuboCop::Cop::Cop
+        end
+      end
+
       # Base class for all shared behaviour between these cops
-      class Base < ::RuboCop::Cop::Cop
+      class Base < best_base_class
         CONFIG_ALL = 'All'
         CONFIG_FLOAT = 'Float'
         CONFIG_INTEGER = 'Integer'

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

@@ -12,15 +12,15 @@ module RuboCop
       #
       # GOOD:
       # object.bottles_on_the_wall(DEFAULT_BOTTLE_COUNT)
-      class NoArgument < Base
+      class NoArgument < RuboCop::Cop::MagicNumbers::Base
         MAGIC_NUMBER_ARGUMENT_PATTERN = <<-PATTERN
           (send
             {
               _
               _
-              (%<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 $_)
               _
               _
             }
@@ -38,14 +38,14 @@ module RuboCop
         }.freeze
 
         def cop_config
-          super.merge(DEFAULT_CONFIG)
+          DEFAULT_CONFIG.merge(super)
         end
 
         def on_message_send(node)
           return unless illegal_argument?(node)
           return if ignored_method?(node)
 
-          add_offense(node, location: :expression, message: ARGUMENT_MSG)
+          add_offense(node, message: ARGUMENT_MSG)
         end
         alias on_send on_message_send # rubocop API method name
 
@@ -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_assignment.rb

@@ -12,7 +12,7 @@ module RuboCop
       # bad: hours = 24
       #
       # good: HOURS_IN_ONE_DAY = 24
-      class NoAssignment < Base
+      class NoAssignment < RuboCop::Cop::MagicNumbers::Base
         MAGIC_NUMBER_ARGUMENT_TO_SETTER_PATTERN = <<-PATTERN
           (send
             ({send self} ...)
@@ -43,7 +43,7 @@ module RuboCop
           return unless illegal_scalar_value?(node)
           return unless node_within_method?(node)
 
-          add_offense(node, location: :expression, message: LOCAL_VARIABLE_ASSIGN_MSG)
+          add_offense(node, message: LOCAL_VARIABLE_ASSIGN_MSG)
         end
         alias on_lvasgn on_local_variable_assignment # rubocop API method name
 
@@ -51,7 +51,7 @@ module RuboCop
           return unless illegal_scalar_value?(node)
           return unless node_within_method?(node)
 
-          add_offense(node, location: :expression, message: INSTANCE_VARIABLE_ASSIGN_MSG)
+          add_offense(node, message: INSTANCE_VARIABLE_ASSIGN_MSG)
         end
         alias on_ivasgn on_instance_variable_assignment # rubocop API method name
 
@@ -59,7 +59,7 @@ module RuboCop
           return unless illegal_scalar_argument_to_setter?(node)
           return unless node_within_method?(node)
 
-          add_offense(node, location: :expression, message: PROPERTY_MSG)
+          add_offense(node, message: PROPERTY_MSG)
         end
         alias on_send on_message_send # rubocop API method name
 
@@ -69,7 +69,7 @@ module RuboCop
           # numbers amongst their assignments
           return false unless illegal_multi_assign_right_hand_side?(node)
 
-          add_offense(node, location: :expression, message: MULTIPLE_ASSIGN_MSG)
+          add_offense(node, message: MULTIPLE_ASSIGN_MSG)
         end
         alias on_masgn on_multiple_assign
 

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

@@ -13,7 +13,7 @@ module RuboCop
       #
       # GOOD
       # def on_the_wall(bottles = DEFAULT_BOTTLE_COUNT)
-      class NoDefault < Base
+      class NoDefault < RuboCop::Cop::MagicNumbers::Base
         MAGIC_NUMBER_OPTIONAL_ARGUMENT_PATTERN = <<-PATTERN
           (def
             _
@@ -35,7 +35,6 @@ module RuboCop
 
           add_offense(
             node,
-            location: :expression,
             message: DEFAULT_OPTIONAL_ARGUMENT_MSG
           )
         end

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

@@ -7,7 +7,7 @@ module RuboCop
     module MagicNumbers
       # Raises an offense if a method returns with a magic number
       # Catches both explicit and implicit returns
-      class NoReturn < Base
+      class NoReturn < RuboCop::Cop::MagicNumbers::Base
         MAGIC_NUMBER_RETURN_PATTERN = <<~PATTERN.chomp
           (%<illegal_scalar_pattern>s _)
         PATTERN
@@ -32,7 +32,7 @@ module RuboCop
           return if allowed_returns.include?(RETURN_TYPE_IMPLICIT)
           return unless implicit_return?(node.children.last)
 
-          add_offense(node.children.last, location: :expression, message: NO_EXPLICIT_RETURN_MSG)
+          add_offense(node.children.last, message: NO_EXPLICIT_RETURN_MSG)
         end
         alias on_def on_method_defined
 
@@ -40,7 +40,7 @@ module RuboCop
           return if allowed_returns.include?(RETURN_TYPE_EXPLICIT)
           return unless forbidden_numerics.include?(node.children.first&.type)
 
-          add_offense(node.children.first, location: :expression, message: NO_EXPLICIT_RETURN_MSG)
+          add_offense(node.children.first, message: NO_EXPLICIT_RETURN_MSG)
         end
 
         private

data/lib/rubocop/magic_numbers/version.rb

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

data/lib/rubocop-magic_numbers.rb

@@ -0,0 +1,3 @@
+# 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.1.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
@@ -49,6 +49,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/rubocop-magic_numbers.rb
 - lib/rubocop/cop/magic_numbers/base.rb
 - lib/rubocop/cop/magic_numbers/no_argument.rb
 - lib/rubocop/cop/magic_numbers/no_assignment.rb