leftovers 0.8.0 → 0.11.0

data/lib/config/actionmailer.yml

@@ -1,22 +1,101 @@
-# 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.
+# https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html
+# https://guides.rubyonrails.org/action_mailer_basics.html
+gems:
+  - activesupport
+  - actionpack
+  - actionview
+  - activejob
+
 keep:
+  # https://guides.rubyonrails.org/action_mailer_basics.html
   - has_suffix: Preview
-    path: '**/mailers/previews/**/*_preview.rb'
+    path: '/test/mailers/previews/**/*_preview.rb'
+    # this path is the default
+    # if it's overridden copy this into .leftovers.yml with
+    # whatever it was overridden as
+
+  # https://guides.rubyonrails.org/action_mailer_basics.html#intercepting-emails
   - delivering_email
+
+  # https://guides.rubyonrails.org/action_mailer_basics.html#observing-emails
   - delivered_email
 
 dynamic:
-  - names:
-      - deliver_now
-      - deliver_later
-    calls:
-      value:
-        deliver
+  # https://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-callbacks
   - names:
       - before_action
       - after_action
       - around_action
-    calls: ['*', if, unless]
+    calls:
+      - arguments: '*'
+      - arguments: [if, unless]
+        nested: '*'
+
+  # https://guides.rubyonrails.org/action_mailer_basics.html#intercepting-emails
+  - names: interceptors=
+    has_receiver: action_mailer
+    calls:
+      argument: 0
+      nested: '*'
+      split: '::'
+
+  # https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html#method-c-register_interceptor
+  - names: register_interceptor
+    calls:
+      argument: 0
+      camelize: true
+      split: '::'
+
+  # https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html#method-c-register_interceptors
+  - names: register_interceptors
+    calls:
+      argument: '*'
+      camelize: true
+      split: '::'
+
+
+  # https://guides.rubyonrails.org/action_mailer_basics.html#observing-emails
+  - names: observers=
+    has_receiver: action_mailer
+    calls:
+      argument: 0
+      nested: '*'
+      split: '::'
+
+  # https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html#method-c-register_observer
+  - names: register_observer
+    calls:
+      argument: 0
+      camelize: true
+      split: '::'
+
+  # https://edgeapi.rubyonrails.org/classes/ActionMailer/Base.html#method-c-register_observers
+  - names: register_observers
+    calls:
+      argument: '*'
+      camelize: true
+      split: '::'
+
+  # https://edgeapi.rubyonrails.org/classes/ActionMailer/DeliveryMethods/ClassMethods.html#method-i-add_delivery_method
+  # i'm going to skip this because it immediately calls the method it creates
+  # - names: add_delivery_method
+  #   defines:
+  #     argument: 0
+  #     transforms:
+  #       - add_suffix: _settings=
+  #       - add_suffix: _settings
+  #   calls:
+  #     argument: 0
+  #     add_suffix: _settings=
+
+  # https://edgeapi.rubyonrails.org/classes/ActionMailer/Previews/ClassMethods.html#method-i-register_preview_interceptor
+  - names: register_preview_interceptor
+    calls:
+      argument: 0
+      split: '::'
+
+  # https://edgeapi.rubyonrails.org/classes/ActionMailer/Previews/ClassMethods.html#method-i-register_preview_interceptors
+  - names: register_preview_interceptors
+    calls:
+      argument: '*'
+      split: '::'

data/lib/config/actionpack.yml

@@ -1,26 +1,31 @@
-# 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'
-
+include_paths: '*.rjs'
 precompile:
-  - paths:
-      - '*.rjs'
-      - '*.rhtml'
+  - paths: '*.rjs'
     format: erb
 
+gems:
+  - activesupport
+  - actionview
+
+
 keep:
-  - ssl_configured? # ApplicationController
-  - default_url_options # called by url_for
-  - matches? # called by route constraints
+  # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Scoping.html#method-i-constraints
+  - matches?
+
+  # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Concerns.html#method-i-concern
+  - call
+
+  # https://edgeapi.rubyonrails.org/classes/AbstractController/Rendering.html#method-i-view_assigns
+  - view_assigns
+
+  # https://edgeapi.rubyonrails.org/classes/ActionController/RequestForgeryProtection/ClassMethods.html#method-i-protect_from_forgery
+  - handle_unverified_request
+
   - has_suffix: Helper
     path: /app/helpers
 
 dynamic:
