leftovers 0.2.3 → 0.4.3

data/lib/config/redcarpet.yml

@@ -1,38 +1,35 @@
----
-rules:
-  skip: true
-  names:
-    - block_code
-    - block_quote
-    - block_html
-    - footnotes
-    - footnote_def
-    - header
-    - hrule
-    - list
-    - list_item
-    - paragraph
-    - table
-    - table_row
-    - table_cell
-    - autolink
-    - codespan
-    - double_emphasis
-    - emphasis
-    - image
-    - linebreak
-    - link
-    - raw_html
-    - triple_emphasis
-    - strikethrough
-    - superscript
-    - underline
-    - highlight
-    - quote
-    - footnote_ref
-    - entity
-    - normal_text
-    - doc_header
-    - doc_footer
-    - preprocess
-    - postprocess
+keep:
+  - autolink
+  - block_code
+  - block_html
+  - block_quote
+  - codespan
+  - doc_footer
+  - doc_header
+  - double_emphasis
+  - emphasis
+  - entity
+  - footnote_def
+  - footnote_ref
+  - footnotes
+  - header
+  - highlight
+  - hrule
+  - image
+  - linebreak
+  - link
+  - list
+  - list_item
+  - normal_text
+  - paragraph
+  - postprocess
+  - preprocess
+  - quote
+  - raw_html
+  - strikethrough
+  - superscript
+  - table
+  - table_cell
+  - table_row
+  - triple_emphasis
+  - underline

data/lib/config/rollbar.yml

@@ -1,3 +1 @@
-rules:
-  skip: true
-  name: current_user_for_rollbar
+keep: current_user_for_rollbar

data/lib/config/rspec.yml

@@ -1,8 +1,10 @@
 test_paths:
   - /spec/
 
-rules:
-  - skip: true
+# split into gems too
+
+keep:
+  - path: /spec/
     name:
       # matchers
       - diffable?
@@ -22,28 +24,31 @@ rules:
       - dump_summary
       - seed
       - close
+dynamic:
   - name:
       - have_attributes
       - has_attributes?
       - receive_messages
     calls:
-      - keys: '*'
+      keywords: '**'
+    path: /spec/
   - name:
     - receive
     - respond_to
     calls:
-      argument: 1
+      argument: 0
+    path: /spec/
   - name: define_negated_matcher
-    defines:
-      argument: 1
-    calls:
-      argument: 2
+    defines: 0
+    calls: 1
+    path: /spec/
   - name:
       has_prefix: be_
     calls:
       itself: true
       delete_prefix: be_
       add_suffix: '?'
+    path: /spec/
   - name:
       has_prefix: have_
     calls:
@@ -51,6 +56,9 @@ rules:
       add_suffix: '?'
       delete_prefix: have_
       add_prefix: has_
+    path: /spec/
   - name: let
-    defines:
-      argument: 1
+    unless:
+      has_argument: 1
+    defines: 0
+    path: /spec/

data/lib/config/ruby.yml

@@ -1,48 +1,48 @@
 ---
 include_paths:
-  - '*.rb'
-  - Gemfile
-  - '*.erb'
+  - '#!:ruby'
   - '*.gemspec'
   - .irbrc
   - irb.rc
   - _irbrc
   - $irbrc
+  - Gemfile
+  - '*.erb'
+  - '*.rb'
 
 test_paths:
   - /tests/
   - /test/
 
