leftovers 0.5.2 → 0.6.0

data/lib/leftovers/matcher_builders/node.rb

@@ -10,7 +10,7 @@ module Leftovers
             ::Leftovers::MatcherBuilders::NodeName.build(pat)
           when ::Hash
             build_from_hash(**pat)
-          # :nocov:
+            # :nocov:
           else raise
             # :nocov:
           end
@@ -19,6 +19,7 @@ module Leftovers
 
       def self.build_from_hash( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
         names: nil, match: nil, has_prefix: nil, has_suffix: nil,
+        document: false,
         paths: nil,
         has_arguments: nil,
         has_receiver: nil,
@@ -29,6 +30,7 @@ module Leftovers
             names,
             { match: match, has_prefix: has_prefix, has_suffix: has_suffix }.compact
           ]),
+          ::Leftovers::MatcherBuilders::Document.build(document),
           ::Leftovers::MatcherBuilders::NodePath.build(paths),
           ::Leftovers::MatcherBuilders::NodeHasArgument.build(has_arguments),
           ::Leftovers::MatcherBuilders::NodeHasReceiver.build(has_receiver),

data/lib/leftovers/matcher_builders/node_has_argument.rb

@@ -26,12 +26,10 @@ module Leftovers
 
         ::Leftovers.each_or_self(at) do |k|
           case k
-          when '*'
+          when '*', ::Integer
             positions << k
           when ::String, ::Hash
             keys << k
-          when ::Integer
-            positions << k
           # :nocov:
           else raise
             # :nocov:
@@ -62,7 +60,8 @@ module Leftovers
         elsif positions
           ::Leftovers::MatcherBuilders::NodeHasPositionalArgument.build(positions, value_matcher)
           # :nocov:
-        else raise
+        else
+          raise
           # :nocov:
         end
 

data/lib/leftovers/matcher_builders/node_has_keyword_argument.rb

@@ -6,7 +6,7 @@ module Leftovers
       class << self
         def build(keywords, value_matcher) # rubocop:disable Metrics/MethodLength
           value_matcher = ::Leftovers::MatcherBuilders::NodePairValue.build(value_matcher)
-          keyword_matcher = if ::Leftovers.each_or_self(keywords).any? { |x| x == '**' }
+          keyword_matcher = if ::Leftovers.each_or_self(keywords).include?('**')
             ::Leftovers::Matchers::NodeType.new(:pair)
           else
             ::Leftovers::MatcherBuilders::NodePairName.build(keywords)

data/lib/leftovers/matcher_builders/node_has_positional_argument.rb

@@ -14,7 +14,7 @@ module Leftovers
               end
             end
           elsif positions
-            pos = 0 if ::Leftovers.each_or_self(positions).any? { |x| x == '*' }
+            pos = 0 if ::Leftovers.each_or_self(positions).include?('*')
             pos ||= ::Leftovers.each_or_self(positions).min
 
             ::Leftovers::Matchers::NodeHasPositionalArgument.new(pos)

data/lib/leftovers/matcher_builders.rb

@@ -4,6 +4,7 @@ module Leftovers
   module MatcherBuilders
     autoload(:AndNot, "#{__dir__}/matcher_builders/and_not")
     autoload(:And, "#{__dir__}/matcher_builders/and")
+    autoload(:Document, "#{__dir__}/matcher_builders/document")
     autoload(:Name, "#{__dir__}/matcher_builders/name")
     autoload(:Node, "#{__dir__}/matcher_builders/node")
     autoload(:NodeHasArgument, "#{__dir__}/matcher_builders/node_has_argument")

data/lib/leftovers/matchers/all.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class All
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(matchers)
         @matchers = matchers
 

data/lib/leftovers/matchers/and.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class And
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(lhs, rhs)
         @lhs = lhs
         @rhs = rhs

data/lib/leftovers/matchers/any.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class Any
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       attr_reader :matchers
 
       def initialize(matchers)

data/lib/leftovers/matchers/node_has_any_keyword_argument.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class NodeHasAnyKeywordArgument
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(pair_matcher)
         @pair_matcher = pair_matcher
 
@@ -17,9 +13,7 @@ module Leftovers
         kwargs = node.kwargs
         return false unless kwargs
 
-        kwargs.children.any? do |pair|
-          @pair_matcher === pair
-        end
+        kwargs.children.any?(@pair_matcher)
       end
 
       freeze

