Class: Avo::Configuration
- Inherits:
-
Object
- Object
- Avo::Configuration
- Includes:
- ResourceConfiguration
- Defined in:
- lib/avo/configuration.rb,
lib/avo/configuration/resource_configuration.rb
Defined Under Namespace
Modules: ResourceConfiguration Classes: Branding
Instance Attribute Summary collapse
- #app_name ⇒ Object
-
#authenticate ⇒ Object
Returns the value of attribute authenticate.
-
#authorization_client ⇒ Object
Returns the value of attribute authorization_client.
-
#authorization_methods ⇒ Object
Returns the value of attribute authorization_methods.
- #branding ⇒ Object
-
#buttons_on_form_footers ⇒ Object
Returns the value of attribute buttons_on_form_footers.
-
#cache_resource_filters ⇒ Object
Returns the value of attribute cache_resource_filters.
-
#cache_resources_on_index_view ⇒ Object
Returns the value of attribute cache_resources_on_index_view.
- #cache_store ⇒ Object
-
#context ⇒ Object
Returns the value of attribute context.
-
#currency ⇒ Object
Returns the value of attribute currency.
-
#current_user ⇒ Object
Returns the value of attribute current_user.
-
#current_user_resource_name ⇒ Object
Returns the value of attribute current_user_resource_name.
-
#default_url_options ⇒ Object
Returns the value of attribute default_url_options.
-
#default_view_type ⇒ Object
Returns the value of attribute default_view_type.
-
#disabled_features ⇒ Object
Returns the value of attribute disabled_features.
-
#display_breadcrumbs ⇒ Object
Returns the value of attribute display_breadcrumbs.
-
#display_license_request_timeout_error ⇒ Object
Returns the value of attribute display_license_request_timeout_error.
-
#field_wrapper_layout ⇒ Object
Returns the value of attribute field_wrapper_layout.
-
#full_width_container ⇒ Object
Returns the value of attribute full_width_container.
-
#full_width_index_view ⇒ Object
Returns the value of attribute full_width_index_view.
-
#hide_layout_when_printing ⇒ Object
Returns the value of attribute hide_layout_when_printing.
-
#home_path ⇒ Object
Returns the value of attribute home_path.
-
#id_links_to_resource ⇒ Object
Returns the value of attribute id_links_to_resource.
-
#initial_breadcrumbs ⇒ Object
Returns the value of attribute initial_breadcrumbs.
-
#license_key ⇒ Object
Returns the value of attribute license_key.
-
#locale ⇒ Object
Returns the value of attribute locale.
- #logger ⇒ Object
-
#main_menu ⇒ Object
Returns the value of attribute main_menu.
-
#model_resource_mapping ⇒ Object
Returns the value of attribute model_resource_mapping.
-
#mount_avo_engines ⇒ Object
Returns the value of attribute mount_avo_engines.
- #pagination ⇒ Object
-
#per_page ⇒ Object
Returns the value of attribute per_page.
-
#per_page_steps ⇒ Object
Returns the value of attribute per_page_steps.
-
#prefix_path ⇒ Object
Returns the value of attribute prefix_path.
-
#profile_menu ⇒ Object
Returns the value of attribute profile_menu.
-
#raise_error_on_missing_policy ⇒ Object
Returns the value of attribute raise_error_on_missing_policy.
-
#resource_default_view ⇒ Object
Returns the value of attribute resource_default_view.
-
#resource_parent_controller ⇒ Object
Returns the value of attribute resource_parent_controller.
-
#resources ⇒ Object
Returns the value of attribute resources.
- #root_path ⇒ Object
-
#search_debounce ⇒ Object
Returns the value of attribute search_debounce.
-
#sign_out_path_name ⇒ Object
Returns the value of attribute sign_out_path_name.
-
#timezone ⇒ Object
Returns the value of attribute timezone.
- #turbo ⇒ Object
-
#via_per_page ⇒ Object
Returns the value of attribute via_per_page.
-
#view_component_path ⇒ Object
Returns the value of attribute view_component_path.
Instance Method Summary collapse
- #authenticate_with(&block) ⇒ Object
-
#computed_cache_store ⇒ Object
When not in production or test we’ll just use the MemoryStore which is good enough.
- #current_user_method(&block) ⇒ Object
- #current_user_method=(method) ⇒ Object
- #default_logger ⇒ Object
- #default_turbo ⇒ Object
- #feature_enabled?(feature) ⇒ Boolean
-
#initialize ⇒ Configuration
constructor
A new instance of Configuration.
- #license ⇒ Object
- #license=(value) ⇒ Object
- #namespace ⇒ Object
- #set_context(&block) ⇒ Object
- #set_initial_breadcrumbs(&block) ⇒ Object
Methods included from ResourceConfiguration
#resource_controls_on_the_left?, #resource_controls_on_the_right?, #resource_controls_placement, #resource_controls_placement=
Constructor Details
#initialize ⇒ Configuration
Returns a new instance of Configuration.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 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 |
# File 'lib/avo/configuration.rb', line 53 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 {} @authorization_methods = { index: "index?", show: "show?", edit: "edit?", new: "new?", update: "update?", create: "create?", destroy: "destroy?" } @id_links_to_resource = false @full_width_container = false @full_width_index_view = false @cache_resources_on_index_view = Avo::PACKED @cache_resource_filters = false @context = proc {} @initial_breadcrumbs = proc { I18n.t("avo.home").humanize, avo.root_path } @display_breadcrumbs = true @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 @disabled_features = [] @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" @mount_avo_engines = true @cache_store = computed_cache_store @logger = default_logger @turbo = default_turbo @default_url_options = [] @pagination = {} end |
Instance Attribute Details
#app_name ⇒ Object
152 153 154 |
# File 'lib/avo/configuration.rb', line 152 def app_name Avo::ExecutionContext.new(target: @app_name).handle end |
#authenticate ⇒ Object
Returns the value of attribute authenticate.
21 22 23 |
# File 'lib/avo/configuration.rb', line 21 def authenticate @authenticate end |
#authorization_client ⇒ Object
Returns the value of attribute authorization_client.
44 45 46 |
# File 'lib/avo/configuration.rb', line 44 def @authorization_client end |
#authorization_methods ⇒ Object
Returns the value of attribute authorization_methods.
20 21 22 |
# File 'lib/avo/configuration.rb', line 20 def @authorization_methods end |
#branding ⇒ Object
148 149 150 |
# File 'lib/avo/configuration.rb', line 148 def branding Avo::Configuration::Branding.new(**@branding || {}) end |
#buttons_on_form_footers ⇒ Object
Returns the value of attribute buttons_on_form_footers.
39 40 41 |
# File 'lib/avo/configuration.rb', line 39 def @buttons_on_form_footers end |
#cache_resource_filters ⇒ Object
Returns the value of attribute cache_resource_filters.
27 28 29 |
# File 'lib/avo/configuration.rb', line 27 def cache_resource_filters @cache_resource_filters end |
#cache_resources_on_index_view ⇒ Object
Returns the value of attribute cache_resources_on_index_view.
26 27 28 |
# File 'lib/avo/configuration.rb', line 26 def cache_resources_on_index_view @cache_resources_on_index_view end |
#cache_store ⇒ Object
178 179 180 181 182 183 |
# File 'lib/avo/configuration.rb', line 178 def cache_store Avo::ExecutionContext.new( target: @cache_store, production_rejected_cache_stores: %w[ActiveSupport::Cache::MemoryStore ActiveSupport::Cache::NullStore] ).handle 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.
17 18 19 |
# File 'lib/avo/configuration.rb', line 17 def currency @currency end |
#current_user ⇒ Object
Returns the value of attribute current_user.
22 23 24 |
# File 'lib/avo/configuration.rb', line 22 def current_user @current_user end |
#current_user_resource_name ⇒ Object
Returns the value of attribute current_user_resource_name.
36 37 38 |
# File 'lib/avo/configuration.rb', line 36 def current_user_resource_name @current_user_resource_name end |
#default_url_options ⇒ Object
Returns the value of attribute default_url_options.
51 52 53 |
# File 'lib/avo/configuration.rb', line 51 def @default_url_options end |
#default_view_type ⇒ Object
Returns the value of attribute default_view_type.
18 19 20 |
# File 'lib/avo/configuration.rb', line 18 def default_view_type @default_view_type end |
#disabled_features ⇒ Object
Returns the value of attribute disabled_features.
38 39 40 |
# File 'lib/avo/configuration.rb', line 38 def disabled_features @disabled_features end |
#display_breadcrumbs ⇒ Object
Returns the value of attribute display_breadcrumbs.
29 30 31 |
# File 'lib/avo/configuration.rb', line 29 def @display_breadcrumbs end |
#display_license_request_timeout_error ⇒ Object
Returns the value of attribute display_license_request_timeout_error.
35 36 37 |
# File 'lib/avo/configuration.rb', line 35 def display_license_request_timeout_error @display_license_request_timeout_error end |
#field_wrapper_layout ⇒ Object
Returns the value of attribute field_wrapper_layout.
45 46 47 |
# File 'lib/avo/configuration.rb', line 45 def field_wrapper_layout @field_wrapper_layout end |
#full_width_container ⇒ Object
Returns the value of attribute full_width_container.
24 25 26 |
# File 'lib/avo/configuration.rb', line 24 def full_width_container @full_width_container end |
#full_width_index_view ⇒ Object
Returns the value of attribute full_width_index_view.
25 26 27 |
# File 'lib/avo/configuration.rb', line 25 def full_width_index_view @full_width_index_view end |
#hide_layout_when_printing ⇒ Object
Returns the value of attribute hide_layout_when_printing.
30 31 32 |
# File 'lib/avo/configuration.rb', line 30 def hide_layout_when_printing @hide_layout_when_printing end |
#home_path ⇒ Object
Returns the value of attribute home_path.
32 33 34 |
# File 'lib/avo/configuration.rb', line 32 def home_path @home_path end |
#id_links_to_resource ⇒ Object
Returns the value of attribute id_links_to_resource.
23 24 25 |
# File 'lib/avo/configuration.rb', line 23 def id_links_to_resource @id_links_to_resource end |
#initial_breadcrumbs ⇒ Object
Returns the value of attribute initial_breadcrumbs.
31 32 33 |
# File 'lib/avo/configuration.rb', line 31 def @initial_breadcrumbs end |
#license_key ⇒ Object
Returns the value of attribute license_key.
19 20 21 |
# File 'lib/avo/configuration.rb', line 19 def license_key @license_key end |
#locale ⇒ Object
Returns the value of attribute locale.
16 17 18 |
# File 'lib/avo/configuration.rb', line 16 def locale @locale end |
#logger ⇒ Object
205 206 207 |
# File 'lib/avo/configuration.rb', line 205 def logger Avo::ExecutionContext.new(target: @logger).handle end |
#main_menu ⇒ Object
Returns the value of attribute main_menu.
40 41 42 |
# File 'lib/avo/configuration.rb', line 40 def @main_menu end |
#model_resource_mapping ⇒ Object
Returns the value of attribute model_resource_mapping.
42 43 44 |
# File 'lib/avo/configuration.rb', line 42 def model_resource_mapping @model_resource_mapping end |
#mount_avo_engines ⇒ Object
Returns the value of attribute mount_avo_engines.
50 51 52 |
# File 'lib/avo/configuration.rb', line 50 def mount_avo_engines @mount_avo_engines end |
#pagination ⇒ Object
236 237 238 |
# File 'lib/avo/configuration.rb', line 236 def pagination Avo::ExecutionContext.new(target: @pagination).handle end |
#per_page ⇒ Object
Returns the value of attribute per_page.
13 14 15 |
# File 'lib/avo/configuration.rb', line 13 def per_page @per_page end |
#per_page_steps ⇒ Object
Returns the value of attribute per_page_steps.
14 15 16 |
# File 'lib/avo/configuration.rb', line 14 def per_page_steps @per_page_steps end |
#prefix_path ⇒ Object
Returns the value of attribute prefix_path.
48 49 50 |
# File 'lib/avo/configuration.rb', line 48 def prefix_path @prefix_path end |
#profile_menu ⇒ Object
Returns the value of attribute profile_menu.
41 42 43 |
# File 'lib/avo/configuration.rb', line 41 def @profile_menu end |
#raise_error_on_missing_policy ⇒ Object
Returns the value of attribute raise_error_on_missing_policy.
37 38 39 |
# File 'lib/avo/configuration.rb', line 37 def raise_error_on_missing_policy @raise_error_on_missing_policy end |
#resource_default_view ⇒ Object
Returns the value of attribute resource_default_view.
43 44 45 |
# File 'lib/avo/configuration.rb', line 43 def resource_default_view @resource_default_view end |
#resource_parent_controller ⇒ Object
Returns the value of attribute resource_parent_controller.
49 50 51 |
# File 'lib/avo/configuration.rb', line 49 def resource_parent_controller @resource_parent_controller end |
#resources ⇒ Object
Returns the value of attribute resources.
47 48 49 |
# File 'lib/avo/configuration.rb', line 47 def resources @resources end |
#root_path ⇒ Object
138 139 140 141 142 |
# File 'lib/avo/configuration.rb', line 138 def root_path return "" if @root_path === "/" @root_path end |
#search_debounce ⇒ Object
Returns the value of attribute search_debounce.
33 34 35 |
# File 'lib/avo/configuration.rb', line 33 def search_debounce @search_debounce end |
#sign_out_path_name ⇒ Object
Returns the value of attribute sign_out_path_name.
46 47 48 |
# File 'lib/avo/configuration.rb', line 46 def sign_out_path_name @sign_out_path_name end |
#timezone ⇒ Object
Returns the value of attribute timezone.
12 13 14 |
# File 'lib/avo/configuration.rb', line 12 def timezone @timezone end |
#turbo ⇒ Object
224 225 226 |
# File 'lib/avo/configuration.rb', line 224 def turbo Avo::ExecutionContext.new(target: @turbo).handle end |
#via_per_page ⇒ Object
Returns the value of attribute via_per_page.
15 16 17 |
# File 'lib/avo/configuration.rb', line 15 def via_per_page @via_per_page end |
#view_component_path ⇒ Object
Returns the value of attribute view_component_path.
34 35 36 |
# File 'lib/avo/configuration.rb', line 34 def view_component_path @view_component_path end |
Instance Method Details
#authenticate_with(&block) ⇒ Object
118 119 120 |
# File 'lib/avo/configuration.rb', line 118 def authenticate_with(&block) @authenticate = block if block.present? end |
#computed_cache_store ⇒ Object
When not in production or test we’ll just use the MemoryStore 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).
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/avo/configuration.rb', line 189 def computed_cache_store -> { if Rails.env.production? if Rails.cache.class.to_s.in?(production_rejected_cache_stores) ActiveSupport::Cache.lookup_store(:file_store, Rails.root.join("tmp", "cache")) else Rails.cache end elsif Rails.env.test? Rails.cache else ActiveSupport::Cache.lookup_store(:memory_store) end } end |
#current_user_method(&block) ⇒ Object
110 111 112 |
# File 'lib/avo/configuration.rb', line 110 def current_user_method(&block) @current_user = block if block.present? end |
#current_user_method=(method) ⇒ Object
114 115 116 |
# File 'lib/avo/configuration.rb', line 114 def current_user_method=(method) @current_user = method if method.present? end |
#default_logger ⇒ Object
209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/avo/configuration.rb', line 209 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
228 229 230 231 232 233 234 |
# File 'lib/avo/configuration.rb', line 228 def default_turbo -> do { instant_click: true } end end |
#feature_enabled?(feature) ⇒ Boolean
144 145 146 |
# File 'lib/avo/configuration.rb', line 144 def feature_enabled?(feature) !@disabled_features.map(&:to_sym).include?(feature.to_sym) end |
#license ⇒ Object
162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/avo/configuration.rb', line 162 def license gems = Gem::Specification.map {|gem| gem.name} @license ||= if gems.include?("avo-advanced") "advanced" elsif gems.include?("avo-pro") "pro" elsif gems.include?("avo") "community" end end |
#license=(value) ⇒ Object
156 157 158 159 160 |
# File 'lib/avo/configuration.rb', line 156 def license=(value) if Rails.env.development? puts "[Avo DEPRECATION WARNING]: The `config.license` configuration option is no longer supported and will be removed in future versions. Please discontinue its use and solely utilize the `license_key` instead." end end |
#namespace ⇒ Object
130 131 132 133 134 135 136 |
# File 'lib/avo/configuration.rb', line 130 def namespace if Avo.configuration.root_path.present? Avo.configuration.root_path.delete "/" else root_path.delete "/" end end |
#set_context(&block) ⇒ Object
122 123 124 |
# File 'lib/avo/configuration.rb', line 122 def set_context(&block) @context = block if block.present? end |
#set_initial_breadcrumbs(&block) ⇒ Object
126 127 128 |
# File 'lib/avo/configuration.rb', line 126 def (&block) @initial_breadcrumbs = block if block.present? end |