leftovers 0.5.0 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d666abea8ce822697d18bd1b07a31684e7e85b81d3e3184c097438f0f83d89f5
-  data.tar.gz: 16c80ab37e2073f7738e40f8db24c628d688d9640cc5c00d0864d5da4f207bb6
+  metadata.gz: cc87c83e3671055ddbbd445768b73d55576676da6cfff8d83f5ceb57eb1d78e8
+  data.tar.gz: a3cc4945b1d4158817d0a6b5a0c0cc8bc8ad1d2e7a402d0b0a3221cebba7dc02
 SHA512:
-  metadata.gz: f57aa2dc36e1c980a05afb8a4feb156f34a5a91b2486713d118d161b41f164c0afc73e05fc79dc693b550a14a17e4510ac57a0be84b6c97cc6e5f3df29b940c3
-  data.tar.gz: 9aa8746deda0bc64cdd2c9f476396d7e01859cf81ebbdf982fbab484bfde0c0d14e9dbc636bb5c5fab3a46119fab4531424e3cbdcf4ac3dc71a043eb671e6808
+  metadata.gz: 450162ef45051251a698a5cfbd0451ac50d175339b2a9888edd7790e29071a4360f7677ca4f8d6b927bfdc004b0e4fde747884804c8e480659b76a5b39d0f8e3
+  data.tar.gz: 6ae0474561c71a1eddd0f6ecb0ba184de668eaca4aea36da0460fbeec313f9f095533f913863913de89ad192903b1cadaaffb3231432136138b2720df094f636

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# 0.5.4
+- Add support for slim templates #13 - thanks @veganstraightedge
+- fix the #how-to-resolve link #11 - thanks @veganstraightedge
+
+# v0.5.3
+- fix incompatibility with activesupport 7.
+
+# v0.5.2
+- allow config entries to have duplicates (especially as --write-todo) can write a file with duplicates)
+
+# v0.5.1
+- fixed a bug with the erb parsing where it was incorrectly compiling comments:
+```
+<% # Comment %>
+<% if query? %>
+  <%= content %>
+<% end %>
+```
+
 # v0.5.0
 - `has_receiver:` will match the receiver for methods and the namespace for constants.
 - `has_value_type:` is now `has_value: type:`

data/README.md

@@ -57,7 +57,7 @@ Not directly called at all:
 lib/hello_world.rb:6:6 generated_method= attr_accessor :generated_method
 lib/hello_world.rb:6:6 generated_method attr_accessor :generated_method
 
-how to resolve: https://github.com/robotdana/leftovers/tree/main/Readme.md#how_to_resolve
+how to resolve: https://github.com/robotdana/leftovers/tree/main/Readme.md#how-to-resolve
 ```
 
 if there is an overwhelming number of results, try using [`--write-todo`](#write-todo)
@@ -163,7 +163,7 @@ see the [built in config files](https://github.com/robotdana/leftovers/tree/main
 
   Add the method/pattern to the `dynamic:` list with `skip: true` in the `.leftovers.yml`, or add an inline comment with the list of possibilities `# leftovers:call my_method_1, my_method_2`.
 - Leftovers compares by name only, so multiple definitions with the same name will count as used even if only one is.
-- haml & erb line and column numbers will be wrong as the files have to be precompiled before checking.
+- haml, slim & erb line and column numbers will be wrong as the files have to be precompiled before checking.
 
 ## Other tools
 

data/docs/Configuration.md

