leftovers 0.11.1 → 0.12.0

data/lib/leftovers/todo_reporter.rb

@@ -3,100 +3,102 @@
 require 'pathname'
 
 module Leftovers
-  class TodoReporter
-    def prepare
-      return unless path.exist?
-
-      puts "Removing previous #{path.basename} file"
-      puts ''
-      path.delete
-    end
-
-    def report(only_test:, none:)
-      path.write(generate_file_body(only_test, none))
-      report_instructions
-
-      0
-    end
-
-    def report_success
-      puts "No #{path.basename} file generated, everything is used"
-
-      0
-    end
-
-    private
-
-    def report_instructions
-      puts <<~MESSAGE
-        generated #{path.basename}.
-        running leftovers again will read this file and not alert you to any unused items mentioned in it.
-
-        commit this file so you/your team can gradually address these items while still having leftovers alert you to any newly unused items.
-      MESSAGE
-    end
-
-    def path
-      Leftovers.pwd.join('.leftovers_todo.yml')
-    end
-
-    def generate_file_body(only_test, none)
-      <<~YML.chomp
-        #{generation_message.chomp}
-        #
-        #{resolution_instructions}
-        #{todo_data(only_test, none).chomp}
-      YML
-    end
-
-    def generation_message
-      <<~YML
-        # This file was generated by `leftovers --write-todo`
-        # Generated at: #{Time.now.utc.strftime('%F %T')} UTC
-      YML
-    end
-
-    def resolution_instructions
-      <<~YML
-        # for instructions on how to address these
-        # see #{Leftovers.resolution_instructions_link}
-      YML
-    end
-
-    def todo_data(only_test, none)
-      [
-        list_data(
-          :test_only, 'Only directly called in tests', only_test
-        ),
-        list_data(
-          :keep, 'Not directly called at all', none
-        )
-      ].compact.join
-    end
-
-    def list_data(key, title, list)
-      return if list.empty?
-
-      <<~YML
-        #{key}:
-          # #{title}:
-        #{print_definition_list(list)}
-
-      YML
-    end
-
-    def print_definition_list(definition_list)
-      definition_list.map { |definition| print_definition(definition) }.sort.join("\n")
-    end
-
-    def print_definition(definition)
-      return print_definition_list(definition.definitions) if definition.is_a?(DefinitionSet)
-
-      "  - #{definition.to_s.inspect} # #{definition.location_s} #{definition.source_line.strip}"
-    end
-
-    def puts(string)
-      Leftovers.puts(string)
+  module TodoReporter
+    class << self
+      def prepare
+        return unless path.exist?
+
+        puts "Removing previous #{path.basename} file"
+        puts ''
+        path.delete
+      end
+
+      def report(collection)
+        path.write(generate_file_body(collection))
+        report_instructions
+
+        0
+      end
+
+      def report_success
+        puts "No #{path.basename} file generated, everything is used"
+
+        0
+      end
+
+      private
+
+      def report_instructions
+        puts <<~MESSAGE
+          generated #{path.basename}.
+          running leftovers again will read this file and not alert you to any unused items mentioned in it.
+
+          commit this file so you/your team can gradually address these items while still having leftovers alert you to any newly unused items.
+        MESSAGE
+      end
+
+      def path
+        ::Leftovers.pwd.join('.leftovers_todo.yml')
+      end
+
+      def generate_file_body(collection)
+        <<~YML.chomp
+          #{generation_message.chomp}
+          #
+          #{resolution_instructions}
+          #{todo_data(collection).chomp}
+        YML
+      end
+
+      def generation_message
+        <<~YML
+          # This file was generated by `leftovers --write-todo`
+          # Generated at: #{Time.now.utc.strftime('%F %T')} UTC
+        YML
+      end
+
+      def resolution_instructions
+        <<~YML
+          # for instructions on how to address these
+          # see #{::Leftovers.resolution_instructions_link}
+        YML
+      end
+
+      def todo_data(collection)
+        [
+          list_data(
+            :test_only, 'Only directly called in tests', collection.with_tests
+          ),
+          list_data(
+            :keep, 'Not directly called at all', collection.without_tests
+          )
+        ].compact.join
+      end
+
+      def list_data(key, title, list)
+        return if list.empty?
+
+        <<~YML
+          #{key}:
+            # #{title}:
+          #{print_definition_list(list)}
+
+        YML
+      end
+
+      def print_definition_list(definition_list)
+        definition_list.map { |definition| print_definition(definition) }.sort.join("\n")
+      end
+
+      def print_definition(definition)
+        return print_definition_list(definition.definitions) if definition.is_a?(DefinitionSet)
+
+        "  - #{definition.to_s.inspect} # #{definition.location_s} #{definition.source_line.strip}"
+      end
+
+      def puts(string)
+        ::Leftovers.puts(string)
+      end
     end
   end
 end

