leftovers 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36067c7870efb2d16529b0af04739161fc445c310bd5eab7b4b5ff5ccf556126
-  data.tar.gz: 5953a6893935af8ac6f1c33afad540c097515a12c4dede73261079cbbd2a561d
+  metadata.gz: f2cb691dc74d8b0d43765f899ea718a4d06c1ba8fa36ea3a68c44ece27531920
+  data.tar.gz: e24ade3f01a888de2e9438736d71b0e4f2d159a6783b3278e8ec7e58e7c8c626
 SHA512:
-  metadata.gz: 70b0cd0d8f3caa5f14282b36bf7f3776a1b0396485a7cfb7fb66460fc3f287edf7ed1d8f733ce303fcb67704c8839df2bb9eb105c761f492b53e1ea575b8f685
-  data.tar.gz: f43bf9b235fcc43dfdf0d322037523f659214d35387ad788dc5f2c8453a74ef74861db6cca91dc9ae159f8122edcf2fbb6adb9fa107b69e74a753b4e4d286d42
+  metadata.gz: a734ec1916762c5bc51fc212bfc254eb3d4083c968e6bcd128aa0c10ee9085762c6edbd86eb8afd3dd17ac5fa8b883d343bf34df3a3caaea1b84db5bc720bfaa
+  data.tar.gz: 7b80b90518a6a3e45aa3739394c18f4c7884ea07d75021dc919c62d23d6d110714c9969ab78b8078d6c219bfd9289a821bb4b828bc4e248a82a63f235cb7758f

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.10.0
+- Fixed an issue with t.belongs_to (within the migration generated by rails active_storage:install - thanks @veganstraightedge)
+  - this was two issues:
+    1. it was raising an error because the DefinitionNode didn't act enough like an AST::Node, now it does
+    2. this should never have been defining anything anyway as the activerecord method was being assumed to be used, now if there's an explicit receiver for belongs_to/has_many etc, don't consider them the active record association methods.
+
+- now `has_receiver: true` and `has_receiver: false/nil` act differently, they refer to the presence or absence of any receiver, instead of the receiver being literally true or false or nil.
+- to have the previous behaviour, use the new `has_receiver: { literal: true }` or `literal: false` or `literal: null`
+
 # v0.9.0
 - Automatically test the config examples in the documentation, and fix the errors
 - simplify the `type: Proc` matcher

data/docs/Configuration.md

