leftovers 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f27830ef42bcbcec33a78126a3b47582fa394714e1d137e802cd5ab166e35df5
-  data.tar.gz: a111ed33a8345fe8dc5d43cb92206d52cbc47a03bc8e961baee8558d677542b6
+  metadata.gz: c2e0c74dad85b7b571608a7207f006fe14d5748e1a155470185112b80a7b80a3
+  data.tar.gz: 68f3d83b310f640e127b961e6ac2ece795a7b9e2a6de961a1b42498916e092d7
 SHA512:
-  metadata.gz: e14c6c1b74d4c13ebcbb4d1184d50257d6aacaf05e8e6708282633f61ea1988374156880d66bb26a037bf4b67b58381246f12357bdaa99ff9248db620d94c152
-  data.tar.gz: 34e766e6ca2374858ee6da35e924287641bc4441d8f642e4d08285a0066185aa865724567b90f91de34b17f340f3f182e9b3f326c5fc63bf6abc414c0dc058b3
+  metadata.gz: c57c64254cc2092e38b8decfd7bde0a021d66a7c3f563dc3e1f5a68b91c4bfc7b16a8490e5437b3da942071d41d2c35c247e1e51739064e14fdfcc6653b192b3
+  data.tar.gz: b129119436c793987c89b032d5936b10ca935c7fc5398e7a2843665bbfec28ccaacd0a0090c8cd37c5172b6892f4291455aef40df6bae67727d25ac47fd871a3

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v0.8.0
+- Allow custom precompilers
+  ```yml
+    require: './path/to/my_precompiler'
+    precompile:
+      - paths: '*.myCustomFormat'
+        format: { custom: 'MyPrecompiler' }
+  ```
+  the built in precompilers have moved into this system too, with `format: haml` etc. `haml_paths` etc are now deprecated
+- a lot of refactoring, which revealed some edge cases i was handling
+  - collect a call to :my_method= with receiver&.my_method ||= (and += etc)
+  - if `add_prefix:` or `add_suffix:` points to another argument for a name that we can't use because it's a variable, it now just don't return the value, rather than returning the value but without the affix
+
 # v0.7.0
 - Rewrite the config parser/validation
   - to provide clearer error messages with line numbers and everything

data/README.md

