Class: Avo::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/avo/configuration.rb

Defined Under Namespace

Classes: Branding

Constant Summary collapse

CONTAINER_WIDTH_DEFAULTS = 
{
  index: :large,
  show: :small,
  new: :small,
  edit: :small,
  create: :small,
  update: :small
}.freeze
VALID_CONTAINER_WIDTHS = 
%i[full large small].freeze
CONTAINER_WIDTH_GROUPS = 
{
  forms: %i[new edit create update],
  display: %i[index show],
  single: %i[show new edit create update]
}.freeze
RESOURCE_ROW_CONTROLS_CONFIG_DEFAULTS = 
{
  placement: :right,
  float: false,
  show_on_hover: false
}.freeze
HOTKEYS_DEFAULTS = 
{
  enabled: true,
  show_key_badges: true
}.freeze
RTL_LOCALES =

Known RTL (Right-to-Left) locale codes

%w[ar he fa ur yi ps sd ku ckb ug dv].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



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
 
# File 'lib/avo/configuration.rb', line 119

def initialize
  @root_path = "/avo"
  @app_name = ::Rails.application.class.to_s.split("::").first.underscore.humanize(keep_id_suffix: true)
  @timezone = "UTC"
  @per_page = 24
  @per_page_steps = [12, 24, 48, 72]
  @via_per_page = 8
  @locale = nil
  @currency = "USD"
  @default_view_type = :table
  @license_key = nil
  @current_user = proc {}
  @authenticate = proc {}
  @explicit_authorization = false
  @authorization_methods = {
    index: "index?",
    show: "show?",
    edit: "edit?",
    new: "new?",
    update: "update?",
    create: "create?",
    destroy: "destroy?"
  }
  @id_links_to_resource = false
  @cache_resources_on_index_view = Avo::PACKED
  @persistence = {
    driver: nil
  }
  @context = proc {}
  @initial_breadcrumbs = proc {
    add_breadcrumb title: I18n.t("avo.home").humanize, path: avo.root_path, icon: "tabler/outline/home"
  }
  @hide_layout_when_printing = false
  @home_path = nil
  @search_debounce = 300
  @view_component_path = "app/components"
  @display_license_request_timeout_error = true
  @current_user_resource_name = "user"
  @raise_error_on_missing_policy = false
  @buttons_on_form_footers = false
  @main_menu = nil
  @profile_menu = nil
  @model_resource_mapping = {}
  @resource_default_view = Avo::ViewInquirer.new("show")
  @authorization_client = :pundit
  @field_wrapper_layout = :inline
  @resources = nil
  @resource_parent_controller = "Avo::ResourcesController"
  @cache_store = computed_cache_store
  @logger = default_logger
  @turbo = default_turbo
  @default_url_options = []
  @pagination = {}
  @click_row_to_view_record = true
  @alert_dismiss_time = 5000
  @is_admin_method = :is_admin?
  @is_developer_method = :is_developer?
  @search_results_count = 8
  @first_sorting_option = :desc # :desc or :asc
  @associations_lookup_list_limit = 1000
  @exclude_from_status = []
  @column_names_mapping = {}
  @column_types_mapping = {}
  @resource_row_controls_config = {}
  @hotkeys = {}
  @global_search = {
    enabled: true,
    navigation_section: true
  }
  @model_generator_hook = true
  @send_metadata = true
  @use_stacked_fields = false
  @default_editor_url = "cursor://file/%{path}"
  @sidebar_toggle_visible = true
  @body_classes = []
  @tailwindcss_integration_enabled = true
end

Instance Attribute Details

#alert_dismiss_time ⇒ Object

Returns the value of attribute alert_dismiss_time.



51
52
53
 
# File 'lib/avo/configuration.rb', line 51

def alert_dismiss_time
  @alert_dismiss_time
end

#app_name ⇒ Object 



264
265
266
 
# File 'lib/avo/configuration.rb', line 264

def app_name
  Avo::ExecutionContext.new(target: @app_name).handle
end

#associations_lookup_list_limit ⇒ Object

Returns the value of attribute associations_lookup_list_limit.



56
57
58
 
# File 'lib/avo/configuration.rb', line 56

def associations_lookup_list_limit
  @associations_lookup_list_limit
end

#authenticate ⇒ Object

Returns the value of attribute authenticate.



24
25
26
 
# File 'lib/avo/configuration.rb', line 24

def authenticate
  @authenticate
end

#authorization_client ⇒ Object

Returns the value of attribute authorization_client.



43
44
45
 
# File 'lib/avo/configuration.rb', line 43

def authorization_client
  @authorization_client
end

#authorization_methods ⇒ Object

