Module: RubyCms::SettingsRegistry

Defined in:
lib/generators/ruby_cms/templates/lib/ruby_cms/settings_registry.rb

Defined Under Namespace

Classes: Entry

Class Method Summary collapse

Class Method Details

.configure(&block) ⇒ Object

Host hook. Call from an initializer:

RubyCms::SettingsRegistry.configure do |r|
r.register(key: :ui_v3_enabled, type: :boolean, default: true,
           category: :custom, description: "Use the new public UI")
end

Use category: :custom (or any name) to get a dedicated block in Settings.



28
29
30
31
32
 
# File 'lib/generators/ruby_cms/templates/lib/ruby_cms/settings_registry.rb', line 28

def configure(&block)
  self.custom_registrar = block
  seed_defaults! if @gem_defaults_seeded
  block
end

.defaults_hash ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/generators/ruby_cms/templates/lib/ruby_cms/settings_registry.rb', line 53

def defaults_hash
  seed_defaults! if entries.empty?

  entries.values.to_h do |entry|
    [
      entry.key.to_sym,
      {
        value: entry.default,
        type: value_type_for(entry.type),
        description: entry.description,
        category: entry.category
      }
    ]
  end
end

.each ⇒ Object 



49
50
51
 
# File 'lib/generators/ruby_cms/templates/lib/ruby_cms/settings_registry.rb', line 49

def each(&)
  entries.each_value(&)
end

.fetch(key) ⇒ Object 



45
46
47
 
# File 'lib/generators/ruby_cms/templates/lib/ruby_cms/settings_registry.rb', line 45

def fetch(key)
  entries[key.to_s]
end

.register(key:, type:, default:, category: "general", description: nil) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/generators/ruby_cms/templates/lib/ruby_cms/settings_registry.rb', line 34

def register(key:, type:, default:, category: "general", description: nil)
  k = key.to_s
  entries[k] = Entry.new(
    key: k,
    type: normalize_type(type),
    default: default,
    category: category.to_s,
    description: description.to_s
  )
end

.seed_defaults! ⇒ Object 



69
70
71
72
 
# File 'lib/generators/ruby_cms/templates/lib/ruby_cms/settings_registry.rb', line 69

def seed_defaults!
  seed_gem_defaults!
  custom_registrar&.call(self)
end

.seed_gem_defaults! ⇒ Object

Gem defaults seed exactly once; kept separate from the host registrar so the two never clobber each other and order of registration does not matter.



76
77
78
79
80
81
82
83
84
85
86
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
172
173
174
175
176
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/generators/ruby_cms/templates/lib/ruby_cms/settings_registry.rb', line 76

