leftovers 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ca0079209fd4a81f12410ab2b9ccc3ac8eeb176
-  data.tar.gz: 1c4cca1116e1cb07b630bf97742da022a2fc8362
+SHA256:
+  metadata.gz: 32e8f2762f7f513145ea799b64a059c7228dd7e9a4e08c2762abe92aad1370b1
+  data.tar.gz: 9134e7d5c66bcbb25bb5fba15f5b1bb661ce18972cf91e179f165af52f955662
 SHA512:
-  metadata.gz: 64427530e7fc79d4f683adbbb5eb3df1b6e7693171ab2debd2b2e5b32b394bf7185e2a742b94524a08b130c9eb76ed02d786020acfdffd52a306e7588fc3eff3
-  data.tar.gz: 1aa3183b82769536d95738f1271f0d7581622fc5607dc48a40788151228151f1e1117ef75b6520db5ca28389b31ddefde19b675d6884e092e405ce123785b188
+  metadata.gz: e361dc15e0a3496dadf81f91d356183631b1ad9f0b44951f976785622aa8550ccd0d8a6632064ab646a65231c4b772236cf1136b9267ceb81c59217d36bb4f78
+  data.tar.gz: d82fd190746370c9ead45a27e5a660f81aafadf58736afd644d5fafad816daa450f25eebcf30d18875b185ab7d76b3215a696ed35bb75ad33509a474cff87736

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 0.6.0
+- drop ruby 2.4 support, allowing for some performance improvements
+- Add ability to parse JSON and YAML files
+- Add magic comment that points to a particular dynamic rule
+- repeated calls to --write-todo won't have ordering differences
+- fix issue with --write-todo and unused methods defined in test files
+
+# 0.5.5
+- Fix rails resource/resources method signatures
+
+# 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)
 

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)
@@ -129,7 +129,7 @@ To do this for all definitions of this name, instead of adding a comment, add th
 
 ### `# leftovers:call`
 _aliases `leftovers:calls`_
-To mark a dynamic call that doesn't use literal values, use `leftovers:call` with the method name listed
+To mark a call that doesn't use literal values, use `leftovers:call` with the method name listed
 ```ruby
 method = [:puts, :warn].sample # leftovers:call puts, warn
 send(method, 'text')
@@ -137,6 +137,26 @@ send(method, 'text')
 
 This would consider `puts` and `warn` to both have been called
 
+### `# leftovers:dynamic:*`
+To mark a dynamic call for literal hash and array values without enumerating everything in the comment again, use `leftovers:dynamic:`  on the same line as the beginning of the array or hash
+
+```ruby
+[ # leftovers:dynamic:call_login
+  :user,
+  :admin
+].each { |method| send("#{method}_login") }
+```
+
+with the following configuration matching the `name: value` to the `leftovers:dynamic:process_name`
+
+```yaml
+dynamic:
+  name: call_login
+  arguments: '*'
+  add_suffix: '_login'
+```
+This would consider `user_login` and `admin_login` to both have been called.
+
 ## Configuration file
 
 The configuration is read from `.leftovers.yml` in your project root.