Returns the value of attribute authorization_methods.



23
24
25
 
# File 'lib/avo/configuration.rb', line 23

def authorization_methods
  @authorization_methods
end

#body_classes ⇒ Object 



364
365
366
 
# File 'lib/avo/configuration.rb', line 364

def body_classes
  Avo::ExecutionContext.new(target: @body_classes).handle
end

#branding ⇒ Object 



260
261
262
 
# File 'lib/avo/configuration.rb', line 260

def branding
  Avo::Configuration::Branding.new(**@branding || {})
end

#buttons_on_form_footers ⇒ Object

Returns the value of attribute buttons_on_form_footers.



38
39
40
 
# File 'lib/avo/configuration.rb', line 38

def buttons_on_form_footers
  @buttons_on_form_footers
end

#cache_resources_on_index_view ⇒ Object

Returns the value of attribute cache_resources_on_index_view.



27
28
29
 
# File 'lib/avo/configuration.rb', line 27

def cache_resources_on_index_view
  @cache_resources_on_index_view
end

#cache_store ⇒ Object 



272
273
274
275
276
277
 
# File 'lib/avo/configuration.rb', line 272

def cache_store
  Avo::ExecutionContext.new(
    target: @cache_store,
    production_rejected_cache_stores: %w[ActiveSupport::Cache::MemoryStore ActiveSupport::Cache::NullStore]
  ).handle
end

#click_row_to_view_record ⇒ Object

Returns the value of attribute click_row_to_view_record.



50
51
52
 
# File 'lib/avo/configuration.rb', line 50

def click_row_to_view_record
  @click_row_to_view_record
end

#column_names_mapping ⇒ Object

Returns the value of attribute column_names_mapping.



57
58
59
 
# File 'lib/avo/configuration.rb', line 57

def column_names_mapping
  @column_names_mapping
end

#column_types_mapping ⇒ Object

Returns the value of attribute column_types_mapping.



58
59
60
 
# File 'lib/avo/configuration.rb', line 58

def column_types_mapping
  @column_types_mapping
end

#context ⇒ Object

Returns the value of attribute context.



28
29
30
 
# File 'lib/avo/configuration.rb', line 28

def context
  @context
end

#currency ⇒ Object

Returns the value of attribute currency.



20
21
22
 
# File 'lib/avo/configuration.rb', line 20

def currency
  @currency
end

#current_user ⇒ Object

Returns the value of attribute current_user.



25
26
27
 
# File 'lib/avo/configuration.rb', line 25

def current_user
  @current_user
end

#current_user_resource_name ⇒ Object

Returns the value of attribute current_user_resource_name.



35
36
37
 
# File 'lib/avo/configuration.rb', line 35

def current_user_resource_name
  @current_user_resource_name
end

#default_editor_url ⇒ Object

Returns the value of attribute default_editor_url.



62
63
64
 
# File 'lib/avo/configuration.rb', line 62

def default_editor_url
  @default_editor_url
end

#default_url_options ⇒ Object

Returns the value of attribute default_url_options.



49
50
51
 
# File 'lib/avo/configuration.rb', line 49

def default_url_options
  @default_url_options
end

#default_view_type ⇒ Object

Returns the value of attribute default_view_type.



21
22
23
 
# File 'lib/avo/configuration.rb', line 21

def default_view_type
  @default_view_type
end

#display_license_request_timeout_error ⇒ Object

Returns the value of attribute display_license_request_timeout_error.



34
35
36
 
# File 'lib/avo/configuration.rb', line 34

def display_license_request_timeout_error
  @display_license_request_timeout_error
end

#exclude_from_status ⇒ Object 



322
323
324
 
# File 'lib/avo/configuration.rb', line 322

def exclude_from_status
  Avo::ExecutionContext.new(target: @exclude_from_status).handle
end

#explicit_authorization ⇒ Object 



360
361
362
 
# File 'lib/avo/configuration.rb', line 360

def explicit_authorization
  Avo::ExecutionContext.new(target: @explicit_authorization).handle
end

#field_wrapper_layout ⇒ Object

Returns the value of attribute field_wrapper_layout.



44
45
46
 
# File 'lib/avo/configuration.rb', line 44

def field_wrapper_layout
  @field_wrapper_layout
end

#first_sorting_option ⇒ Object

Returns the value of attribute first_sorting_option.



55
56
57
 
# File 'lib/avo/configuration.rb', line 55

def first_sorting_option
  @first_sorting_option
end

#global_search ⇒ Object

Returns the value of attribute global_search.



37
38
39
 
# File 'lib/avo/configuration.rb', line 37

def global_search
  @global_search
