leftovers 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02f0f5136df6e16a7d27e47d118446f9118395f9242e29a32c91476ccd070591
-  data.tar.gz: fa438c525a212769b17cae1b2e2f05495c2772da5c9f3a05c9dd2d869743e969
+  metadata.gz: d666abea8ce822697d18bd1b07a31684e7e85b81d3e3184c097438f0f83d89f5
+  data.tar.gz: 16c80ab37e2073f7738e40f8db24c628d688d9640cc5c00d0864d5da4f207bb6
 SHA512:
-  metadata.gz: 3c88300e0a1e822f510dd22ff72a91ab1db5ed35ac7cdd323ec3fe194f347748faad08efd62ac727501ed6f854e5623b6958589e216a4e2389ed44f9fc878b54
-  data.tar.gz: '08deaf4ffb911b2a1d53960e5bfc6c46a3990d0a6197d28f18b8ccfc60031b48c3701dca1e1d1ffe7db5e1ab892b1630c9332e87706769326141b0793115a2d6'
+  metadata.gz: f57aa2dc36e1c980a05afb8a4feb156f34a5a91b2486713d118d161b41f164c0afc73e05fc79dc693b550a14a17e4510ac57a0be84b6c97cc6e5f3df29b940c3
+  data.tar.gz: 9aa8746deda0bc64cdd2c9f476396d7e01859cf81ebbdf982fbab484bfde0c0d14e9dbc636bb5c5fab3a46119fab4531424e3cbdcf4ac3dc71a043eb671e6808

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# v0.5.0
+- `has_receiver:` will match the receiver for methods and the namespace for constants.
+- `has_value_type:` is now `has_value: type:`
+- `has_value:` can be nested with `at:` and `has_value:`.
+- `has_argument:` can be given `at:` with `'*'` or `'**'` which matches all positional arguments or keyword arguments respectively
+- the rails.yml config has been broken up into e.g. activerecord, actionpack, etc
+- `haml_paths:` and `erb_paths:` are now configurable.
+- `type:` can match on `'Array'`, `'Hash'`, and `'Proc'` literals.
+- rails.yml config determines which `scope` is which by its shape rather than its path: (ActiveRecord#scope has a proc as the second parameter)
+- `--write--todo` now correctly handles grouped definitions (like activemodel attributes)
+
+# v0.4.4
+- don't hard-wrap the --write-todo instructions it looks weird
+
+# v0.4.3
+- add --write-todo so you can add this to your project without
+immediately fixing everything.
+
+# v0.4.2
+- Make sorbet happy with this as a dependency
+# v0.4.1
+- add `test_only:` to mark methods/constants/assignments as test_only in the config rather than just with magic comments
 
 # v0.4.0
 - add `requires:` to .leftovers.yml config to e.g. load inflections in a different place than `config/initializers/inflections`

data/README.md

@@ -56,8 +56,38 @@ lib/hello_world.rb:18:6 another_tested_unused_method def another_tested_unused_m
 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
 ```
 
+if there is an overwhelming number of results, try using [`--write-todo`](#write-todo)
+
+## How to resolve
+
+When running `leftovers` you'll be given a list of method, constant, and variable definitions it thinks are unused. Now what?
+
+they were unintentionally left when removing their calls:
+  - remove their definitions. (they're still there in your git etc history if you want them back)
+
+they are called dynamically:
+  - define how they're called dynamically in the [.leftovers.yml](#configuration-file); or
+  - mark the calls with [`# leftovers:call my_unused_method`](#leftovers-call); or
+  - mark the definition with [`# leftovers:keep`](#leftovers-keep)
+
+they're defined intentionally to only be used by tests:
+  - add [`# leftovers:test_only`](#leftovers-test-only)
+
+they're from a file that shouldn't be checked by leftovers:
+  - add the paths to the [`exclude_paths:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#exclude_paths) list in the [.leftovers.yml](#configuration-file) file
+
+if there are too many to address when first adding leftovers to your project, try running [`leftovers --write-todo`](#write-todo),
+
+### --write-todo
+
+running `leftovers --write-todo` will generate a supplemental configuration file allowing all the currently detected uncalled definitions, which will be read on subsequent runs of `leftovers` without alerting any of the items mentioned in it.
+
+commit this file so you/your team can gradually address these items while still having leftovers alert you to any newly unused items.
+
 ## Magic comments
 
 ### `# leftovers:keep`
@@ -72,16 +102,16 @@ class MyClass
 end
 ```
 This would report `MyClass` is unused, but not my_method
-To do this for all definitions of this name, add the name with `skip: true` in the configuration file.
+To do this for all definitions of this name, instead of adding a comment, add the name to the [`keep:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#keep) list in the [configuration file](#configuration-file).
 
-### `# leftovers:test`
+### `# leftovers:test_only`
 _aliases `leftovers:for_test`, `leftovers:for_tests`, `leftovers:test`, `leftovers:tests`, `leftovers:testing`_
 
-To mark a definition from a non-test dir, as intentionally only used by tests, use `leftovers:test`
+To mark a definition from a non-test dir, as intentionally only used by tests, use `leftovers:test_only`
 ```ruby
 # app/my_class.rb
 class MyClass
-  def my_method # leftovers:test
+  def my_method # leftovers:test_only
     true
   end
 end
@@ -95,6 +125,8 @@ end
 
 This would consider `my_method` to be used, even though it is only called by tests.
 
+To do this for all definitions of this name, instead of adding a comment, add the name to the [`test_only:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#test_only) list in the [configuration file](#configuration-file).
+
 ### `# leftovers:call`
 _aliases `leftovers:calls`_
 To mark a dynamic call that doesn't use literal values, use `leftovers:call` with the method name listed
@@ -116,6 +148,7 @@ Its presence is optional and all of these settings are optional.
 - [`requires:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#requires)
 - [`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)
 - [`dynamic:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#dynamic)
 
 see the [complete config documentation](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md) for details.

data/docs/Configuration.md

@@ -6,9 +6,12 @@ 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)
+- [`erb_paths:`](#erb_paths)
 - [`requires:`](#requires)
 - [`gems:`](#gems)
 - [`keep:`](#keep)
+- [`test_only:](#test_only)
 - [`dynamic:`](#dynamic)
 
 see the [built in config files](https://github.com/robotdana/leftovers/tree/main/lib/config) or [this repo's own config](https://github.com/robotdana/leftovers/tree/main/.leftovers.yml) for examples.
@@ -46,7 +49,7 @@ exclude_paths:
 
 Arrays are not necessary for single values
 
-## `requires:` # TODO
+## `requires:`
 _alias `require`_
 
 List filenames/paths that you want to include
@@ -77,6 +80,30 @@ 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)
+
+```yml
+haml_paths:
+  - '*.haml'
+```
+
+Arrays are not necessary for single values. `*.haml` 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'
+```
+
+Arrays are not necessary for single values. `*.erb` is recognized by default
+
 ## `gems:`
 _alias `gem:`_
 
@@ -104,6 +131,7 @@ Each entry can be a string (an exact match for a method, constant, or variable n
   - [`matches:`](#matches) (can't be used in the same entry as `has_prefix:` or `has_suffix:`)
 - [`paths:`](#paths)
 - [`has_arguments:`](#has_arguments)
+- [`has_receiver:`](#has_receiver)
 - [`unless`](#unless)
 
 Arrays are not necessary for single values
@@ -120,6 +148,34 @@ keep:
 
 Alternatively, you can mark method/constants/variables in-place using [magic comments](https://github.com/robotdana/leftovers/tree/main/README.md#magic-comments).
 
+## `test_only:`
+
+This is a list of methods/constants/variables that are ok to be defined outside of [test paths](#test_paths), but only used within test paths, maybe because they're your public api, or convenience methods for tests etc.
+
+Each entry can be a string (an exact match for a method, constant, or variable name that includes the sigil), or have at least one of the following properties:
+- [`names:`](#names)
+  or the properties from `names:`
+  - [`has_prefix:`](#has_prefix)
+  - [`has_suffix:`](#has_suffix)
+  - [`matches:`](#matches) (can't be used in the same entry as `has_prefix:` or `has_suffix:`)
+- [`paths:`](#paths)
+- [`has_arguments:`](#has_arguments)
+- [`unless`](#unless)
+
+Arrays are not necessary for single values
+
+example from rails.yml
+```yml
+test_only:
+  - APP_PATH
+  - ssl_configured?
+  - has_suffix: Helper
+    path: /app/helpers
+  ...
+```
+
+Alternatively, you can mark method/constants/variables in-place using [magic comments](https://github.com/robotdana/leftovers/tree/main/README.md#magic-comments).
+
 ## `dynamic:`
 
 This is a list of methods, constants, or variables whose called arguments or assigned value/s are used to dynamically `call:` or define (`define:`) other methods, constants, or variables
@@ -132,6 +188,7 @@ Each entry must have at least one of the following properties to restrict which
   - [`matches:`](#matches)
 - [`paths:`](#paths)
 - [`has_arguments:`](#has_arguments)
+- [`has_receiver:`](#has_receiver)
 - [`unless`](#unless)
 
 And must have one or both of
@@ -294,8 +351,7 @@ and when used in:
 
 It can have any of these properties:
 - [`at:`](#at)
-- [`has_value:`](#has_value)
-- [`has_value_type:`](#has_value_type)
+- [`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
 
@@ -311,8 +367,7 @@ The method call/constant variable/assignment will be considered matching if it h
 
 It can have any of these properties:
 - [`at:`](#at)
-- [`has_value:`](#has_value) # TODO
-- [`has_value_type:`](#has_value_type) # TODO
+- [`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
 
@@ -354,9 +409,9 @@ Each entry can be any of:
 
 Arrays are not necessary for single values
 
-## `has_value:`
+## `has_value:`, `has_receiver:`
 
-filter [`arguments:`](#arguments), [`has_arguments:`](#has_arguments), and [`keywords:`](#keywords), by the argument/assigned value
+filter [`arguments:`](#arguments), [`has_arguments:`](#has_arguments), and [`keywords:`](#keywords), by the argument/assigned/receiver value
 
 Each entry can be one of
 - `true`, `false`, `nil`, or an Integer. matches the literal value
@@ -365,16 +420,25 @@ Each entry can be one of
   - [`has_prefix:`](#has_prefix)
   - [`has_suffix:`](#has_suffix)
   - [`matches:`](#matches) (this can't be used in the same entry as `has_prefix:` or `has_suffix:`)
+- or have at least one of the following properties to match within an array or hash:
+  - [`at`](#at)
+  - [`has_value`](#has_value_has_receiver)
+- or have the following property to match the value type
+  - [`type`](#type)
+- or have the following property to match the receiver
+  - [`has_receiver`](#has_value_has_receiver)
 
-## `has_value_type:`
+## `type:`
 
-Filter [`arguments:`](#arguments), [`has_arguments:`](#has_arguments), and [`keywords:`](#keywords), by the argument/assigned value
+Filter [`has_value`](#has_value_has_receiver), by the argument/assigned value type
 
 Each entry can be one of
 - `'String'`
 - `'Symbol'`
 - `'Integer'`
 - `'Float'`
+- `'Array'`
+- `'Hash'`
 
 Arrays are not necessary for single values
 
@@ -584,9 +648,9 @@ Can be used in the [`transforms:`](#transforms) list (or anywhere `transforms:`
 if used in a hash `true` can be used as a placeholder value
 
 the incoming value will be transformed using the [active_support String core extensions](https://edgeguides.rubyonrails.org/active_support_core_extensions.html#inflections)
-and if using [gems:](#gems) with `active_support` or `rails` then your `config/initializers/inflections.rb` will be loaded. if you have inflections in another file, then supply that to [`requires:`](#requires).
+and if using [gems:](#gems) with `activesupport` or `rails` then your `config/initializers/inflections.rb` will be loaded. if you have inflections in another file, then supply that to [`requires:`](#requires).
 
-If the `active_support` gem is not available this will raise an error.
+If the `activesupport` gem is not available this will raise an error.
 
 ## `unless:`
 

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 'timecop'
   spec.add_development_dependency 'tty_string', '>= 0.2.1'
 
   spec.add_development_dependency 'spellr', '>= 0.8.1'

data/lib/config/actioncable.yml

@@ -0,0 +1,4 @@
+# THIS IS INCOMPLETE (you can help by expanding it)
+# rails is _really complicated_ and has a lot of magic which calls methods for you.
+# some is currently impossible to handle (with_options).
+# Some is just corners of rails I haven't hit yet.

data/lib/config/actionmailer.yml

@@ -0,0 +1,22 @@
+# THIS IS INCOMPLETE (you can help by expanding it)
+# rails is _really complicated_ and has a lot of magic which calls methods for you.
+# some is currently impossible to handle (with_options).
+# Some is just corners of rails I haven't hit yet.
+keep:
+  - has_suffix: Preview
+    path: '**/mailers/previews/**/*_preview.rb'
+  - delivering_email
+  - delivered_email
+
+dynamic:
+  names:
+    - deliver_now
+    - deliver_later
+  calls:
+    value:
+      deliver
+  names:
+    - before_action
+    - after_action
+    - around_action
+  calls: ['*', if, unless]

data/lib/config/actionpack.yml

@@ -0,0 +1,190 @@
+# THIS IS INCOMPLETE (you can help by expanding it)
+# rails is _really complicated_ and has a lot of magic which calls methods for you.
+# some is currently impossible to handle (with_options).
+# Some is just corners of rails I haven't hit yet.
+
+include_paths:
+  - '*.rjs'
+  - '*.rhtml'
+
+erb_paths:
+  - '*.rjs'
+  - '*.rhtml'
+
+keep:
+  - ssl_configured? # ApplicationController
+  - default_url_options # called by url_for
+  - matches? # called by route constraints
+  - has_suffix: Helper
+    path: /app/helpers
+
+dynamic:
+  - names:
+      - after_action
+      - append_after_action
+      - append_around_action
+      - append_before_action
+      - around_action
+      - before_action
+      - prepend_after_action
+      - prepend_around_action
+      - prepend_before_action
+      - skip_before_action
+      - skip_after_action
+      - skip_around_action
+    calls:
+      - arguments: ['*', if, unless]
+  - name: scope
+    unless:
+      has_argument:
+        at: 1
+        has_value:
+          type: Proc
+    calls:
+      argument: module # routes
+      camelize: true
+      split: '::'
+  - name: namespace
+    calls:
+      - argument: 0
+        camelize: true
+        split: '::'
+  - name:
+      - rescue_from
+    calls:
+      - argument: [1, with]
+  - name:
+      - match
+      - delete
+      - get
+      - patch
+      - post
+      - put
+      - root
+    calls:
+      - arguments: [0, action]
+      - argument: '**'
+        delete_before: '#'
+      - argument: '**'
+        delete_after: '#'
+        camelize: true
+        add_suffix: Controller
+        split: '::'
+  - name:
+      - resource
+      - resources
+    calls:
+      - argument: only
+      - argument: controller
+        camelize: true
+        add_suffix: Controller
+        split: '::'
+  - name:
+    - resource
+    - resources
+    unless:
+      has_argument:
+        - at: only
+        - at: except
+          has_value: index
+        - at: except
+          has_value:
+            at: '*'
+            has_value: index
+    calls:
+      - value: index
+  - name:
+    - resource
+    - resources
+    unless:
+      has_argument:
+        - at: only
+        - at: except
+          has_value: new
+        - at: except
+          has_value:
+            at: '*'
+            has_value: new
+    calls:
+      - value: new
+  - name:
+    - resource
+    - resources
+    unless:
+      has_argument:
+        - at: only
+        - at: except
+          has_value: create
+        - at: except
+          has_value:
+            at: '*'
+            has_value: create
+    calls:
+      - value: create
+  - name:
+    - resource
+    - resources
+    unless:
+      has_argument:
+        - at: only
+        - at: except
+          has_value: edit
+        - at: except
+          has_value:
+            at: '*'
+            has_value: edit
+    calls:
+      - value: edit
+  - name:
+    - resource
+    - resources
+    unless:
+      has_argument:
+        - at: only
+        - at: except
+          has_value: update
+        - at: except
+          has_value:
+            at: '*'
+            has_value: update
+    calls:
+      - value: update
+  - name:
+    - resource
+    - resources
+    unless:
+      has_argument:
+        - at: only
+        - at: except
+          has_value: destroy
+        - at: except
+          has_value:
+            at: '*'
+            has_value: destroy
+    calls:
+      - value: destroy
+  - name:
+      - resources
+      - controller
+      - namespace
+    calls:
+      - argument: 0
+        camelize: true
+        add_suffix: Controller
+        split: '::'
+  - name: resource
+    calls:
+      - argument: 0
+        camelize: true
+        pluralize: true
+        add_suffix: Controller
+        split: '::'
+  - name: permit
+    calls:
+      arguments: ['*', '**']
+      keywords: '**'
+      add_suffix: "="
+      recursive: true
+  - name: layout
+    calls:
+      argument: 0

data/lib/config/actionview.yml

@@ -0,0 +1,64 @@
+# THIS IS INCOMPLETE (you can help by expanding it)
+# rails is _really complicated_ and has a lot of magic which calls methods for you.
+# some is currently impossible to handle (with_options).
+# Some is just corners of rails I haven't hit yet.
+keep:
+  - has_suffix: Helper
+    path: /app/helpers
+
+dynamic:
+  - name:
+    - check_box
+    - date_select
+    - datetime_select
+    - file_field
+    - hidden_field
+    - label
+    - radio_button
+    - select
+    - time_select
+    - time_zone_select
+    - color_field
+    - date_field
+    - datetime_field
+    - datetime_local_field
+    - email_field
+    - month_field
+    - number_field
+    - password_field
+    - phone_field
+    - range_field
+    - search_field
+    - telephone_field
+    - text_area
+    - text_field
+    - time_field
+    - url_field
+    - week_field
+    calls:
+      - arguments: [0,1] # 0: with a receiver, 1: with no receiver
+      - arguments: [0,1]
+        add_suffix: '='
+  - name: fields_for
+    calls:
+      argument: 1
+      add_suffix: _attributes
+  - name: options_from_collection_for_select
+    calls:
+      - arguments: [1,2]
+  - name:
+      - collection_select
+      - collection_check_boxes
+      - collection_radio_buttons
+    calls:
+      - argument: 1
+        add_suffix: '='
+      - arguments: [3,4]
+  - name: grouped_collection_select
+    calls:
+      - argument: 1
+        add_suffix: '='
+      - arguments: [3,4,5,6]
+  - name: option_groups_from_collection_for_select
+    calls:
+      - arguments: [0,1,2,3]

data/lib/config/activejob.yml

@@ -0,0 +1,29 @@
+# THIS IS INCOMPLETE (you can help by expanding it)
+# rails is _really complicated_ and has a lot of magic which calls methods for you.
+# some is currently impossible to handle (with_options).
+# Some is just corners of rails I haven't hit yet.
+keep:
+  - serialize?
+  - serialize
+  - deserialize
+dynamic:
+  - name:
+      - perform_later
+      - perform
+    calls:
+      - value: perform
+  - names:
+      - before_enqueue
+      - around_enqueue
+      - after_enqueue
+      - before_perform
+      - around_perform
+      - after_perform
+    calls:
+      - arguments: 1
+      - arguments: [if, unless]
+        nested:
+          arguments: '*'
+  - name: rescue_from
+    calls:
+      - arguments: 1

data/lib/config/activemodel.yml

@@ -0,0 +1,74 @@
+# THIS IS INCOMPLETE (you can help by expanding it)
+# rails is _really complicated_ and has a lot of magic which calls methods for you.
+# some is currently impossible to handle (with_options).
+# Some is just corners of rails I haven't hit yet.
+keep:
+  - validate_each # ActiveModel::EachValidator
+
+dynamic:
+  - names:
+      - after_initialize
+      - before_validation
+      - after_validation
+    calls:
+      - arguments: 0
+      - arguments: [if, unless]
+        nested:
+          arguments: '*'
+  - name:
+      - validates_associated
+    calls:
+      - arguments: ['*', if, unless]
+  - name: validates
+    calls:
+      - arguments:
+          - '*'
+          - within
+          - inclusion
+          - scope
+          - if
+          - unless
+      - arguments: inclusion
+        nested:
+          arguments: 'in'
+      - keywords:
+          unless: [if, unless]
+        camelize: true
+        add_suffix: Validator
+        split: '::'
+  - names:
+      - validate
+      - validate_associated
+    calls:
+      - arguments: ['*', if, unless]
+  - name:
+      - attribute
+      - alias_attribute
+    path: app/models/*
+    defines:
+      argument: 0
+      transforms:
+        - original
+        - add_suffix: '?'
+        - add_suffix: '='
+  - name: alias_attribute
+    calls:
+      - argument: 1
+      - argument: 1
+        add_suffix: '?'
+      - argument: 1
+        add_suffix: '='
+  - name: resource
+    calls:
+      - argument: 0
+        camelize: true
+        pluralize: true
+        add_suffix: Controller
+        split: '::'
+
+  - name:
+    - new
+    - assign_attributes
+    calls:
+      keyword: '**'
+      add_suffix: '='