leftovers 0.7.0 → 0.8.0

data/lib/leftovers/value_processors/each_for_definition_set.rb

@@ -10,14 +10,11 @@ module Leftovers
       end
 
       def process(str, node, method_node)
-        definitions = @then_processors.map do |then_processor|
+        definitions = Leftovers.map_or_self(@then_processors) do |then_processor|
           then_processor.process(str, node, method_node)
         end
 
-        definitions.flatten!
-        definitions.compact!
-
-        return definitions.first if definitions.length <= 1
+        return definitions unless definitions.is_a?(Array)
 
         ::Leftovers::DefinitionNodeSet.new(definitions)
       end

data/lib/leftovers/value_processors/each_keyword.rb

@@ -13,7 +13,7 @@ module Leftovers
         kwargs = node.kwargs
         return unless kwargs
 
-        kwargs.children.map do |pair|
+        Leftovers.map_or_self(kwargs.children) do |pair|
           next unless pair.type == :pair
 
           argument_node = pair.first

data/lib/leftovers/value_processors/each_keyword_argument.rb

@@ -13,7 +13,7 @@ module Leftovers
         kwargs = node.kwargs
         return unless kwargs
 
-        kwargs.children.map do |pair|
+        Leftovers.map_or_self(kwargs.children) do |pair|
           next unless pair.type == :pair
 
           argument_node = pair.second

data/lib/leftovers/value_processors/each_positional_argument.rb

@@ -11,9 +11,10 @@ module Leftovers
 
       def process(_str, node, method_node)
         positional_arguments = node.positional_arguments
+
         return unless positional_arguments
 
-        positional_arguments.map do |argument_node|
+        Leftovers.map_or_self(positional_arguments) do |argument_node|
           str = argument_node.to_s if argument_node.string_or_symbol_or_def?
 
           @then_processor.process(str, argument_node, method_node)

data/lib/leftovers/value_processors/keyword.rb

@@ -14,18 +14,14 @@ module Leftovers
         kwargs = node.kwargs
         return unless kwargs
 
-        result = []
-
-        kwargs.children.each do |pair|
+        Leftovers.map_or_self(kwargs.children) do |pair|
           next unless @matcher === pair
 
           argument_node = pair.first
-          str = argument_node.to_s
+          str = argument_node.to_s if argument_node.string_or_symbol?
 
-          result << @then_processor.process(str, argument_node, method_node)
+          @then_processor.process(str, argument_node, method_node)
         end
-
-        result
       end
     end
   end

data/lib/leftovers/value_processors/keyword_argument.rb

@@ -14,18 +14,14 @@ module Leftovers
         kwargs = node.kwargs
         return unless kwargs
 
-        result = []
-
-        kwargs.children.each do |pair|
+        Leftovers.map_or_self(kwargs.children) do |pair|
           next unless @matcher === pair
 
           argument_node = pair.second
           str = argument_node.to_s if argument_node.string_or_symbol?
 
-          result << @then_processor.process(str, argument_node, method_node)
+          @then_processor.process(str, argument_node, method_node)
         end
-
-        result
       end
     end
   end

data/lib/leftovers/value_processors/split.rb

@@ -13,8 +13,8 @@ module Leftovers
       def process(str, node, method_node)
         return unless str
 
-        str.split(@split_on).map do |substring|
-          @then_processor.process(substring, node, method_node)
+        Leftovers.map_or_self(str.split(@split_on)) do |sub_str|
+          @then_processor.process(sub_str, node, method_node)
         end
       end
     end

data/lib/leftovers/version.rb

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

data/lib/leftovers.rb

@@ -1,7 +1,28 @@
 # frozen_string_literal: true
 
+require 'parser'
+require 'parser/current' # to get the error message early and once.
+
 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}"
+    end
+  end
 
   autoload(:AST, "#{__dir__}/leftovers/ast")
   autoload(:CLI, "#{__dir__}/leftovers/cli")
@@ -13,21 +34,17 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
   autoload(:DefinitionNodeSet, "#{__dir__}/leftovers/definition_node_set")
   autoload(:DefinitionSet, "#{__dir__}/leftovers/definition_set")
   autoload(:DefinitionToAdd, "#{__dir__}/leftovers/definition_to_add")
-  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(:YAML, "#{__dir__}/leftovers/yaml")
-  autoload(:JSON, "#{__dir__}/leftovers/json")
   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(:Slim, "#{__dir__}/leftovers/slim")
   autoload(:TodoReporter, "#{__dir__}/leftovers/todo_reporter")
   autoload(:DynamicProcessors, "#{__dir__}/leftovers/dynamic_processors")
   autoload(:ValueProcessors, "#{__dir__}/leftovers/value_processors")
@@ -146,11 +163,29 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
 
       case value
       when nil then nil
-      when Array then value.each { |i| each_or_self(i, &block) }
+      when Array then value.each(&block)
+      else yield(value)
+      end
+    end
+
+    def map_or_self(value, &block)
+      # return enum_for(__method__, value) unless block
+
+      case value
+      when nil then nil
+      when Array then unwrap_array(value.flat_map(&block).compact)
       else yield(value)
       end
     end
 
