leftovers 0.4.0 → 0.5.0

data/lib/leftovers/merged_config.rb

@@ -12,6 +12,7 @@ module Leftovers
 
       self << :ruby
       self << project_config
+      self << project_todo
       load_bundled_gem_config
     end
 
@@ -32,10 +33,16 @@ module Leftovers
       Leftovers::Config.new(:'.leftovers.yml', path: Leftovers.pwd + '.leftovers.yml')
     end
 
-    def unmemoize
+    def project_todo
+      Leftovers::Config.new(:'.leftovers_todo.yml', path: Leftovers.pwd + '.leftovers_todo.yml')
+    end
+
+    def unmemoize # rubocop:disable Metrics/CyclomaticComplexity
       remove_instance_variable(:@exclude_paths) if defined?(@exclude_paths)
       remove_instance_variable(:@include_paths) if defined?(@include_paths)
       remove_instance_variable(:@test_paths) if defined?(@test_paths)
+      remove_instance_variable(:@haml_paths) if defined?(@haml_paths)
+      remove_instance_variable(:@erb_paths) if defined?(@erb_paths)
       remove_instance_variable(:@dynamic) if defined?(@dynamic)
       remove_instance_variable(:@keep) if defined?(@keep)
     end
@@ -56,6 +63,22 @@ module Leftovers
       )
     end
 
+    def haml_paths
+      @haml_paths ||= FastIgnore.new(
+        include_rules: @configs.flat_map(&:haml_paths),
+        gitignore: false,
+        root: Leftovers.pwd
+      )
+    end
+
+    def erb_paths
+      @erb_paths ||= FastIgnore.new(
+        include_rules: @configs.flat_map(&:erb_paths),
+        gitignore: false,
+        root: Leftovers.pwd
+      )
+    end
+
     def dynamic
       @dynamic ||= ::Leftovers::ProcessorBuilders::EachDynamic.build(@configs.map(&:dynamic))
     end
@@ -64,6 +87,10 @@ module Leftovers
       @keep ||= ::Leftovers::MatcherBuilders::Or.build(@configs.map(&:keep))
     end
 
+    def test_only
+      @test_only ||= ::Leftovers::MatcherBuilders::Or.build(@configs.map(&:test_only))
+    end
+
     private
 
     def load_bundled_gem_config

data/lib/leftovers/reporter.rb

@@ -2,10 +2,62 @@
 
 module Leftovers
   class Reporter