end

#hide_layout_when_printing ⇒ Object

Returns the value of attribute hide_layout_when_printing.



29
30
31
 
# File 'lib/avo/configuration.rb', line 29

def hide_layout_when_printing
  @hide_layout_when_printing
end

#home_path ⇒ Object

Returns the value of attribute home_path.



31
32
33
 
# File 'lib/avo/configuration.rb', line 31

def home_path
  @home_path
end

#hotkeys ⇒ Object 



216
217
218
 
# File 'lib/avo/configuration.rb', line 216

def hotkeys
  HOTKEYS_DEFAULTS.merge @hotkeys
end

#id_links_to_resource ⇒ Object

Returns the value of attribute id_links_to_resource.



26
27
28
 
# File 'lib/avo/configuration.rb', line 26

def id_links_to_resource
  @id_links_to_resource
end

#initial_breadcrumbs ⇒ Object

Returns the value of attribute initial_breadcrumbs.



30
31
32
 
# File 'lib/avo/configuration.rb', line 30

def initial_breadcrumbs
  @initial_breadcrumbs
end

#is_admin_method ⇒ Object

Returns the value of attribute is_admin_method.



52
53
54
 
# File 'lib/avo/configuration.rb', line 52

def is_admin_method
  @is_admin_method
end

#is_developer_method ⇒ Object

Returns the value of attribute is_developer_method.



53
54
55
 
# File 'lib/avo/configuration.rb', line 53

def is_developer_method
  @is_developer_method
end

#license_key ⇒ Object

Returns the value of attribute license_key.



22
23
24
 
# File 'lib/avo/configuration.rb', line 22

def license_key
  @license_key
end

#locale ⇒ Object

Returns the value of attribute locale.



19
20
21
 
# File 'lib/avo/configuration.rb', line 19

def locale
  @locale
end

#logger ⇒ Object 



299
300
301
 
# File 'lib/avo/configuration.rb', line 299

def logger
  Avo::ExecutionContext.new(target: @logger).handle
end

#main_menu ⇒ Object

Returns the value of attribute main_menu.



39
40
41
 
# File 'lib/avo/configuration.rb', line 39

def main_menu
  @main_menu
end

#model_generator_hook ⇒ Object

Returns the value of attribute model_generator_hook.



59
60
61
 
# File 'lib/avo/configuration.rb', line 59

def model_generator_hook
  @model_generator_hook
end

#model_resource_mapping ⇒ Object

Returns the value of attribute model_resource_mapping.



41
42
43
 
# File 'lib/avo/configuration.rb', line 41

def model_resource_mapping
  @model_resource_mapping
end

#pagination ⇒ Object 



334
335
336
 
# File 'lib/avo/configuration.rb', line 334

def pagination
  Avo::ExecutionContext.new(target: @pagination).handle
end

#per_page ⇒ Object

Returns the value of attribute per_page.



16
17
18
 
# File 'lib/avo/configuration.rb', line 16

def per_page
  @per_page
end

#per_page_steps ⇒ Object

Returns the value of attribute per_page_steps.



17
18
19
 
# File 'lib/avo/configuration.rb', line 17

def per_page_steps
  @per_page_steps
end

#persistence ⇒ Object 



368
369
370
 
# File 'lib/avo/configuration.rb', line 368

def persistence
  Avo::ExecutionContext.new(target: @persistence).handle
end

#prefix_path ⇒ Object

Returns the value of attribute prefix_path.



47
48
49
 
# File 'lib/avo/configuration.rb', line 47

def prefix_path
  @prefix_path
end

#profile_menu ⇒ Object

Returns the value of attribute profile_menu.



40
41
42
 
# File 'lib/avo/configuration.rb', line 40

def profile_menu
  @profile_menu
end

#raise_error_on_missing_policy ⇒ Object

Returns the value of attribute raise_error_on_missing_policy.



36
37
38
 
# File 'lib/avo/configuration.rb', line 36

def raise_error_on_missing_policy
  @raise_error_on_missing_policy
end

#resource_default_view ⇒ Object

Returns the value of attribute resource_default_view.



42
43
44
 
# File 'lib/avo/configuration.rb', line 42

def resource_default_view
  @resource_default_view
end

#resource_parent_controller ⇒ Object

Returns the value of attribute resource_parent_controller.



48
49
50
 
# File 'lib/avo/configuration.rb', line 48

def resource_parent_controller
  @resource_parent_controller
end

#resource_row_controls_config ⇒ Object 



212
213
214
 
# File 'lib/avo/configuration.rb', line 212

