leftovers 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99d72b44b74c747074583f8c9254872a175563d0f25135b7798c5e76f42c19ef
-  data.tar.gz: 6b4bd9219256b8734df956978892da7ffe028e0539367a1f98d46c73912ae79e
+  metadata.gz: 7094671fa508c2a3af0cfdc0b64dfc41346c88a16a9203d901628fe40af66a86
+  data.tar.gz: 35ae640a73003aaf96a362ca08e3c92b51b46e93184b1c3641a5427a1dce31d4
 SHA512:
-  metadata.gz: d51c93c652bdd0aa55a176c1600e9d557fd29e7e9726411d7ac6eb086178a655e17e96e8d7530c97945f169d32961649358dd712daf9e50cb82b30caa1b55c10
-  data.tar.gz: b8ca04321b17c7d9c9b831f3fb2fab47554d859f910d38f08a04d41f344c4585a1008019af12d13b3e2807027fe6ba7d6fd6a4d1eca3fb947d68d6812249bc39
+  metadata.gz: 4da3eb08e61869a3d5a82c8a0ecdfb7217872299cee46d1ec7ac0234c892c10a0afa5ca3786e23939d893302cf83e2d91e4cb33939c02e4f6b856c51aef22cdc
+  data.tar.gz: 29f81218dfad69a62ea35032cc4149eff849a363067b67aa9175a568674e473e6a28f2b0eeb5d6de36246917efb911a527163aab45e7382ff0d915a843777b99

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v0.12.0
+- improve error handling when a file can't be processed
+- fail rather than warn when encountering a syntax error in a file being processed
+
+# v0.11.2
+
+- add `has_block: true/false` for matching method calls with a block.
+- fix block_pass (`call(&block)`) being considered a regular argument, which meant the keyword arguments was a hash in the second-last position instead of the last position, so weren't keyword arguments, and also inflated how many positional arguments there were.
+- Fixed integration with Haml 6.x
+- Noted the with_options limitation in readme
+- Add more rspec config: `RSpec::Matchers.define`, `matcher {}`, `alias_matcher`
+
 # v0.11.1
 - Fixed an issue with parsing files that have `MyConstant ||= value` patterns #19 (thanks for the pr - @kamoh)
 

data/README.md

