Class: OpenLoam::Generators::InstallGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Includes:
ActiveRecord::Generators::Migration, PrimaryKeyOptions
Defined in:
lib/generators/open_loam/install/install_generator.rb

Overview

rails g open_loam:install

Installs the OpenLoam foundation into a host Rails app: tenants, memberships, audit records, a minimal User, the admin surface, structural guardrail tests, and AGENTS.md — the contract AI agents work against.

Constant Summary

Constants included from PrimaryKeyOptions

PrimaryKeyOptions::DEFAULT_STRING_LIMIT, PrimaryKeyOptions::SUPPORTED

Instance Method Summary collapse

Methods included from PrimaryKeyOptions

included

Instance Method Details

#add_routes ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 177

def add_routes
  route <<~RUBY
    namespace :admin do
      root "dashboard#index"
      resource :session, only: %i[new create destroy] do
        get :mfa_challenge
        post :mfa_verify
        post :select_tenant
        post :sso_start     # home-realm discovery: email -> tenant IdP
        get  :sso_callback  # the IdP redirect target
      end
      resource :mfa, only: %i[show new create destroy], controller: "mfa"  # a user's own two-factor setup
      resource :sudo, only: %i[new create], controller: "sudo"             # step-up re-challenge
      resources :pending_actions, only: %i[index] do                       # the approval queue
        member do
          post :approve
          post :reject
        end
      end
      resources :perspectives, only: %i[index create update destroy] do    # saved table views
        post :set_default, on: :member
      end
      delete "record_lock", to: "record_locks#destroy"  # manager take-over of an edit lock
      get "events/stream", to: "events#stream", as: :events_stream  # SSE push (OpenLoam::EventStream)
      resources :business_rules, only: %i[index new create edit update destroy]  # when/then rules
      resources :sso_providers, only: %i[index new create edit update destroy]  # per-tenant OIDC config
      resources :dictionaries, only: %i[index new create edit update destroy] do # managed lookup lists
        resources :entries, only: %i[create update destroy], controller: "dictionary_entries"
      end
      resources :progress_jobs, only: %i[index] do  # long-running task progress (live via SSE)
        post :cancel, on: :member
      end
      resources :scheduled_jobs, only: %i[index new create edit update destroy] do  # recurring jobs
        post :run_now, on: :member
      end
      resources :event_deliveries, only: %i[index] do  # durable-event dead-letter view (L-706)
        post :redeliver, on: :member
      end
      resources :inbound_webhook_sources, only: %i[index new create destroy] do  # receive external webhooks (L-710)
        member do
          post :rotate_secret
          post :rotate_token
          post :toggle
        end
      end
      get  "history", to: "history#index", as: :history              # a record's audit trail (L-704)
      post "history/:id/undo", to: "history#undo", as: :undo_history  # undo one change (redo = undo the undo)
      resources :imports, only: %i[new create] do  # generic CSV importer (by entity_type)
        collection do
          post :preview
          post :download_errors
        end
      end
      resources :field_definitions, only: %i[index new create destroy]
      resources :notifications, only: %i[index] do
        post :mark_read, on: :member
      end
      resources :webhook_endpoints, only: %i[index new create destroy]
      resources :api_tokens, only: %i[index create destroy]
      resources :comments, only: %i[create]
      # Settings are keyed by a dotted string ("billing.currency"), which a
      # resourceful :id would truncate at the dot, so the key travels as a param.
      get    "configs",      to: "configs#index",  as: :configs
      get    "configs/edit", to: "configs#edit",   as: :edit_config
      patch  "configs",      to: "configs#update"
      delete "configs",      to: "configs#reset"
      # Feature flags are keyed by a dotted name too, so the name travels as a param.
      get    "features",         to: "features#index",   as: :features
      post   "features/enable",  to: "features#enable",  as: :enable_feature
      post   "features/disable", to: "features#disable", as: :disable_feature
      delete "features",         to: "features#reset"
      get "search", to: "search#index"
      get "api_docs", to: "api_docs#index", as: :api_docs  # OpenAPI explorer (+ .json)
      get "overrides", to: "overrides#index", as: :overrides  # OpenLoam::Overrides (read-only)
      get   "translations", to: "translations#index", as: :translations  # per-record content translations
      patch "translations", to: "translations#update"
      get   "dashboard_widgets", to: "dashboard_widgets#index", as: :dashboard_widgets  # dashboard settings
      patch "dashboard_widgets", to: "dashboard_widgets#update"
    end

    namespace :api do
      # `rails g open_loam:entity` injects `resources :<entities>` here.
    end

    # Public inbound webhook receiver (L-710). No auth middleware — the HMAC
    # signature is the auth; the :token identifies the source/tenant.
    post "/webhooks/:token", to: "inbound_webhooks#receive", as: :inbound_webhook
  RUBY
