leftovers 0.2.3 → 0.3.0

data/lib/leftovers/backports.rb

@@ -3,6 +3,14 @@
 module Leftovers
   ruby_version = Gem::Version.new(RUBY_VERSION)
   unless ruby_version >= Gem::Version.new('2.5')
+    require 'set'
+    module SetCaseEq
+      refine ::Set do
+        def ===(value)
+          include?(value)
+        end
+      end
+    end
     module StringDeletePrefixSuffix
       refine ::String do
         def delete_prefix!(str)
@@ -24,33 +32,5 @@ module Leftovers
         end
       end
     end
-
-    require 'yaml'
-    module YAMLSymbolizeNames
-      refine YAML.singleton_class do
-        alias_method :safe_load_without_symbolize_names, :safe_load
-        def safe_load(path, *args, symbolize_names: false, **kwargs)
-          if symbolize_names
-            symbolize_names!(safe_load_without_symbolize_names(path, *args, **kwargs))
-          else
-            safe_load_without_symbolize_names(path, *args, **kwargs)
-          end
-        end
-
-        private
-
-        def symbolize_names!(obj) # rubocop:disable Metrics/MethodLength
-          case obj
-          when Hash
-            obj.keys.each do |key| # rubocop:disable Style/HashEachMethods # each_key never finishes.
-              obj[key.to_sym] = symbolize_names!(obj.delete(key))
-            end
-          when Array
-            obj.map! { |ea| symbolize_names!(ea) }
-          end
-          obj
-        end
-      end
-    end
   end
 end

data/lib/leftovers/cli.rb

@@ -6,25 +6,31 @@ require_relative 'version'
 
 module Leftovers
   class CLI
-    attr_reader :argv, :stdout, :stderr
-
     def initialize(argv: [], stdout: $stdout, stderr: $stderr)
       @argv = argv
       @stdout = stdout
       @stderr = stderr
+    end
 
-      parse_options
+    def run
+      catch(:leftovers_exit) do
+        Leftovers.reset
+        parse_options
 
-      exit Leftovers.run(stdout: stdout, stderr: stderr)
+        Leftovers.run(stdout: stdout, stderr: stderr)
+      end
     end
 
+    private
+
+    attr_reader :argv, :stdout, :stderr
+
     def parse_options # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       opts = OptionParser.new
       Leftovers.parallel = true
       Leftovers.progress = true
 
       opts.banner = 'Usage: leftovers [options]'
-      opts.on('-q', '--quiet', 'Silences output') { Leftovers.quiet = true }
       opts.on('--[no-]parallel', 'Run in parallel or not, default --parallel') do |p|
         Leftovers.parallel = p
       end
@@ -32,16 +38,16 @@ module Leftovers
         Leftovers.progress = p
       end
       opts.on('-v', '--version', 'Returns the current version') do
-        stdout.puts(Leftovers::Version)
-        exit
+        stdout.puts(Leftovers::VERSION)
+        Leftovers.exit
       end
       opts.on('--dry-run', 'Output files that will be looked at') do
-        stdout.puts(Leftovers::FileList.new.to_a.map(&:relative_path).join("\n"))
-        exit
+        Leftovers::FileList.new.each { |f| stdout.puts f.relative_path }
+        Leftovers.exit
       end
       opts.on('-h', '--help', 'Shows this message') do
         stdout.puts(opts.help)
-        exit
+        Leftovers.exit
       end
 
       opts.parse(argv)

data/lib/leftovers/collector.rb

@@ -31,9 +31,9 @@ module Leftovers
 
     def collect_file_list(list)
       if Leftovers.parallel?
-        Parallel.each(list, finish: method(:finish_parallel), &method(:collect_file))
+        Parallel.each(list, finish: method(:finish_file), &method(:collect_file))
       else
-        list.each { |file| finish_parallel(nil, nil, collect_file(file)) }
+        list.each { |file| finish_file(nil, nil, collect_file(file)) }
       end
     end
 
@@ -46,11 +46,11 @@ module Leftovers
 
     def print_progress
       Leftovers.print(
-        "checked #{@count} files, collected #{@count_calls} calls, #{@count_definitions} definitions\r" # rubocop:disable Layout/LineLength
+        "\e[2Kchecked #{@count} files, collected #{@count_calls} calls, #{@count_definitions} definitions\r" # rubocop:disable Layout/LineLength
       )
     end
 
-    def finish_parallel(_, _, result) # rubocop:disable Metrics/MethodLength
+    def finish_file(_, _, result) # rubocop:disable Metrics/MethodLength
       @count += 1
       @count_calls += result[:calls].length
       @count_definitions += result[:definitions].length

data/lib/leftovers/config.rb

@@ -6,16 +6,12 @@ require_relative 'rule'
 module Leftovers
   class Config
     # :nocov:
-    using ::Leftovers::YAMLSymbolizeNames if defined?(::Leftovers::YAMLSymbolizeNames)
+    using ::Leftovers::SetCaseEq if defined?(::Leftovers::SetCaseEq)
     # :nocov:
 
     attr_reader :name
 