+  # https://edgeapi.rubyonrails.org/classes/AbstractController/Callbacks.html
   - names:
       - after_action
       - append_after_action
@@ -31,11 +36,49 @@ dynamic:
       - prepend_after_action
       - prepend_around_action
       - prepend_before_action
-      - skip_before_action
-      - skip_after_action
-      - skip_around_action
     calls:
-      - arguments: ['*', if, unless]
+      - arguments: '*'
+      - arguments: [if, unless]
+        nested: '*'
+
+  - names:
+    - skip_after_action
+    - skip_around_action
+    - skip_before_action
+    calls:
+      arguments: [if, unless]
+      nested: '*'
+
+  - names: protect_from_forgery
+    calls:
+      arguments: [if, unless]
+      nested: '*'
+
+
+  # https://edgeapi.rubyonrails.org/classes/ActionController/Logging/ClassMethods.html#method-i-log_at
+  - names: log_at
+    calls:
+      arguments: [if, unless]
+      nested: '*'
+
+
+  - name: helper
+    calls:
+      - arguments: '*'
+        camelize: true
+
+  # https://edgeapi.rubyonrails.org/classes/ActionController/TestCase/Behavior.html
+  - names: [delete, get, head, patch, put, post]
+    unless:
+      has_argument: 1
+    calls: 0
+
+  - names: process
+    calls: 0
+    unless:
+      has_argument: 1
+
+  # https://edgeapi.rubyonrails.org/classes/AbstractController/Helpers/ClassMethods.html
   - name: scope
     unless:
       has_argument:
@@ -46,32 +89,77 @@ dynamic:
       argument: module # routes
       camelize: true
       split: '::'
-  - name: namespace
-    calls:
-      - argument: 0
-        camelize: true
-        split: '::'
-  - name:
-      - rescue_from
-    calls:
-      - argument: [1, with]
+
   - name:
+      # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Base.html#method-i-match
       - match
+      # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/HttpHelpers.html
       - delete
       - get
+      - options
       - patch
       - post
       - put
+      # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Resources.html#method-i-namespace
       - root
     calls:
-      - arguments: [0, action]
-      - argument: '**'
+      - argument: action
+      - argument: controller
+        camelize: true
+        add_suffix: Controller
+        split: '::'
+      - argument: 'to'
+        delete_before: '#'
+      - argument: 'to'
+        delete_after: '#'
+        camelize: true
+        add_suffix: Controller
+        split: '::'
+      - argument: module
+        camelize: true
+        split: '::'
+      # these might not make sense for root
+      - argument: { type: String }
         delete_before: '#'
-      - argument: '**'
+      - argument: { type: String }
         delete_after: '#'
         camelize: true
         add_suffix: Controller
         split: '::'
+
+    # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Base.html#method-i-match
+    # defines:
+      # my logic is, `as:` generates a method you chose, everything else you might just be setting up the routes to be whatever.
+      # argument: as
+      # add_suffix: [_path, _url]
+
+    # unfortunately we can't do this as the method generated by as: depends on scope/namespace and we can't look up yet
+
+  # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Resources.html#method-i-root
+  # in addition to the above nonsense, root can also have the to: as the first positional argument
+  - name: root
+    calls:
+    - argument: 0
+      delete_before: '#'
+    - argument: 0
+      delete_after: '#'
+      camelize: true
+      add_suffix: Controller
+      split: '::'
+  # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/CustomUrls.html#method-i-direct
+  - name: direct
+    defines:
+      argument: 0
+      add_suffix: [_path, _url]
+
+  # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/CustomUrls.html#method-i-resolve
+  - name: resolve
+    calls:
+      argument: 0
+      split: '::'
+
+  # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Resources.html#method-i-resources
+  # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Resources.html#method-i-resource
   - name:
       - resource
       - resources
@@ -178,8 +266,8 @@ dynamic:
   - name:
       - resources
       - resource
+      # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Scoping.html#method-i-controller
       - controller
-      - namespace
     calls:
       - argument: 0
         camelize: true
@@ -192,12 +280,28 @@ dynamic:
         pluralize: true
         add_suffix: Controller
         split: '::'