-rules:
-  - skip: true
-    name:
-      - initialize # called by new
-      - inspect # called by repl, to_s
-      - respond_to_missing? # called by respond_to?
-      - method_missing # called by method dispatch
-      - coerce # called by Numeric
-      - to_s # called by "#{}"
-      - to_ary # called by Array(), []+
-      - to_a # called by Array(), *splat
-      - to_str # called by String(), ""+
-      - to_hash # called by Hash(), **splat, {}.merge
-      - to_int # called by Integer()
-      - to_i # called by Integer()
-      - to_f # called by Float()
-      - <=> # called by Comparable
-      - each # called by Enumerable
-      - marshal_dump # called by Marshal.dump
-      - marshal_load # called by Marshal.load
-      - _dump # called by Marshal.dump
-      - _load # called by Marshal.load
-      - inherited # called by Subclass < Klass or Class.new(Klass)
-      - extended # called by extend Module
-      - included # called by include Module
-      - $VERBOSE # called by whatever is outputting warnings i guess
-      - === # called by when
-      - == # called by Array value, Hash value equality, ===
-      - hash # called by Hash key equality
-      - eql? # called by Hash key equality
+keep:
+  - initialize # called by new
+  - inspect # called by repl, to_s
+  - respond_to_missing? # called by respond_to?
+  - method_missing # called by method dispatch
+  - coerce # called by Numeric
+  - to_s # called by "#{}"
+  - to_ary # called by Array(), []+
+  - to_a # called by Array(), *splat
+  - to_str # called by String(), ""+
+  - to_hash # called by Hash(), **splat, {}.merge
+  - to_int # called by Integer()
+  - to_i # called by Integer()
+  - to_f # called by Float()
+  - <=> # called by Comparable
+  - each # called by Enumerable
+  - marshal_dump # called by Marshal.dump
+  - marshal_load # called by Marshal.load
+  - _dump # called by Marshal.dump
+  - _load # called by Marshal.load
+  - inherited # called by Subclass < Klass or Class.new(Klass)
+  - extended # called by extend Module
+  - included # called by include Module
+  - $VERBOSE # called by whatever is outputting warnings i guess
+  - === # called by when
+  - == # called by Array value, Hash value equality, ===
+  - hash # called by Hash key equality
+  - eql? # called by Hash key equality
+dynamic:
   - name:
       - send
       - public_send
@@ -50,8 +50,7 @@ rules:
       - method
       - respond_to?
       - instance_method
-    calls:
-      argument: 1
+    calls: 0
   - name: attr_reader
     defines:
       argument: '*'
@@ -65,27 +64,21 @@ rules:
   - name: attr_accessor
     defines:
       - argument: '*'
-        transforms:
-          - original
-          - add_suffix: '='
+        add_suffix: '='
+      - argument: '*'
     calls:
       argument: '*'
       add_prefix: '@'
   - name: define_method
-    defines:
-      argument: 1
+    defines: 0
   - name: alias_method
-    defines:
-      argument: 1
-    calls:
-      argument: 2
+    defines: 0
+    calls: 1
   - name:
       - instance_variable_get
-      - class_variable_set
-    calls:
-      argument: 1
+      - class_variable_get
+    calls: 0
   - name:
       - instance_variable_set
       - class_variable_set
-    defines:
-      argument: 1
+    defines: 0

data/lib/config/selenium-webdriver.yml

@@ -0,0 +1,19 @@
+keep:
+  - before_navigate_to
+  - before_navigate_back
+  - after_navigate_back
+  - before_navigate_forward
+  - after_navigate_forward
+  - before_find
+  - after_find
+  - before_click
+  - before_change_value_of
+  - after_change_value_of
+  - before_execute_script
+  - after_execute_script
+  - before_quit
+  - before_close
+  - after_navigate_to
+  - after_click
+  - after_quit
+  - after_close

data/lib/config/sidekiq.yml

@@ -1,13 +1,9 @@
-rules:
-  - skip: true
-    names:
-      - on_complete
+keep: on_complete
+dynamic:
   - names:
       - perform_async
     calls:
-      itself: true
-      delete_suffix: _async
+      value: perform
   - name: register
     calls:
-      argument: 2
-
+      argument: 1

data/lib/config/will_paginate.yml

@@ -1,14 +1,12 @@
-rules:
-  skip: true
-  name:
-    # WillPaginate::ViewHelpers::LinkRenderer
-    - page_number
-    - gap
-    - previous_page
-    - next_page
-    - previous_or_next_page
-    - html_container
-    - url
-    - prepare
-    - to_html
-    - container_attributes
+keep:
+  # WillPaginate::ViewHelpers::LinkRenderer
+  - page_number
+  - gap
+  - previous_page
+  - next_page
+  - previous_or_next_page
+  - html_container
+  - url
+  - prepare
+  - to_html
+  - container_attributes

data/lib/leftovers.rb

@@ -1,22 +1,39 @@
 # frozen_string_literal: true
 
-require_relative './leftovers/core_ext'
-require_relative './leftovers/backports'
-require_relative './leftovers/collector'
-require_relative './leftovers/merged_config'
-require_relative './leftovers/reporter'
-
 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")