-    def initialize(
-      name,
-      path: ::File.join(__dir__, '..', 'config', "#{name}.yml"),
-      content: (::File.exist?(path) ? ::File.read(path) : '')
-    )
+    def initialize(name, path: nil, content: nil)
       @name = name.to_sym
       @path = path
       @content = content
@@ -39,15 +35,46 @@ module Leftovers
 
     def rules
       @rules ||= Rule.wrap(yaml[:rules])
+    rescue Leftovers::ConfigError => e
+      warn "\e[31mConfig Error: (#{path}): #{e.message}\e[0m"
+      Leftovers.exit 1
     end
 
     private
 
-    def yaml
-      @yaml ||= YAML.safe_load(@content, symbolize_names: true) || {}
-    rescue Psych::SyntaxError => e
-      warn "\e[31mError with config #{path}: #{e.message}\e[0m"
-      exit 1
+    def content
+      @content ||= ::File.exist?(path) ? ::File.read(path) : ''
     end
+
+    def path
+      @path ||= ::File.expand_path("../config/#{name}.yml", __dir__)
+    end
+
+    def yaml # rubocop:disable Metrics/MethodLength
+      # :nocov:
+      @yaml ||= if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
+        Psych.safe_load(content, symbolize_names: true, filename: path) || {}
+      else
+        symbolize_names!(Psych.safe_load(content, [], [], false, path)) || {}
+      end
+      # :nocov:
+    rescue ::Psych::SyntaxError => e
+      warn "\e[31mConfig SyntaxError: #{e.message}\e[0m"
+      Leftovers.exit 1
+    end
+
+    # :nocov:
+    def symbolize_names!(obj) # rubocop:disable Metrics/MethodLength
+      case obj
+      when Hash
+        obj.keys.each do |key| # rubocop:disable Style/HashEachMethods # each_key never finishes.
+          obj[key.to_sym] = symbolize_names!(obj.delete(key))
+        end
+      when Array
+        obj.map! { |ea| symbolize_names!(ea) }
+      end
+      obj
+    end
+    # :nocov:
   end
 end

data/lib/leftovers/core_ext.rb

@@ -3,11 +3,13 @@
 require 'set'
 
 class Array
-  def leftovers_append(other)
-    case other
-    when Array, Set then concat(other)
-    when nil then self
-    else self.<< other
+  def leftovers_append(other) # rubocop:disable Metrics/MethodLength
+    return self if other.nil?
+
+    if other.respond_to?(:to_a)
+      concat(other.to_a)
+    else
+      self << other
     end
   end
 end

data/lib/leftovers/definition.rb

@@ -4,13 +4,10 @@ module Leftovers
   class Definition
     attr_reader :name
     alias_method :names, :name
-    alias_method :full_name, :name
-    attr_reader :name_s
-    alias_method :to_s, :name_s
     attr_reader :test
     alias_method :test?, :test
 