@@ -185,6 +185,7 @@ see the [built in config files](https://github.com/robotdana/leftovers/tree/main
   Add the method/pattern to the `dynamic:` list with `skip: true` in the `.leftovers.yml`, or add an inline comment with the list of possibilities `# leftovers:call my_method_1, my_method_2`.
 - Leftovers compares by name only, so multiple definitions with the same name will count as used even if only one is.
 - haml, slim & erb line and column numbers will be wrong as the files have to be precompiled before checking.
+- dynamic calls & definitions based on values copied by rails `with_options` method aren't captured by leftovers.
 
 ## Other tools
 

data/docs/Configuration.md

@@ -250,6 +250,7 @@ Each entry must have at least one of the following properties to restrict which
 - [`paths:`](#paths)
 - [`has_arguments:`](#has_arguments)
 - [`has_receiver:`](#has_receiver)
+- [`has_block:`](#has_block)
 - [`type:`](#type)
 - [`privacy:`](#privacy)
 - [`unless:`](#unless)
@@ -528,6 +529,12 @@ Arrays are not necessary for single values and if the rule contains only `at:` i
 
 Positional arguments are zero indexed
 
+## `has_block:`
+
+Use `has_block: true` or `has_block: false` filter by whether they have a block or not
+
+This will match either `this { syntax }` or `this(&syntax)`
+
 ## `keywords:`
 When the keyword argument **keywords** are the thing being called.
 

data/exe/leftovers

@@ -3,4 +3,6 @@
 
 require_relative '../lib/leftovers'
 
-exit Leftovers::CLI.new(argv: ARGV).run
+Leftovers.stderr = $stderr
+Leftovers.stdout = $stdout
+exit ::Leftovers::CLI.new(argv: ::ARGV).run

data/leftovers.gemspec

@@ -4,9 +4,9 @@ lib = ::File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'leftovers/version'
 
-Gem::Specification.new do |spec|
+::Gem::Specification.new do |spec|
   spec.name = 'leftovers'
-  spec.version = Leftovers::VERSION
+  spec.version = ::Leftovers::VERSION
   spec.authors = ['Dana Sherson']
   spec.email = ['robot@dana.sh']
 
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.metadata['rubygems_mfa_required'] = 'true'
   spec.required_ruby_version = '>= 2.5.0'
 
-  spec.files = Dir.glob('{lib,exe,docs}/**/{*,.*}') + %w{
+  spec.files = ::Dir.glob('{lib,exe,docs}/**/{*,.*}') + %w{
     CHANGELOG.md
     Gemfile
     LICENSE.txt
@@ -35,7 +35,6 @@ 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'

data/lib/config/activesupport.yml

@@ -156,7 +156,7 @@ dynamic:
     calls: 1
     unless:
       - has_argument: 2
-      # - has_block_argument: true
+      - has_block: true
 
   # https://api.rubyonrails.org/classes/ActiveSupport/Callbacks/ClassMethods.html#method-i-skip_callback
   - name: skip_callback

data/lib/config/rspec.yml

@@ -62,3 +62,24 @@ dynamic:
       has_argument: 1
     defines: 0
     path: /spec/
+
+  - name: define
+    has_receiver:
+      match: Matchers
+      has_receiver: RSpec
+    defines:
+      argument: 0
+    path: /spec/
+
+  - name: matcher
+    has_block: true
+    defines:
+      argument: 0
+    path: /spec/
+
+  - name: alias_matcher
+    defines:
+      argument: 0
+    calls:
+      argument: 1
+    path: /spec/

data/lib/leftovers/ast/array_node.rb

@@ -2,8 +2,8 @@
 
 module Leftovers
   module AST
-    class ArrayNode < ::Leftovers::AST::Node
-      include Leftovers::AST::HasArguments
+    class ArrayNode < Node
+      include HasArguments
 
       alias_method :arguments, :children
       alias_method :as_arguments_list, :arguments

data/lib/leftovers/ast/block_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class BlockNode < ::Leftovers::AST::Node
+    class BlockNode < Node
       def proc?
         name = first.name
         name == :lambda || name == :proc

data/lib/leftovers/ast/builder.rb

@@ -11,28 +11,29 @@ module Leftovers
 
       def self.node_class(type) # rubocop:disable Metrics
         case type
-        when :array then ::Leftovers::AST::ArrayNode
-        when :block then ::Leftovers::AST::BlockNode
-        when :casgn then ::Leftovers::AST::CasgnNode
-        when :const then ::Leftovers::AST::ConstNode
-        when :def then ::Leftovers::AST::DefNode
-        when :defs then ::Leftovers::AST::DefsNode
-        when :false then ::Leftovers::AST::FalseNode
-        when :hash then ::Leftovers::AST::HashNode
-        when :int, :float then ::Leftovers::AST::NumericNode
-        when :lvar, :ivar, :gvar, :cvar then ::Leftovers::AST::VarNode
-        when :ivasgn, :cvasgn, :gvasgn then ::Leftovers::AST::VasgnNode
-        when :module, :class then ::Leftovers::AST::ModuleNode
-        when :nil then ::Leftovers::AST::NilNode
-        when :send, :csend then ::Leftovers::AST::SendNode
-        when :str then ::Leftovers::AST::StrNode
-        when :sym then ::Leftovers::AST::SymNode
-        when :true then ::Leftovers::AST::TrueNode
-        else ::Leftovers::AST::Node
+        when :array then ArrayNode
+        when :block then BlockNode
+        when :casgn then CasgnNode
+        when :const then ConstNode
+        when :def then DefNode
+        when :defs then DefsNode
+        when :false then FalseNode
+        when :hash then HashNode
+        when :int, :float then NumericNode
+        when :lvar, :ivar, :gvar, :cvar then VarNode
+        when :ivasgn, :cvasgn, :gvasgn then VasgnNode
+        when :module, :class then ModuleNode
+        when :nil then NilNode
+        when :send, :csend then SendNode
+        when :str then StrNode
+        when :sym then SymNode
+        when :true then TrueNode
+        else Node
         end
       end
 
       # Don't complain about invalid strings
+      # This is called by ::Parser::AST internals
       def string_value(token) # leftovers:keep
         value(token)
       end

data/lib/leftovers/ast/casgn_node.rb

@@ -2,8 +2,8 @@
 
 module Leftovers
   module AST
-    class CasgnNode < ::Leftovers::AST::Node
-      include Leftovers::AST::HasArguments
+    class CasgnNode < Node
+      include HasArguments
 
       alias_method :name, :second
       alias_method :to_sym, :second

data/lib/leftovers/ast/const_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class ConstNode < ::Leftovers::AST::Node
+    class ConstNode < Node
       alias_method :receiver, :first
       alias_method :name, :second
       alias_method :to_sym, :second

data/lib/leftovers/ast/def_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class DefNode < ::Leftovers::AST::Node
+    class DefNode < Node
       alias_method :name, :first
       alias_method :to_sym, :first
 

data/lib/leftovers/ast/defs_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class DefsNode < ::Leftovers::AST::Node
+    class DefsNode < Node
       alias_method :name, :second
       alias_method :to_sym, :second
 

data/lib/leftovers/ast/false_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class FalseNode < ::Leftovers::AST::Node
+    class FalseNode < Node
       def to_scalar_value
         false
       end

data/lib/leftovers/ast/hash_node.rb

@@ -2,8 +2,8 @@
 
 module Leftovers
   module AST
-    class HashNode < ::Leftovers::AST::Node
-      include Leftovers::AST::HasArguments
+    class HashNode < Node
+      include HasArguments
 
       def arguments
         @memo[:arguments] ||= [self]

data/lib/leftovers/ast/module_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class ModuleNode < ::Leftovers::AST::Node
+    class ModuleNode < Node
       def name
         first.name
       end

data/lib/leftovers/ast/nil_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class NilNode < ::Leftovers::AST::Node
+    class NilNode < Node
       def to_scalar_value
         nil
       end

data/lib/leftovers/ast/node.rb

@@ -17,7 +17,7 @@ module Leftovers
       def updated(type = nil, children = nil, properties = nil) # leftovers:keep
         maybe_copy = super
 
-        class_for_type = Leftovers::AST::Builder.node_class(maybe_copy.type)
+        class_for_type = Builder.node_class(maybe_copy.type)
         return maybe_copy if maybe_copy.instance_of?(class_for_type)
 
         class_for_type.new(maybe_copy.type, maybe_copy.children, location: maybe_copy.loc)
@@ -43,6 +43,14 @@ module Leftovers
         @memo[:privacy] || :public
       end
 
+      def parent
+        @memo[:parent]
+      end
+
+      def parent=(value)
+        @memo[:parent] = value
+      end
+
       def to_scalar_value
         nil
       end
@@ -98,6 +106,10 @@ module Leftovers
       def name
         nil
       end
+
+      def block_given?
+        false
+      end
     end
   end
 end

data/lib/leftovers/ast/numeric_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class NumericNode < ::Leftovers::AST::Node
+    class NumericNode < Node
       alias_method :to_scalar_value, :first
 
       def scalar?

data/lib/leftovers/ast/send_node.rb

@@ -2,8 +2,8 @@
 
 module Leftovers
   module AST
-    class SendNode < ::Leftovers::AST::Node
-      include Leftovers::AST::HasArguments
+    class SendNode < Node
+      include HasArguments
 
       alias_method :receiver, :first
       alias_method :name, :second
@@ -14,12 +14,25 @@ module Leftovers
       end
 
       def arguments
-        @memo[:arguments] ||= children.drop(2)
+        @memo[:arguments] ||= if block_pass_argument?
+          children[2...-1]
+        else
+          children.drop(2)
+        end
       end
 
       def as_arguments_list
         first.as_arguments_list if name == :freeze
       end
+
+      def block_pass_argument?
+        last_child = children.last
+        last_child.respond_to?(:type) && last_child.type == :block_pass
+      end
+
+      def block_given?
+        block_pass_argument? || parent&.type == :block
+      end
     end
   end
 end

data/lib/leftovers/ast/str_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class StrNode < ::Leftovers::AST::Node
+    class StrNode < Node
       alias_method :to_scalar_value, :first
 
       def name

data/lib/leftovers/ast/sym_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class SymNode < ::Leftovers::AST::Node
+    class SymNode < Node
       alias_method :name, :first
       alias_method :to_scalar_value, :first
       alias_method :to_sym, :first

data/lib/leftovers/ast/true_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class TrueNode < ::Leftovers::AST::Node
+    class TrueNode < Node
       def to_scalar_value
         true
       end

data/lib/leftovers/ast/var_node.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   module AST
-    class VarNode < ::Leftovers::AST::Node
+    class VarNode < Node
       alias_method :name, :first
       alias_method :to_sym, :first
 

data/lib/leftovers/ast/vasgn_node.rb

@@ -2,8 +2,8 @@
 
 module Leftovers
   module AST
-    class VasgnNode < ::Leftovers::AST::Node
-      include Leftovers::AST::HasArguments
+    class VasgnNode < Node
+      include HasArguments
 
       alias_method :name, :first
       alias_method :to_sym, :first

data/lib/leftovers/ast.rb

@@ -1,26 +1,7 @@
-# frozen-string-literal: true
+# frozen_string_literal: true
 
 module Leftovers
   module AST
-    autoload(:ArrayNode, "#{__dir__}/ast/array_node")
-    autoload(:BlockNode, "#{__dir__}/ast/block_node")
-    autoload(:Builder, "#{__dir__}/ast/builder")
-    autoload(:CasgnNode, "#{__dir__}/ast/casgn_node")
-    autoload(:ConstNode, "#{__dir__}/ast/const_node")
-    autoload(:DefNode, "#{__dir__}/ast/def_node")
-    autoload(:DefsNode, "#{__dir__}/ast/defs_node")
-    autoload(:FalseNode, "#{__dir__}/ast/false_node")
-    autoload(:HashNode, "#{__dir__}/ast/hash_node")
-    autoload(:HasArguments, "#{__dir__}/ast/has_arguments")
-    autoload(:ModuleNode, "#{__dir__}/ast/module_node")
-    autoload(:NilNode, "#{__dir__}/ast/nil_node")
-    autoload(:Node, "#{__dir__}/ast/node")
-    autoload(:NumericNode, "#{__dir__}/ast/numeric_node")
-    autoload(:SendNode, "#{__dir__}/ast/send_node")
-    autoload(:StrNode, "#{__dir__}/ast/str_node")
-    autoload(:SymNode, "#{__dir__}/ast/sym_node")
-    autoload(:TrueNode, "#{__dir__}/ast/true_node")
-    autoload(:VasgnNode, "#{__dir__}/ast/vasgn_node")
-    autoload(:VarNode, "#{__dir__}/ast/var_node")
+    include Autoloader
   end
 end

data/lib/leftovers/autoloader.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Leftovers
+  # zero dependency zeitwerk
+  module Autoloader
+    ALL_CAPS_NAMES = %w{ast cli version erb json yaml}.freeze
+
+    def self.included(klass)
+      ::Dir[glob_children(klass)].each_entry do |path|
+        klass.autoload(class_from_path(path), path)
+      end
+    end
+
+    def self.class_from_path(path)
+      name = ::File.basename(path).delete_suffix('.rb')
+      if ALL_CAPS_NAMES.include?(name)
+        name.upcase
+      else
+        name.gsub(/(?:^|_)(\w)/, &:upcase).delete('_')
+      end
+    end
+
+    def self.dir_path_from_class(klass)
+      klass.name.gsub(/::/, '/')
+        .gsub(/(?<=[a-z])([A-Z])/, '_\1').downcase
+    end
+
+    def self.glob_children(klass)
+      "#{root}/#{dir_path_from_class(klass)}/*.rb"
+    end
+
+    def self.root
+      ::File.dirname(__dir__)
+    end
+  end
+end

data/lib/leftovers/cli.rb

@@ -1,73 +1,92 @@
 # frozen_string_literal: true
 
 require 'optparse'
+
 module Leftovers
   class CLI
-    def initialize(argv: [], stdout: $stdout, stderr: $stderr)
+    def initialize(argv: [])
       @argv = argv
-      @stdout = stdout
-      @stderr = stderr
     end
 
     def run
-      catch(:leftovers_exit) do
-        Leftovers.reset
-        parse_options
+      parse_options
 
-        Leftovers.run(stdout: stdout, stderr: stderr)
-      end
+      runner.run
+    rescue ::Leftovers::Error => e
+      Leftovers.warn("\e[31m#{e.class}: #{e.message}\e[0m\n\n#{e.backtrace.join("\n")}")
+      1
+    rescue ::Leftovers::Exit => e
+      e.status # what why?
     end
 
     private
 
-    attr_reader :argv, :stdout, :stderr
+    attr_reader :argv
 
-    def parse_options # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      opts = OptionParser.new
-      Leftovers.parallel = true
-      Leftovers.progress = true
+    def option_parser
+      @option_parser ||= ::OptionParser.new do |o|
+        o.banner = 'Usage: leftovers [options]'
 
-      opts.banner = 'Usage: leftovers [options]'
-
-      opts.on('--[no-]parallel', 'Run in parallel or not, default --parallel') do |p|
-        Leftovers.parallel = p
+        o.on('--[no-]parallel', 'Run in parallel or not, default --parallel') { |p| parallel(p) }
+        o.on('--[no-]progress', 'Show live counts or not, default --progress') { |p| progress(p) }
+        o.on('--dry-run', 'Print a list of files that would be looked at') { dry_run }
+        o.on('--view-compiled', 'Print the compiled content of the files') { view_compiled }
+        o.on('--write-todo', 'Create a config file with the existing unused items') { write_todo }
+        o.on('-v', '--version', 'Print the current version') { print_version }
+        o.on('-h', '--help', 'Print this message') { print_help }
       end
+    end
 
-      opts.on('--[no-]progress', 'Show progress counts or not, default --progress') do |p|
-        Leftovers.progress = p
-      end
+    def parse_options
+      option_parser.parse!(argv)
+    rescue ::OptionParser::ParseError => e
+      ::Leftovers.error("CLI Error: #{e.message}", option_parser.help)
+    end
 
-      opts.on('--dry-run', 'Output files that will be looked at') do
-        Leftovers::FileList.new.each { |f| stdout.puts f.relative_path }
-        Leftovers.exit
-      end
+    def runner
+      @runner ||= Runner.new
+    end
 
-      opts.on('--view-compiled', 'Output the compiled content of the files') do
-        Leftovers::FileList.new(argv_rules: argv)
-          .each { |f| stdout.puts "\e[0;2m#{f.relative_path}\e[0m\n#{f.ruby}" }
-        Leftovers.exit
-      end
+    def exit(status = 0)
+      ::Leftovers.exit status
+    end
 
-      opts.on('--write-todo', 'Outputs the unused items in a todo file to gradually fix') do
-        Leftovers.reporter = Leftovers::TodoReporter.new
-      end
+    def dry_run
+      FileList.new.each { |file| ::Leftovers.puts file.relative_path }
 
-      opts.on('-v', '--version', 'Returns the current version') do
-        stdout.puts(Leftovers::VERSION)
-        Leftovers.exit
-      end
+      exit
+    end
 
-      opts.on('-h', '--help', 'Shows this message') do
-        stdout.puts(opts.help)
-        Leftovers.exit
+    def view_compiled
+      FileList.new(argv_rules: argv).each do |file|
+        ::Leftovers.puts "\e[0;2m#{file.relative_path}\e[0m\n#{file.ruby}"
       end
 
-      opts.parse!(argv)
-    rescue OptionParser::InvalidOption => e
-      stderr.puts("\e[31mCLI Error: #{e.message}\e[0m")
-      stderr.puts ''
-      stderr.puts(opts.help)
-      Leftovers.exit 1
+      exit
+    end
+
+    def print_version
+      ::Leftovers.puts(VERSION)
+
+      exit
+    end
+
+    def print_help
+      ::Leftovers.puts(option_parser.help)
+
+      exit
+    end
+
+    def parallel(value)
+      runner.parallel = value
+    end
+
+    def progress(value)
+      runner.progress = value
+    end
+
+    def write_todo
+      runner.reporter = TodoReporter
     end
   end
 end