def seed_gem_defaults!
  return if @gem_defaults_seeded

  @gem_defaults_seeded = true

  # Pagination
  register(
    key: :visitor_errors_per_page,
    type: :integer,
    default: 25,
    category: :pagination,
    description: "Number of visitor errors to show per page"
  )
  register(
    key: :content_blocks_per_page,
    type: :integer,
    default: 50,
    category: :pagination,
    description: "Number of content blocks to show per page"
  )
  register(
    key: :users_per_page,
    type: :integer,
    default: 50,
    category: :pagination,
    description: "Number of users to show per page"
  )
  register(
    key: :permissions_per_page,
    type: :integer,
    default: 50,
    category: :pagination,
    description: "Number of permissions to show per page"
  )
  register(
    key: :pagination_min_per_page,
    type: :integer,
    default: 5,
    category: :pagination,
    description: "Minimum allowed per-page size"
  )
  register(
    key: :pagination_max_per_page,
    type: :integer,
    default: 200,
    category: :pagination,
    description: "Maximum allowed per-page size"
  )

  # Analytics
  register(
    key: :analytics_high_volume_threshold,
    type: :integer,
    default: 1000,
    category: :analytics,
    description: "Threshold of visits per IP in selected period to flag high volume traffic"
  )
  register(
    key: :analytics_rapid_request_threshold,
    type: :integer,
    default: 50,
    category: :analytics,
    description: "Threshold of visits from an IP per minute to flag rapid requests"
  )
  register(
    key: :analytics_default_period,
    type: :string,
    default: "week",
    category: :analytics,
    description: "Default analytics period (day/week/month/year)"
  )
  register(
    key: :analytics_max_date_range_days,
    type: :integer,
    default: 365,
    category: :analytics,
    description: "Maximum date range for analytics filters"
  )
  register(
    key: :analytics_max_popular_pages,
    type: :integer,
    default: 10,
    category: :analytics,
    description: "Maximum number of popular pages to show"
  )
  register(
    key: :analytics_max_top_visitors,
    type: :integer,
    default: 10,
    category: :analytics,
    description: "Maximum number of top visitors to show"
  )
  register(
    key: :analytics_cache_duration_seconds,
    type: :integer,
    default: 600,
    category: :analytics,
    description: "Analytics cache duration in seconds"
  )
  register(
    key: :analytics_recent_page_views_limit,
    type: :integer,
    default: 25,
    category: :analytics,
    description: "Recent page views shown on analytics dashboard"
  )
  register(
    key: :analytics_page_details_limit,
    type: :integer,
    default: 100,
    category: :analytics,
    description: "Events shown on page details screen"
  )
  register(
    key: :analytics_visitor_details_limit,
    type: :integer,
    default: 100,
    category: :analytics,
    description: "Events shown on visitor details screen"
  )
  register(
    key: :analytics_max_exit_pages,
    type: :integer,
    default: 10,
    category: :analytics,
    description: "Maximum number of exit pages to show"
  )
  register(
    key: :analytics_max_conversions,
    type: :integer,
    default: 10,
    category: :analytics,
    description: "Maximum number of conversion goals to show in breakdown"
  )
  register(
    key: :analytics_max_referrers,
    type: :integer,
    default: 10,
    category: :analytics,
    description: "Maximum number of top referrers to show"
  )
  register(
    key: :analytics_max_landing_pages,
    type: :integer,
    default: 10,
    category: :analytics,
    description: "Maximum number of top landing pages to show"
  )
  register(
    key: :analytics_max_utm_sources,
    type: :integer,
    default: 10,
    category: :analytics,
    description: "Maximum number of UTM sources to show"
  )

  # Dashboard
  register(
    key: :dashboard_recent_errors_limit,
    type: :integer,
    default: 5,
    category: :dashboard,
    description: "Recent visitor errors shown on dashboard"
  )
  register(
    key: :dashboard_recent_content_blocks_limit,
    type: :integer,
    default: 5,
    category: :dashboard,
    description: "Recent content blocks shown on dashboard"
  )

  # Navigation visibility
  register(
    key: :nav_show_dashboard,
    type: :boolean,
    default: true,
    category: :navigation,
    description: "Show Dashboard in navigation"
  )
  register(
    key: :nav_show_visual_editor,
    type: :boolean,
    default: true,
    category: :navigation,
    description: "Show Visual Editor in navigation"
  )
  register(
    key: :nav_show_content_blocks,
    type: :boolean,
    default: true,
    category: :navigation,
    description: "Show Content Blocks in navigation"
  )
  register(
    key: :nav_show_settings,
    type: :boolean,
    default: true,
    category: :navigation,
    description: "Show Settings in navigation"
  )
  register(
    key: :nav_show_visitor_errors,
    type: :boolean,
    default: true,
    category: :navigation,
    description: "Show Visitor Errors in navigation"
  )
  register(
    key: :nav_show_permissions,
    type: :boolean,
    default: true,
    category: :navigation,
    description: "Show Permissions in navigation"
  )
  register(
    key: :nav_show_users,
    type: :boolean,
    default: true,
    category: :navigation,
    description: "Show Users in navigation"
  )
  register(
    key: :nav_show_analytics,
    type: :boolean,
    default: true,
    category: :navigation,
    description: "Show Analytics in navigation"
  )
  register(
    key: :nav_show_commands,
    type: :boolean,
    default: true,
    category: :navigation,
    description: "Show Commands in navigation"
  )
  register(
    key: :nav_order,
    type: :json,
    default: [],
    category: :navigation,
    description: "Order of nav items (set via Settings → Navigation drag-and-drop)"
  )

  # Content/image constraints
  register(
    key: :reserved_key_prefixes,
    type: :json,
    default: [ "admin_" ],
    category: :content,
    description: "Reserved prefixes blocked for content block keys"
  )
  register(
    key: :image_content_types,
    type: :json,
    default: [ "image/png", "image/jpeg", "image/gif", "image/webp" ],
    category: :content,
    description: "Allowed MIME types for content block images"
  )
  register(
    key: :image_max_size,
    type: :integer,
    default: 5 * 1024 * 1024,
    category: :content,
    description: "Max image attachment size in bytes"
  )

  # General — site behaviour an admin actually controls.
  register(
    key: :maintenance_mode,
    type: :boolean,
    default: false,
    category: :general,
    description: "Toont een onderhouds-banner aan bezoekers."
  )
  register(
    key: :maintenance_message,
    type: :string,
    default: "Onze site is tijdelijk in onderhoud. We zijn snel weer terug.",
    category: :general,
    description: "Bericht getoond aan bezoekers tijdens maintenance mode."
  )

  # Visual editor preview — lets a host make the preview iframe match its public
  # site without forking the minimal layout.
  register(
    key: :visual_editor_preview_title,
    type: :string,
    default: "Page Preview",
    category: :visual_editor,
    description: "Titel van het preview-tabblad in de visual editor."
  )
  register(
    key: :visual_editor_preview_stylesheets,
    type: :string,
    default: "tailwind,application,actiontext",
    category: :visual_editor,
    description: "Komma-lijst van stylesheet-namen die de preview laadt (bv. je publieke CSS + actiontext)."
  )
  register(
    key: :visual_editor_preview_head,
    type: :string,
    default: "",
    category: :visual_editor,
    description: "Extra <head> HTML voor de preview (bv. font-preloads). Wordt rauw ingevoegd — alleen admin."
  )

  # Site identity — used in host app (mailers, branding, etc.).
  register(
    key: :site_name,
    type: :string,
    default: "",
    category: :general,
    description: "Naam van de site (algemeen, bv. in e-mails of meta)."
  )
end