def resource_row_controls_config
  RESOURCE_ROW_CONTROLS_CONFIG_DEFAULTS.merge @resource_row_controls_config
end

#resources ⇒ Object

Returns the value of attribute resources.



46
47
48
 
# File 'lib/avo/configuration.rb', line 46

def resources
  @resources
end

#root_path ⇒ Object 



254
255
256
257
258
 
# File 'lib/avo/configuration.rb', line 254

def root_path
  return "" if @root_path === "/"

  @root_path
end

#search_debounce ⇒ Object

Returns the value of attribute search_debounce.



32
33
34
 
# File 'lib/avo/configuration.rb', line 32

def search_debounce
  @search_debounce
end

#search_results_count ⇒ Object

Returns the value of attribute search_results_count.



54
55
56
 
# File 'lib/avo/configuration.rb', line 54

def search_results_count
  @search_results_count
end

#send_metadata ⇒ Object

Returns the value of attribute send_metadata.



60
61
62
 
# File 'lib/avo/configuration.rb', line 60

def send_metadata
  @send_metadata
end

#sidebar_toggle_visible ⇒ Object

Returns the value of attribute sidebar_toggle_visible.



64
65
66
 
# File 'lib/avo/configuration.rb', line 64

def sidebar_toggle_visible
  @sidebar_toggle_visible
end

#sign_out_path_name ⇒ Object

Returns the value of attribute sign_out_path_name.



45
46
47
 
# File 'lib/avo/configuration.rb', line 45

def sign_out_path_name
  @sign_out_path_name
end

#tailwindcss_integration_enabled ⇒ Object

Returns the value of attribute tailwindcss_integration_enabled.



65
66
67
 
# File 'lib/avo/configuration.rb', line 65

def tailwindcss_integration_enabled
  @tailwindcss_integration_enabled
end

#timezone ⇒ Object

Returns the value of attribute timezone.



15
16
17
 
# File 'lib/avo/configuration.rb', line 15

def timezone
  @timezone
end

#turbo ⇒ Object 



318
319
320
 
# File 'lib/avo/configuration.rb', line 318

def turbo
  Avo::ExecutionContext.new(target: @turbo).handle
end

#use_stacked_fields ⇒ Object

Returns the value of attribute use_stacked_fields.



61
62
63
 
# File 'lib/avo/configuration.rb', line 61

def use_stacked_fields
  @use_stacked_fields
end

#via_per_page ⇒ Object

Returns the value of attribute via_per_page.



18
19
20
 
# File 'lib/avo/configuration.rb', line 18

def via_per_page
  @via_per_page
end

#view_component_path ⇒ Object

Returns the value of attribute view_component_path.



33
34
35
 
# File 'lib/avo/configuration.rb', line 33

def view_component_path
  @view_component_path
end

Class Method Details

.rtl_locale?(locale = I18n.locale) ⇒ Boolean

Check if the given locale is RTL

Returns:

  • (Boolean) 


346
347
348
 
# File 'lib/avo/configuration.rb', line 346

def self.rtl_locale?(locale = I18n.locale)
  RTL_LOCALES.include?(locale.to_s.split("-").first.downcase)
end

Instance Method Details

#authenticate_with(&block) ⇒ Object 



234
235
236
 
# File 'lib/avo/configuration.rb', line 234

def authenticate_with(&block)
  @authenticate = block if block.present?
end

#authorization_enabled? ⇒ Boolean

Authorization is enabled when: (avo-pro gem is installed) AND (authorization_client is NOT nil)

Returns:

  • (Boolean) 


222
223
224
 
# File 'lib/avo/configuration.rb', line 222

def authorization_enabled?
  @authorization_enabled ||= Avo.plugin_manager.installed?("avo-pro") && !authorization_client.nil?
end

#computed_cache_store ⇒ Object

When not in production we’ll just use the FileStore which is good enough. When running in production we’ll use Rails.cache if it’s not ActiveSupport::Cache::MemoryStore or ActiveSupport::Cache::NullStore. If it’s one of rejected cache stores, we’ll use the FileStore. We decided against the MemoryStore in production because it will not be shared between multiple processes (when using Puma).



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/avo/configuration.rb', line 283

def computed_cache_store
  file_store_instance = ActiveSupport::Cache.lookup_store(:file_store, Rails.root.join("tmp", "cache"))

  -> {
    if Rails.env.production?
      if Rails.cache.class.to_s.in?(production_rejected_cache_stores)
        file_store_instance
      else
        Rails.cache
      end
    else
      file_store_instance
    end
  }
end

#container_width ⇒ Object 



115
116
117
 
# File 'lib/avo/configuration.rb', line 115

def container_width
  @container_width || CONTAINER_WIDTH_DEFAULTS