data/lib/leftovers/matchers/node_has_any_positional_argument_with_value.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class NodeHasAnyPositionalArgumentWithValue
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(matcher)
         @matcher = matcher
 
@@ -17,9 +13,7 @@ module Leftovers
         args = node.positional_arguments
         return false unless args
 
-        args.any? do |value|
-          @matcher === value
-        end
+        args.any?(@matcher)
       end
 
       freeze

data/lib/leftovers/matchers/node_has_positional_argument_with_value.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class NodeHasPositionalArgumentWithValue
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(position, matcher)
         @position = position
         @matcher = matcher

data/lib/leftovers/matchers/node_name.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class NodeName
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(name_matcher)
         @name_matcher = name_matcher
 

data/lib/leftovers/matchers/node_pair_value.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class NodePairValue
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(value_matcher)
         @value_matcher = value_matcher
 

data/lib/leftovers/matchers/node_path.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class NodePath
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(path_matcher)
         @path_matcher = path_matcher
 

data/lib/leftovers/matchers/node_scalar_value.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class NodeScalarValue
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(matcher)
         @matcher = matcher
 

data/lib/leftovers/matchers/node_type.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class NodeType
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(type_matcher)
         @type_matcher = type_matcher
 

data/lib/leftovers/matchers/not.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class Not
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(matcher)
         @matcher = matcher
 

data/lib/leftovers/matchers/or.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module Matchers
     class Or
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       attr_reader :lhs, :rhs
 
       def initialize(lhs, rhs)

data/lib/leftovers/merged_config.rb

@@ -4,7 +4,7 @@ require 'set'
 require 'fast_ignore'
 
 module Leftovers
-  class MergedConfig
+  class MergedConfig # rubocop:disable Metrics/ClassLength
     def initialize(load_defaults: false)
       @configs = []
       @loaded_configs = Set.new
@@ -37,14 +37,24 @@ module Leftovers
       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)
+    MEMOIZED_IVARS = %i{
+      @exclude_paths
+      @include_paths
+      @test_paths
+      @haml_paths
+      @slim_paths
+      @yaml_paths
+      @json_paths
+      @erb_paths
+      @dynamic
+      @keep
+      @test_only
+    }.freeze
+
+    def unmemoize
+      MEMOIZED_IVARS.each do |ivar|
+        remove_instance_variable(ivar) if instance_variable_get(ivar)
+      end
     end
 
     def exclude_paths
@@ -71,6 +81,30 @@ module Leftovers
       )
     end
 
+    def slim_paths
+      @slim_paths ||= FastIgnore.new(
+        include_rules: @configs.flat_map(&:slim_paths),
+        gitignore: false,
+        root: Leftovers.pwd
+      )
+    end
+
+    def yaml_paths
+      @yaml_paths ||= FastIgnore.new(
+        include_rules: @configs.flat_map(&:yaml_paths),
+        gitignore: false,
+        root: Leftovers.pwd
+      )
+    end
+
+    def json_paths
+      @json_paths ||= FastIgnore.new(
+        include_rules: @configs.flat_map(&:json_paths),
+        gitignore: false,
+        root: Leftovers.pwd
+      )
+    end
+
     def erb_paths
       @erb_paths ||= FastIgnore.new(
         include_rules: @configs.flat_map(&:erb_paths),

data/lib/leftovers/processor_builders/dynamic.rb

@@ -17,7 +17,8 @@ module Leftovers
           elsif call
             ::Leftovers::DynamicProcessors::Call.new(matcher, call)
           # :nocov:
-          else raise
+          else
+            raise
             # :nocov:
           end
         end

data/lib/leftovers/slim.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Leftovers
+  module Slim
+    module_function
+
+    def precompile(file, name)
+      return '' unless Leftovers.try_require('slim', message: <<~MESSAGE) # rubocop:disable Layout/EmptyLineAfterGuardClause
+        Skipped parsing #{name.relative_path}, because the slim gem was not available
+        `gem install slim`
+      MESSAGE
+
+      begin
+        ::Slim::Engine.new(file: file).call(file)
+      rescue ::Slim::Parser::SyntaxError => e
+        Leftovers.warn "#{e.class}: \"#{e.error}\" #{name.relative_path}:#{e.lineno}:#{e.column}"
+        ''
+      end
+    end
+  end
+end

data/lib/leftovers/todo_reporter.rb

@@ -64,54 +64,29 @@ module Leftovers
     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)