data/lib/leftovers/unexpected_case.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Leftovers
+  class UnexpectedCase < Error
+  end
+end
+# :nocov:

data/lib/leftovers/version.rb

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

data/lib/leftovers.rb

@@ -1,118 +1,38 @@
 # frozen_string_literal: true
 
-require 'parser'
-require 'parser/current' # to get the error message early and once.
+module Leftovers
+  class Exit < ::StandardError
+    attr_reader :status
 
-module Leftovers # rubocop:disable Metrics/ModuleLength
-  class Error < ::StandardError; end
-  class UnexpectedCase < Error; end
-
-  class PrecompileError < Error
-    attr_reader :line, :column
-
-    def initialize(message, line: nil, column: nil)
-      @line = line
-      @column = column
-      super(message)
-    end
-
-    def warn(path:)
-      line_column = ":#{line}#{":#{column}" if column}" if line
-      klass = cause ? cause.class : self.class
-
-      Leftovers.warn "#{klass}: #{path}#{line_column} #{message}"
+    def initialize(status) # rubocop:disable Lint/MissingSuper
+      @status = status
     end
   end
 
-  autoload(:AST, "#{__dir__}/leftovers/ast")
-  autoload(:CLI, "#{__dir__}/leftovers/cli")
-  autoload(:Collector, "#{__dir__}/leftovers/collector")
-  autoload(:ComparableInstance, "#{__dir__}/leftovers/comparable_instance")
-  autoload(:ConfigLoader, "#{__dir__}/leftovers/config_loader")
-  autoload(:Config, "#{__dir__}/leftovers/config")
-  autoload(:Definition, "#{__dir__}/leftovers/definition")
-  autoload(:DefinitionCollection, "#{__dir__}/leftovers/definition_collection")
-  autoload(:DefinitionNode, "#{__dir__}/leftovers/definition_node")
-  autoload(:DefinitionNodeSet, "#{__dir__}/leftovers/definition_node_set")
-  autoload(:DefinitionSet, "#{__dir__}/leftovers/definition_set")
-  autoload(:DefinitionToAdd, "#{__dir__}/leftovers/definition_to_add")
-  autoload(:FileCollector, "#{__dir__}/leftovers/file_collector")
-  autoload(:FileList, "#{__dir__}/leftovers/file_list")
-  autoload(:File, "#{__dir__}/leftovers/file")
-  autoload(:MatcherBuilders, "#{__dir__}/leftovers/matcher_builders")
-  autoload(:Matchers, "#{__dir__}/leftovers/matchers")
-  autoload(:MergedConfig, "#{__dir__}/leftovers/merged_config")
-  autoload(:Parser, "#{__dir__}/leftovers/parser")
-  autoload(:Precompilers, "#{__dir__}/leftovers/precompilers")
-  autoload(:ProcessorBuilders, "#{__dir__}/leftovers/processor_builders")
-  autoload(:RakeTask, "#{__dir__}/leftovers/rake_task")
-  autoload(:Reporter, "#{__dir__}/leftovers/reporter")
-  autoload(:TodoReporter, "#{__dir__}/leftovers/todo_reporter")
-  autoload(:Processors, "#{__dir__}/leftovers/processors")
-  autoload(:VERSION, "#{__dir__}/leftovers/version")
+  require_relative 'leftovers/autoloader'
+  include Autoloader
 
   MEMOIZED_IVARS = %i{
     @config
-    @collector
-    @reporter
-    @leftovers
     @try_require_cache
     @stdout
     @stderr
-    @parallel
     @pwd
-    @progress
   }.freeze
 
   class << self