end

#create_admin ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 87

def create_admin
  template "admin/base_controller.rb", "app/controllers/admin/base_controller.rb"
  template "admin/sessions_controller.rb", "app/controllers/admin/sessions_controller.rb"
  template "admin/mfa_controller.rb", "app/controllers/admin/mfa_controller.rb"
  template "admin/sudo_controller.rb", "app/controllers/admin/sudo_controller.rb"
  template "admin/pending_actions_controller.rb", "app/controllers/admin/pending_actions_controller.rb"
  template "admin/perspectives_controller.rb", "app/controllers/admin/perspectives_controller.rb"
  template "admin/record_locks_controller.rb", "app/controllers/admin/record_locks_controller.rb"
  template "admin/events_controller.rb", "app/controllers/admin/events_controller.rb"
  template "admin/dashboard_controller.rb", "app/controllers/admin/dashboard_controller.rb"
  template "admin/field_definitions_controller.rb", "app/controllers/admin/field_definitions_controller.rb"
  template "admin/notifications_controller.rb", "app/controllers/admin/notifications_controller.rb"
  template "admin/webhook_endpoints_controller.rb", "app/controllers/admin/webhook_endpoints_controller.rb"
  template "admin/api_tokens_controller.rb", "app/controllers/admin/api_tokens_controller.rb"
  template "admin/comments_controller.rb", "app/controllers/admin/comments_controller.rb"
  template "admin/configs_controller.rb", "app/controllers/admin/configs_controller.rb"
  template "admin/features_controller.rb", "app/controllers/admin/features_controller.rb"
  template "admin/business_rules_controller.rb", "app/controllers/admin/business_rules_controller.rb"
  template "admin/sso_providers_controller.rb", "app/controllers/admin/sso_providers_controller.rb"
  template "admin/dictionaries_controller.rb", "app/controllers/admin/dictionaries_controller.rb"
  template "admin/dictionary_entries_controller.rb", "app/controllers/admin/dictionary_entries_controller.rb"
  template "admin/progress_jobs_controller.rb", "app/controllers/admin/progress_jobs_controller.rb"
  template "admin/scheduled_jobs_controller.rb", "app/controllers/admin/scheduled_jobs_controller.rb"
  template "admin/event_deliveries_controller.rb", "app/controllers/admin/event_deliveries_controller.rb"
  template "inbound_webhooks_controller.rb", "app/controllers/inbound_webhooks_controller.rb"
  template "admin/inbound_webhook_sources_controller.rb", "app/controllers/admin/inbound_webhook_sources_controller.rb"
  template "admin/history_controller.rb", "app/controllers/admin/history_controller.rb"
  template "admin/imports_controller.rb", "app/controllers/admin/imports_controller.rb"
  template "admin/dashboard_widgets_controller.rb", "app/controllers/admin/dashboard_widgets_controller.rb"
  template "admin/api_docs_controller.rb", "app/controllers/admin/api_docs_controller.rb"
  template "admin/translations_controller.rb", "app/controllers/admin/translations_controller.rb"
  template "admin/overrides_controller.rb", "app/controllers/admin/overrides_controller.rb"
  template "import_job.rb", "app/jobs/import_job.rb"
  template "admin/search_controller.rb", "app/controllers/admin/search_controller.rb"
  template "admin/pagination.rb", "app/controllers/admin/pagination.rb"
  template "admin/layout.html.erb", "app/views/layouts/admin.html.erb"
  template "admin.css", "app/assets/stylesheets/admin.css"
  template "admin/sessions_new.html.erb", "app/views/admin/sessions/new.html.erb"
  template "admin/sessions_mfa_challenge.html.erb", "app/views/admin/sessions/mfa_challenge.html.erb"
  template "admin/mfa_show.html.erb", "app/views/admin/mfa/show.html.erb"
  template "admin/mfa_new.html.erb", "app/views/admin/mfa/new.html.erb"
  template "admin/mfa_activated.html.erb", "app/views/admin/mfa/activated.html.erb"
  template "admin/sudo_new.html.erb", "app/views/admin/sudo/new.html.erb"
  template "admin/pending_actions_index.html.erb", "app/views/admin/pending_actions/index.html.erb"
  template "admin/perspectives_index.html.erb", "app/views/admin/perspectives/index.html.erb"
  template "admin/dashboard_index.html.erb", "app/views/admin/dashboard/index.html.erb"
  template "admin/field_definitions_index.html.erb", "app/views/admin/field_definitions/index.html.erb"
  template "admin/field_definitions_new.html.erb", "app/views/admin/field_definitions/new.html.erb"
  template "admin/notifications_index.html.erb", "app/views/admin/notifications/index.html.erb"
  template "admin/webhook_endpoints_index.html.erb", "app/views/admin/webhook_endpoints/index.html.erb"
  template "admin/webhook_endpoints_new.html.erb", "app/views/admin/webhook_endpoints/new.html.erb"
  template "admin/api_tokens_index.html.erb", "app/views/admin/api_tokens/index.html.erb"
  template "admin/configs_index.html.erb", "app/views/admin/configs/index.html.erb"
  template "admin/configs_edit.html.erb", "app/views/admin/configs/edit.html.erb"
  template "admin/features_index.html.erb", "app/views/admin/features/index.html.erb"
  template "admin/business_rules_index.html.erb", "app/views/admin/business_rules/index.html.erb"
  template "admin/business_rules_new.html.erb", "app/views/admin/business_rules/new.html.erb"
  template "admin/business_rules_edit.html.erb", "app/views/admin/business_rules/edit.html.erb"
  template "admin/business_rules_form.html.erb", "app/views/admin/business_rules/_form.html.erb"
  template "admin/sso_providers_index.html.erb", "app/views/admin/sso_providers/index.html.erb"
  template "admin/sso_providers_new.html.erb", "app/views/admin/sso_providers/new.html.erb"
  template "admin/sso_providers_edit.html.erb", "app/views/admin/sso_providers/edit.html.erb"
  template "admin/sso_providers_form.html.erb", "app/views/admin/sso_providers/_form.html.erb"
  template "admin/dictionaries_index.html.erb", "app/views/admin/dictionaries/index.html.erb"
  template "admin/dictionaries_new.html.erb", "app/views/admin/dictionaries/new.html.erb"
  template "admin/dictionaries_edit.html.erb", "app/views/admin/dictionaries/edit.html.erb"
  template "admin/dictionaries_form.html.erb", "app/views/admin/dictionaries/_form.html.erb"
  template "admin/progress_jobs_index.html.erb", "app/views/admin/progress_jobs/index.html.erb"
  template "admin/scheduled_jobs_index.html.erb", "app/views/admin/scheduled_jobs/index.html.erb"
  template "admin/event_deliveries_index.html.erb", "app/views/admin/event_deliveries/index.html.erb"
  template "admin/inbound_webhook_sources_index.html.erb", "app/views/admin/inbound_webhook_sources/index.html.erb"
  template "admin/inbound_webhook_sources_new.html.erb", "app/views/admin/inbound_webhook_sources/new.html.erb"
  template "admin/history_index.html.erb", "app/views/admin/history/index.html.erb"
  template "admin/scheduled_jobs_new.html.erb", "app/views/admin/scheduled_jobs/new.html.erb"
  template "admin/scheduled_jobs_edit.html.erb", "app/views/admin/scheduled_jobs/edit.html.erb"
  template "admin/scheduled_jobs_form.html.erb", "app/views/admin/scheduled_jobs/_form.html.erb"
  template "admin/imports_new.html.erb", "app/views/admin/imports/new.html.erb"
  template "admin/imports_preview.html.erb", "app/views/admin/imports/preview.html.erb"
  template "admin/imports_summary.html.erb", "app/views/admin/imports/summary.html.erb"
  template "admin/dashboard_widgets_index.html.erb", "app/views/admin/dashboard_widgets/index.html.erb"
  template "admin/api_docs_index.html.erb", "app/views/admin/api_docs/index.html.erb"
  template "admin/translations_index.html.erb", "app/views/admin/translations/index.html.erb"
  template "admin/overrides_index.html.erb", "app/views/admin/overrides/index.html.erb"
  template "admin/search_index.html.erb", "app/views/admin/search/index.html.erb"