+        list_data(
+          :test_only, 'Only directly called in tests', only_test
+        ),
+        list_data(
+          :keep, 'Not directly called at all', none
+        )
       ].compact.join
     end
 
-    def test_only_data(list)
+    def list_data(key, title, 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}
+        #{key}:
+          # #{title}:
         #{print_definition_list(list)}
 
       YML
     end
 
     def print_definition_list(definition_list)
-      definition_list.map { |definition| print_definition(definition) }.join("\n")
+      definition_list.map { |definition| print_definition(definition) }.sort.join("\n")
     end
 
     def print_definition(definition)

data/lib/leftovers/value_processors/camelize.rb

@@ -16,7 +16,7 @@ module Leftovers
       rescue NoMethodError
         Leftovers.error <<~MESSAGE
           Tried using the String#camelize method, but the activesupport gem was not available and/or not required
-          `gem install activesupport`, and/or add `requires: 'active_support/core_ext/string'` to your .leftovers.yml
+          `gem install activesupport`, and/or add `requires: ['active_support', 'active_support/core_ext/string']` to your .leftovers.yml
         MESSAGE
       end
     end

data/lib/leftovers/value_processors/deconstantize.rb

@@ -16,7 +16,7 @@ module Leftovers
       rescue NoMethodError
         Leftovers.error <<~MESSAGE
           Tried using the String#deconstantize method, but the activesupport gem was not available and/or not required
-          `gem install activesupport`, and/or add `requires: 'active_support/core_ext/string'` to your .leftovers.yml
+          `gem install activesupport`, and/or add `requires: ['active_support', 'active_support/core_ext/string']` to your .leftovers.yml
         MESSAGE
       end
     end

data/lib/leftovers/value_processors/delete_prefix.rb

@@ -3,12 +3,6 @@
 module Leftovers
   module ValueProcessors
     class DeletePrefix
-      # :nocov:
-      if defined?(::Leftovers::Backports::StringDeletePrefixSuffix)
-        using ::Leftovers::Backports::StringDeletePrefixSuffix
-      end
-      # :nocov:
-
       def initialize(prefix, then_processor)
         @prefix = prefix
         @then_processor = then_processor

data/lib/leftovers/value_processors/delete_suffix.rb

@@ -3,12 +3,6 @@
 module Leftovers
   module ValueProcessors
     class DeleteSuffix
-      # :nocov:
-      if defined?(::Leftovers::Backports::StringDeletePrefixSuffix)
-        using ::Leftovers::Backports::StringDeletePrefixSuffix
-      end
-      # :nocov:
-
       def initialize(suffix, then_processor)
         @suffix = suffix
         @then_processor = then_processor

data/lib/leftovers/value_processors/demodulize.rb

@@ -16,7 +16,7 @@ module Leftovers
       rescue NoMethodError
         Leftovers.error <<~MESSAGE
           Tried using the String#demodulize method, but the activesupport gem was not available and/or not required
-          `gem install activesupport`, and/or add `requires: 'active_support/core_ext/string'` to your .leftovers.yml
+          `gem install activesupport`, and/or add `requires: ['active_support', 'active_support/core_ext/string']` to your .leftovers.yml
         MESSAGE
       end
     end

data/lib/leftovers/value_processors/keyword.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module ValueProcessors
     class Keyword
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(matcher, then_processor)
         @matcher = matcher
         @then_processor = then_processor

data/lib/leftovers/value_processors/keyword_argument.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module ValueProcessors
     class KeywordArgument
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def initialize(matcher, then_processor)
         @matcher = matcher
         @then_processor = then_processor

data/lib/leftovers/value_processors/parameterize.rb

@@ -16,7 +16,7 @@ module Leftovers
       rescue NoMethodError
         Leftovers.error <<~MESSAGE
           Tried using the String#parameterize method, but the activesupport gem was not available and/or not required
-          `gem install activesupport`, and/or add `requires: 'active_support/core_ext/string'` to your .leftovers.yml
+          `gem install activesupport`, and/or add `requires: ['active_support', 'active_support/core_ext/string']` to your .leftovers.yml
         MESSAGE
       end
     end