+  autoload(:FileCollector, "#{__dir__}/leftovers/file_collector")
+  autoload(:FileList, "#{__dir__}/leftovers/file_list")
+  autoload(:File, "#{__dir__}/leftovers/file")
+  autoload(:Haml, "#{__dir__}/leftovers/haml")
+  autoload(:MatcherBuilders, "#{__dir__}/leftovers/matcher_builders")
+  autoload(:Matchers, "#{__dir__}/leftovers/matchers")
+  autoload(:MergedConfig, "#{__dir__}/leftovers/merged_config")
+  autoload(:Parser, "#{__dir__}/leftovers/parser")
+  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
+    attr_accessor :parallel, :progress, :reporter
     alias_method :parallel?, :parallel
-
-    attr_accessor :quiet
-    alias_method :quiet?, :quiet
-
-    attr_accessor :progress
     alias_method :progress?, :progress
   end
 
@@ -29,7 +46,7 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
   end
 
   def config
-    @config ||= Leftovers::MergedConfig.new
+    @config ||= Leftovers::MergedConfig.new(load_defaults: true)
   end
 
   def collector
@@ -40,24 +57,21 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
     @reporter ||= Leftovers::Reporter.new
   end
 
-  def leftovers # rubocop:disable Metrics/MethodLength
+  def leftovers
     @leftovers ||= begin
       collector.collect
-      collector.definitions.reject do |definition|
-        definition.skipped? || definition.in_collection?
-      end
+      collector.definitions.reject(&:in_collection?)
     end
   end
 
-  def run(stdout: StringIO.new, stderr: StringIO.new) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    reset
+  def run(stdout: StringIO.new, stderr: StringIO.new) # rubocop:disable Metrics/MethodLength
     @stdout = stdout
     @stderr = stderr
-    return 0 if leftovers.empty?
+    return reporter.report_success if leftovers.empty?
 
     only_test = []
     none = []
-    leftovers.sort.each do |definition|
+    leftovers.sort_by(&:location_s).each do |definition|
       if !definition.test? && definition.in_test_collection?
         only_test << definition
       else
@@ -65,20 +79,10 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
       end
     end
 
-    unless only_test.empty?
-      puts "\e[31mOnly directly called in tests:\e[0m"
-      only_test.each { |definition| reporter.call(definition) }
-    end
-
-    unless none.empty?
-      puts "\e[31mNot directly called at all:\e[0m"
-      none.each { |definition| reporter.call(definition) }
-    end
-
-    1
+    reporter.report(only_test: only_test, none: none)
   end
 
-  def reset # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+  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)
@@ -87,20 +91,28 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
     remove_instance_variable(:@stdout) if defined?(@stdout)
     remove_instance_variable(:@stderr) if defined?(@stderr)
     remove_instance_variable(:@parallel) if defined?(@parallel)
-    remove_instance_variable(:@quiet) if defined?(@quiet)
     remove_instance_variable(:@pwd) if defined?(@pwd)
   end
 
+  def resolution_instructions_link
+    "https://github.com/robotdana/leftovers/tree/v#{Leftovers::VERSION}/README.md#how_to_resolve"
+  end
+
   def warn(message)
-    stderr.puts("\e[2K#{message}") unless quiet?
+    stderr.puts("\e[2K#{message}")
+  end
+
+  def error(message)
+    warn(message)
+    exit 1
   end
 
   def puts(message)
-    stdout.puts("\e[2K#{message}") unless quiet?
+    stdout.puts("\e[2K#{message}")
   end
 
   def print(message)
-    stdout.print(message) unless quiet?
+    stdout.print(message)
   end
 
   def newline
@@ -111,18 +123,26 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
     @pwd ||= Pathname.new(Dir.pwd + '/')
   end
 
-  def try_require(*requirables, message: nil) # rubocop:disable Metrics/MethodLength
+  def exit(status = 0)
+    throw :leftovers_exit, status
+  end
+
+  def try_require(requirable, message: nil) # rubocop:disable Metrics/MethodLength
     @try_require ||= {}
-    requirables.each do |requirable|
-      begin
-        return @try_require[requirable] if @try_require.key?(requirable)
-
-        @try_require[requirable] = require requirable
-      rescue LoadError
-        warn message if message
-        @try_require[requirable] = false
+
+    @try_require[requirable] = begin
+      if @try_require.key?(requirable)
+        @try_require[requirable]
+      else
+        require requirable
+        true
       end
+    rescue LoadError
+      false
     end
+
+    warn message if !@try_require[requirable] && message
+    @try_require[requirable]
   end
 
   def each_or_self(value, &block)
@@ -132,12 +152,4 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
     else yield(value)
     end
   end
-
-  def array_wrap(value)
-    case value
-    when nil then [].freeze
-    when Array then value
-    else [value]
-    end
-  end
 end