@@ -163,7 +183,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,7 +7,10 @@ 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)
+- [`yaml_paths:`](#yaml_paths)
+- [`json_paths:`](#json_paths)
 - [`requires:`](#requires)
 - [`gems:`](#gems)
 - [`keep:`](#keep)
@@ -92,6 +95,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
@@ -104,6 +119,76 @@ erb_paths:
 
 Arrays are not necessary for single values. `*.erb` is recognized by default
 
+## `yaml_paths:`
+
+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)
+
+```yml
+include:
+  - 'config/*.yml'
+yaml_paths:
+  - '*.yml'
+```
+
+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.
+
+so you could, e.g. read the class name out of a yaml document like:
+
+```yml
+class_name: MyClass
+```
+
+with config like:
+
+```yml
+include_paths:
+  - 'config/*.yml'
+
+dynamic:
+  document: true
+  path: config/*.yml
+  calls:
+    argument: class_name
+```
+
+[`nested:`](#nested) may be useful for more complex yaml structures
+
+## `json_paths:`
+
+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)
+
+```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:
+
+```json
+{ "class_name": "MyClass" }
+```
+
+with config like:
+
+```yml
+include_paths:
+  - 'config/*.json'
+
+dynamic:
+  document: true
+  path: config/*.json
+  calls:
+    argument: class_name
+```
+
+[`nested:`](#nested) may be useful for more complex json structures
+
 ## `gems:`
 _alias `gem:`_
 
@@ -189,7 +274,8 @@ Each entry must have at least one of the following properties to restrict which
 - [`paths:`](#paths)
 - [`has_arguments:`](#has_arguments)
 - [`has_receiver:`](#has_receiver)
-- [`unless`](#unless)
+- [`unless:`](#unless)
+- [`document: true`](#document-true)
 
 And must have one or both of
 - ['calls:`](#calls-defines)
@@ -286,6 +372,33 @@ keep:
     path: /app/helpers
 ```
 
+## `document: true`
+
+Instructs to consider the whole document. this is useful when parsing [YAML](#yaml-paths) or [JSON](#json-paths) config files for various values.
+
+e.g.
+
+```yml
+includes: /config/roles.yml
+dynamic:
+  - document: true
+    path: /config/roles.yml
+    defines:
+      arguments: '*'
+      add_suffix: '?'
+      add_prefix: can_
+```
+
+will parse "config/roles.yml"
+```yml
+- build_house
+- drive_car
+```
+
+and consider it to have created methods like `can_build_house?` and `can_drive_car?`
+
+[`nested:`](#nested) may be useful for more complex data structures
+
 ## `calls:`, `defines:`
 _aliases `call:`, `define:`_
 
@@ -353,7 +466,9 @@ It can have any of these properties:
 - [`at:`](#at)
 - [`has_value:`](#has_value_has_receiver)
 
-Arrays are not necessary for single values and if the rule contains only `at:` it can be omitted, and the values moved up a level
+Arrays are not necessary for single values and if the rule contains only `at:` it can be omitted, and the values moved up a level.
+
+Positional arguments are zero indexed
 
 ## `has_arguments:`
 _alias `has_argument:`_
@@ -371,6 +486,8 @@ It can have any of these properties:
 
 Arrays are not necessary for single values and if the rule contains only `at:` it can be omitted, and the values moved up a level
 
+Positional arguments are zero indexed
+
 ## `keywords:`
 When the keyword argument **keywords** are the thing being called.
 

data/leftovers.gemspec

@@ -17,7 +17,9 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'http://github.com/robotdana/leftovers'
   spec.metadata['changelog_uri'] = 'http://github.com/robotdana/leftovers/blob/main/CHANGELOG.md'
-  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.required_ruby_version = '>= 2.5.0'
 
   spec.files = Dir.glob('{lib,exe,docs}/**/{*,.*}') + %w{
     CHANGELOG.md
@@ -37,11 +39,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.1'
   spec.add_development_dependency 'rake', '>= 13'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.93.1'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.8.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.44.1'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
   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/actionpack.yml

@@ -73,8 +73,12 @@ dynamic:
   - name:
       - resource
       - resources
+    has_argument: 0
     calls:
       - argument: only
+      - argument: only
+        nested:
+          argument: '*'
       - argument: controller
         camelize: true
         add_suffix: Controller
@@ -82,6 +86,7 @@ dynamic:
   - name:
     - resource
     - resources
+    has_argument: 0
     unless:
       has_argument:
         - at: only
@@ -96,6 +101,7 @@ dynamic:
   - name:
     - resource
     - resources
+    has_argument: 0
     unless:
       has_argument:
         - at: only
@@ -110,6 +116,7 @@ dynamic:
   - name:
     - resource
     - resources
+    has_argument: 0
     unless:
       has_argument:
         - at: only
@@ -124,6 +131,7 @@ dynamic:
   - name:
     - resource
     - resources
+    has_argument: 0
     unless:
       has_argument:
         - at: only
@@ -138,6 +146,7 @@ dynamic:
   - name:
     - resource
     - resources
+    has_argument: 0
     unless:
       has_argument:
         - at: only
@@ -152,6 +161,7 @@ dynamic:
   - name:
     - resource
     - resources
+    has_argument: 0
     unless:
       has_argument:
         - at: only
@@ -165,6 +175,7 @@ dynamic:
       - value: destroy
   - name:
       - resources
+      - resource
       - controller
       - namespace
     calls:

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

@@ -10,6 +10,13 @@ include_paths:
   - '*.erb'
   - '*.rb'
 
+yaml_paths:
+  - '*.yml'
+  - '*.yaml'
+
+json_paths:
+  - '*.json'
+
 test_paths:
   - /tests/
   - /test/
@@ -20,6 +27,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/collector.rb

@@ -28,7 +28,9 @@ module Leftovers
 
     def collect_file_list(list)
       if Leftovers.parallel?
-        Parallel.each(list, finish: method(:finish_file), &method(:collect_file))
+        Parallel.each(list, finish: method(:finish_file)) do |file|
+          collect_file(file)
+        end
       else
         list.each { |file| finish_file(nil, nil, collect_file(file)) }
       end

data/lib/leftovers/config.rb

@@ -4,10 +4,6 @@ require 'yaml'
 
 module Leftovers
   class Config
-    # :nocov:
-    using ::Leftovers::Backports::SetCaseEq if defined?(::Leftovers::Backports::SetCaseEq)
-    # :nocov:
-
     attr_reader :name
 
     def initialize(name, path: nil, content: nil)
@@ -36,6 +32,18 @@ module Leftovers
       @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])
     end