data/lib/leftovers/value_processors/pluralize.rb

@@ -16,7 +16,7 @@ module Leftovers
       rescue NoMethodError
         Leftovers.error <<~MESSAGE
           Tried using the String#pluralize method, but the activesupport gem was not available and/or not required
-          `gem install activesupport`, and/or add `requires: 'active_support/core_ext/string'` to your .leftovers.yml
+          `gem install activesupport`, and/or add `requires: ['active_support', 'active_support/core_ext/string']` to your .leftovers.yml
         MESSAGE
       end
     end

data/lib/leftovers/value_processors/return_definition.rb

@@ -3,10 +3,6 @@
 module Leftovers
   module ValueProcessors
     module ReturnDefinition
-      # :nocov:
-      using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-      # :nocov:
-
       def self.process(str, node, method_node)
         return unless str
         return if str.empty?

data/lib/leftovers/value_processors/singularize.rb

@@ -16,7 +16,7 @@ module Leftovers
       rescue NoMethodError
         Leftovers.error <<~MESSAGE
           Tried using the String#singularize method, but the activesupport gem was not available and/or not required
-          `gem install activesupport`, and/or add `requires: 'active_support/core_ext/string'` to your .leftovers.yml
+          `gem install activesupport`, and/or add `requires: ['active_support', 'active_support/core_ext/string']` to your .leftovers.yml
         MESSAGE
       end
     end

data/lib/leftovers/value_processors/titleize.rb

@@ -16,7 +16,7 @@ module Leftovers
       rescue NoMethodError
         Leftovers.error <<~MESSAGE
           Tried using the String#titleize method, but the activesupport gem was not available and/or not required
-          `gem install activesupport`, and/or add `requires: 'active_support/core_ext/string'` to your .leftovers.yml
+          `gem install activesupport`, and/or add `requires: ['active_support', 'active_support/core_ext/string']` to your .leftovers.yml
         MESSAGE
       end
     end

data/lib/leftovers/value_processors/underscore.rb

@@ -16,7 +16,7 @@ module Leftovers
       rescue NoMethodError
         Leftovers.error <<~MESSAGE
           Tried using the String#underscore method, but the activesupport gem was not available and/or not required
-          `gem install activesupport`, and/or add `requires: 'active_support/core_ext/string'` to your .leftovers.yml
+          `gem install activesupport`, and/or add `requires: ['active_support', 'active_support/core_ext/string']` to your .leftovers.yml
         MESSAGE
       end
     end

data/lib/leftovers/version.rb

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

data/lib/leftovers/yaml.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Leftovers
+  module YAML
+    class Builder < ::Psych::TreeBuilder
+      def initialize
+        @constants = []
+
+        super
+      end
+
+      def add_constant_for_tag(tag, value = nil)
+        match = %r{\A!ruby/[^:]*(?::(.*))?\z}.match(tag)
+        return unless match
+
+        @constants << (match[1] || value)
+      end
+
+      def start_mapping(_anchor, tag, *rest) # leftovers:keep
+        add_constant_for_tag(tag)
+        tag = nil
+
+        super
+      end
+
+      def start_sequence(_anchor, tag, *rest) # leftovers:keep
+        add_constant_for_tag(tag)
+        tag = nil
+
+        super
+      end
+
+      def scalar(value, _anchor, tag, *rest) # leftovers:keep
+        add_constant_for_tag(tag, value)
+        tag = nil
+
+        super
+      end
+
+      def to_ruby_file
+        <<~RUBY
+          __leftovers_document(#{to_ruby_argument(root.to_ruby.first)})
+          #{@constants.join("\n")}
+        RUBY
+      end
+
+      private
+
+      def to_ruby_argument(value)
+        ruby = value.inspect
+        return ruby unless value.is_a?(Array)
+
+        ruby.delete_prefix!('[')
+        ruby.delete_suffix!(']')
+
+        ruby
+      end
+    end
+
+    def self.precompile(yaml, name)
+      builder = ::Leftovers::YAML::Builder.new
+      parser = ::Psych::Parser.new(builder)
+      parser.parse(yaml, name.relative_path)
+
+      builder.to_ruby_file
+    rescue ::Psych::SyntaxError => e
+      Leftovers.warn "#{e.class}: #{e.message}"
+      ''
+    end
+  end
+end