end

#container_width=(value) ⇒ Object 



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
 
# File 'lib/avo/configuration.rb', line 86

def container_width=(value)
  case value
  when NilClass
    @container_width = nil
  when Symbol
    raise ArgumentError, "Invalid container width: #{value}. Must be one of #{VALID_CONTAINER_WIDTHS}" unless VALID_CONTAINER_WIDTHS.include?(value)
    @container_width = CONTAINER_WIDTH_DEFAULTS.transform_values { value }
  when Hash
    valid_keys = CONTAINER_WIDTH_DEFAULTS.keys + CONTAINER_WIDTH_GROUPS.keys
    invalid_keys = value.keys.reject { |k| valid_keys.include?(k) }
    raise ArgumentError, "Invalid container width keys: #{invalid_keys}. Valid keys: #{valid_keys}" if invalid_keys.any?

    invalid_values = value.values.reject { |v| VALID_CONTAINER_WIDTHS.include?(v) }
    raise ArgumentError, "Invalid container widths: #{invalid_values}" if invalid_values.any?

    # Expand group aliases first
    expanded_aliases = value
      .select { |k, _| CONTAINER_WIDTH_GROUPS.key?(k) }
      .each_with_object({}) do |(alias_key, width), result|
        CONTAINER_WIDTH_GROUPS[alias_key].each { |view| result[view] = width }
      end

    # Specific keys win over group aliases
    specific_keys = value.reject { |k, _| CONTAINER_WIDTH_GROUPS.key?(k) }

    @container_width = CONTAINER_WIDTH_DEFAULTS.merge(expanded_aliases).merge(specific_keys)
  end
end

#current_user_method(&block) ⇒ Object 



226
227
228
 
# File 'lib/avo/configuration.rb', line 226

def current_user_method(&block)
  @current_user = block if block.present?
end

#current_user_method=(method) ⇒ Object 



230
231
232
 
# File 'lib/avo/configuration.rb', line 230

def current_user_method=(method)
  @current_user = method if method.present?
end

#default_locale ⇒ Object 



338
339
340
 
# File 'lib/avo/configuration.rb', line 338

def default_locale
  @locale || I18n.default_locale
end

#default_logger ⇒ Object 



303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/avo/configuration.rb', line 303

def default_logger
  -> {
    file_logger = ActiveSupport::Logger.new(Rails.root.join("log", "avo.log"))

    file_logger.datetime_format = "%Y-%m-%d %H:%M:%S"
    file_logger.formatter = proc do |severity, time, progname, msg|
      "[Avo->] #{time}: #{msg}\n".tap do |i|
        puts i
      end
    end

    file_logger
  }
end

#default_turbo ⇒ Object 



326
327
328
329
330
331
332
 
# File 'lib/avo/configuration.rb', line 326

def default_turbo
  -> do
    {
      instant_click: true
    }
  end
end

#mount_avo_engines= ⇒ Object 



376
377
378
379
380
 
# File 'lib/avo/configuration.rb', line 376

def mount_avo_engines=(...)
  raise "'mount_avo_engines' option is now obsolete. \n" \
    "Please refer to the upgrade guide for details on the new mounting point: \n" \
    "https://docs.avohq.io/3.0/upgrade.html#Avo's%20mounting%20point%20update"
end

#namespace ⇒ Object 



246
247
248
249
250
251
252
 
# File 'lib/avo/configuration.rb', line 246

def namespace
  if Avo.configuration.root_path.present?
    Avo.configuration.root_path.delete "/"
  else
    root_path.delete "/"
  end
end

#rtl? ⇒ Boolean

Check if the current locale is RTL

Returns:

  • (Boolean) 


351
352
353
 
# File 'lib/avo/configuration.rb', line 351

def rtl?
  self.class.rtl_locale?(I18n.locale)
end

#session_persistence_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


372
373
374
 
# File 'lib/avo/configuration.rb', line 372

def session_persistence_enabled?
  persistence[:driver] == :session
end

#set_context(&block) ⇒ Object 



238
239
240
 
# File 'lib/avo/configuration.rb', line 238

def set_context(&block)
  @context = block if block.present?
end

#set_initial_breadcrumbs(&block) ⇒ Object 



242
243
244
 
# File 'lib/avo/configuration.rb', line 242

def set_initial_breadcrumbs(&block)
  @initial_breadcrumbs = block if block.present?
end

#text_direction ⇒ Object

Returns “rtl” or “ltr” based on current locale



356
357
358
 
# File 'lib/avo/configuration.rb', line 356

def text_direction
  rtl? ? "rtl" : "ltr"
end