-    def call(definition)
-      Leftovers.puts(
-        "\e[36m#{definition.location_s}\e[0m #{definition} \e[2m#{definition.highlighted_source("\e[33m", "\e[0;2m")}\e[0m" # rubocop:disable Layout/LineLength
-      )
+    def prepare; end
+
+    def report(only_test:, none:)
+      report_list('Only directly called in tests:', only_test)
+      report_list('Not directly called at all:', none)
+      report_instructions
+
+      1
+    end
+
+    def report_success
+      puts green('Everything is used')
+
+      0
+    end
+
+    private
+
+    def report_instructions
+      puts <<~HELP
+
+        how to resolve: #{green Leftovers.resolution_instructions_link}
+      HELP
+    end
+
+    def report_list(title, list)
+      return if list.empty?
+
+      puts red(title)
+      list.each { |d| print_definition(d) }
+    end
+
+    def print_definition(definition)
+      puts "#{aqua definition.location_s} "\
+        "#{definition} "\
+        "#{grey definition.highlighted_source("\e[33m", "\e[0;2m")}"
+    end
+
+    def puts(string)
+      Leftovers.puts(string)
+    end
+
+    def red(string)
+      "\e[31m#{string}\e[0m"
+    end
+
+    def green(string)
+      "\e[32m#{string}\e[0m"
+    end
+
+    def aqua(string)
+      "\e[36m#{string}\e[0m"
+    end
+
+    def grey(string)
+      "\e[2m#{string}\e[0m"
     end
   end
 end

data/lib/leftovers/todo_reporter.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+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)
+      none_test = none.select(&:test?)
+      none_non_test = none.reject(&:test?)
+      [
+        test_only_data(none_test),
+        keep_data(only_test, none_non_test)
+      ].compact.join
+    end
+
+    def test_only_data(list)
+      return if list.empty?
+
+      <<~YML
+        test_only:
+        #{generate_list('Defined in tests:', list).chomp}
+      YML
+    end
+
+    def keep_data(only_test, none_non_test)
+      return if only_test.empty? && none_non_test.empty?
+
+      <<~YML.chomp
+        keep:
+        #{keep_test_called_data(only_test)}#{keep_never_called_data(none_non_test)}
+      YML
+    end
+
+    def keep_test_called_data(list)
+      return if list.empty?
+
+      generate_list('Only directly called in tests:', list)
+    end
+
+    def keep_never_called_data(list)
+      return if list.empty?
+
+      generate_list('Not directly called at all:', list)
+    end
+
+    def generate_list(title, list)
+      <<~YML
+          # #{title}
+        #{print_definition_list(list)}
+
+      YML
+    end
+
+    def print_definition_list(definition_list)
+      definition_list.map { |definition| print_definition(definition) }.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

data/lib/leftovers/value_processors/each_for_definition_set.rb

@@ -9,7 +9,7 @@ module Leftovers
         freeze
       end
 
-      def process(str, node, method_node) # rubocop:disable Metrics/MethodLength
+      def process(str, node, method_node)
         definitions = @then_processors.map do |then_processor|
           processed = then_processor.process(str, node, method_node)
           return if processed == :keep # rubocop:disable Lint/NonLocalExitFromIterator
@@ -22,11 +22,7 @@ module Leftovers
 
         return definitions.first if definitions.length <= 1
 
-        ::Leftovers::DefinitionSet.new(
-          definitions,
-          location: node.loc.expression,
-          method_node: method_node
-        )
+        ::Leftovers::DefinitionSet.new(definitions)
       end
     end
   end

data/lib/leftovers/value_processors/return_definition.rb

@@ -11,12 +11,14 @@ module Leftovers
         return unless str
         return if str.empty?
 
-        return :keep if ::Leftovers.config.keep === node
+        str_node = Leftovers::DefinitionNode.new(str.to_sym, method_node.path)
+
+        return :keep if ::Leftovers.config.keep === str_node
 
         Leftovers::Definition.new(
-          str.to_sym,
+          str_node.name,
           location: node.loc.expression,
-          method_node: method_node
+          test: method_node.test_line? || ::Leftovers.config.test_only === str_node
         )
       end
     end

data/lib/leftovers/version.rb

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

data/lib/leftovers.rb

@@ -3,14 +3,13 @@
 module Leftovers # rubocop:disable Metrics/ModuleLength
   class Error < ::StandardError; end
 
-  module_function
-
   autoload(:AST, "#{__dir__}/leftovers/ast")
   autoload(:Backports, "#{__dir__}/leftovers/backports")
   autoload(:CLI, "#{__dir__}/leftovers/cli")
   autoload(:Collector, "#{__dir__}/leftovers/collector")
   autoload(:ConfigValidator, "#{__dir__}/leftovers/config_validator")
   autoload(:Config, "#{__dir__}/leftovers/config")
+  autoload(:DefinitionNode, "#{__dir__}/leftovers/definition_node")
   autoload(:DefinitionSet, "#{__dir__}/leftovers/definition_set")
   autoload(:Definition, "#{__dir__}/leftovers/definition")
   autoload(:ERB, "#{__dir__}/leftovers/erb")
@@ -25,136 +24,135 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
   autoload(:ProcessorBuilders, "#{__dir__}/leftovers/processor_builders")
   autoload(:RakeTask, "#{__dir__}/leftovers/rake_task")
   autoload(:Reporter, "#{__dir__}/leftovers/reporter")
+  autoload(:TodoReporter, "#{__dir__}/leftovers/todo_reporter")
   autoload(:DynamicProcessors, "#{__dir__}/leftovers/dynamic_processors")
   autoload(:ValueProcessors, "#{__dir__}/leftovers/value_processors")
   autoload(:VERSION, "#{__dir__}/leftovers/version")
 
   class << self
     attr_accessor :parallel, :progress
+    attr_writer :reporter
     alias_method :parallel?, :parallel
-
     alias_method :progress?, :progress
-  end
-
-  def stdout
-    @stdout ||= $stdout
-  end
 
-  def stderr
-    @stderr ||= $stderr
-  end
+    def stdout
+      @stdout ||= $stdout
+    end
 
-  def config
-    @config ||= Leftovers::MergedConfig.new(load_defaults: true)
-  end
+    def stderr
+      @stderr ||= $stderr
+    end
 
-  def collector
-    @collector ||= Leftovers::Collector.new
-  end
+    def config
+      @config ||= Leftovers::MergedConfig.new(load_defaults: true)
+    end
 
-  def reporter
-    @reporter ||= Leftovers::Reporter.new
-  end
+    def collector
+      @collector ||= Leftovers::Collector.new
+    end
 
-  def leftovers
-    @leftovers ||= begin
-      collector.collect
-      collector.definitions.reject(&:in_collection?)
+    def reporter
+      @reporter ||= Leftovers::Reporter.new
     end
-  end
 
-  def run(stdout: StringIO.new, stderr: StringIO.new) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    @stdout = stdout
-    @stderr = stderr
-    return 0 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
+    def leftovers
+      @leftovers ||= begin
+        collector.collect
+        collector.definitions.reject(&:in_collection?)
       end
     end
 
-    unless only_test.empty?
-      puts "\e[31mOnly directly called in tests:\e[0m"
-      only_test.each { |definition| reporter.call(definition) }
+    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)
     end
 
-    unless none.empty?
-      puts "\e[31mNot directly called at all:\e[0m"
-      none.each { |definition| reporter.call(definition) }
+    def reset # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+      remove_instance_variable(:@config) if defined?(@config)
+      remove_instance_variable(:@collector) if defined?(@collector)
+      remove_instance_variable(:@reporter) if defined?(@reporter)
+      remove_instance_variable(:@leftovers) if defined?(@leftovers)
+      remove_instance_variable(:@try_require_cache) if defined?(@try_require_cache)
+      remove_instance_variable(:@stdout) if defined?(@stdout)
+      remove_instance_variable(:@stderr) if defined?(@stderr)
+      remove_instance_variable(:@parallel) if defined?(@parallel)
+      remove_instance_variable(:@pwd) if defined?(@pwd)
     end
 
-    1
-  end
+    def resolution_instructions_link
+      "https://github.com/robotdana/leftovers/tree/v#{Leftovers::VERSION}/README.md#how_to_resolve"
+    end
 
-  def reset # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
-    remove_instance_variable(:@config) if defined?(@config)
-    remove_instance_variable(:@collector) if defined?(@collector)
-    remove_instance_variable(:@reporter) if defined?(@reporter)
-    remove_instance_variable(:@leftovers) if defined?(@leftovers)
-    remove_instance_variable(:@try_require) if defined?(@try_require)
-    remove_instance_variable(:@stdout) if defined?(@stdout)
-    remove_instance_variable(:@stderr) if defined?(@stderr)
-    remove_instance_variable(:@parallel) if defined?(@parallel)
-    remove_instance_variable(:@pwd) if defined?(@pwd)
-  end
+    def warn(message)
+      stderr.puts("\e[2K#{message}")
+    end
 
-  def warn(message)
-    stderr.puts("\e[2K#{message}")
-  end
+    def error(message)
+      warn(message)
+      exit 1
+    end
 
-  def error(message)
-    warn(message)
-    exit 1
-  end
+    def puts(message)
+      stdout.puts("\e[2K#{message}")
+    end
 
-  def puts(message)
-    stdout.puts("\e[2K#{message}")
-  end
+    def print(message)
+      stdout.print(message)
+    end
 
-  def print(message)
-    stdout.print(message)
-  end
+    def newline
+      stdout.puts('')
+    end
 
-  def newline
-    stdout.puts('')
-  end
+    def pwd
+      @pwd ||= Pathname.new(Dir.pwd + '/')
+    end
 
-  def pwd
-    @pwd ||= Pathname.new(Dir.pwd + '/')
-  end
+    def exit(status = 0)
+      throw :leftovers_exit, status
+    end
 
-  def exit(status = 0)
-    throw :leftovers_exit, status
-  end
+    def try_require(requirable, message: nil)
+      warn message if !try_require_cache(requirable) && message
+      try_require_cache(requirable)
+    end
 
-  def try_require(requirable, message: nil) # rubocop:disable Metrics/MethodLength
-    @try_require ||= {}
+    def each_or_self(value, &block)
+      return enum_for(__method__, value) unless block
 
-    @try_require[requirable] = begin
-      if @try_require.key?(requirable)
-        @try_require[requirable]
-      else
-        require requirable
-        true
+      case value
+      when nil then nil
+      when Array then value.each(&block)
+      else yield(value)
       end
-    rescue LoadError
-      false
     end
 
-    warn message if !@try_require[requirable] && message
-    @try_require[requirable]
-  end
+    private
 
-  def each_or_self(value, &block)
-    case value
-    when nil then nil
-    when Array then value.each(&block)
-    else yield(value)
+    def try_require_cache(requirable)
+      @try_require_cache ||= {}
+
+      @try_require_cache.fetch(requirable) do
+        begin
+          require requirable
+          @try_require_cache[requirable] = true
+        rescue LoadError
+          @try_require_cache[requirable] = false
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leftovers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: tty_string
   requirement: !ruby/object:Gem::Requirement
@@ -277,6 +291,14 @@ files:
 - docs/Configuration.md
 - exe/leftovers
 - leftovers.gemspec
+- lib/config/actioncable.yml
+- lib/config/actionmailer.yml
+- lib/config/actionpack.yml
+- lib/config/actionview.yml
+- lib/config/activejob.yml
+- lib/config/activemodel.yml
+- lib/config/activerecord.yml
+- lib/config/activesupport.yml
 - lib/config/attr_encrypted.yml
 - lib/config/audited.yml
 - lib/config/builder.yml
@@ -313,6 +335,7 @@ files:
 - lib/leftovers/config_validator/error_processor.rb
 - lib/leftovers/config_validator/schema_hash.rb
 - lib/leftovers/definition.rb
+- lib/leftovers/definition_node.rb
 - lib/leftovers/definition_set.rb
 - lib/leftovers/dynamic_processors.rb
 - lib/leftovers/dynamic_processors/call.rb
@@ -328,17 +351,18 @@ files:
 - lib/leftovers/matcher_builders.rb
 - lib/leftovers/matcher_builders/and.rb
 - lib/leftovers/matcher_builders/and_not.rb
-- lib/leftovers/matcher_builders/argument_node_value.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_keyword_argument.rb
 - lib/leftovers/matcher_builders/node_has_positional_argument.rb
+- lib/leftovers/matcher_builders/node_has_receiver.rb
 - lib/leftovers/matcher_builders/node_name.rb
 - lib/leftovers/matcher_builders/node_pair_name.rb
 - lib/leftovers/matcher_builders/node_pair_value.rb
 - lib/leftovers/matcher_builders/node_path.rb
 - lib/leftovers/matcher_builders/node_type.rb
+- lib/leftovers/matcher_builders/node_value.rb
 - lib/leftovers/matcher_builders/or.rb
 - lib/leftovers/matcher_builders/path.rb
 - lib/leftovers/matcher_builders/string.rb
@@ -352,6 +376,7 @@ files:
 - lib/leftovers/matchers/node_has_any_positional_argument_with_value.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
 - lib/leftovers/matchers/node_name.rb
 - lib/leftovers/matchers/node_pair_value.rb
 - lib/leftovers/matchers/node_path.rb
@@ -359,6 +384,7 @@ files:
 - lib/leftovers/matchers/node_type.rb
 - lib/leftovers/matchers/not.rb
 - lib/leftovers/matchers/or.rb
+- lib/leftovers/matchers/predicate.rb
 - lib/leftovers/merged_config.rb
 - lib/leftovers/parser.rb
 - lib/leftovers/processor_builders.rb
@@ -380,6 +406,7 @@ files:
 - lib/leftovers/processor_builders/value.rb
 - lib/leftovers/rake_task.rb
 - lib/leftovers/reporter.rb
+- lib/leftovers/todo_reporter.rb
 - lib/leftovers/value_processors.rb
 - lib/leftovers/value_processors/add_dynamic_prefix.rb
 - lib/leftovers/value_processors/add_dynamic_suffix.rb
@@ -438,8 +465,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Find unused methods and classes/modules

data/lib/leftovers/matcher_builders/argument_node_value.rb

@@ -1,21 +0,0 @@
-# frozen-string-literal: true
-
-module Leftovers
-  module MatcherBuilders
-    module ArgumentNodeValue
-      def self.build(pattern)
-        ::Leftovers::MatcherBuilders::Or.each_or_self(pattern) do |pat|
-          case pat
-          when ::Integer, true, false, nil
-            ::Leftovers::Matchers::NodeScalarValue.new(pat)
-          when ::String, ::Hash
-            ::Leftovers::MatcherBuilders::NodeName.build(pat)
-          # :nocov:
-          else raise
-            # :nocov:
-          end
-        end
-      end
-    end
-  end
-end