+    def unwrap_array(array)
+      if array.length <= 1
+        array.first
+      else
+        array
+      end
+    end
+
     private
 
     def try_require_cache(requirable)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leftovers
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2022-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -317,6 +317,7 @@ files:
 - LICENSE.txt
 - README.md
 - docs/Configuration.md
+- docs/Custom-Precompilers.md
 - exe/leftovers
 - leftovers.gemspec
 - lib/.DS_Store
@@ -364,13 +365,17 @@ files:
 - lib/leftovers/config_loader/argument_position_schema.rb
 - lib/leftovers/config_loader/argumentless_transform_schema.rb
 - lib/leftovers/config_loader/attribute.rb
+- lib/leftovers/config_loader/built_in_precompiler_schema.rb
 - lib/leftovers/config_loader/document_schema.rb
 - lib/leftovers/config_loader/dynamic_schema.rb
 - lib/leftovers/config_loader/has_argument_schema.rb
 - lib/leftovers/config_loader/has_value_schema.rb
+- lib/leftovers/config_loader/inherit_schema_attributes.rb
 - lib/leftovers/config_loader/keep_test_only_schema.rb
 - lib/leftovers/config_loader/node.rb
 - lib/leftovers/config_loader/object_schema.rb
+- lib/leftovers/config_loader/precompile_schema.rb
+- lib/leftovers/config_loader/precompiler_schema.rb
 - lib/leftovers/config_loader/privacy_processor_schema.rb
 - lib/leftovers/config_loader/privacy_schema.rb
 - lib/leftovers/config_loader/require_schema.rb
@@ -387,6 +392,7 @@ files:
 - lib/leftovers/config_loader/true_schema.rb
 - lib/leftovers/config_loader/value_matcher_schema.rb
 - lib/leftovers/config_loader/value_or_array_schema.rb
+- lib/leftovers/config_loader/value_or_object_schema.rb
 - lib/leftovers/config_loader/value_processor_schema.rb
 - lib/leftovers/config_loader/value_type_schema.rb
 - lib/leftovers/definition.rb
@@ -402,12 +408,11 @@ files:
 - lib/leftovers/dynamic_processors/null.rb
 - lib/leftovers/dynamic_processors/set_default_privacy.rb
 - lib/leftovers/dynamic_processors/set_privacy.rb
-- lib/leftovers/erb.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_list.rb
-- lib/leftovers/haml.rb
-- lib/leftovers/json.rb
 - lib/leftovers/matcher_builders.rb
 - lib/leftovers/matcher_builders/and.rb
 - lib/leftovers/matcher_builders/and_not.rb
@@ -450,6 +455,13 @@ files:
 - lib/leftovers/matchers/predicate.rb
 - lib/leftovers/merged_config.rb
 - lib/leftovers/parser.rb
+- lib/leftovers/precompilers.rb
+- lib/leftovers/precompilers/erb.rb
+- lib/leftovers/precompilers/haml.rb
+- lib/leftovers/precompilers/json.rb
+- lib/leftovers/precompilers/precompiler.rb
+- lib/leftovers/precompilers/slim.rb
+- lib/leftovers/precompilers/yaml.rb
 - lib/leftovers/processor_builders.rb
 - lib/leftovers/processor_builders/action.rb
 - lib/leftovers/processor_builders/add_prefix.rb
@@ -469,7 +481,6 @@ files:
 - lib/leftovers/processor_builders/value.rb
 - lib/leftovers/rake_task.rb
 - lib/leftovers/reporter.rb
-- lib/leftovers/slim.rb
 - lib/leftovers/todo_reporter.rb
 - lib/leftovers/value_processors.rb
 - lib/leftovers/value_processors/add_dynamic_prefix.rb
@@ -507,7 +518,6 @@ files:
 - lib/leftovers/value_processors/underscore.rb
 - lib/leftovers/value_processors/upcase.rb
 - lib/leftovers/version.rb
-- lib/leftovers/yaml.rb
 homepage: http://github.com/robotdana/leftovers
 licenses:
 - MIT

data/lib/leftovers/erb.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require 'erb'
-
-module Leftovers
-  class ERB < ::ERB::Compiler
-    def self.precompile(erb, _name)
-      @compiler ||= new('-')
-      @compiler.compile(erb).first
-    end
-
-    def add_insert_cmd(out, content) # leftovers:keep
-      out.push("\n#{content}\n")
-    end
-
-    def add_put_cmd(out, _content) # leftovers:keep
-      out.push("\n")
-    end
-  end
-end

data/lib/leftovers/haml.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Leftovers
-  module Haml
-    module_function
-
-    def precompile(file, name)
-      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
-
-      begin
-        ::Haml::Engine.new(file).precompiled
-      rescue ::Haml::SyntaxError => e
-        Leftovers.warn "#{e.class}: #{e.message} #{name.relative_path}:#{e.line}"
-        ''
-      end
-    end
-  end
-end

data/lib/leftovers/json.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module Leftovers
-  module JSON
-    class << self
-      def precompile(json, name)
-        "__leftovers_document(#{to_ruby_argument(::JSON.parse(json))})"
-      rescue ::JSON::ParserError => e
-        Leftovers.warn "#{e.class}: (#{name.relative_path}): #{e.message}"
-        ''
-      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
-  end
-end

data/lib/leftovers/slim.rb

@@ -1,21 +0,0 @@
-# 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/yaml.rb

@@ -1,73 +0,0 @@
-# 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