-    attr_accessor :parallel, :progress
-    attr_writer :reporter
-    alias_method :parallel?, :parallel
-    alias_method :progress?, :progress
+    attr_writer :stdout, :stderr
 
     def stdout
-      @stdout ||= $stdout
+      @stdout ||= ::StringIO.new
     end
 
     def stderr
-      @stderr ||= $stderr
+      @stderr ||= ::StringIO.new
     end
 
     def config
-      @config ||= Leftovers::MergedConfig.new(load_defaults: true)
-    end
-
-    def collector
-      @collector ||= Leftovers::Collector.new
-    end
-
-    def reporter
-      @reporter ||= Leftovers::Reporter.new
-    end
-
-    def leftovers
-      @leftovers ||= begin
-        collector.collect
-        collector.definitions.reject(&:in_collection?)
-      end
-    end
-
-    def run(stdout: StringIO.new, stderr: StringIO.new) # rubocop:disable Metrics/MethodLength
-      @stdout = stdout
-      @stderr = stderr
-      return reporter.report_success if leftovers.empty?
-
-      only_test = []
-      none = []
-      leftovers.sort_by(&:location_s).each do |definition|
-        if !definition.test? && definition.in_test_collection?
-          only_test << definition
-        else
-          none << definition
-        end
-      end
-
-      reporter.report(only_test: only_test, none: none)
+      @config ||= MergedConfig.new(load_defaults: true)
     end
 
     def reset
@@ -122,16 +42,17 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
     end
 
     def resolution_instructions_link
-      "https://github.com/robotdana/leftovers/tree/v#{Leftovers::VERSION}/README.md#how-to-resolve"
+      "https://github.com/robotdana/leftovers/tree/v#{VERSION}/README.md#how-to-resolve"
     end
 
     def warn(message)
       stderr.puts("\e[2K#{message}")
     end
 
-    def error(message)
+    def error(message, did_you_mean = nil)
       warn("\e[31m#{message}\e[0m")
-      exit 1
+      warn("\n#{did_you_mean}") if did_you_mean
+      raise Exit, 1
     end
 
     def puts(message)
@@ -139,19 +60,15 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
     end
 
     def print(message)
-      stdout.print(message)
-    end
-
-    def newline
-      stdout.puts('')
+      stdout.print("\e[2K#{message}\r")
     end
 
     def pwd
-      @pwd ||= Pathname.new(Dir.pwd + '/')
+      @pwd ||= ::Pathname.new(::Dir.pwd + '/')
     end
 
     def exit(status = 0)
-      throw :leftovers_exit, status
+      raise Exit, status
     end
 
     def try_require(requirable, message: nil)
@@ -159,13 +76,11 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
       try_require_cache(requirable)
     end
 
-    def each_or_self(value, &block)
-      return enum_for(__method__, value) unless block
-
+    def wrap_array(value)
       case value
-      when nil then nil
-      when Array then value.each(&block)
-      else yield(value)
+      when nil then []
+      when ::Array then value
+      else [value]
       end
     end
 
@@ -185,7 +100,7 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
       @try_require_cache.fetch(requirable) do
         require requirable
         @try_require_cache[requirable] = true
-      rescue LoadError
+      rescue ::LoadError
         @try_require_cache[requirable] = false
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leftovers
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: did_you_mean
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -396,7 +382,9 @@ files:
 - lib/leftovers/ast/true_node.rb
 - lib/leftovers/ast/var_node.rb
 - lib/leftovers/ast/vasgn_node.rb
+- lib/leftovers/autoloader.rb
 - lib/leftovers/cli.rb
+- lib/leftovers/collection.rb
 - lib/leftovers/collector.rb
 - lib/leftovers/comparable_instance.rb
 - lib/leftovers/config.rb
