leftovers 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32e8f2762f7f513145ea799b64a059c7228dd7e9a4e08c2762abe92aad1370b1
-  data.tar.gz: 9134e7d5c66bcbb25bb5fba15f5b1bb661ce18972cf91e179f165af52f955662
+  metadata.gz: f27830ef42bcbcec33a78126a3b47582fa394714e1d137e802cd5ab166e35df5
+  data.tar.gz: a111ed33a8345fe8dc5d43cb92206d52cbc47a03bc8e961baee8558d677542b6
 SHA512:
-  metadata.gz: e361dc15e0a3496dadf81f91d356183631b1ad9f0b44951f976785622aa8550ccd0d8a6632064ab646a65231c4b772236cf1136b9267ceb81c59217d36bb4f78
-  data.tar.gz: d82fd190746370c9ead45a27e5a660f81aafadf58736afd644d5fafad816daa450f25eebcf30d18875b185ab7d76b3215a696ed35bb75ad33509a474cff87736
+  metadata.gz: e14c6c1b74d4c13ebcbb4d1184d50257d6aacaf05e8e6708282633f61ea1988374156880d66bb26a037bf4b67b58381246f12357bdaa99ff9248db620d94c152
+  data.tar.gz: 34e766e6ca2374858ee6da35e924287641bc4441d8f642e4d08285a0066185aa865724567b90f91de34b17f340f3f182e9b3f326c5fc63bf6abc414c0dc058b3

data/CHANGELOG.md

@@ -1,14 +1,32 @@
-# 0.6.0
+# v0.7.0
+- Rewrite the config parser/validation
+  - to provide clearer error messages with line numbers and everything
+  - to allow removing the json_schemer dependency with its 4 further dependencies
+- Allow `match:` to be used with `has_prefix:` and/or `has_suffix:`. There's not a good use for this but it was easier than encoding 'this can't be used with that' logic especially for it.
+- Add the possibility to quiet the `requires:` config, like:
+  ```yml
+  requires:
+  - 'active_support/inflections'
+  - quiet: './config/initializers/inflections'
+  ```
+- consider all the public methods in rails custom generators to be used, this required some new features:
+  - add filtering methods/constants by public/protected/private
+  - add the possibility to set the privacy of methods and constants with method calls (`set_privacy:`, and `set_default_privacy:`)
+  - add `Method` and `Constant` as options for the `type:` filter
+  - add type filtering to dynamic.
+- check `def self.whatever` as a definition, i didn't realise i wasn't checking this.
+
+# v0.6.0
 - drop ruby 2.4 support, allowing for some performance improvements
 - Add ability to parse JSON and YAML files
 - Add magic comment that points to a particular dynamic rule
 - repeated calls to --write-todo won't have ordering differences
 - fix issue with --write-todo and unused methods defined in test files
 
-# 0.5.5
+# v0.5.5
 - Fix rails resource/resources method signatures
 
-# 0.5.4
+# v0.5.4
 - Add support for slim templates #13 - thanks @veganstraightedge
 - fix the #how-to-resolve link #11 - thanks @veganstraightedge
 

data/docs/Configuration.md

@@ -59,12 +59,17 @@ List filenames/paths that you want to include
 Unlike other `paths:` configuration, each entry is **not** the gitignore pattern format.
 Instead it is strings that can be passed directly to ruby's `require` method (relative paths should start with `./`).
 
-Missing files/gems will be a warning, but not a LoadError.
+```yml
+require: ./config/initializers/my_other_inflections_file
+```
 
-By default, the default [`gems: active_support`]() config `require: activesupport` and `gems: rails` will `require: ./config/initializers/inflections`
+Missing files/gems will be a warning, but not a LoadError.
+To avoid seeing the warning if the file isn't there use `quiet:`.
 
 ```yml
-require: ./config/initializers/my_other_inflections_file
+  requires:
+  - 'active_support/inflections' # will warn if it's missing
+  - quiet: './config/initializers/inflections' # will say nothing
 ```
 
 Arrays are not necessary for single values