+
+  # https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Scoping.html#method-i-namespace
+  - name: namespace
+    has_argument: module
+    calls:
+      argument: module
+      camelize: true
+      split: '::'
+  - name: namespace
+    unless:
+      has_argument: module
+    calls:
+      argument: 0
+      camelize: true
+      split: '::'
+
+  # this is not technically calling these,
+  # but it feels useful nonetheless as permit will (generally) be used to process
+  # before calling AR or AM #create or #update
   - name: permit
     calls:
       arguments: ['*', '**']
       keywords: '**'
       add_suffix: "="
       recursive: true
-  - name: layout
-    calls:
-      argument: 0

data/lib/config/actiontext.yml

@@ -0,0 +1,56 @@
+# https://edgeguides.rubyonrails.org/action_text_overview.html
+
+gems:
+  - activesupport
+  - activerecord
+  - activestorage
+  - actionpack
+
+keep:
+  # https://edgeguides.rubyonrails.org/action_text_overview.html#rendering-attachments
+  - to_attachable_partial_path
+
+dynamic:
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-rich_text_area
+  - name: rich_text_area
+    has_receiver: true
+    calls:
+      argument: 0
+      transforms:
+        - original
+        - add_suffix: '='
+
+  - name: rich_text_area
+    unless:
+      has_receiver: true
+    calls:
+      - argument: 1
+        transforms:
+         - original
+         - add_suffix: '='
+      - argument: 0
+        add_prefix: '@'
+
+  # https://edgeapi.rubyonrails.org/classes/ActionText/Attribute.html#method-i-has_rich_text
+  - name: has_rich_text
+    defines:
+      argument: 0
+      transforms:
+        # defines its own methods
+        - original
+        - add_suffix: '?'
+        - add_suffix: '='
+        # some scopes
+        - add_prefix: with_rich_text_
+        - { add_prefix: with_rich_text_, add_suffix: _and_embeds }
+        # and has_one with this prefix
+        - add_prefix: rich_text_
+          transforms:
+            # these are copied from has_one
+            - original
+            - add_suffix: '='
+            - add_prefix: build_
+            - add_prefix: create_
+            - { add_prefix: create_, add_suffix: '!' }
+            - add_prefix: reload_
+

data/lib/config/actionview.yml

@@ -1,64 +1,214 @@
-# 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
+  # https://guides.rubyonrails.org/layouts_and_rendering.html#rendering-objects
+  - render_in
 
 dynamic:
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Base.html
+  - name: render
+    has_argument: 0
+    defines:
+      keywords:
+        unless:
+          # https://guides.rubyonrails.org/layouts_and_rendering.html#options-for-render
+          - content_type
+          - layout
+          - location
+          - status
+          - formats
+          - variants
+
+  # https://edgeapi.rubyonrails.org/classes/ActionView/PartialRenderer.html
+  - name: render
+    has_argument: [object, collection]
+    unless:
+      has_argument: as
+    defines:
+      argument: partial
+      delete_before_last: '/'
+
+  - name: render
+    all:
+      - has_argument: [object, collection]
+      - has_argument: as
+    defines: as
+
+  - name: render
+    defines:
+      argument: locals
+      nested:
+        keywords: '**'
+
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Template.html#method-i-local_assigns
+  - name: '[]'
+    has_receiver: local_assigns
+    calls: 0
+
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html
   - 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
+      - check_box
+      - color_field
+      - date_field
+      - date_select
+      - datetime_field
+      - datetime_local_field
+      - datetime_select
+      - email_field
+      - file_field
+      - hidden_field
+      - month_field
+      - number_field
+      - password_field
+      - phone_field
+      - radio_button
+      - range_field
+      - search_field
+      - select
+      - telephone_field
+      - text_area
+      - text_field
+      - time_field
+      - time_select
+      - time_zone_select
+      - url_field
+      - week_field
+      - weekday_select
+    has_receiver: true
     calls:
-      - arguments: [0,1] # 0: with a receiver, 1: with no receiver
-      - arguments: [0,1]
-        add_suffix: '='
+      - argument: 0
+        transforms:
+          - original
+          - add_suffix: '='
+
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-fields_for
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-fields_for
   - name: fields_for
+    has_receiver: true
     calls:
-      argument: 1
-      add_suffix: _attributes
-  - name: options_from_collection_for_select
+      argument: 0
+      transforms:
+        add_suffix: _attributes=
+
+  - name: fields_for
+    unless:
+      any:
+        - has_receiver: true
+        - has_argument: 1
     calls:
-      - arguments: [1,2]
+      argument: 0
+      add_prefix: '@'
+
+  - name: form_for
+    has_argument:
+      at: 0
+      has_value:
+        type: [String, Symbol]
+    calls:
+      argument: 0
+      add_prefix: '@'
+
+
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html
+  - name:
+      - check_box
+      - color_field
+      - date_field
+      - date_select
+      - datetime_field
+      - datetime_local_field
+      - datetime_select
+      - email_field
+      - file_field
+      - hidden_field
+      - month_field
+      - number_field
+      - password_field
+      - phone_field
+      - radio_button
+      - range_field
+      - search_field
+      - select
+      - telephone_field
+      - text_area
+      - text_field
+      - time_field
+      - time_select
+      - time_zone_select
+      - url_field
+      - week_field
+      - weekday_select
+    unless:
+      has_receiver: true
+    calls:
+      - argument: 1
+        transforms:
+         - original
+         - add_suffix: '='
+      - argument: 0
+        add_prefix: '@'
+
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-collection_check_boxes
   - name:
       - collection_select
       - collection_check_boxes
       - collection_radio_buttons
+    has_receiver: true
+    calls:
+      - argument: 0
+        transforms:
+          - original
+          - add_suffix: '='
+      - arguments: [2,3]
+
+  - name:
+      - collection_select
+      - collection_check_boxes
+      - collection_radio_buttons
+    unless:
+      has_receiver: true
     calls:
       - argument: 1
-        add_suffix: '='
+        transforms:
+          - original
+          - add_suffix: '='
       - arguments: [3,4]
+      - argument: 0
+        add_prefix: '@'
+
+  - name: grouped_collection_select
+    has_receiver: true
+    calls:
+      - argument: 0
+        transforms:
+          - original
+          - add_suffix: '='
+      - arguments: [2,3,4,5]
+
   - name: grouped_collection_select
+    unless:
+      has_receiver: true
     calls:
       - argument: 1
-        add_suffix: '='
+        transforms:
+          - original
+          - add_suffix: '='
       - arguments: [3,4,5,6]
+      - argument: 0
+        add_prefix: '@'
+
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-option_groups_from_collection_for_select
   - name: option_groups_from_collection_for_select
-    calls:
-      - arguments: [0,1,2,3]
+    calls: [1,2,3,4]
+
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-options_from_collection_for_select
+  - name: options_from_collection_for_select
+    calls: [1,2]
+
+
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Layouts.html
+  # https://edgeapi.rubyonrails.org/classes/ActionView/Layouts/ClassMethods.html#method-i-layout
+  - name: layout
+    has_argument:
+      at: 0
+      has_value:
+        type: Symbol
+    calls: 0

data/lib/config/activejob.yml

@@ -1,17 +1,20 @@
-# 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.
+gem:
+  - activesupport
+
 keep:
+  # https://guides.rubyonrails.org/active_job_basics.html#serializers
   - serialize?
   - serialize
   - deserialize
 dynamic:
+  # https://guides.rubyonrails.org/active_job_basics.html#enqueue-the-job
   - name:
       - perform_later
-      - perform
+      - perform_now
     calls:
       - value: perform
+  # https://api.rubyonrails.org/v7.0.2.2/classes/ActiveJob/Callbacks/ClassMethods.html
+  # These all use if/unless because they call set_callback, though this isn't documented
   - names:
       - before_enqueue
       - around_enqueue
@@ -20,10 +23,13 @@ dynamic:
       - around_perform
       - after_perform
     calls:
-      - arguments: 1
+      - arguments: '*'
       - arguments: [if, unless]
-        nested:
-          arguments: '*'
-  - name: rescue_from
+        nested: '*'
+
+  # https://api.rubyonrails.org/v7.0.2.2/classes/ActiveJob/Exceptions/ClassMethods.html#method-i-discard_on
+  # https://api.rubyonrails.org/v7.0.2.2/classes/ActiveJob/Exceptions/ClassMethods.html#method-i-retry_on
+  - names: [discard_on, retry_on]
     calls:
-      - arguments: 1
+    - argument: '*'
+      split: '::'