end

#create_agents_md ⇒ Object 



83
84
85
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 83

def create_agents_md
  template "AGENTS.md", "AGENTS.md"
end

#create_api ⇒ Object 



173
174
175
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 173

def create_api
  template "api_base_controller.rb", "app/controllers/api/base_controller.rb"
end

#create_guardrail_tests ⇒ Object 



267
268
269
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 267

def create_guardrail_tests
  template "guardrails_test.rb", "test/open_loam_guardrails_test.rb"
end

#create_initializer ⇒ Object 



69
70
71
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 69

def create_initializer
  template "initializer.rb", "config/initializers/open_loam.rb"
end

#create_migrations ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 18

def create_migrations
  migration_template "migrations/create_users.rb", "db/migrate/create_users.rb"
  migration_template "migrations/create_open_loam_tenants.rb", "db/migrate/create_open_loam_tenants.rb"
  migration_template "migrations/create_open_loam_memberships.rb", "db/migrate/create_open_loam_memberships.rb"
  migration_template "migrations/create_open_loam_audit_records.rb", "db/migrate/create_open_loam_audit_records.rb"
  migration_template "migrations/create_open_loam_field_definitions.rb", "db/migrate/create_open_loam_field_definitions.rb"
  migration_template "migrations/create_open_loam_notifications.rb", "db/migrate/create_open_loam_notifications.rb"
  migration_template "migrations/create_open_loam_api_tokens.rb", "db/migrate/create_open_loam_api_tokens.rb"
  migration_template "migrations/create_open_loam_webhook_endpoints.rb", "db/migrate/create_open_loam_webhook_endpoints.rb"
  migration_template "migrations/create_open_loam_comments.rb", "db/migrate/create_open_loam_comments.rb"
  migration_template "migrations/create_open_loam_configs.rb", "db/migrate/create_open_loam_configs.rb"
  migration_template "migrations/create_open_loam_mfa_credentials.rb", "db/migrate/create_open_loam_mfa_credentials.rb"
  migration_template "migrations/create_open_loam_pending_actions.rb", "db/migrate/create_open_loam_pending_actions.rb"
  migration_template "migrations/create_open_loam_perspectives.rb", "db/migrate/create_open_loam_perspectives.rb"
  migration_template "migrations/create_open_loam_record_locks.rb", "db/migrate/create_open_loam_record_locks.rb"
  migration_template "migrations/create_open_loam_business_rules.rb", "db/migrate/create_open_loam_business_rules.rb"
  migration_template "migrations/create_open_loam_search_tokens.rb", "db/migrate/create_open_loam_search_tokens.rb"
  migration_template "migrations/create_open_loam_sso_providers.rb", "db/migrate/create_open_loam_sso_providers.rb"
  migration_template "migrations/create_open_loam_dictionaries.rb", "db/migrate/create_open_loam_dictionaries.rb"
  migration_template "migrations/create_open_loam_dictionary_entries.rb", "db/migrate/create_open_loam_dictionary_entries.rb"
  migration_template "migrations/create_open_loam_progress_jobs.rb", "db/migrate/create_open_loam_progress_jobs.rb"
  migration_template "migrations/create_open_loam_scheduled_jobs.rb", "db/migrate/create_open_loam_scheduled_jobs.rb"
  migration_template "migrations/create_open_loam_dashboard_widgets.rb", "db/migrate/create_open_loam_dashboard_widgets.rb"
  migration_template "migrations/create_open_loam_translations.rb", "db/migrate/create_open_loam_translations.rb"
  migration_template "migrations/create_open_loam_auth_attempts.rb", "db/migrate/create_open_loam_auth_attempts.rb"
  migration_template "migrations/create_open_loam_custom_field_values.rb", "db/migrate/create_open_loam_custom_field_values.rb"
  migration_template "migrations/create_open_loam_event_deliveries.rb", "db/migrate/create_open_loam_event_deliveries.rb"
  migration_template "migrations/create_open_loam_event_records.rb", "db/migrate/create_open_loam_event_records.rb"
  migration_template "migrations/create_open_loam_inbound_webhooks.rb", "db/migrate/create_open_loam_inbound_webhooks.rb"