@@ -504,7 +504,7 @@ and when used in:
 
 It can have any of these properties:
 - [`at:`](#at)
-- [`has_value:`](#has_value_has_receiver)
+- [`has_value:`](#has_value)
 
 Arrays are not necessary for single values and if the rule contains only `at:` it can be omitted, and the values moved up a level.
 
@@ -522,7 +522,7 @@ The method call/constant variable/assignment will be considered matching if it h
 
 It can have any of these properties:
 - [`at:`](#at)
-- [`has_value:`](#has_value_has_receiver)
+- [`has_value:`](#has_value)
 
 Arrays are not necessary for single values and if the rule contains only `at:` it can be omitted, and the values moved up a level
 
@@ -603,9 +603,9 @@ dynamic:
 will match the first argument of anything named my_method or with the receiver MyReceiver, that have both the keyword arguments part_a and part_b
 
 
-## `has_value:`, `has_receiver:`
+## `has_value:`
 
-filter [`arguments:`](#arguments), [`has_arguments:`](#has_arguments), and [`keywords:`](#keywords), by the argument/assigned/receiver value
+filter [`arguments:`](#arguments), [`has_arguments:`](#has_arguments), and [`keywords:`](#keywords), by the argument/assigned value
 
 Each entry can be one of
 - `true`, `false`, `nil`, or an Integer. matches the literal value
@@ -616,11 +616,33 @@ Each entry can be one of
   - [`matches:`](#matches)
 - or have at least one of the following properties to match within an array or hash:
   - [`at`](#at)
-  - [`has_value`](#has_value_has_receiver)
+  - [`has_value`](#has_value)
 - or have the following property to match the value type
   - [`type`](#type)
 - or have the following property to match the receiver
-  - [`has_receiver`](#has_value_has_receiver)
+  - [`has_receiver`](#has_receiver)
+
+## `has_receiver:`
+
+filter [`dynamic:`](#dynamic), and [`keep:`](#keep), by the receiver presence or value
+
+Each entry can be one of
+- `true`, `false`, matches the presence of any receiver or not
+- an Integer. matches the literal value
+- a String. matches the literal string or symbol value
+- or have at least one of the following properties to match the name:
+  - [`has_prefix:`](#has_prefix)
+  - [`has_suffix:`](#has_suffix)
+  - [`matches:`](#matches)
+- or have at least one of the following properties to match the literal value or match within an array or hash:
+  - [`at`](#at)
+  - [`has_value`](#has_value)
+- or have the following property to match the value type
+  - [`type`](#type)
+- or have the following property to match the receiver of the receiver
+  - [`has_receiver`](#has_receiver)
+- or have the following property to match a literal true, false, or nil value:
+  - `literal: true`, or `literal: false`, or `literal: nil`
 
 ## `privacy:`
 

data/lib/config/activerecord.yml

@@ -88,6 +88,8 @@ dynamic:
 
   # https://edgeapi.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html
   - name: has_one
+    unless:
+      has_receiver: true
     defines:
       argument: 0
       transforms:
@@ -100,6 +102,8 @@ dynamic:
 
   - name: belongs_to
     has_argument: polymorphic
+    unless:
+      has_receiver: true
     defines:
       argument: 0
       transforms:
@@ -111,7 +115,9 @@ dynamic:
 
   - name: belongs_to
     unless:
-      has_argument: polymorphic
+      any:
+        - has_argument: polymorphic
+        - has_receiver: true
     defines:
       argument: 0
       transforms:
@@ -125,6 +131,8 @@ dynamic:
         - add_suffix: _previously_changed?
 
   - name: [has_and_belongs_to_many, has_many]
+    unless:
+      has_receiver: true
     defines:
       argument: 0
       transforms:
@@ -139,7 +147,9 @@ dynamic:
     - has_one
     - belongs_to
     unless:
-      has_argument: [class_name, polymorphic]
+      any:
+        - has_argument: [class_name, polymorphic]
+        - has_receiver: true
     calls:
       argument: 0
       camelize: true
@@ -149,7 +159,9 @@ dynamic:
     - has_many
     - has_and_belongs_to_many
     unless:
-      has_argument: [class_name, polymorphic]
+      any:
+        - has_argument: [class_name, polymorphic]
+        - has_receiver: true
     calls:
       - argument: 0
         camelize: true
@@ -174,9 +186,11 @@ dynamic:
 
   - name: belongs_to
     unless:
-      has_argument:
-        at: optional
-        has_value: true
+      any:
+        - has_argument:
+            at: optional
+            has_value: true
+        - has_receiver: true
     calls:
       argument: 0
 
@@ -185,6 +199,8 @@ dynamic:
      - has_many
      - belongs_to
      - has_and_belongs_to_many
+    unless:
+      has_receiver: true
     calls:
       - argument: class_name
         split: '::'
@@ -193,6 +209,8 @@ dynamic:
         add_suffix: '='
 
   - name: belongs_to
+    unless:
+      has_receiver: true
     calls:
       argument: ensuring_owner_was
 
@@ -202,6 +220,8 @@ dynamic:
      - has_many
      - belongs_to
      - has_and_belongs_to_many
+    unless:
+      has_receiver: true
     has_argument:
       at:
         - dependent
@@ -219,6 +239,8 @@ dynamic:
       argument: 0
 
   - name: [has_one, has_many, belongs_to, has_and_belongs_to_many]
+    unless:
+      has_receiver: true
     calls:
       argument: [before_add, after_add, before_remove, after_remove]
       nested: '*'

data/lib/leftovers/config_loader/has_receiver_schema.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Leftovers
+  class ConfigLoader
+    class HasReceiverSchema < ValueOrObjectSchema
+      inherit_attributes_from HasValueSchema, except: :unless
+
+      attribute :literal, ValueOrArraySchema[ScalarValueSchema],
+                require_group: :matcher
+      attribute :unless, ValueOrArraySchema[HasReceiverSchema], require_group: :matcher
+
+      self.or_value_schema = ScalarValueSchema
+    end
+  end
+end

data/lib/leftovers/config_loader/has_value_schema.rb

@@ -12,7 +12,7 @@ module Leftovers
       attribute :at, ValueOrArraySchema[ArgumentPositionSchema], require_group: :matcher
       attribute :has_value, ValueOrArraySchema[HasValueSchema], require_group: :matcher
 
-      attribute :has_receiver, ValueOrArraySchema[HasValueSchema], require_group: :matcher
+      attribute :has_receiver, ValueOrArraySchema[HasReceiverSchema], require_group: :matcher
       attribute :type, ValueOrArraySchema[ValueTypeSchema], require_group: :matcher
       attribute :unless, ValueOrArraySchema[HasValueSchema], require_group: :matcher
 

data/lib/leftovers/config_loader/rule_pattern_schema.rb

@@ -9,7 +9,7 @@ module Leftovers
       attribute :document, TrueSchema, require_group: :matcher
       attribute :has_arguments, ValueOrArraySchema[HasArgumentSchema], aliases: :has_argument,
         require_group: :matcher
-      attribute :has_receiver, ValueOrArraySchema[HasValueSchema], require_group: :matcher
+      attribute :has_receiver, ValueOrArraySchema[HasReceiverSchema], require_group: :matcher
       attribute :type, ValueOrArraySchema[ValueTypeSchema], require_group: :matcher
       attribute :privacy, ValueOrArraySchema[PrivacySchema], require_group: :matcher
       attribute :unless, ValueOrArraySchema[RulePatternSchema], require_group: :matcher

data/lib/leftovers/config_loader/value_matcher_condition_schema.rb

@@ -4,7 +4,7 @@ module Leftovers
   class ConfigLoader
     class ValueMatcherConditionSchema < ObjectSchema
       attribute :has_arguments, ValueOrArraySchema[HasArgumentSchema], aliases: :has_argument
-      attribute :has_receiver, ValueOrArraySchema[HasValueSchema]
+      attribute :has_receiver, ValueOrArraySchema[HasReceiverSchema]
       attribute :unless, ValueOrArraySchema[ValueMatcherConditionSchema]
       attribute :all, ArraySchema[ValueMatcherConditionSchema]
       attribute :any, ArraySchema[ValueMatcherConditionSchema]

data/lib/leftovers/config_loader.rb

@@ -13,6 +13,7 @@ module Leftovers
     autoload(:DynamicSchema, "#{__dir__}/config_loader/dynamic_schema")
     autoload(:HasArgumentSchema, "#{__dir__}/config_loader/has_argument_schema")
     autoload(:HasValueSchema, "#{__dir__}/config_loader/has_value_schema")
+    autoload(:HasReceiverSchema, "#{__dir__}/config_loader/has_receiver_schema")
     autoload(:InheritSchemaAttributes, "#{__dir__}/config_loader/inherit_schema_attributes")
     autoload(:KeepTestOnlySchema, "#{__dir__}/config_loader/keep_test_only_schema")
     autoload(:KeywordArgumentSchema, "#{__dir__}/config_loader/keyword_argument_schema")

data/lib/leftovers/definition_node.rb

@@ -1,25 +1,19 @@
 # frozen-string-literal: true
 
 module Leftovers
-  class DefinitionNode
-    attr_reader :name, :loc, :node
+  class DefinitionNode < ::Leftovers::AST::Node
+    attr_reader :name, :path
+    alias_method :to_sym, :name
 
     def initialize(node, name:, location: node.loc.expression)
-      @node = node
       @name = name
-      @loc = location
+      @path = node.path
+      @location = location
+      super(:leftovers_definition)
     end
 
-    def kwargs
-      nil
-    end
-
-    def positional_arguments
-      nil
-    end
-
-    def path
-      node.path
+    def to_s
+      name.to_s
     end
   end
 end

data/lib/leftovers/matcher_builders/node_has_receiver.rb

@@ -4,10 +4,19 @@ module Leftovers
   module MatcherBuilders
     module NodeHasReceiver
       class << self
-        def build(pattern)
-          matcher = ::Leftovers::MatcherBuilders::NodeValue.build(pattern)
+        def build(pattern) # rubocop:disable Metrics/MethodLength
+          case pattern
+          when true
+            ::Leftovers::Matchers::NodeHasAnyReceiver
+          when false, :_leftovers_nil_value
+            ::Leftovers::Matchers::Not.new(
+              ::Leftovers::Matchers::NodeHasAnyReceiver
+            )
+          else
+            matcher = ::Leftovers::MatcherBuilders::NodeValue.build(pattern)
 
-          ::Leftovers::Matchers::NodeHasReceiver.new(matcher) if matcher
+            ::Leftovers::Matchers::NodeHasReceiver.new(matcher) if matcher
+          end
         end
       end
     end

data/lib/leftovers/matcher_builders/node_value.rb

@@ -53,6 +53,7 @@ module Leftovers
           names: nil, match: nil, has_prefix: nil, has_suffix: nil,
           type: nil,
           has_receiver: nil,
+          literal: nil,
           unless_arg: nil
         )
           ::Leftovers::MatcherBuilders::And.build([
@@ -60,6 +61,7 @@ module Leftovers
             build_node_name_matcher(names, match, has_prefix, has_suffix),
             ::Leftovers::MatcherBuilders::NodeType.build(type),
             ::Leftovers::MatcherBuilders::NodeHasReceiver.build(has_receiver),
+            ::Leftovers::MatcherBuilders::NodeValue.build(literal),
             build_unless(unless_arg)
           ])
         end

data/lib/leftovers/matchers/node_has_any_receiver.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Leftovers
+  module Matchers
+    module NodeHasAnyReceiver
+      def self.===(node)
+        node.receiver
+      end
+
+      freeze
+    end
+  end
+end

data/lib/leftovers/matchers.rb

@@ -10,6 +10,7 @@ module Leftovers
       :NodeHasAnyPositionalArgumentWithValue,
       "#{__dir__}/matchers/node_has_any_positional_argument_with_value"
     )
+    autoload(:NodeHasAnyReceiver, "#{__dir__}/matchers/node_has_any_receiver")
     autoload(
       :NodeHasPositionalArgumentWithValue,
       "#{__dir__}/matchers/node_has_positional_argument_with_value"

data/lib/leftovers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Leftovers
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leftovers
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-15 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -409,6 +409,7 @@ files:
 - lib/leftovers/config_loader/document_schema.rb
 - lib/leftovers/config_loader/dynamic_schema.rb
 - lib/leftovers/config_loader/has_argument_schema.rb
+- lib/leftovers/config_loader/has_receiver_schema.rb
 - lib/leftovers/config_loader/has_value_schema.rb
 - lib/leftovers/config_loader/inherit_schema_attributes.rb
 - lib/leftovers/config_loader/keep_test_only_schema.rb
@@ -477,6 +478,7 @@ files:
 - lib/leftovers/matchers/any.rb
 - lib/leftovers/matchers/node_has_any_keyword_argument.rb
 - lib/leftovers/matchers/node_has_any_positional_argument_with_value.rb
+- lib/leftovers/matchers/node_has_any_receiver.rb
 - lib/leftovers/matchers/node_has_positional_argument.rb
 - lib/leftovers/matchers/node_has_positional_argument_with_value.rb
 - lib/leftovers/matchers/node_has_receiver.rb
@@ -586,7 +588,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubyforge_project:
+rubygems_version: 2.7.6
 signing_key:
 specification_version: 4
 summary: Find unused methods and classes/modules