rails-ai-context 5.30.2 → 5.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +868 -0
- data/CONTEXT.md +7 -3
- data/README.md +1 -1
- data/docs/ARCHITECTURE.md +3 -3
- data/docs/CLI.md +1 -1
- data/docs/COMPATIBILITY.md +50 -14
- data/docs/CONFIGURATION.md +4 -1
- data/docs/FAQ.md +1 -1
- data/docs/GUIDE.md +14 -8
- data/docs/INTROSPECTORS.md +50 -23
- data/docs/SECURITY.md +56 -1
- data/docs/TOOLS.md +58 -12
- data/lib/generators/rails_ai_context/install/install_generator.rb +1 -0
- data/lib/rails_ai_context/action_filters.rb +121 -48
- data/lib/rails_ai_context/app_commands.rb +2 -2
- data/lib/rails_ai_context/app_kind.rb +65 -8
- data/lib/rails_ai_context/ast_cache.rb +53 -18
- data/lib/rails_ai_context/base_mixins.rb +46 -16
- data/lib/rails_ai_context/boot_manager.rb +5 -1
- data/lib/rails_ai_context/cli/entry_boot.rb +17 -2
- data/lib/rails_ai_context/cli/tool_runner.rb +15 -1
- data/lib/rails_ai_context/concern_macros.rb +791 -111
- data/lib/rails_ai_context/concern_membership.rb +25 -5
- data/lib/rails_ai_context/concern_paths.rb +63 -17
- data/lib/rails_ai_context/config_yaml.rb +40 -0
- data/lib/rails_ai_context/configuration.rb +3 -3
- data/lib/rails_ai_context/data/docs/index.json +324 -0
- data/lib/rails_ai_context/database_yml.rb +136 -0
- data/lib/rails_ai_context/doctor.rb +30 -37
- data/lib/rails_ai_context/erb_source.rb +40 -0
- data/lib/rails_ai_context/fingerprinter.rb +48 -22
- data/lib/rails_ai_context/fixture_keys.rb +42 -1
- data/lib/rails_ai_context/gem_lock.rb +275 -47
- data/lib/rails_ai_context/git_ignore.rb +13 -11
- data/lib/rails_ai_context/hydrators/hydration_formatter.rb +8 -2
- data/lib/rails_ai_context/hydrators/schema_hint_builder.rb +10 -5
- data/lib/rails_ai_context/introspector.rb +10 -1
- data/lib/rails_ai_context/introspectors/action_mailbox_introspector.rb +27 -19
- data/lib/rails_ai_context/introspectors/action_presence.rb +11 -8
- data/lib/rails_ai_context/introspectors/action_resolver.rb +38 -26
- data/lib/rails_ai_context/introspectors/action_text_introspector.rb +2 -2
- data/lib/rails_ai_context/introspectors/active_record_settings.rb +56 -0
- data/lib/rails_ai_context/introspectors/active_storage_introspector.rb +1 -1
- data/lib/rails_ai_context/introspectors/active_support_introspector.rb +98 -22
- data/lib/rails_ai_context/introspectors/admin_resources.rb +101 -0
- data/lib/rails_ai_context/introspectors/anyway_configs.rb +64 -0
- data/lib/rails_ai_context/introspectors/apartment_config.rb +47 -0
- data/lib/rails_ai_context/introspectors/api_introspector.rb +125 -26
- data/lib/rails_ai_context/introspectors/asset_pipeline_introspector.rb +24 -19
- data/lib/rails_ai_context/introspectors/ast_walk.rb +18 -0
- data/lib/rails_ai_context/introspectors/auth_introspector.rb +71 -18
- data/lib/rails_ai_context/introspectors/autoload_introspector.rb +62 -15
- data/lib/rails_ai_context/introspectors/base.rb +38 -0
- data/lib/rails_ai_context/introspectors/call_site_expansion.rb +349 -39
- data/lib/rails_ai_context/introspectors/component_introspector.rb +26 -14
- data/lib/rails_ai_context/introspectors/config_introspector.rb +22 -9
- data/lib/rails_ai_context/introspectors/connection_pool_introspector.rb +1 -4
- data/lib/rails_ai_context/introspectors/controller_filters.rb +335 -31
- data/lib/rails_ai_context/introspectors/controller_introspector.rb +315 -129
- data/lib/rails_ai_context/introspectors/controller_settings.rb +182 -0
- data/lib/rails_ai_context/introspectors/convention_introspector.rb +18 -15
- data/lib/rails_ai_context/introspectors/database_stats_introspector.rb +1 -1
- data/lib/rails_ai_context/introspectors/declared_constant.rb +108 -23
- data/lib/rails_ai_context/introspectors/eager_load.rb +12 -7
- data/lib/rails_ai_context/introspectors/engine_introspector.rb +13 -5
- data/lib/rails_ai_context/introspectors/env_config_introspector.rb +62 -17
- data/lib/rails_ai_context/introspectors/env_introspector.rb +8 -6
- data/lib/rails_ai_context/introspectors/env_references.rb +21 -4
- data/lib/rails_ai_context/introspectors/frontend_framework_introspector.rb +37 -22
- data/lib/rails_ai_context/introspectors/gem_introspector.rb +3 -1
- data/lib/rails_ai_context/introspectors/gemfile_gems.rb +53 -5
- data/lib/rails_ai_context/introspectors/grape_endpoints.rb +109 -0
- data/lib/rails_ai_context/introspectors/helper_names.rb +12 -1
- data/lib/rails_ai_context/introspectors/i18n_introspector.rb +101 -46
- data/lib/rails_ai_context/introspectors/includers.rb +6 -1
- data/lib/rails_ai_context/introspectors/initializer_introspector.rb +2 -5
- data/lib/rails_ai_context/introspectors/job_introspector.rb +548 -103
- data/lib/rails_ai_context/introspectors/listener_registration.rb +11 -1
- data/lib/rails_ai_context/introspectors/listeners/associations_listener.rb +51 -4
- data/lib/rails_ai_context/introspectors/listeners/autoload_ignore_listener.rb +31 -0
- data/lib/rails_ai_context/introspectors/listeners/autoload_paths_listener.rb +4 -47
- data/lib/rails_ai_context/introspectors/listeners/base_listener.rb +80 -14
- data/lib/rails_ai_context/introspectors/listeners/branch_conditions.rb +156 -0
- data/lib/rails_ai_context/introspectors/listeners/callbacks_listener.rb +85 -23
- data/lib/rails_ai_context/introspectors/listeners/class_definition_listener.rb +35 -6
- data/lib/rails_ai_context/introspectors/listeners/component_structure_listener.rb +30 -2
- data/lib/rails_ai_context/introspectors/listeners/conditional_macro_listener.rb +19 -0
- data/lib/rails_ai_context/introspectors/listeners/config_assignment_listener.rb +255 -10
- data/lib/rails_ai_context/introspectors/listeners/constant_reference_listener.rb +34 -0
- data/lib/rails_ai_context/introspectors/listeners/constructor_macro_listener.rb +123 -0
- data/lib/rails_ai_context/introspectors/listeners/definition_file_paths_listener.rb +66 -0
- data/lib/rails_ai_context/introspectors/listeners/enums_listener.rb +2 -2
- data/lib/rails_ai_context/introspectors/listeners/env_access_listener.rb +31 -0
- data/lib/rails_ai_context/introspectors/listeners/filter_macro_listener.rb +54 -0
- data/lib/rails_ai_context/introspectors/listeners/fixture_paths_listener.rb +62 -0
- data/lib/rails_ai_context/introspectors/listeners/gemfile_dsl_listener.rb +42 -1
- data/lib/rails_ai_context/introspectors/listeners/generic_macro_listener.rb +28 -2
- data/lib/rails_ai_context/introspectors/listeners/grape_api_listener.rb +137 -0
- data/lib/rails_ai_context/introspectors/listeners/http_client_call_listener.rb +50 -0
- data/lib/rails_ai_context/introspectors/listeners/i18n_load_path_listener.rb +54 -0
- data/lib/rails_ai_context/introspectors/listeners/literal_paths.rb +123 -0
- data/lib/rails_ai_context/introspectors/listeners/macros_listener.rb +248 -4
- data/lib/rails_ai_context/introspectors/listeners/mailbox_routing_listener.rb +2 -1
- data/lib/rails_ai_context/introspectors/listeners/method_call_listener.rb +7 -1
- data/lib/rails_ai_context/introspectors/listeners/methods_listener.rb +352 -69
- data/lib/rails_ai_context/introspectors/listeners/migration_dsl_listener.rb +1 -1
- data/lib/rails_ai_context/introspectors/listeners/migration_replay_listener.rb +35 -26
- data/lib/rails_ai_context/introspectors/listeners/mixins_listener.rb +62 -29
- data/lib/rails_ai_context/introspectors/listeners/mount_listener.rb +8 -0
- data/lib/rails_ai_context/introspectors/listeners/namespaced_roots_listener.rb +35 -0
- data/lib/rails_ai_context/introspectors/listeners/nested_constants_listener.rb +32 -0
- data/lib/rails_ai_context/introspectors/listeners/owner_scope.rb +67 -0
- data/lib/rails_ai_context/introspectors/listeners/preview_paths_listener.rb +16 -7
- data/lib/rails_ai_context/introspectors/listeners/proc_literal_listener.rb +42 -0
- data/lib/rails_ai_context/introspectors/listeners/queue_assignment_listener.rb +54 -0
- data/lib/rails_ai_context/introspectors/listeners/rake_task_dsl_listener.rb +21 -8
- data/lib/rails_ai_context/introspectors/listeners/route_files_listener.rb +4 -11
- data/lib/rails_ai_context/introspectors/listeners/routes_dsl_listener.rb +461 -65
- data/lib/rails_ai_context/introspectors/listeners/schema_dsl_listener.rb +76 -14
- data/lib/rails_ai_context/introspectors/listeners/scopes_listener.rb +40 -1
- data/lib/rails_ai_context/introspectors/listeners/validations_listener.rb +10 -1
- data/lib/rails_ai_context/introspectors/listeners/view_paths_listener.rb +37 -0
- data/lib/rails_ai_context/introspectors/middleware_introspector.rb +47 -3
- data/lib/rails_ai_context/introspectors/migration_introspector.rb +3 -3
- data/lib/rails_ai_context/introspectors/migration_replay/helpers.rb +4 -3
- data/lib/rails_ai_context/introspectors/migration_replay/statements.rb +72 -12
- data/lib/rails_ai_context/introspectors/migration_replay.rb +110 -14
- data/lib/rails_ai_context/introspectors/model_introspector.rb +708 -214
- data/lib/rails_ai_context/introspectors/module_aliases.rb +11 -3
- data/lib/rails_ai_context/introspectors/multi_database_introspector.rb +9 -57
- data/lib/rails_ai_context/introspectors/observability_introspector.rb +5 -8
- data/lib/rails_ai_context/introspectors/performance_introspector.rb +28 -8
- data/lib/rails_ai_context/introspectors/rake_task_introspector.rb +118 -51
- data/lib/rails_ai_context/introspectors/recurring_schedules.rb +150 -0
- data/lib/rails_ai_context/introspectors/rendered_record.rb +87 -0
- data/lib/rails_ai_context/introspectors/retry_policy.rb +8 -5
- data/lib/rails_ai_context/introspectors/route_introspector.rb +153 -42
- data/lib/rails_ai_context/introspectors/schema_conventions.rb +127 -40
- data/lib/rails_ai_context/introspectors/schema_dump_path.rb +80 -0
- data/lib/rails_ai_context/introspectors/schema_introspector.rb +346 -112
- data/lib/rails_ai_context/introspectors/schema_reader.rb +69 -29
- data/lib/rails_ai_context/introspectors/service_classes.rb +21 -15
- data/lib/rails_ai_context/introspectors/source_calls.rb +1 -1
- data/lib/rails_ai_context/introspectors/source_introspector.rb +17 -2
- data/lib/rails_ai_context/introspectors/source_scan.rb +174 -26
- data/lib/rails_ai_context/introspectors/sqlite_virtual_tables.rb +28 -0
- data/lib/rails_ai_context/introspectors/stimulus_introspector.rb +16 -5
- data/lib/rails_ai_context/introspectors/structure_sql_reader.rb +372 -98
- data/lib/rails_ai_context/introspectors/superclass_chain.rb +14 -15
- data/lib/rails_ai_context/introspectors/table_name.rb +46 -45
- data/lib/rails_ai_context/introspectors/test_introspector.rb +289 -78
- data/lib/rails_ai_context/introspectors/turbo_introspector.rb +10 -5
- data/lib/rails_ai_context/introspectors/view_introspector.rb +5 -40
- data/lib/rails_ai_context/introspectors/view_template_introspector.rb +12 -10
- data/lib/rails_ai_context/method_name.rb +31 -0
- data/lib/rails_ai_context/migration_status.rb +5 -5
- data/lib/rails_ai_context/output_guard.rb +6 -4
- data/lib/rails_ai_context/package_json.rb +96 -5
- data/lib/rails_ai_context/path_resolver.rb +170 -15
- data/lib/rails_ai_context/payload.rb +48 -0
- data/lib/rails_ai_context/pending_migrations.rb +15 -18
- data/lib/rails_ai_context/portable_path.rb +76 -4
- data/lib/rails_ai_context/redaction.rb +8 -2
- data/lib/rails_ai_context/route_coverage.rb +5 -1
- data/lib/rails_ai_context/safe_file.rb +4 -1
- data/lib/rails_ai_context/safe_path.rb +61 -10
- data/lib/rails_ai_context/schema_hint.rb +8 -2
- data/lib/rails_ai_context/schema_version.rb +7 -9
- data/lib/rails_ai_context/serializers/claude_rules_serializer.rb +1 -1
- data/lib/rails_ai_context/serializers/markdown_serializer.rb +13 -4
- data/lib/rails_ai_context/serializers/section_facts.rb +5 -1
- data/lib/rails_ai_context/serializers/stack_overview_helper.rb +2 -2
- data/lib/rails_ai_context/serializers/tool_guide_helper.rb +7 -4
- data/lib/rails_ai_context/server.rb +26 -7
- data/lib/rails_ai_context/test_framework.rb +32 -5
- data/lib/rails_ai_context/tools/analyze_feature.rb +22 -10
- data/lib/rails_ai_context/tools/base_tool.rb +69 -30
- data/lib/rails_ai_context/tools/diagnose.rb +1 -1
- data/lib/rails_ai_context/tools/generate_test.rb +8 -9
- data/lib/rails_ai_context/tools/get_active_support.rb +19 -4
- data/lib/rails_ai_context/tools/get_api.rb +17 -11
- data/lib/rails_ai_context/tools/get_autoload.rb +10 -5
- data/lib/rails_ai_context/tools/get_callbacks.rb +65 -14
- data/lib/rails_ai_context/tools/get_component_catalog.rb +7 -4
- data/lib/rails_ai_context/tools/get_concern.rb +31 -18
- data/lib/rails_ai_context/tools/get_config.rb +52 -18
- data/lib/rails_ai_context/tools/get_controllers.rb +57 -13
- data/lib/rails_ai_context/tools/get_conventions.rb +44 -22
- data/lib/rails_ai_context/tools/get_engines.rb +2 -0
- data/lib/rails_ai_context/tools/get_env.rb +209 -52
- data/lib/rails_ai_context/tools/get_env_config.rb +38 -7
- data/lib/rails_ai_context/tools/get_frontend_stack.rb +56 -7
- data/lib/rails_ai_context/tools/get_helper_methods.rb +136 -26
- data/lib/rails_ai_context/tools/get_job_pattern.rb +143 -87
- data/lib/rails_ai_context/tools/get_mailers.rb +59 -2
- data/lib/rails_ai_context/tools/get_model_details.rb +178 -28
- data/lib/rails_ai_context/tools/get_partial_interface.rb +101 -62
- data/lib/rails_ai_context/tools/get_routes.rb +35 -9
- data/lib/rails_ai_context/tools/get_schema.rb +160 -61
- data/lib/rails_ai_context/tools/get_service_pattern.rb +121 -25
- data/lib/rails_ai_context/tools/get_stimulus.rb +1 -1
- data/lib/rails_ai_context/tools/get_test_info.rb +152 -82
- data/lib/rails_ai_context/tools/get_view.rb +37 -20
- data/lib/rails_ai_context/tools/migration_advisor.rb +64 -24
- data/lib/rails_ai_context/tools/onboard.rb +174 -88
- data/lib/rails_ai_context/tools/performance_check.rb +5 -13
- data/lib/rails_ai_context/tools/query.rb +122 -28
- data/lib/rails_ai_context/tools/read_logs.rb +45 -17
- data/lib/rails_ai_context/tools/runtime_info.rb +1 -1
- data/lib/rails_ai_context/tools/safe_call.rb +20 -15
- data/lib/rails_ai_context/tools/search_code.rb +114 -40
- data/lib/rails_ai_context/tools/search_docs.rb +22 -11
- data/lib/rails_ai_context/tools/security_scan.rb +51 -4
- data/lib/rails_ai_context/tools/validate.rb +21 -4
- data/lib/rails_ai_context/tools/validate_semantics.rb +18 -6
- data/lib/rails_ai_context/version.rb +1 -1
- data/lib/rails_ai_context/vfs.rb +2 -2
- data/lib/rails_ai_context/view_file.rb +53 -3
- data/lib/rails_ai_context.rb +10 -2
- data/server.json +1 -1
- metadata +34 -3
|
@@ -44,22 +44,23 @@ module RailsAiContext
|
|
|
44
44
|
# gives us the v5.8.0 fields (identified_by, streams, periodic, actions)
|
|
45
45
|
# that JobIntrospector#extract_channels populates.
|
|
46
46
|
jobs_data = cached_context[:jobs]
|
|
47
|
-
|
|
48
|
-
channels = channels.reject { |c| c.is_a?(Hash) && c[:error] }
|
|
47
|
+
data = jobs_data.is_a?(Hash) ? jobs_data : {}
|
|
48
|
+
channels = Array(data[:channels]).reject { |c| c.is_a?(Hash) && c[:error] }
|
|
49
49
|
channels_note = unavailable_note(jobs_data)
|
|
50
50
|
|
|
51
|
-
|
|
52
|
-
|
|
51
|
+
queue_line = [ sidekiq_queues_line(data), solid_queue_line(data, jobs) ].compact.join(" ").presence
|
|
52
|
+
return format_single_job(job, jobs, real_root, queue_line, data) if job
|
|
53
53
|
|
|
54
|
-
|
|
55
|
-
return format_single_job(job, jobs, real_root, sidekiq_line, workers, job_bases(jobs_data), enqueue_helpers)
|
|
56
|
-
end
|
|
54
|
+
workers = Array(data[:workers])
|
|
57
55
|
|
|
58
56
|
# No jobs and no channels - bail out. Channel absence is only a real
|
|
59
57
|
# negative when the :jobs section actually ran - if it's unavailable
|
|
60
58
|
# (static tier), say so instead of claiming "no channels detected".
|
|
61
|
-
|
|
62
|
-
|
|
59
|
+
async_methods = Array(data[:async_methods])
|
|
60
|
+
recurring = detail == "full" ? recurring_lines(schedules(data)) : []
|
|
61
|
+
if jobs.empty? && channels.empty? && workers.empty? && async_methods.empty?
|
|
62
|
+
message = with_bases_note(no_jobs_or_channels_message(channels_note, queue_line), data)
|
|
63
|
+
return text_response([ message, *("\n#{recurring.join("\n")}" if recurring.any?) ].join("\n"))
|
|
63
64
|
end
|
|
64
65
|
|
|
65
66
|
# Compose: jobs section (if any) + workers + channels section (if any).
|
|
@@ -69,18 +70,29 @@ module RailsAiContext
|
|
|
69
70
|
lines << "" if lines.any?
|
|
70
71
|
lines.concat(format_workers_section(workers, detail))
|
|
71
72
|
end
|
|
73
|
+
if async_methods.any?
|
|
74
|
+
lines << "" if lines.any?
|
|
75
|
+
lines << "## Background methods (delayed_job `handle_asynchronously`, #{async_methods.size})" << ""
|
|
76
|
+
async_methods.each do |m|
|
|
77
|
+
lines << "- `#{m[:owner]}##{m[:method]}`#{" [#{m[:options]}]" if m[:options]} (`#{m[:file]}`)"
|
|
78
|
+
end
|
|
79
|
+
end
|
|
72
80
|
if channels.any?
|
|
73
81
|
lines << "" if lines.any?
|
|
74
|
-
lines.concat(format_channels_section(channels))
|
|
82
|
+
lines.concat(format_channels_section(channels, data[:connections]))
|
|
83
|
+
end
|
|
84
|
+
if recurring.any?
|
|
85
|
+
lines << "" if lines.any?
|
|
86
|
+
lines.concat(recurring)
|
|
75
87
|
end
|
|
76
|
-
bases = bases_note("jobs", job_bases(
|
|
88
|
+
bases = bases_note("jobs", job_bases(data).map { |base| base[:name] })
|
|
77
89
|
if bases
|
|
78
90
|
lines << "" if lines.any?
|
|
79
91
|
lines << bases
|
|
80
92
|
end
|
|
81
93
|
# Counts are bounded by the directories scanned, so the caveat goes under any listing.
|
|
82
94
|
lines << "" if lines.any?
|
|
83
|
-
lines << "_#{[
|
|
95
|
+
lines << "_#{[ queue_line, NOT_COVERED ].compact.join(" ")}_"
|
|
84
96
|
|
|
85
97
|
text_response(lines.join("\n"))
|
|
86
98
|
end
|
|
@@ -96,7 +108,7 @@ module RailsAiContext
|
|
|
96
108
|
size = detailed && worker[:line_count] ? " (#{count_phrase(worker[:line_count], "line")})" : ""
|
|
97
109
|
retries = detailed ? own_retries(worker) : []
|
|
98
110
|
calls = detailed ? Array(worker[:calls]) : []
|
|
99
|
-
retry_label = retries.any? ? " - #{retries.
|
|
111
|
+
retry_label = retries.any? ? " - #{retries.uniq.join(", ")}" : ""
|
|
100
112
|
calls_label = calls.any? ? " → #{calls.join(', ')}" : ""
|
|
101
113
|
lines << "- **#{worker[:name]}**#{label}#{size}#{retry_label}#{calls_label}"
|
|
102
114
|
next unless detailed
|
|
@@ -135,22 +147,26 @@ module RailsAiContext
|
|
|
135
147
|
parts.any? ? " [#{parts.join('; ')}]" : ""
|
|
136
148
|
end
|
|
137
149
|
|
|
138
|
-
# `retry:` shows in the worker's bracket, so this line carries only its own retry_on
|
|
150
|
+
# `retry:` shows in the worker's bracket, so this line carries only its own retry_on;
|
|
151
|
+
# a retry block is named by its macro, its body stays on the worker's page.
|
|
139
152
|
private_class_method def self.own_retries(worker)
|
|
140
|
-
Array(worker[:retries]).reject { |entry| entry.start_with?("sidekiq retry:") }
|
|
153
|
+
Array(worker[:retries]).reject { |entry| entry.start_with?("sidekiq retry:") }.map do |entry|
|
|
154
|
+
macro = RailsAiContext::Introspectors::RetryPolicy::BLOCK_MACROS.find { |name| entry.start_with?("#{name} ") || entry == name.to_s }
|
|
155
|
+
macro ? "#{macro} (block)" : entry
|
|
156
|
+
end
|
|
141
157
|
end
|
|
142
158
|
|
|
143
159
|
# An empty answer still names the bases it left out, as every listing
|
|
144
160
|
# does, so the name it offers can be asked for.
|
|
145
|
-
private_class_method def self.with_bases_note(message,
|
|
146
|
-
[ message, bases_note("jobs", job_bases(
|
|
161
|
+
private_class_method def self.with_bases_note(message, data)
|
|
162
|
+
[ message, bases_note("jobs", job_bases(data).map { |base| base[:name] }) ].compact.join("\n\n")
|
|
147
163
|
end
|
|
148
164
|
|
|
149
165
|
HEIRS_SHOWN = 12
|
|
150
166
|
ENQUEUERS_SHOWN = 20
|
|
151
167
|
|
|
152
|
-
private_class_method def self.no_job_files_message(
|
|
153
|
-
[ "No jobs found. #{NOT_COVERED}",
|
|
168
|
+
private_class_method def self.no_job_files_message(queue_line = nil)
|
|
169
|
+
[ "No jobs found. #{NOT_COVERED}", queue_line ].compact.join(" ")
|
|
154
170
|
end
|
|
155
171
|
|
|
156
172
|
# The "nothing async at all" bail-out, phrased to keep reading naturally
|
|
@@ -159,16 +175,16 @@ module RailsAiContext
|
|
|
159
175
|
# tier) - in that case, asserting "no Action Cable channels detected"
|
|
160
176
|
# would be a fabricated negative rather than an observed one, so the
|
|
161
177
|
# note replaces that claim instead of joining it.
|
|
162
|
-
private_class_method def self.no_jobs_or_channels_message(channels_note,
|
|
178
|
+
private_class_method def self.no_jobs_or_channels_message(channels_note, queue_line = nil)
|
|
163
179
|
channels_clause = channels_note || "no Action Cable channels detected"
|
|
164
|
-
[ "No jobs found, and #{channels_clause}. #{NOT_COVERED}",
|
|
180
|
+
[ "No jobs found, and #{channels_clause}. #{NOT_COVERED}", queue_line ].compact.join(" ")
|
|
165
181
|
end
|
|
166
182
|
|
|
167
183
|
# JobIntrospector#extract_sidekiq_config already read this file, and on an
|
|
168
184
|
# app that runs everything through Sidekiq workers it is the only evidence
|
|
169
185
|
# in reach that async work happens at all.
|
|
170
|
-
private_class_method def self.sidekiq_queues_line(
|
|
171
|
-
config =
|
|
186
|
+
private_class_method def self.sidekiq_queues_line(data)
|
|
187
|
+
config = data[:sidekiq_config]
|
|
172
188
|
return nil unless config.is_a?(Hash)
|
|
173
189
|
|
|
174
190
|
queues = Array(config[:queues])
|
|
@@ -179,13 +195,45 @@ module RailsAiContext
|
|
|
179
195
|
"#{line}."
|
|
180
196
|
end
|
|
181
197
|
|
|
198
|
+
private_class_method def self.solid_queue_line(data, jobs)
|
|
199
|
+
config = data[:solid_queue_config]
|
|
200
|
+
return nil unless config.is_a?(Hash)
|
|
201
|
+
|
|
202
|
+
return "#{config[:file]} sets worker queues with ERB, so which queues they poll is not known from source." if config[:queues_computed]
|
|
203
|
+
|
|
204
|
+
queues = Array(config[:queues])
|
|
205
|
+
line = "#{config[:file]} workers poll #{count_phrase(queues.size, "queue")}: #{queues.join(', ')}."
|
|
206
|
+
missed = unpolled_queues(data, jobs).group_by { |job| job[:queue] }
|
|
207
|
+
return line if missed.empty?
|
|
208
|
+
|
|
209
|
+
"#{line} No worker polls #{missed.map { |queue, held| "#{queue} (#{held.filter_map { |j| j[:name] }.join(', ')})" }.join(', ')}."
|
|
210
|
+
end
|
|
211
|
+
|
|
212
|
+
# An Active Job's plain queue name no worker pattern matches: "*" polls all, "name*" a prefix; Solid Queue runs no other kind.
|
|
213
|
+
private_class_method def self.unpolled_queues(data, jobs)
|
|
214
|
+
config = data[:solid_queue_config]
|
|
215
|
+
return [] if !config.is_a?(Hash) || config[:queues_computed]
|
|
216
|
+
|
|
217
|
+
patterns = Array(config[:queues])
|
|
218
|
+
jobs.select { |job| job[:active_job] }.select do |job|
|
|
219
|
+
queue = job[:queue].to_s
|
|
220
|
+
queue.match?(/\A[\w.:-]+\z/) && patterns.none? { |pattern| pattern.end_with?("*") ? queue.start_with?(pattern.delete_suffix("*")) : pattern == queue }
|
|
221
|
+
end
|
|
222
|
+
end
|
|
223
|
+
|
|
182
224
|
# The name never rebuilds the path: the file is the one the introspector
|
|
183
225
|
# recorded, which is the only place a pack job's path is written down.
|
|
184
|
-
private_class_method def self.job_bases(
|
|
185
|
-
(
|
|
226
|
+
private_class_method def self.job_bases(data)
|
|
227
|
+
Array(data[:job_bases]).select { |b| b.is_a?(Hash) }
|
|
186
228
|
end
|
|
187
229
|
|
|
188
|
-
private_class_method def self.
|
|
230
|
+
private_class_method def self.schedules(data)
|
|
231
|
+
Array(data[:recurring_jobs]).select { |task| task.is_a?(Hash) }
|
|
232
|
+
end
|
|
233
|
+
|
|
234
|
+
private_class_method def self.format_single_job(job, jobs, root, queue_line, data)
|
|
235
|
+
workers = Array(data[:workers])
|
|
236
|
+
bases = job_bases(data)
|
|
189
237
|
names = jobs.map { |j| j[:name] }
|
|
190
238
|
worker_names = workers.map { |w| w[:name] }.compact
|
|
191
239
|
# A base answers by name because every listing, the empty one too,
|
|
@@ -194,7 +242,7 @@ module RailsAiContext
|
|
|
194
242
|
# "SendWelcomeEmailJob", "send_welcome_email_job" and "send_welcome_email" all name one job.
|
|
195
243
|
query = job.to_s.delete_suffix(".rb")
|
|
196
244
|
if names.empty? && worker_names.empty? && !fuzzy_find_key(base_names, query)
|
|
197
|
-
return text_response(no_job_files_message(
|
|
245
|
+
return text_response(no_job_files_message(queue_line))
|
|
198
246
|
end
|
|
199
247
|
class_name = fuzzy_find_key(names, query) ||
|
|
200
248
|
fuzzy_find_key(names, "#{query.underscore.delete_suffix("_job")}_job")
|
|
@@ -251,9 +299,15 @@ module RailsAiContext
|
|
|
251
299
|
end
|
|
252
300
|
|
|
253
301
|
# A worker or base declares its queue in `sidekiq_options`, which the introspector read.
|
|
254
|
-
queue
|
|
255
|
-
|
|
302
|
+
# The record's queue carries the app's prefix and delimiter, which the source line does not.
|
|
303
|
+
queue = (record && (record[:queue] || (record[:options] || {})["queue"])) || extract_queue(source)
|
|
304
|
+
unpolled = queue && !worker && unpolled_queues(data, [ (record || {}).merge(queue: queue.to_s) ]).any?
|
|
305
|
+
lines << "**Queue:** #{queue_text(queue)}#{" (no worker in #{Introspectors::JobIntrospector::SOLID_QUEUE_FILE} polls it)" if unpolled}" if queue
|
|
256
306
|
lines << "**Throttle:** #{worker[:throttle]}" if worker && worker[:throttle]
|
|
307
|
+
lines << "**Priority:** #{record[:priority]}" if record && !record[:priority].nil?
|
|
308
|
+
lines << "**Enqueue after transaction commit:** #{record[:enqueue_after_transaction_commit]}" if record&.key?(:enqueue_after_transaction_commit)
|
|
309
|
+
lines << "**Concurrency:** `#{record[:concurrency]}`" if record && record[:concurrency]
|
|
310
|
+
lines << "**Continuable:** yes (ActiveJob::Continuable): a retry resumes at the first unfinished step" if record && record[:continuable]
|
|
257
311
|
if base && (declares = Array(base[:declares])).any?
|
|
258
312
|
lines << "" << "## Declares (every job below inherits these)"
|
|
259
313
|
declares.each { |line| lines << "- `#{line}`" }
|
|
@@ -265,12 +319,28 @@ module RailsAiContext
|
|
|
265
319
|
retry_config.each { |r| lines << "- #{r}" }
|
|
266
320
|
end
|
|
267
321
|
|
|
322
|
+
steps = Array(record && record[:steps])
|
|
323
|
+
if steps.any?
|
|
324
|
+
lines << "" << "## Steps"
|
|
325
|
+
steps.each_with_index do |step, index|
|
|
326
|
+
lines << "#{index + 1}. `#{step[:name]}` (#{[ step[:runs], step[:options] ].compact.join(', ')})"
|
|
327
|
+
end
|
|
328
|
+
lines << ""
|
|
329
|
+
end
|
|
330
|
+
|
|
331
|
+
callbacks = Array(record && record[:callbacks])
|
|
332
|
+
if callbacks.any?
|
|
333
|
+
lines << "" << "## Callbacks"
|
|
334
|
+
callbacks.each { |c| lines << "- `#{c}`" }
|
|
335
|
+
end
|
|
336
|
+
lines << "" if lines.last.to_s.start_with?("- ")
|
|
337
|
+
|
|
268
338
|
# Perform method signature
|
|
269
|
-
perform_sig = extract_perform_signature(source)
|
|
339
|
+
perform_sig = extract_perform_signature(source, record)
|
|
270
340
|
lines << "**Perform:** `#{perform_sig}`" if perform_sig
|
|
271
341
|
|
|
272
342
|
# Guard clauses
|
|
273
|
-
guards = extract_guard_clauses(source)
|
|
343
|
+
guards = extract_guard_clauses(source, record)
|
|
274
344
|
if guards.any?
|
|
275
345
|
lines << "" << "## Guard Clauses"
|
|
276
346
|
guards.each { |g| lines << "- `#{g}`" }
|
|
@@ -290,9 +360,8 @@ module RailsAiContext
|
|
|
290
360
|
broadcasts.each { |b| lines << "- `#{b}`" }
|
|
291
361
|
end
|
|
292
362
|
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
lines << "**Schedule:** #{schedule}" if schedule
|
|
363
|
+
scheduled = schedules(data).select { |task| task[:class] == class_name }
|
|
364
|
+
lines << "**Schedule:** #{scheduled.map { |task| schedule_text(task) }.join('; ')}" if scheduled.any?
|
|
296
365
|
|
|
297
366
|
# Side effects
|
|
298
367
|
side_effects = extract_side_effects(source)
|
|
@@ -304,7 +373,7 @@ module RailsAiContext
|
|
|
304
373
|
# Cross-reference: who enqueues this job
|
|
305
374
|
# The section always prints: missing, it would read as "nothing enqueues it".
|
|
306
375
|
known = (names + worker_names + base_names).uniq
|
|
307
|
-
enqueuers = find_enqueuers(class_name, root, relative,
|
|
376
|
+
enqueuers = find_enqueuers(class_name, root, relative, enqueue_helpers, known)
|
|
308
377
|
lines << "" << "## Enqueued By"
|
|
309
378
|
if enqueuers.any?
|
|
310
379
|
enqueuers.first(ENQUEUERS_SHOWN).each { |e| lines << "- `#{e}`" }
|
|
@@ -336,7 +405,8 @@ module RailsAiContext
|
|
|
336
405
|
# No ActiveJob or Sidekiq ancestry found, and the bracket says so.
|
|
337
406
|
unknown_base: job[:unknown_base],
|
|
338
407
|
retry_config: Array(job[:retries]),
|
|
339
|
-
|
|
408
|
+
entry_point: job[:entry_point],
|
|
409
|
+
perform_sig: source ? extract_perform_signature(source, job) : job[:perform_signature],
|
|
340
410
|
dependencies: source ? Introspectors::SourceCalls.calls(source, own: class_name) : []
|
|
341
411
|
}
|
|
342
412
|
end
|
|
@@ -374,7 +444,7 @@ module RailsAiContext
|
|
|
374
444
|
job_data.each do |j|
|
|
375
445
|
lines << "## #{j[:class_name]}"
|
|
376
446
|
lines << "- **File:** `#{j[:file]}` (#{count_phrase(j[:line_count], "line")})" if j[:line_count]
|
|
377
|
-
lines << "- **Queue:**
|
|
447
|
+
lines << "- **Queue:** #{queue_text(j[:queue])}" if j[:queue]
|
|
378
448
|
lines << "- **Perform:** `#{j[:perform_sig]}`" if j[:perform_sig]
|
|
379
449
|
lines << "- **Retries:** #{j[:retry_config].join('; ')}" if j[:retry_config].any?
|
|
380
450
|
lines << "- **Calls:** #{j[:dependencies].join(', ')}" if j[:dependencies].any?
|
|
@@ -382,7 +452,7 @@ module RailsAiContext
|
|
|
382
452
|
# Read source for additional detail
|
|
383
453
|
source = j[:file] && safe_read(File.join(root, j[:file]))
|
|
384
454
|
if source
|
|
385
|
-
guards = extract_guard_clauses(source)
|
|
455
|
+
guards = extract_guard_clauses(source, j)
|
|
386
456
|
lines << "- **Guards:** #{guards.join('; ')}" if guards.any?
|
|
387
457
|
|
|
388
458
|
broadcasts = extract_broadcasts(source)
|
|
@@ -399,17 +469,25 @@ module RailsAiContext
|
|
|
399
469
|
lines
|
|
400
470
|
end
|
|
401
471
|
|
|
402
|
-
|
|
403
|
-
|
|
472
|
+
# A queue name reads as code; a sentence about how the queue is picked
|
|
473
|
+
# carries its own backticks.
|
|
474
|
+
private_class_method def self.queue_text(queue)
|
|
475
|
+
queue.to_s.match?(/\s/) ? queue : "`#{queue}`"
|
|
476
|
+
end
|
|
404
477
|
|
|
405
|
-
|
|
478
|
+
private_class_method def self.queue_label(job)
|
|
479
|
+
[ (" [#{job[:queue]}]" if job[:queue]), (" [unknown base]" if job[:unknown_base]) ].join
|
|
406
480
|
end
|
|
407
481
|
|
|
408
482
|
# Renders the v5.8.0 enriched Action Cable channel detail produced by
|
|
409
483
|
# JobIntrospector#extract_channels (identified_by, streams, periodic, actions).
|
|
410
484
|
# Returns lines, not a Response - caller composes.
|
|
411
|
-
private_class_method def self.format_channels_section(channels)
|
|
485
|
+
private_class_method def self.format_channels_section(channels, connections = nil)
|
|
412
486
|
lines = [ "# Action Cable Channels (#{channels.size})", "" ]
|
|
487
|
+
Array(connections).each do |c|
|
|
488
|
+
lines << "**Connection:** `#{c[:name]}` identified by #{Array(c[:identified_by]).map { |i| "`#{i}`" }.join(', ')}"
|
|
489
|
+
end
|
|
490
|
+
lines << "" if Array(connections).any?
|
|
413
491
|
|
|
414
492
|
channels.each do |c|
|
|
415
493
|
lines << "## `#{c[:name]}`"
|
|
@@ -430,7 +508,7 @@ module RailsAiContext
|
|
|
430
508
|
if (periodic = c[:periodic]) && periodic.any?
|
|
431
509
|
lines << "- **Periodic timers:**"
|
|
432
510
|
periodic.each do |t|
|
|
433
|
-
lines << " - `#{t[:method]}` every `#{t[:every]}`"
|
|
511
|
+
lines << " - #{t[:method] ? "`#{t[:method]}`" : "a block"} every `#{t[:every]}`"
|
|
434
512
|
end
|
|
435
513
|
end
|
|
436
514
|
|
|
@@ -453,22 +531,25 @@ module RailsAiContext
|
|
|
453
531
|
match[1] if match
|
|
454
532
|
end
|
|
455
533
|
|
|
456
|
-
|
|
457
|
-
|
|
534
|
+
# The introspector named the entry point when it is not perform: Que's run, or a base's execute.
|
|
535
|
+
private_class_method def self.perform_method(source, record = nil)
|
|
536
|
+
entry = record && record[:entry_point]
|
|
537
|
+
Introspectors::ActionResolver.entry_point(Introspectors::ActionResolver.methods_in(source),
|
|
538
|
+
names: entry ? [ entry ] : Introspectors::ActionResolver::ENTRY_POINTS)
|
|
458
539
|
end
|
|
459
540
|
|
|
460
|
-
private_class_method def self.extract_perform_signature(source)
|
|
461
|
-
perform = perform_method(source)
|
|
541
|
+
private_class_method def self.extract_perform_signature(source, record = nil)
|
|
542
|
+
perform = perform_method(source, record)
|
|
462
543
|
Introspectors::ActionResolver.signature(perform) if perform
|
|
463
544
|
end
|
|
464
545
|
|
|
465
546
|
# The `return` lines inside perform's own body, first ten.
|
|
466
|
-
private_class_method def self.extract_guard_clauses(source)
|
|
467
|
-
perform = perform_method(source)
|
|
468
|
-
|
|
547
|
+
private_class_method def self.extract_guard_clauses(source, record = nil)
|
|
548
|
+
perform = perform_method(source, record)
|
|
549
|
+
body = perform && Introspectors::ActionResolver.body_of(source, perform)
|
|
550
|
+
return [] unless body
|
|
469
551
|
|
|
470
|
-
body
|
|
471
|
-
body.map(&:strip).select { |line|
|
|
552
|
+
body[:code].lines.map(&:strip).select { |line|
|
|
472
553
|
line.match?(/\Areturn\s+(if|unless)\b/) || (line.match?(/\Areturn\b/) && line.length < 120)
|
|
473
554
|
}.first(10)
|
|
474
555
|
end
|
|
@@ -503,44 +584,19 @@ module RailsAiContext
|
|
|
503
584
|
effects.to_a.sort
|
|
504
585
|
end
|
|
505
586
|
|
|
506
|
-
private_class_method def self.
|
|
507
|
-
|
|
508
|
-
schedule_files = %w[config/sidekiq.yml config/sidekiq_cron.yml config/schedule.yml config/recurring.yml]
|
|
509
|
-
schedule_files.each do |file|
|
|
510
|
-
path = File.join(root, file)
|
|
511
|
-
content = safe_read(path)
|
|
512
|
-
next unless content
|
|
513
|
-
next unless content.include?(class_name)
|
|
514
|
-
|
|
515
|
-
# Extract the cron expression near the class name
|
|
516
|
-
content.each_line do |line|
|
|
517
|
-
if line.include?("cron:") && content_near_class?(content, class_name, line)
|
|
518
|
-
cron = line.match(/cron:\s*["']?([^"'\n]+)/)
|
|
519
|
-
return "#{cron[1].strip} (from #{file})" if cron
|
|
520
|
-
end
|
|
521
|
-
end
|
|
587
|
+
private_class_method def self.recurring_lines(schedules)
|
|
588
|
+
return [] if schedules.empty?
|
|
522
589
|
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
return match[1] if match
|
|
530
|
-
end
|
|
531
|
-
|
|
532
|
-
nil
|
|
590
|
+
[ "## Recurring Tasks", *schedules.map { |task|
|
|
591
|
+
label = task[:name] ? "`#{task[:name]}`: " : ""
|
|
592
|
+
runs = task[:class] || task[:command]
|
|
593
|
+
runs = runs ? "`#{runs}` " : "#{task[:computed] ? "a #{task[:computed]} an ERB tag sets" : "no class or command"}, "
|
|
594
|
+
"- #{label}#{runs}#{schedule_text(task)}"
|
|
595
|
+
} ]
|
|
533
596
|
end
|
|
534
597
|
|
|
535
|
-
private_class_method def self.
|
|
536
|
-
|
|
537
|
-
target_idx = lines.index(target_line)
|
|
538
|
-
return false unless target_idx
|
|
539
|
-
|
|
540
|
-
# Check surrounding lines (within 5 lines) for the class name
|
|
541
|
-
start_idx = [ target_idx - 5, 0 ].max
|
|
542
|
-
end_idx = [ target_idx + 5, lines.size - 1 ].min
|
|
543
|
-
lines[start_idx..end_idx].any? { |l| l.include?(class_name) }
|
|
598
|
+
private_class_method def self.schedule_text(task)
|
|
599
|
+
"#{task[:schedule]} (#{"#{task[:env]}, " if task[:env]}from #{task[:file]})"
|
|
544
600
|
end
|
|
545
601
|
|
|
546
602
|
# Read off call nodes, so a call inside a comment does not count. The app's own enqueue
|
|
@@ -4,7 +4,9 @@ module RailsAiContext
|
|
|
4
4
|
module Tools
|
|
5
5
|
class GetMailers < BaseTool
|
|
6
6
|
tool_name "rails_get_mailers"
|
|
7
|
-
description "Get ActionMailer mailers: every mailer class with its delivery actions
|
|
7
|
+
description "Get ActionMailer mailers: every mailer class with its delivery actions, delivery method, own defaults, layout and callbacks, " \
|
|
8
|
+
"template formats per action and preview class, the queue deliver_later uses, interceptors and observers, " \
|
|
9
|
+
"and the Action Mailbox mailboxes with the routing that sends inbound mail to each. " \
|
|
8
10
|
"Use when: adding an email, checking which mailer sends what, or finding the action to preview/test. " \
|
|
9
11
|
"Filter with mailer:\"UserMailer\". Omit for all mailers."
|
|
10
12
|
|
|
@@ -29,7 +31,7 @@ module RailsAiContext
|
|
|
29
31
|
order: 41,
|
|
30
32
|
mcp: "rails_get_mailers(mailer:\"UserMailer\")",
|
|
31
33
|
cli_args: "mailer=UserMailer",
|
|
32
|
-
summary: "Mailer classes with delivery actions and delivery method"
|
|
34
|
+
summary: "Mailer classes with delivery actions and delivery method, mailboxes and their routing"
|
|
33
35
|
)
|
|
34
36
|
|
|
35
37
|
annotations(read_only_hint: true, destructive_hint: false, idempotent_hint: true, open_world_hint: false)
|
|
@@ -62,12 +64,14 @@ module RailsAiContext
|
|
|
62
64
|
# Past the end of the list, the hint below says where the end is.
|
|
63
65
|
past_end = page[:items].empty? && !page[:total].zero?
|
|
64
66
|
lines << "" << bases_note("mailers", base_names) if bases.any? && mailer.nil? && !past_end
|
|
67
|
+
lines.concat(settings_lines(jobs[:mailer_settings])) if mailer.nil? && page[:offset].zero?
|
|
65
68
|
if page[:items].any?
|
|
66
69
|
page[:items].each do |m|
|
|
67
70
|
lines << "" << "## #{m[:name]}"
|
|
68
71
|
# Configured at boot, so the static tier has no value to give.
|
|
69
72
|
lines << "- **Delivery method:** #{m[:delivery_method]}" if m[:delivery_method].present?
|
|
70
73
|
lines.concat(action_lines(m))
|
|
74
|
+
lines.concat(detail_lines(m))
|
|
71
75
|
end
|
|
72
76
|
elsif page[:total].zero?
|
|
73
77
|
# An empty page past the end is not an app without mailers, and the
|
|
@@ -75,6 +79,7 @@ module RailsAiContext
|
|
|
75
79
|
lines << "_No mailers found#{" matching '#{mailer}'" if mailer}._"
|
|
76
80
|
end
|
|
77
81
|
|
|
82
|
+
lines.concat(mailbox_lines(Payload.section(cached_context, :action_mailbox))) if mailer.nil? && page[:offset].zero?
|
|
78
83
|
lines << "" << page[:hint] unless page[:hint].empty?
|
|
79
84
|
text_response(lines.join("\n"))
|
|
80
85
|
end
|
|
@@ -82,6 +87,58 @@ module RailsAiContext
|
|
|
82
87
|
|
|
83
88
|
HEIRS_SHOWN = 12
|
|
84
89
|
|
|
90
|
+
private_class_method def self.settings_lines(settings)
|
|
91
|
+
return [] unless settings.is_a?(Hash) && settings.any?
|
|
92
|
+
|
|
93
|
+
lines = [ "" ]
|
|
94
|
+
lines << "**deliver_later queue:** `#{settings[:deliver_later_queue]}`" if settings[:deliver_later_queue]
|
|
95
|
+
{ "Interceptors" => settings[:interceptors], "Observers" => settings[:observers] }.each do |label, list|
|
|
96
|
+
list = Array(list)
|
|
97
|
+
lines << "**#{label}:** #{list.map { |e| "#{e[:unresolved] ? "`#{e[:name]}`, not read" : e[:name]} (`#{e[:file]}`)" }.join(', ')}" if list.any?
|
|
98
|
+
end
|
|
99
|
+
paths = Array(settings[:preview_paths])
|
|
100
|
+
lines << "**Preview paths:** #{paths.map { |p| "`#{p}`" }.join(', ')}" if paths.any?
|
|
101
|
+
lines.size > 1 ? lines : []
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
private_class_method def self.detail_lines(mailer)
|
|
105
|
+
lines = []
|
|
106
|
+
declares = Array(mailer[:declares])
|
|
107
|
+
lines << "- **Declares:** #{declares.map { |d| "`#{d}`" }.join(', ')}" if declares.any?
|
|
108
|
+
templates = mailer[:templates] || {}
|
|
109
|
+
lines << "- **Templates:** #{templates.map { |action, formats| "#{action} (#{formats.join(', ')})" }.join(', ')}" if templates.any?
|
|
110
|
+
if (preview = mailer[:preview])
|
|
111
|
+
lines << "- **Preview:** #{preview[:name]} (`#{preview[:file]}`)#{": #{preview[:methods].join(', ')}" if Array(preview[:methods]).any?}"
|
|
112
|
+
end
|
|
113
|
+
lines
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
private_class_method def self.mailbox_lines(data)
|
|
117
|
+
routes = Array(data&.dig(:routes))
|
|
118
|
+
mailboxes = Array(data&.dig(:mailboxes))
|
|
119
|
+
return [] if routes.empty? && mailboxes.empty?
|
|
120
|
+
|
|
121
|
+
lines = [ "", "## Mailboxes (Action Mailbox)" ]
|
|
122
|
+
if routes.any?
|
|
123
|
+
defined = mailboxes.map { |m| m[:name] }
|
|
124
|
+
files = routes.map { |r| r[:file] }.uniq.map { |f| "`#{f}`" }.join(", ")
|
|
125
|
+
lines << "" << "Routing, first match wins (#{files}):"
|
|
126
|
+
routes.each_with_index do |r, i|
|
|
127
|
+
missing = " (not defined in app/mailboxes)" unless defined.include?(r[:mailbox])
|
|
128
|
+
lines << "#{i + 1}. `#{r[:pattern]}` -> #{r[:mailbox]}#{missing}"
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
lines << "" if mailboxes.any?
|
|
132
|
+
mailboxes.each do |m|
|
|
133
|
+
callbacks = Array(m[:callbacks]).map { |c| "#{c[:type]} :#{c[:method]}" }
|
|
134
|
+
line = "- **#{m[:name]}** (`#{m[:file]}`)"
|
|
135
|
+
line += ": #{callbacks.join(', ')}" if callbacks.any?
|
|
136
|
+
line += " - no route sends mail here" if routes.any? && Array(m[:routed_from]).empty?
|
|
137
|
+
lines << line
|
|
138
|
+
end
|
|
139
|
+
lines
|
|
140
|
+
end
|
|
141
|
+
|
|
85
142
|
private_class_method def self.base_page(base)
|
|
86
143
|
lines = [ "# #{base[:name]}", "",
|
|
87
144
|
"_A base class: other mailers inherit from it, so it is not counted as a mailer of its own._" ]
|