-    def initialize( # rubocop:disable Metrics/MethodLength
+    def initialize(
       name,
       method_node: nil,
       location: method_node.loc.expression,
@@ -18,7 +15,6 @@ module Leftovers
       test: method_node.test?
     )
       @name = name
-      @name_s = name.to_s.freeze
 
       @location = location
       @file = file
@@ -37,6 +33,10 @@ module Leftovers
       @file.relative_path
     end
 
+    def to_s
+      @name.to_s
+    end
+
     def line
       @location.line
     end
@@ -46,7 +46,7 @@ module Leftovers
     end
 
     def full_location
-      "#{path}:#{@location.line}:#{@location.column}"
+      "#{path}:#{line}:#{column}"
     end
 
     def highlighted_source(highlight = "\e[31m", normal = "\e[0m") # rubocop:disable Metrics/AbcSize
@@ -64,7 +64,7 @@ module Leftovers
     end
 
     def skipped?
-      Leftovers.config.skip_rules.any? { |r| r.match?(@name, @name_s, path) }
+      Leftovers.config.skip_rules.any? { |r| r.match?(@name, path) }
     end
   end
 end

data/lib/leftovers/definition_set.rb

@@ -21,10 +21,6 @@ module Leftovers
       freeze
     end
 
-    def full_name
-      names.join(', ')
-    end
-
     def names
       @definitions.map(&:names)
     end

data/lib/leftovers/file.rb

@@ -19,7 +19,7 @@ module Leftovers
     def ruby # rubocop:disable Metrics/MethodLength
       case extname
       when '.haml'
-        Leftovers::Haml.precompile(read)
+        Leftovers::Haml.precompile(read, self)
       when '.rhtml', '.rjs', '.erb'
         Leftovers::ERB.precompile(read)
       else

data/lib/leftovers/file_collector.rb

@@ -52,11 +52,9 @@ module Leftovers
     def process_comments(comments) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       comments.each do |comment|
         @allow_lines << comment.loc.line if comment.text.match?(LEFTOVERS_ALLOW_RE)
-
         @test_lines << comment.loc.line if comment.text.match?(LEFTOVERS_TEST_RE)
 
         next unless (match = comment.text.match(LEFTOVERS_CALL_RE))
-        next unless match[1]
 
         match[1].scan(NAME_RE).each { |s| add_call(s.to_sym) }
       end
@@ -64,13 +62,15 @@ module Leftovers
 
     # grab method definitions
     def on_def(node)
-      add_definition(node.children.first, node.loc.name)
+      add_definition(node.name, node.loc.name)
 
       super
     end
 
     def on_ivasgn(node)
-      add_definition(node.children.first, node.loc.name)
+      add_definition(node.name, node.loc.name)
+
+      collect_rules(node)
 
       super
     end
@@ -78,7 +78,7 @@ module Leftovers
     alias_method :on_cvasgn, :on_ivasgn
 
     def on_ivar(node)
-      add_call(node.children.first)
+      add_call(node.name)
 
       super
     end
@@ -107,8 +107,7 @@ module Leftovers
     def on_send(node)
       super
 
-      add_call(node.children[1])
-
+      add_call(node.name)
       collect_rules(node)
     end
     alias_method :on_csend, :on_send
@@ -116,14 +115,14 @@ module Leftovers
     def on_const(node)
       super
 
-      add_call(node.children[1])
+      add_call(node.name)
     end
 
     # grab e.g. :to_s in each(&:to_s)
     def on_block_pass(node)
       super
 
-      add_call(node.children.first.to_sym) if node.children.first&.string_or_symbol?
+      add_call(node.children.first.to_sym) if node.children.first.string_or_symbol?
     end
 
     # grab class Constant or module Constant
@@ -134,7 +133,7 @@ module Leftovers
 
       node = node.children.first
 
-      add_definition(node.children[1], node.loc.name)
+      add_definition(node.name, node.loc.name)
     end
     alias_method :on_module, :on_class
 
@@ -142,7 +141,7 @@ module Leftovers
     def on_casgn(node)
       super
 
-      add_definition(node.children[1], node.loc.name)
+      add_definition(node.name, node.loc.name)
 
       collect_rules(node)
     end
@@ -177,22 +176,20 @@ module Leftovers
     def collect_var_op_asgn(node)
       name = node.children.first
 
-      return unless name
-
       add_call(name)
     end
 
     def collect_send_op_asgn(node)
       name = node.children[1]
 
-      return unless name
-
       add_call(:"#{name}=")
     end
 
     def collect_op_asgn(node)
       node = node.children.first
+      # :nocov: # don't need else, it's exhaustive for callers
       case node.type
+      # :nocov:
       when :send then collect_send_op_asgn(node)
       when :ivasgn, :gvasgn, :cvasgn then collect_var_op_asgn(node)
       end
@@ -200,7 +197,7 @@ module Leftovers
 
     def collect_rules(node) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       Leftovers.config.rules.each do |rule|
-        next unless rule.match?(node.name, node.name_s, filename)
+        next unless rule.match?(node.name, filename)
 
         next if rule.skip?
 

data/lib/leftovers/file_list.rb

@@ -4,24 +4,19 @@ require 'fast_ignore'
 require_relative 'file'
 
 module Leftovers
-  class FileList
-    include Enumerable
+  class FileList < ::FastIgnore
+    def initialize
+      super(
+        ignore_rules: Leftovers.config.exclude_paths,
+        include_rules: Leftovers.config.include_paths,
+        root: Leftovers.pwd
+      )
+    end
 
     def each
-      fast_ignore.each do |file|
+      super do |file|
         yield(Leftovers::File.new(file))
       end
     end
-
-    def to_a
-      enum_for(:each).to_a
-    end
-
-    def fast_ignore
-      FastIgnore.new(
-        ignore_rules: Leftovers.config.exclude_paths,
-        include_rules: ['#!:ruby'] + Leftovers.config.include_paths
-      )
-    end
   end
 end

data/lib/leftovers/haml.rb

@@ -4,19 +4,16 @@ module Leftovers
   module Haml
     module_function
 
-    def precompile(file) # rubocop:disable Metrics/MethodLength
-      Leftovers.try_require('haml', message: <<~MESSAGE)
-        Skipped parsing a haml file, because the haml gem was not available
-        `gem install Haml`
+    def precompile(file, name) # rubocop:disable Metrics/MethodLength
+      return '' unless Leftovers.try_require('haml', message: <<~MESSAGE) # rubocop:disable Layout/EmptyLineAfterGuardClause
+        Skipped parsing #{name.relative_path}, because the haml gem was not available
+        `gem install haml`
       MESSAGE
-      if defined?(::Haml)
-        begin
-          ::Haml::Engine.new(file).precompiled
-        rescue ::Haml::SyntaxError => e
-          Leftovers.warn "#{e.class}: #{e.message} #{filename}:#{e.line}"
-          ''
-        end
-      else
+
+      begin
+        ::Haml::Engine.new(file).precompiled
+      rescue ::Haml::SyntaxError => e
+        Leftovers.warn "#{e.class}: #{e.message} #{name.relative_path}:#{e.line}"
         ''
       end
     end