@@ -166,6 +166,7 @@ Its presence is optional and all of these settings are optional.
 - [`exclude_paths:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#exclude_paths)
 - [`test_paths:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#test_paths)
 - [`requires:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#requires)
+- [`precompile:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#precompile)
 - [`gems:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#gems)
 - [`keep:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#keep)
 - [`test_only:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#test_only)

data/docs/Configuration.md

@@ -6,11 +6,7 @@ Its presence is optional and all of these settings are optional.
 - [`include_paths:`](#include_paths)
 - [`exclude_paths:`](#exclude_paths)
 - [`test_paths:`](#test_paths)
-- [`haml_paths:`](#haml_paths)
-- [`slim_paths:`](#slim_paths)
-- [`erb_paths:`](#erb_paths)
-- [`yaml_paths:`](#yaml_paths)
-- [`json_paths:`](#json_paths)
+- [`precompile:`](#precompile)
 - [`requires:`](#requires)
 - [`gems:`](#gems)
 - [`keep:`](#keep)
@@ -88,55 +84,32 @@ test_paths:
 
 Arrays are not necessary for single values
 
-## `haml_paths:`
-
-list filenames/paths of test directories that are in the haml format
-Defined using the [.gitignore pattern format](https://git-scm.com/docs/gitignore#_pattern_format)
+## `precompile:`
 
 ```yml
-haml_paths:
-  - '*.haml'
+  require: './path/my_project/my_precompiler'
+  precompile:
+    - paths: '*.myCustomFormat'
+      format: { custom: 'MyProject::MyPrecompiler' }
+    - paths: '*.my.json'
+      format: json
 ```
 
-Arrays are not necessary for single values. `*.haml` is recognized by default
+Define any precompilers and the paths they affect.
 
-## `slim_paths:`
-
-list filenames/paths of test directories that are in the slim format
-Defined using the [.gitignore pattern format](https://git-scm.com/docs/gitignore#_pattern_format)
-
-```yml
-slim_paths:
-  - '*.slim'
-```
-
-Arrays are not necessary for single values. `*.slim` is recognized by default
-
-## `erb_paths:`
-
-list filenames/paths of test directories that are in the erb format
-Defined using the [.gitignore pattern format](https://git-scm.com/docs/gitignore#_pattern_format)
-
-```yml
-erb_paths:
-  - '*.erb'
-```
+`paths:` are defined using the [.gitignore pattern format](https://git-scm.com/docs/gitignore#_pattern_format)
 
-Arrays are not necessary for single values. `*.erb` is recognized by default
+`format:` must be one of the predefined precompilers (erb, haml, [json](#format-json), slim, [yaml](#format-yaml)), or `custom:` with the name of a [custom precompiler]('../Custom-Precompilers.md) module.
+(use [`require:`](#requires) to have leftovers load its file)
 
-## `yaml_paths:`
+See [Custom precompilers]('../Custom-Precompilers.md) for more details on the custom precompiler class
 
-list filenames/paths of test directories that are in the yaml format
-Defined using the [.gitignore pattern format](https://git-scm.com/docs/gitignore#_pattern_format)
+Arrays are not necessary for single values.
 
-```yml
-include:
-  - 'config/*.yml'
-yaml_paths:
-  - '*.yml'
-```
+### `format: yaml`
 
-These documents will consider yaml tags like `!ruby/class 'MyClass'` to be a call to `MyClass` and render the structure of the yaml as arguments for the [`document:true`](#document-true) rule.
+The yaml precompiler considers yaml tags like `!ruby/class 'MyClass'` to be a call to `MyClass`.
+and renders the structure of the yaml document as arguments for the [`document:true`](#document-true) rule.
 
 so you could, e.g. read the class name out of a yaml document like:
 
@@ -159,21 +132,11 @@ dynamic:
 
 [`nested:`](#nested) may be useful for more complex yaml structures
 
-## `json_paths:`
+### `format: json`
 
-list filenames/paths of test directories that are in the json format
-Defined using the [.gitignore pattern format](https://git-scm.com/docs/gitignore#_pattern_format)
+The json precompiler renders the structure of the json document as arguments for the [`document:true`](#document-true) rule.
 
-```yml
-include:
-  - 'config/*.json'
-json_paths:
-  - '*.json'
-```
-
-These documents render the structure of the yaml as arguments for the [`document:true`](#document-true) rule.
-
-so you could, e.g. read the class name out of a yaml document like:
+so you could, e.g. read the class name out of a json document like:
 
 ```json
 { "class_name": "MyClass" }

data/docs/Custom-Precompilers.md

@@ -0,0 +1,38 @@
+# Custom Precompilers
+
+In addition to the built in precompilers, it's possible to add a custom precompiler
+
+It must be a class or module with a singleton method `precompile`. take a string of whatever code it likes, and return a string of valid ruby.
+
+```ruby
+require 'not_ruby' # require the gem that does the actual transformation
+
+module MyNotRubyPrecompiler
+  def self.precompile(not_ruby_content)
+    # not_ruby_content is a string of (hopefully) valid precompilable code
+    NotRuby::Parser.parse(not_ruby_content).to_ruby # output a string of valid ruby
+  end
+end
+```
+
+See the [build in precompilers](https://github.com/robotdana/leftovers/tree/main/lib/precompilers) for other examples.
+
+To configure the precompiler to be used by leftovers, add something similar to this to the `.leftovers.yml` file
+
+```yml
+  include_paths:
+    - 'lib/**/*.not_rb'
+  require: './path/to/my_not_ruby_precompiler'
+  precompile:
+    - paths: '*.not_rb'
+      format: { custom: MyNotRubyPrecompiler }
+```
+
+Ensure any necessary extension patterns are added to to [`include_paths:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#include_paths) for those particular files you wish to check.
+
+Require the custom precompiler using [`require:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#requires)
+
+Define which paths use the custom precompiler using [`precompile:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#precompile),
+reference the name of the precompiler with `format: { custom: MyNotRubyPrecompiler }`
+
+If the `precompile` method raises any errors while precompiling, a warning will be printed to stderr and the file will be skipped

data/lib/config/actionpack.yml

@@ -7,9 +7,11 @@ include_paths:
   - '*.rjs'
   - '*.rhtml'
 
-erb_paths:
-  - '*.rjs'
-  - '*.rhtml'
+precompile:
+  - paths:
+      - '*.rjs'
+      - '*.rhtml'
+    format: erb
 
 keep:
   - ssl_configured? # ApplicationController

data/lib/config/haml.yml

@@ -1,4 +1,6 @@
 include_paths:
   - '*.haml'
-haml_paths:
-  - '*.haml'
+requires: 'haml'
+precompile:
+  format: haml
+  paths: '*.haml'

data/lib/config/ruby.yml

@@ -10,25 +10,14 @@ include_paths:
   - '*.erb'
   - '*.rb'
 
-yaml_paths:
-  - '*.yml'
-  - '*.yaml'
-
-json_paths:
-  - '*.json'
-
 test_paths:
   - /tests/
   - /test/
 
-erb_paths:
-  - '*.erb'
-
-haml_paths:
-  - '*.haml'
-
-slim_paths:
-  - '*.slim'
+precompile:
+  - { paths: '*.erb', format: 'erb' }
+  - { paths: ['*.yml', '*.yaml'], format: 'yaml' }
+  - { paths: '*.json', format: 'json' }
 
 keep:
   - initialize # called by new

data/lib/config/slim.yml

@@ -1,4 +1,6 @@
 include_paths:
   - '*.slim'
-slim_paths:
-  - '*.slim'
+requires: 'slim'
+precompile:
+  paths: '*.slim'
+  format: slim

data/lib/leftovers/cli.rb

@@ -57,6 +57,11 @@ module Leftovers
       end
 
       opts.parse(argv)
+    rescue OptionParser::InvalidOption => e
+      stderr.puts("\e[31mCLI Error: #{e.message}\e[0m")
+      stderr.puts ''
+      stderr.puts(opts.help)
+      Leftovers.exit 1
     end
   end
 end

data/lib/leftovers/collector.rb

@@ -45,7 +45,8 @@ module Leftovers
 
     def print_progress
       Leftovers.print(
-        "\e[2Kchecked #{@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"
       )
     end
 

data/lib/leftovers/config.rb

@@ -26,24 +26,8 @@ module Leftovers
       @test_paths ||= Array(yaml[:test_paths])
     end
 
-    def haml_paths
-      @haml_paths ||= Array(yaml[:haml_paths])
-    end
-
-    def slim_paths
-      @slim_paths ||= Array(yaml[:slim_paths])
-    end
-
-    def yaml_paths
-      @yaml_paths ||= Array(yaml[:yaml_paths])
-    end
-
-    def json_paths
-      @json_paths ||= Array(yaml[:json_paths])
-    end
-
-    def erb_paths
-      @erb_paths ||= Array(yaml[:erb_paths])
+    def precompile
+      @precompile ||= Leftovers.each_or_self(yaml[:precompile]).to_a
     end
 
     def dynamic

data/lib/leftovers/config_loader/argument_position_schema.rb

@@ -2,10 +2,10 @@
 
 module Leftovers
   class ConfigLoader
-    class ArgumentPositionSchema < ObjectSchema
+    class ArgumentPositionSchema < ValueOrObjectSchema
       inherit_attributes_from StringPatternSchema
 
-      self.or_schema = ScalarArgumentSchema
+      self.or_value_schema = ScalarArgumentSchema
     end
   end
 end

data/lib/leftovers/config_loader/attribute.rb

@@ -3,27 +3,53 @@
 module Leftovers
   class ConfigLoader
     class Attribute
-      def initialize(name, value_schema, aliases: nil, require_group: nil)
+      attr_reader(
+        :name,
+        :aliases, :schema # leftovers:test_only
+      )
+
+      attr_accessor :require_group
+
+      def initialize(name, schema, aliases: nil, require_group: nil, suggest: true)
         @name = name
-        @value_schema = value_schema
+        @schema = schema
         @aliases = aliases
         @require_group = require_group
+        @suggest = suggest
+      end
+
+      def without_require_group
+        new = dup
+        new.require_group = nil
+        new
+      end
+
+      def suggest?
+        @suggest
       end
 
       def attributes
-        { @name => @value_schema }
+        [self]
+      end
+
+      def name?(name)
+        name = name.to_sym
+
+        @name == name || Leftovers.each_or_self(@aliases).include?(name)
+      end
+
+      def to_ruby(value)
+        [key_to_ruby, @schema.to_ruby(value)]
       end
 
-      def aliases
-        ::Leftovers.each_or_self(@aliases).map do |aka|
-          [aka, @name]
-        end.to_h
+      def validate_value(value)
+        @schema.validate(value)
       end
 
-      def require_groups
-        return {} unless @require_group
+      private
 
-        { @require_group => [@name, *::Leftovers.each_or_self(@aliases)] }
+      def key_to_ruby
+        name == :unless ? :unless_arg : name
       end
     end
   end

data/lib/leftovers/config_loader/built_in_precompiler_schema.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Leftovers
+  class ConfigLoader
+    class BuiltInPrecompilerSchema < StringEnumSchema
+      value :erb
+      value :yaml
+      value :json
+      value :slim
+      value :haml
+    end
+  end
+end

data/lib/leftovers/config_loader/document_schema.rb

@@ -6,16 +6,43 @@ module Leftovers
       attribute :include_paths, ValueOrArraySchema[StringSchema], aliases: :include_path
       attribute :exclude_paths, ValueOrArraySchema[StringSchema], aliases: :exclude_path
       attribute :test_paths, ValueOrArraySchema[StringSchema], aliases: :test_path
-      attribute :haml_paths, ValueOrArraySchema[StringSchema], aliases: :haml_path
-      attribute :slim_paths, ValueOrArraySchema[StringSchema], aliases: :slim_path
-      attribute :yaml_paths, ValueOrArraySchema[StringSchema], aliases: :yaml_path
-      attribute :json_paths, ValueOrArraySchema[StringSchema], aliases: :json_path
-      attribute :erb_paths, ValueOrArraySchema[StringSchema], aliases: :erb_path
+      attribute :haml_paths, ValueOrArraySchema[StringSchema], aliases: :haml_path, suggest: false
+      attribute :slim_paths, ValueOrArraySchema[StringSchema], aliases: :slim_path, suggest: false
+      attribute :yaml_paths, ValueOrArraySchema[StringSchema], aliases: :yaml_path, suggest: false
+      attribute :json_paths, ValueOrArraySchema[StringSchema], aliases: :json_path, suggest: false
+      attribute :erb_paths, ValueOrArraySchema[StringSchema], aliases: :erb_path, suggest: false
+      attribute :precompile, ValueOrArraySchema[PrecompileSchema]
       attribute :requires, ValueOrArraySchema[RequireSchema], aliases: :require
       attribute :gems, ValueOrArraySchema[StringSchema], aliases: :gem
       attribute :keep, ValueOrArraySchema[KeepTestOnlySchema]
       attribute :test_only, ValueOrArraySchema[KeepTestOnlySchema]
       attribute :dynamic, ValueOrArraySchema[DynamicSchema]
+
+      PRECOMPILERS = %i{haml_paths slim_paths json_paths yaml_paths erb_paths}.freeze
+
+      def self.to_ruby(node) # rubocop:disable Metrics
+        read_hash = super
+        write_hash = read_hash.dup
+
+        read_hash.each do |key, value|
+          next unless PRECOMPILERS.include?(key)
+
+          value = { paths: value, format: key.to_s.delete_suffix('_paths') }
+          yaml = { 'precompile' => [value.transform_keys(&:to_s)] }.to_yaml.delete_prefix("---\n")
+
+          Leftovers.warn(<<~MESSAGE)
+            \e[33m`#{key}:` is deprecated\e[0m
+            Replace with:
+            \e[32m#{yaml}\e[0m
+          MESSAGE
+
+          write_hash[:precompile] = Leftovers.each_or_self(write_hash[:precompile]).to_a
+          write_hash[:precompile] << value
+          write_hash.delete(key)
+        end
+
+        write_hash
+      end
     end
   end
 end

data/lib/leftovers/config_loader/has_argument_schema.rb

@@ -2,12 +2,12 @@
 
 module Leftovers
   class ConfigLoader
-    class HasArgumentSchema < ObjectSchema
+    class HasArgumentSchema < ValueOrObjectSchema
       attribute :at, ValueOrArraySchema[ArgumentPositionSchema], require_group: :matcher
       attribute :has_value, ValueOrArraySchema[HasValueSchema], require_group: :matcher
       attribute :unless, ValueOrArraySchema[HasArgumentSchema], require_group: :matcher
 
-      self.or_schema = ScalarArgumentSchema
+      self.or_value_schema = ScalarArgumentSchema
     end
   end
 end

data/lib/leftovers/config_loader/has_value_schema.rb

@@ -2,7 +2,7 @@
 
 module Leftovers
   class ConfigLoader
-    class HasValueSchema < ObjectSchema
+    class HasValueSchema < ValueOrObjectSchema
       inherit_attributes_from StringPatternSchema, except: :unless
 
       attribute :at, ValueOrArraySchema[ArgumentPositionSchema], require_group: :matcher
@@ -12,7 +12,7 @@ module Leftovers
       attribute :type, ValueOrArraySchema[ValueTypeSchema], require_group: :matcher
       attribute :unless, ValueOrArraySchema[HasValueSchema], require_group: :matcher
 
-      self.or_schema = ScalarValueSchema
+      self.or_value_schema = ScalarValueSchema
     end
   end
 end

data/lib/leftovers/config_loader/inherit_schema_attributes.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Leftovers
+  class ConfigLoader
+    class InheritSchemaAttributes
+      def initialize(schema, require_group: true, except: nil)
+        @schema = schema
+        @use_require_groups = require_group
+        @except = Leftovers.each_or_self(except)
+      end
+
+      def attributes
+        @schema.attributes.map do |attr|
+          next if @except.include?(attr.name)
+          next attr.without_require_group unless @use_require_groups
+
+          attr
+        end.compact
+      end
+    end
+  end
+end

data/lib/leftovers/config_loader/keep_test_only_schema.rb

@@ -2,12 +2,12 @@
 
 module Leftovers
   class ConfigLoader
-    class KeepTestOnlySchema < ObjectSchema
+    class KeepTestOnlySchema < ValueOrObjectSchema
       inherit_attributes_from StringPatternSchema, except: :unless
       inherit_attributes_from RulePatternSchema, except: :unless
       attribute :unless, ValueOrArraySchema[KeepTestOnlySchema], require_group: :matcher
 
-      self.or_schema = StringSchema
+      self.or_value_schema = StringSchema
     end
   end
 end