@@ -7,6 +7,7 @@ Its presence is optional and all of these settings are optional.
 - [`exclude_paths:`](#exclude_paths)
 - [`test_paths:`](#test_paths)
 - [`haml_paths:`](#haml_paths)
+- [`slim_paths:`](#slim_paths)
 - [`erb_paths:`](#erb_paths)
 - [`requires:`](#requires)
 - [`gems:`](#gems)
@@ -92,6 +93,18 @@ haml_paths:
 
 Arrays are not necessary for single values. `*.haml` is recognized by default
 
+## `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

data/leftovers.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rspec', '~> 1.44.1'
   spec.add_development_dependency 'simplecov', '>= 0.18.5'
   spec.add_development_dependency 'simplecov-console'
+  spec.add_development_dependency 'slim'
   spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'tty_string', '>= 0.2.1'
 

data/lib/config/activesupport.yml

@@ -1,4 +1,5 @@
 requires:
+  - 'active_support'
   - 'active_support/core_ext/string'
   - 'active_support/inflections'
   - './config/initializers/inflections'

data/lib/config/ruby.yml

@@ -20,6 +20,9 @@ erb_paths:
 haml_paths:
   - '*.haml'
 
+slim_paths:
+  - '*.slim'
+
 keep:
   - initialize # called by new
   - inspect # called by repl, to_s

data/lib/config/slim.yml

@@ -0,0 +1,4 @@
+include_paths:
+  - '*.slim'
+slim_paths:
+  - '*.slim'

data/lib/leftovers/config.rb

@@ -36,6 +36,10 @@ module Leftovers
       @haml_paths ||= Array(yaml[:haml_paths])
     end
 
+    def slim_paths
+      @slim_paths ||= Array(yaml[:slim_paths])
+    end
+
     def erb_paths
       @erb_paths ||= Array(yaml[:erb_paths])
     end

data/lib/leftovers/config_validator/schema_hash.rb

@@ -36,8 +36,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/string' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             },
             { '$ref' => '#/definitions/string' }
           ]
@@ -65,8 +64,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/name' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             },
             { '$ref' => '#/definitions/name' }
           ]
@@ -84,8 +82,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/argumentPosition' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             }
           ]
         },
@@ -99,8 +96,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/valueType' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             }
           ]
         },
@@ -153,8 +149,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/hasValue' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             }
           ]
         },
@@ -184,8 +179,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/hasArgument' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             }
           ]
         },
@@ -298,8 +292,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/transform' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             }
           ]
         },
@@ -314,8 +307,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/keyword' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             }
           ]
         },
@@ -384,8 +376,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/action' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             }
           ]
         },
@@ -415,8 +406,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/ruleMatcher' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             },
             { '$ref' => '#/definitions/ruleMatcher' }
           ]
@@ -481,8 +471,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/dynamic' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             },
             { '$ref' => '#/definitions/dynamic' }
           ]
@@ -517,8 +506,7 @@ module Leftovers
             {
               'type' => 'array',
               'items' => { '$ref' => '#/definitions/keepTestOnly' },
-              'minItems' => 1,
-              'uniqueItems' => true
+              'minItems' => 1
             },
             { '$ref' => '#/definitions/keepTestOnly' }
           ]
@@ -529,6 +517,7 @@ module Leftovers
         'exclude_paths' => { '$ref' => '#/definitions/stringList' },
         'test_paths' => { '$ref' => '#/definitions/stringList' },
         'haml_paths' => { '$ref' => '#/definitions/stringList' },
+        'slim_paths' => { '$ref' => '#/definitions/stringList' },
         'erb_paths' => { '$ref' => '#/definitions/stringList' },
         'requires' => { '$ref' => '#/definitions/stringList' },
         'gems' => { '$ref' => '#/definitions/stringList' },

data/lib/leftovers/erb.rb

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

data/lib/leftovers/file.rb

@@ -15,12 +15,18 @@ module Leftovers
     end
 
     def ruby
+      precompiler&.precompile(read, self) || read
+    end
+
+    private
+
+    def precompiler
       if Leftovers.config.haml_paths.allowed?(relative_path)
-        ::Leftovers::Haml.precompile(read, self)
+        ::Leftovers::Haml
+      elsif Leftovers.config.slim_paths.allowed?(relative_path)
+        ::Leftovers::Slim
       elsif Leftovers.config.erb_paths.allowed?(relative_path)