@@ -213,10 +218,12 @@ Each entry can be a string (an exact match for a method, constant, or variable n
   or the properties from `names:`
   - [`has_prefix:`](#has_prefix)
   - [`has_suffix:`](#has_suffix)
-  - [`matches:`](#matches) (can't be used in the same entry as `has_prefix:` or `has_suffix:`)
+  - [`matches:`](#matches)
 - [`paths:`](#paths)
 - [`has_arguments:`](#has_arguments)
 - [`has_receiver:`](#has_receiver)
+- [`type:`](#type)
+- [`privacy:`](#privacy)
 - [`unless`](#unless)
 
 Arrays are not necessary for single values
@@ -242,7 +249,7 @@ Each entry can be a string (an exact match for a method, constant, or variable n
   or the properties from `names:`
   - [`has_prefix:`](#has_prefix)
   - [`has_suffix:`](#has_suffix)
-  - [`matches:`](#matches) (can't be used in the same entry as `has_prefix:` or `has_suffix:`)
+  - [`matches:`](#matches)
 - [`paths:`](#paths)
 - [`has_arguments:`](#has_arguments)
 - [`unless`](#unless)
@@ -277,9 +284,11 @@ Each entry must have at least one of the following properties to restrict which
 - [`unless:`](#unless)
 - [`document: true`](#document-true)
 
-And must have one or both of
+And must have at least one of
 - ['calls:`](#calls-defines)
 - [`defines:`](#calls-defines)
+- [`set_privacy:](#set-privacy)
+- [`set_default_privacy:`](#set-default-privacy)
 
 Arrays are not necessary for single values.
 
@@ -305,7 +314,7 @@ This is a list of methods/constants/variables, and can be used in [`dynamic:`](#
 Each entry can be a string (an exact match for a method, constant, or variable name that includes the sigil), or have at least one of the following properties:
 - [`has_prefix:`](#has_prefix)
 - [`has_suffix:`](#has_suffix)
-- [`matches:`](#matches) (this can't be used in the same entry as `has_prefix:` or `has_suffix:`)
+- [`matches:`](#matches)
 
 Arrays are not necessary for single values
 
@@ -402,7 +411,7 @@ and consider it to have created methods like `can_build_house?` and `can_drive_c
 ## `calls:`, `defines:`
 _aliases `call:`, `define:`_
 
-At least one of these must be used in each entry in [`dynamic:`](#dynamic)
+These may be used as entries in [`dynamic:`](#dynamic)
 
 This is a list of values that are called or defined dynamically by the matched method, or eventually after being assigned to the the matched constant or variable.
 
@@ -454,6 +463,43 @@ dynamic:
   calls: 1
 ```
 
+## `set_privacy:`
+
+Set privacy has the same requirements as [`calls:` & `defines:`](#calls-defines).
+
+additional it requires a `to:` with one of either `private`, `public`, or `protected`.
+
+For example, from the ruby config:
+```yml
+dynamic:
+  name: private_class_method
+  has_argument: 0
+  set_privacy:
+    argument: '*'
+    to: private
+```
+
+which sets all methods named by the arguments to the privacy_class_method method to private.
+
+these methods could then be filtered using the [`privacy:`](#privacy) method in another [`dynamic:`](#dynamic) or [`keep:`](#keep) rule.
+
+Leftovers limits this to only affect methods defined in the same file.
+
+## `set_default_privacy:`
+
+This must be one of `public`, `private`, or `protected` and will set all subsequent method definitions in this file to that default privacy (unless its then overridden by [`set_privacy`](#set_privacy))
+
+For example, from the default ruby config:
+```yml
+dynamic:
+  name: private
+  unless:
+    has_argument: 0
+  set_default_privacy: private
+```
+
+these methods could then be filtered using the [`privacy:`](#privacy) method in another [`dynamic:`](#dynamic) or [`keep:`](#keep) rule.
+
 ## `arguments:`
 _alias `argument:`_
 
@@ -522,7 +568,7 @@ Each entry can be any of:
 - or have at least one of the following properties to match the keyword/hash key string or symbol:
   - [`has_prefix:`](#has_prefix)
   - [`has_suffix:`](#has_suffix)
-  - [`matches:`](#matches) (this can't be used in the same entry as `has_prefix:` or `has_suffix:`)
+  - [`matches:`](#matches)
 
 Arrays are not necessary for single values
 
@@ -533,10 +579,10 @@ filter [`arguments:`](#arguments), [`has_arguments:`](#has_arguments), and [`key
 Each entry can be one of
 - `true`, `false`, `nil`, or 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 a string or symbol:
+- or have at least one of the following properties to match the name:
   - [`has_prefix:`](#has_prefix)
   - [`has_suffix:`](#has_suffix)
-  - [`matches:`](#matches) (this can't be used in the same entry as `has_prefix:` or `has_suffix:`)
+  - [`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)
@@ -545,17 +591,35 @@ Each entry can be one of
 - or have the following property to match the receiver
   - [`has_receiver`](#has_value_has_receiver)
 
+## `privacy:`
+
+filter [`dynamic:`](#dynamic) and [`keep:`](#keep) by method/constant privacy
+
+e.g.
+
+```yml
+keep:
+  - path: '**/generators/**/*_generator.rb'
+    privacy: public
+    type: Method
+```
+
+considers all public methods defined in rails generators to be called.
+
 ## `type:`
 
-Filter [`has_value`](#has_value_has_receiver), by the argument/assigned value type
+Filter by the literal type
 
 Each entry can be one of
-- `'String'`
-- `'Symbol'`
-- `'Integer'`
-- `'Float'`
-- `'Array'`
-- `'Hash'`
+- `'String'` a literal string, defined with "" or '' (not String.new)
+- `'Symbol'` a literal symbol
+- `'Integer'` a literal integer
+- `'Float'` a literal float
+- `'Array'` a literal array defined with [] (not Array.new)
+- `'Hash'` a literal hash, defined with {} (not Hash.new)
+- `'Proc'` a literal proc/lambda, defined with lambda {}, proc {}, or -> {} (not Proc.new)
+- `'Method'` a method call or definition defined with def, (not define_method {})
+- `'Constant'` a constant assignment, or a literal module or class defined with keywords, (not Module/Class.new)
 
 Arrays are not necessary for single values
 

data/leftovers.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'activesupport'
   spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'did_you_mean'
   spec.add_development_dependency 'haml'
   spec.add_development_dependency 'pry', '~> 0.1'
   spec.add_development_dependency 'rake', '>= 13'
@@ -51,7 +52,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'spellr', '>= 0.8.1'
   spec.add_dependency 'fast_ignore', '>= 0.15.1'
-  spec.add_dependency 'json_schemer'
   spec.add_dependency 'parallel'
   spec.add_dependency 'parser'
 end

data/lib/config/actionmailer.yml

@@ -9,14 +9,14 @@ keep:
   - delivered_email
 
 dynamic:
-  names:
-    - deliver_now
-    - deliver_later
-  calls:
-    value:
-      deliver
-  names:
-    - before_action
-    - after_action
-    - around_action
-  calls: ['*', if, unless]
+  - names:
+      - deliver_now
+      - deliver_later
+    calls:
+      value:
+        deliver
+  - names:
+      - before_action
+      - after_action
+      - around_action
+    calls: ['*', if, unless]

data/lib/config/activesupport.yml

@@ -2,7 +2,7 @@ requires:
   - 'active_support'
   - 'active_support/core_ext/string'
   - 'active_support/inflections'
-  - './config/initializers/inflections'
+  - quiet: './config/initializers/inflections'
 
 # THIS IS INCOMPLETE (you can help by expanding it)
 # rails is _really complicated_ and has a lot of magic which calls methods for you.

data/lib/config/rails.yml

@@ -3,7 +3,6 @@
 # some is currently impossible to handle (with_options).
 # Some is just corners of rails I haven't hit yet.
 gems:
-  - actioncable
   - actionmailer
   - actionpack
   - actionview
@@ -11,6 +10,7 @@ gems:
   - activemodel
   - activerecord
   - activesupport
+  - railties
 
 keep:
   - default_url_options # called by url_for, unsure what gem does

data/lib/config/railties.yml

@@ -0,0 +1,11 @@
+keep:
+  - # https://guides.rubyonrails.org/generators.html#generators-lookup
+    path: '**/generators/**/*_generator.rb'
+    # "When a generator is invoked, each public method in the generator is executed sequentially in
+    # the order that it is defined When a generator is invoked, each public method in the generator
+    # is executed sequentially in the order that it is defined"
+    #
+    # https://guides.rubyonrails.org/generators.html
+    privacy: public
+    type: Method
+

data/lib/config/ruby.yml

@@ -98,3 +98,75 @@ dynamic:
       - instance_variable_set
       - class_variable_set
     defines: 0
+
+  # Module
+  - name: public
+    unless:
+      has_argument: 0
+    set_default_privacy: public
+
+  - name:
+      - public
+      - public_class_method
+      - public_constant
+    has_argument: 0
+    set_privacy:
+      argument: '*'
+      to: public
+
+  - name:
+      - public
+      - public_class_method
+    has_argument: 0
+    unless:
+      has_argument: 1
+    set_privacy:
+      argument: 0
+      nested:
+        argument: '*'
+      to: public
+
+  - name: protected
+    unless:
+      has_argument: 0
+    set_default_privacy: protected
+
+  - name: protected
+    has_argument: 0
+    set_privacy:
+      argument: '*'
+      to: protected
+
+  - name: protected
+    has_argument: 0
+    unless:
+      has_argument: 1
+    set_privacy:
+      argument: 0
+      nested:
+        argument: '*'
+      to: protected
+
+  - name: private
+    unless:
+      has_argument: 0
+    set_default_privacy: private
+
+  - name:
+      - private
+      - private_class_method
+      - private_constant
+    has_argument: 0
+    set_privacy:
+      argument: '*'
+      to: private
+
+  - name: private
+    has_argument: 0
+    unless:
+      has_argument: 1
+    set_privacy:
+      argument: 0
+      nested:
+        argument: '*'
+      to: private

data/lib/leftovers/ast/node.rb

@@ -25,14 +25,6 @@ module Leftovers
         @memo[:path] ||= loc.expression.source_buffer.name.to_s
       end
 
-      def test_line?
-        @memo[:test_line]
-      end
-
-      def test_line=(value)
-        @memo[:test_line] = value
-      end
-
       def keep_line=(value)
         @memo[:keep_line] = value
       end
@@ -41,6 +33,14 @@ module Leftovers
         @memo[:keep_line]
       end
 
+      def privacy=(value)
+        @memo[:privacy] = value
+      end
+
+      def privacy
+        @memo[:privacy] || :public
+      end
+
       def to_scalar_value
         case type
         when :sym, :int, :float, :str
@@ -58,7 +58,8 @@ module Leftovers
         case type
         when :sym, :int, :float, :str, :true, :false, :nil
           true
-        else false
+        else
+          false
         end
       end
 
@@ -78,6 +79,10 @@ module Leftovers
         type == :str || type == :sym
       end
 
+      def string_or_symbol_or_def?
+        type == :str || type == :sym || type == :def || type == :defs
+      end
+
       def proc?
         return unless type == :block
 
@@ -140,9 +145,9 @@ module Leftovers
 
       def name
         @memo[:name] ||= case type
-        when :send, :csend, :casgn, :const
+        when :send, :csend, :casgn, :const, :defs
           second
-        when :def, :ivasgn, :ivar, :gvar, :cvar, :gvasgn, :cvasgn, :sym
+        when :def, :ivasgn, :ivar, :gvar, :cvar, :gvasgn, :cvasgn, :sym, :lvar
           first
         when :str
           first.to_sym

data/lib/leftovers/config.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'yaml'
-
 module Leftovers
   class Config
     attr_reader :name
@@ -66,29 +64,8 @@ module Leftovers
 
     private
 
-    def content
-      @content ||= ::File.exist?(path) ? ::File.read(path) : ''
-    end
-
-    def path
-      @path ||= ::File.expand_path("../config/#{name}.yml", __dir__)
-    end
-
     def yaml
-      @yaml ||= ::Leftovers::ConfigValidator.validate_and_process!(parse_yaml, path)
-    end
-
-    def parse_yaml
-      # :nocov:
-      if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
-        Psych.safe_load(content, filename: path) || {}
-      else
-        Psych.safe_load(content, [], [], false, path) || {}
-      end
-      # :nocov:
-    rescue ::Psych::SyntaxError => e
-      warn "\e[31mConfig SyntaxError: #{e.message}\e[0m"
-      Leftovers.exit 1
+      @yaml ||= ::Leftovers::ConfigLoader.load(name, path: @path, content: @content)
     end
   end
 end

data/lib/leftovers/config_loader/argument_position_schema.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Leftovers
+  class ConfigLoader
+    class ArgumentPositionSchema < ObjectSchema
+      inherit_attributes_from StringPatternSchema
+
+      self.or_schema = ScalarArgumentSchema
+    end
+  end
+end

data/lib/leftovers/config_loader/argumentless_transform_schema.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Leftovers
+  class ConfigLoader
+    class ArgumentlessTransformSchema < StringEnumSchema
+      value :original
+      value :pluralize
+      value :singularize
+      value :camelize, aliases: :camelcase
+      value :underscore
+      value :titleize, aliases: :titlecase
+      value :demodulize
+      value :deconstantize
+      value :parameterize
+      value :downcase
+      value :upcase
+      value :capitalize
+      value :swapcase
+    end
+  end
+end

data/lib/leftovers/config_loader/attribute.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Leftovers
+  class ConfigLoader
+    class Attribute
+      def initialize(name, value_schema, aliases: nil, require_group: nil)
+        @name = name
+        @value_schema = value_schema
+        @aliases = aliases
+        @require_group = require_group
+      end
+
+      def attributes
+        { @name => @value_schema }
+      end
+
+      def aliases
+        ::Leftovers.each_or_self(@aliases).map do |aka|
+          [aka, @name]
+        end.to_h
+      end
+
+      def require_groups
+        return {} unless @require_group
+
+        { @require_group => [@name, *::Leftovers.each_or_self(@aliases)] }
+      end
+    end
+  end
+end

data/lib/leftovers/config_loader/document_schema.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Leftovers
+  class ConfigLoader
+    class DocumentSchema < ObjectSchema
+      attribute :include_paths, ValueOrArraySchema[StringSchema], aliases: :include_path
+      attribute :exclude_paths, ValueOrArraySchema[StringSchema], aliases: :exclude_path
+      attribute :test_paths, ValueOrArraySchema[StringSchema], aliases: :test_path
+      attribute :haml_paths, ValueOrArraySchema[StringSchema], aliases: :haml_path
+      attribute :slim_paths, ValueOrArraySchema[StringSchema], aliases: :slim_path
+      attribute :yaml_paths, ValueOrArraySchema[StringSchema], aliases: :yaml_path
+      attribute :json_paths, ValueOrArraySchema[StringSchema], aliases: :json_path
+      attribute :erb_paths, ValueOrArraySchema[StringSchema], aliases: :erb_path
+      attribute :requires, ValueOrArraySchema[RequireSchema], aliases: :require
+      attribute :gems, ValueOrArraySchema[StringSchema], aliases: :gem
+      attribute :keep, ValueOrArraySchema[KeepTestOnlySchema]
+      attribute :test_only, ValueOrArraySchema[KeepTestOnlySchema]
+      attribute :dynamic, ValueOrArraySchema[DynamicSchema]
+    end
+  end
+end

data/lib/leftovers/config_loader/dynamic_schema.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Leftovers
+  class ConfigLoader
+    class DynamicSchema < ObjectSchema
+      inherit_attributes_from RulePatternSchema
+
+      attribute :call, ValueOrArraySchema[ValueProcessorSchema], aliases: :calls,
+        require_group: :processor
+      attribute :define, ValueOrArraySchema[ValueProcessorSchema], aliases: :defines,
+        require_group: :processor
+      attribute :set_privacy, ValueOrArraySchema[PrivacyProcessorSchema],
+                require_group: :processor
+      attribute :set_default_privacy, PrivacySchema, require_group: :processor
+    end
+  end
+end

data/lib/leftovers/config_loader/has_argument_schema.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Leftovers
+  class ConfigLoader
+    class HasArgumentSchema < ObjectSchema
+      attribute :at, ValueOrArraySchema[ArgumentPositionSchema], require_group: :matcher
+      attribute :has_value, ValueOrArraySchema[HasValueSchema], require_group: :matcher
+      attribute :unless, ValueOrArraySchema[HasArgumentSchema], require_group: :matcher
+
+      self.or_schema = ScalarArgumentSchema
+    end
+  end
+end

data/lib/leftovers/config_loader/has_value_schema.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Leftovers
+  class ConfigLoader
+    class HasValueSchema < ObjectSchema
+      inherit_attributes_from StringPatternSchema, except: :unless
+
+      attribute :at, ValueOrArraySchema[ArgumentPositionSchema], require_group: :matcher
+      attribute :has_value, ValueOrArraySchema[HasValueSchema], require_group: :matcher
+
+      attribute :has_receiver, ValueOrArraySchema[HasValueSchema], require_group: :matcher
+      attribute :type, ValueOrArraySchema[ValueTypeSchema], require_group: :matcher
+      attribute :unless, ValueOrArraySchema[HasValueSchema], require_group: :matcher
+
+      self.or_schema = ScalarValueSchema
+    end
+  end
+end

data/lib/leftovers/config_loader/keep_test_only_schema.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Leftovers
+  class ConfigLoader
+    class KeepTestOnlySchema < ObjectSchema
+      inherit_attributes_from StringPatternSchema, except: :unless
+      inherit_attributes_from RulePatternSchema, except: :unless
+      attribute :unless, ValueOrArraySchema[KeepTestOnlySchema], require_group: :matcher
+
+      self.or_schema = StringSchema
+    end
+  end
+end