@@ -405,6 +393,7 @@ files:
 - lib/leftovers/config_loader/argumentless_transform_schema.rb
 - lib/leftovers/config_loader/array_schema.rb
 - lib/leftovers/config_loader/attribute.rb
+- lib/leftovers/config_loader/bool_schema.rb
 - lib/leftovers/config_loader/built_in_precompiler_schema.rb
 - lib/leftovers/config_loader/document_schema.rb
 - lib/leftovers/config_loader/dynamic_schema.rb
@@ -445,18 +434,20 @@ files:
 - lib/leftovers/definition_node_set.rb
 - lib/leftovers/definition_set.rb
 - lib/leftovers/definition_to_add.rb
+- lib/leftovers/error.rb
 - lib/leftovers/file.rb
 - lib/leftovers/file_collector.rb
 - lib/leftovers/file_collector/comments_processor.rb
 - lib/leftovers/file_collector/node_processor.rb
+- lib/leftovers/file_collector/node_processor/error.rb
 - lib/leftovers/file_list.rb
 - lib/leftovers/matcher_builders.rb
 - lib/leftovers/matcher_builders/and.rb
-- lib/leftovers/matcher_builders/and_not.rb
 - lib/leftovers/matcher_builders/document.rb
 - lib/leftovers/matcher_builders/name.rb
 - lib/leftovers/matcher_builders/node.rb
 - lib/leftovers/matcher_builders/node_has_argument.rb
+- lib/leftovers/matcher_builders/node_has_block.rb
 - lib/leftovers/matcher_builders/node_has_keyword_argument.rb
 - lib/leftovers/matcher_builders/node_has_positional_argument.rb
 - lib/leftovers/matcher_builders/node_has_receiver.rb
@@ -479,6 +470,7 @@ files:
 - 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_block.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
@@ -495,6 +487,7 @@ files:
 - lib/leftovers/matchers/path.rb
 - lib/leftovers/merged_config.rb
 - lib/leftovers/parser.rb
+- lib/leftovers/precompile_error.rb
 - lib/leftovers/precompilers.rb
 - lib/leftovers/precompilers/erb.rb
 - lib/leftovers/precompilers/haml.rb
@@ -502,6 +495,7 @@ files:
 - lib/leftovers/precompilers/precompiler.rb
 - lib/leftovers/precompilers/slim.rb
 - lib/leftovers/precompilers/yaml.rb
+- lib/leftovers/precompilers/yaml/builder.rb
 - lib/leftovers/processor_builders.rb
 - lib/leftovers/processor_builders/action.rb
 - lib/leftovers/processor_builders/add_prefix.rb
@@ -509,6 +503,7 @@ files:
 - lib/leftovers/processor_builders/argument.rb
 - lib/leftovers/processor_builders/dynamic.rb
 - lib/leftovers/processor_builders/each.rb
+- lib/leftovers/processor_builders/each_for_definition_set.rb
 - lib/leftovers/processor_builders/itself.rb
 - lib/leftovers/processor_builders/keyword.rb
 - lib/leftovers/processor_builders/keyword_argument.rb
@@ -563,7 +558,9 @@ files:
 - lib/leftovers/processors/upcase.rb
 - lib/leftovers/rake_task.rb
 - lib/leftovers/reporter.rb
+- lib/leftovers/runner.rb
 - lib/leftovers/todo_reporter.rb
+- lib/leftovers/unexpected_case.rb
 - lib/leftovers/version.rb
 homepage: http://github.com/robotdana/leftovers
 licenses:
@@ -588,7 +585,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Find unused methods and classes/modules

data/lib/leftovers/matcher_builders/and_not.rb

@@ -1,16 +0,0 @@
-# frozen-string-literal: true
-
-module Leftovers
-  module MatcherBuilders
-    module AndNot
-      class << self
-        def build(positive_matcher, negative_matcher)
-          ::Leftovers::MatcherBuilders::And.build([
-            positive_matcher,
-            ::Leftovers::MatcherBuilders::Unless.build(negative_matcher)
-          ])
-        end
-      end
-    end
-  end
-end