-        ::Leftovers::ERB.precompile(read)
-      else
-        read
+        ::Leftovers::ERB
       end
     end
   end

data/lib/leftovers/matcher_builders/node_value.rb

@@ -12,7 +12,7 @@ module Leftovers
             when ::String
               ::Leftovers::MatcherBuilders::NodeName.build(pat)
             when ::Hash
-              build_from_hash(pat)
+              build_from_hash(**pat)
             # :nocov:
             else raise
               # :nocov:
@@ -22,18 +22,26 @@ module Leftovers
 
         private
 
-        def build_from_hash(pat) # rubocop:disable Metrics/MethodLength
+        def build_from_hash( # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+          at: nil, has_value: nil,
+          match: nil, has_prefix: nil, has_suffix: nil,
+          type: nil,
+          has_receiver: nil,
+          unless_arg: nil
+        )
           matcher = ::Leftovers::MatcherBuilders::And.build([
-            ::Leftovers::MatcherBuilders::NodeHasArgument.build(pat.slice(:at, :has_value)),
+            ::Leftovers::MatcherBuilders::NodeHasArgument.build(
+              at: at, has_value: has_value
+            ),
             ::Leftovers::MatcherBuilders::NodeName.build(
-              pat.slice(:match, :has_prefix, :has_suffix)
+              match: match, has_prefix: has_prefix, has_suffix: has_suffix
             ),
-            ::Leftovers::MatcherBuilders::NodeType.build(pat[:type]),
-            ::Leftovers::MatcherBuilders::NodeHasReceiver.build(pat[:has_receiver])
+            ::Leftovers::MatcherBuilders::NodeType.build(type),
+            ::Leftovers::MatcherBuilders::NodeHasReceiver.build(has_receiver)
           ])
 
           ::Leftovers::MatcherBuilders::AndNot.build(
-            matcher, ::Leftovers::MatcherBuilders::NodeValue.build(pat[:unless_arg])
+            matcher, ::Leftovers::MatcherBuilders::NodeValue.build(unless_arg)
           )
         end
       end

data/lib/leftovers/merged_config.rb

@@ -37,14 +37,22 @@ 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
+      @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 +79,14 @@ module Leftovers
       )
     end
 
+    def slim_paths
+      @slim_paths ||= FastIgnore.new(
+        include_rules: @configs.flat_map(&:slim_paths),
+        gitignore: false,
+        root: Leftovers.pwd
+      )
+    end
+
     def erb_paths
       @erb_paths ||= FastIgnore.new(
         include_rules: @configs.flat_map(&:erb_paths),

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/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/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/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/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.0'
+  VERSION = '0.5.4'
 end

data/lib/leftovers.rb

@@ -24,6 +24,7 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
   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")
@@ -93,7 +94,7 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
     end
 
     def resolution_instructions_link
-      "https://github.com/robotdana/leftovers/tree/v#{Leftovers::VERSION}/README.md#how_to_resolve"
+      "https://github.com/robotdana/leftovers/tree/v#{Leftovers::VERSION}/README.md#how-to-resolve"
     end
 
     def warn(message)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leftovers
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.4
 platform: ruby
 authors:
 - Dana Sherson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -291,6 +305,7 @@ files:
 - docs/Configuration.md
 - exe/leftovers
 - leftovers.gemspec
+- lib/.DS_Store
 - lib/config/actioncable.yml
 - lib/config/actionmailer.yml
 - lib/config/actionpack.yml
@@ -322,6 +337,7 @@ files:
 - lib/config/selenium-webdriver.yml
 - lib/config/sidekiq.yml
 - lib/config/simplecov.yml
+- lib/config/slim.yml
 - lib/config/will_paginate.yml
 - lib/leftovers.rb
 - lib/leftovers/ast.rb
@@ -406,6 +422,7 @@ 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
@@ -465,7 +482,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Find unused methods and classes/modules