end

#create_user_model ⇒ Object 



65
66
67
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 65

def create_user_model
  template "user.rb", "app/models/user.rb"
end

#filter_open_loam_parameters ⇒ Object

Rails' default filter list covers passwords and tokens but not the params OpenLoam introduces: an uploaded :csv is a payload of real records, and :code is a live TOTP.



76
77
78
79
80
81
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 76

def filter_open_loam_parameters
  append_to_file "config/initializers/filter_parameter_logging.rb", <<~RUBY

    Rails.application.config.filter_parameters += %i[csv file code recovery secret otp]
  RUBY
end

#install_active_storage ⇒ Object

Attachments (OpenLoam::Attachable, included in every generated entity) are ActiveStorage, which needs its own tables. The task copies its migration and says so if it is already there, so running it twice is harmless.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 53

def install_active_storage
  unless defined?(ActiveStorage::Engine)
    say ""
    say "ActiveStorage is not available in this app — attachments will not work.", :yellow
    say "  Generated entities `include OpenLoam::Attachable`; either re-create the app without"
    say "  --skip-active-storage, or remove that include from app/models."
    return
  end

  rails_command "active_storage:install"
end

#print_next_steps ⇒ Object 



290
291
292
293
294
295
296
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 290

def print_next_steps
  say ""
  say "OpenLoam installed. Next:", :green
  say "  1. bin/rails db:migrate"
  say "  2. rails g open_loam:entity Equipment name:string daily_rate:decimal status:string --domain rental"
  say "  3. Read AGENTS.md before pointing an AI agent at this app."
end

#wire_test_helpers ⇒ Object

An app generated with --skip-test has no test/test_helper.rb. Creating one here would be OpenLoam deciding how the app tests; saying so and moving on leaves the install complete either way.



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/generators/open_loam/install/install_generator.rb', line 274

def wire_test_helpers
  unless File.file?(File.join(destination_root, "test/test_helper.rb"))
    say ""
    say "No test/test_helper.rb (--skip-test?) — skipping OpenLoam test wiring.", :yellow
    say "  test/open_loam_guardrails_test.rb was still written. To run it, add to your test setup:"
    say "    require \"open_loam/test_helpers\"   (after the environment is loaded)"
    say "    include OpenLoam::TestHelpers       (in your base test case)"
    return
  end

  inject_into_file "test/test_helper.rb", "require \"open_loam/test_helpers\"\n",
                   after: /require_relative "\.\.\/config\/environment"\n/
  inject_into_file "test/test_helper.rb", "    include OpenLoam::TestHelpers\n",
                   after: /class TestCase\n/
end