Module: Avo
- Extended by:
- ActiveSupport::LazyLoadHooks
- Defined in:
- lib/avo/view_inquirer.rb,
lib/avo.rb,
lib/avo/engine.rb,
lib/avo/plugin.rb,
lib/avo/version.rb,
lib/avo/base_action.rb,
lib/avo/test_helpers.rb,
lib/avo/asset_manager.rb,
lib/avo/base_resource.rb,
lib/avo/configuration.rb,
lib/avo/error_manager.rb,
lib/avo/licensing/h_q.rb,
lib/avo/dynamic_router.rb,
lib/avo/loaders/loader.rb,
lib/avo/plugin_manager.rb,
lib/avo/fields/id_field.rb,
lib/avo/dsl/field_parser.rb,
lib/avo/execution_context.rb,
lib/avo/fields/area_field.rb,
lib/avo/fields/base_field.rb,
lib/avo/fields/code_field.rb,
lib/avo/fields/date_field.rb,
lib/avo/fields/file_field.rb,
lib/avo/fields/tags_field.rb,
lib/avo/fields/text_field.rb,
lib/avo/fields/time_field.rb,
lib/avo/fields/trix_field.rb,
lib/avo/licensing/license.rb,
lib/avo/base_resource_tool.rb,
lib/avo/concerns/has_items.rb,
lib/avo/concerns/hydration.rb,
lib/avo/fields/badge_field.rb,
lib/avo/fields/files_field.rb,
lib/avo/tools/tool_manager.rb,
app/helpers/avo/url_helpers.rb,
lib/avo/concerns/is_visible.rb,
lib/avo/concerns/pagination.rb,
lib/avo/fields/hidden_field.rb,
lib/avo/fields/number_field.rb,
lib/avo/fields/select_field.rb,
lib/avo/fields/status_field.rb,
lib/avo/fields/tiptap_field.rb,
lib/avo/filters/base_filter.rb,
lib/avo/filters/text_filter.rb,
lib/avo/concerns/breadcrumbs.rb,
lib/avo/concerns/has_helpers.rb,
lib/avo/fields/boolean_field.rb,
lib/avo/fields/country_field.rb,
lib/avo/fields/field_manager.rb,
lib/avo/fields/has_one_field.rb,
lib/avo/fields/heading_field.rb,
lib/avo/fields/preview_field.rb,
lib/avo/services/uri_service.rb,
lib/avo/concerns/has_controls.rb,
lib/avo/fields/gravatar_field.rb,
lib/avo/fields/has_base_field.rb,
lib/avo/fields/has_many_field.rb,
lib/avo/fields/location_field.rb,
lib/avo/fields/markdown_field.rb,
lib/avo/fields/password_field.rb,
lib/avo/fields/textarea_field.rb,
lib/avo/filters/select_filter.rb,
lib/avo/licensing/nil_license.rb,
lib/avo/licensing/pro_license.rb,
lib/avo/loaders/fields_loader.rb,
lib/avo/loaders/scopes_loader.rb,
lib/avo/prefixed_test_helpers.rb,
lib/avo/concerns/has_item_type.rb,
lib/avo/concerns/visible_items.rb,
lib/avo/fields/date_time_field.rb,
lib/avo/fields/key_value_field.rb,
lib/avo/filters/boolean_filter.rb,
lib/avo/grid_fields/body_field.rb,
lib/avo/grid_fields/grid_field.rb,
lib/avo/loaders/actions_loader.rb,
lib/avo/loaders/filters_loader.rb,
lib/avo/fields/belongs_to_field.rb,
lib/avo/grid_fields/title_field.rb,
app/helpers/avo/resources_helper.rb,
lib/avo/concerns/has_description.rb,
lib/avo/concerns/request_methods.rb,
lib/avo/concerns/is_resource_item.rb,
lib/avo/fields/progress_bar_field.rb,
lib/avo/grid_fields/preview_field.rb,
lib/avo/licensing/license_manager.rb,
app/helpers/avo/application_helper.rb,
lib/avo/concerns/can_replace_items.rb,
lib/avo/fields/boolean_group_field.rb,
lib/avo/resources/resource_manager.rb,
app/controllers/avo/base_controller.rb,
app/controllers/avo/home_controller.rb,
lib/avo/fields/concerns/has_default.rb,
lib/avo/fields/concerns/is_disabled.rb,
lib/avo/fields/concerns/is_readonly.rb,
lib/avo/fields/concerns/is_required.rb,
lib/avo/fields/concerns/reload_icon.rb,
lib/avo/fields/external_image_field.rb,
lib/avo/licensing/community_license.rb,
lib/avo/services/encryption_service.rb,
app/controllers/avo/debug_controller.rb,
lib/avo/concerns/borrow_items_holder.rb,
lib/avo/fields/concerns/use_resource.rb,
app/controllers/avo/charts_controller.rb,
app/controllers/avo/search_controller.rb,
lib/avo/fields/concerns/frame_loading.rb,
lib/avo/fields/concerns/is_searchable.rb,
app/controllers/avo/actions_controller.rb,
app/controllers/avo/private_controller.rb,
lib/avo/fields/concerns/has_field_name.rb,
lib/avo/fields/concerns/linkable_title.rb,
lib/avo/filters/multiple_select_filter.rb,
lib/avo/resources/controls/back_button.rb,
lib/avo/resources/controls/edit_button.rb,
lib/avo/resources/controls/save_button.rb,
lib/avo/resources/controls/show_button.rb,
lib/avo/services/authorization_service.rb,
lib/avo/resources/controls/actions_list.rb,
lib/avo/resources/controls/base_control.rb,
app/controllers/avo/resources_controller.rb,
lib/avo/concerns/filters_session_handler.rb,
lib/avo/resources/controls/attach_button.rb,
lib/avo/resources/controls/create_button.rb,
lib/avo/resources/controls/delete_button.rb,
lib/avo/resources/controls/detach_button.rb,
lib/avo/concerns/model_class_constantized.rb,
lib/avo/resources/controls/order_controls.rb,
app/controllers/avo/application_controller.rb,
app/controllers/avo/attachments_controller.rb,
lib/avo/fields/concerns/file_authorization.rb,
lib/avo/fields/concerns/handles_field_args.rb,
app/controllers/avo/associations_controller.rb,
app/helpers/avo/turbo_stream_actions_helper.rb,
lib/avo/concerns/checks_assoc_authorization.rb,
lib/avo/concerns/visible_in_different_views.rb,
lib/avo/fields/concerns/has_html_attributes.rb,
lib/avo/fields/concerns/use_view_components.rb,
app/controllers/concerns/avo/initializes_avo.rb,
lib/avo/configuration/resource_configuration.rb,
lib/avo/fields/has_and_belongs_to_many_field.rb,
app/components/avo/fields/concerns/item_labels.rb,
app/components/avo/index/resource_map_component.rb,
lib/avo/concerns/has_action_stimulus_controllers.rb,
lib/avo/fields/field_extensions/has_include_blank.rb,
lib/avo/concerns/has_resource_stimulus_controllers.rb
Overview
This concern helps us figure out what kind of items (field, tool, tab_group, or panel) have been passed to the resource or action.
Defined Under Namespace
Modules: ApplicationHelper, Concerns, Dsl, Fields, Filters, GridFields, Index, InitializesAvo, Licensing, Loaders, PrefixedTestHelpers, Resources, ResourcesHelper, Services, TestHelpers, Tools, TurboStreamActionsHelper, UrlHelpers
Classes: ActionsComponent, ActionsController, AlertComponent, ApplicationController, AssetManager, AssociationsController, AttachmentsController, BaseAction, BaseComponent, BaseController, BaseResource, BaseResourceTool, BlankFieldComponent, ButtonComponent, ChartsController, Configuration, Current, DebugController, DeprecatedAPIError, DividerComponent, DynamicRouter, EmptyStateComponent, Engine, ErrorManager, ExecutionContext, FieldWrapperComponent, FiltersComponent, FlashAlertsComponent, HomeController, ItemGrapher, LicenseInvalidError, LicenseVerificationTemperedError, LoadingComponent, MissingGemError, MissingResourceError, ModalComponent, NoPolicyError, NotAuthorizedError, PaginatorComponent, PanelComponent, PanelNameComponent, Plugin, PluginManager, PrivateController, ProfileItemComponent, ReferrerParamsComponent, Reloader, ResourceComponent, ResourceSidebarComponent, ResourcesController, RowComponent, SearchController, SidebarComponent, SidebarProfileComponent, SvgFinder, TabGroupComponent, TabSwitcherComponent, TurboFrameWrapperComponent, ViewInquirer
Constant Summary
collapse
- ROOT_PATH =
Pathname.new(File.join(__dir__, ".."))
- IN_DEVELOPMENT =
ENV["AVO_IN_DEVELOPMENT"] == "1"
- PACKED =
!IN_DEVELOPMENT
- COOKIES_KEY =
"avo"
- ACTIONS_TURBO_FRAME_ID =
:actions_show
- ACTIONS_BACKGROUND_FRAME =
:actions_background
- VERSION =
"3.7.4"
Class Attribute Summary collapse
Class Method Summary
collapse
Class Attribute Details
.cache_store ⇒ Object
Returns the value of attribute cache_store.
57
58
59
|
# File 'lib/avo.rb', line 57
def cache_store
@cache_store
end
|
.field_manager ⇒ Object
Returns the value of attribute field_manager.
58
59
60
|
# File 'lib/avo.rb', line 58
def field_manager
@field_manager
end
|
.logger ⇒ Object
Returns the value of attribute logger.
56
57
58
|
# File 'lib/avo.rb', line 56
def logger
@logger
end
|
Class Method Details
.app_status ⇒ Object
111
112
113
|
# File 'lib/avo.rb', line 111
def app_status
license.valid?
end
|
.asset_manager ⇒ Object
27
28
29
|
# File 'lib/avo/asset_manager.rb', line 27
def self.asset_manager
@manager ||= AssetManager.new
end
|
.avo_dynamic_filters_installed? ⇒ Boolean
115
116
117
|
# File 'lib/avo.rb', line 115
def avo_dynamic_filters_installed?
defined?(Avo::DynamicFilters).present?
end
|
.boot ⇒ Object
Runs when the app boots up
.configuration ⇒ Object
241
242
243
|
# File 'lib/avo/configuration.rb', line 241
def self.configuration
@configuration ||= Configuration.new
end
|
.configuration=(config) ⇒ Object
245
246
247
|
# File 'lib/avo/configuration.rb', line 245
def self.configuration=(config)
@configuration = config
end
|
249
250
251
|
# File 'lib/avo/configuration.rb', line 249
def self.configure
yield configuration
end
|
.eager_load_actions ⇒ Object
146
147
148
|
# File 'lib/avo.rb', line 146
def eager_load_actions
Rails.autoloaders.main.eager_load_namespace(Avo::Actions) if defined?(Avo::Actions)
end
|
142
143
144
|
# File 'lib/avo.rb', line 142
def
[:pro, :advanced, :menu, :dynamic_filters, :dashboards, :enterprise, :audits]
end
|
.has_main_menu? ⇒ Boolean
119
120
121
122
123
124
|
# File 'lib/avo.rb', line 119
def has_main_menu?
return false if Avo.license.lacks_with_trial(:menu_editor)
return false if Avo.configuration.main_menu.nil?
true
end
|
126
127
128
129
130
131
|
# File 'lib/avo.rb', line 126
def
return false if Avo.license.lacks_with_trial(:menu_editor)
return false if Avo.configuration..nil?
true
end
|
.main_menu ⇒ Object
93
94
95
96
97
98
99
100
|
# File 'lib/avo.rb', line 93
def main_menu
return unless Avo.plugin_manager.installed?("avo-menu")
return Avo::Menu::Builder.new.build unless has_main_menu?
Avo::Menu::Builder.(&Avo.configuration.main_menu)
end
|
.mount_engines ⇒ Object
134
135
136
137
138
139
140
|
# File 'lib/avo.rb', line 134
def mount_engines
-> {
mount Avo::DynamicFilters::Engine, at: "/avo-dynamic_filters" if defined?(Avo::DynamicFilters::Engine)
mount Avo::Dashboards::Engine, at: "/dashboards" if defined?(Avo::Dashboards::Engine)
mount Avo::Pro::Engine, at: "/avo-pro" if defined?(Avo::Pro::Engine)
}
end
|
.mount_path ⇒ Object
89
90
91
|
# File 'lib/avo.rb', line 89
def mount_path
Avo::Engine.routes.find_script_name({})
end
|
.plugin_manager ⇒ Object
61
62
63
|
# File 'lib/avo/plugin_manager.rb', line 61
def self.plugin_manager
@plugin_manager ||= PluginManager.new
end
|
102
103
104
105
106
107
108
109
|
# File 'lib/avo.rb', line 102
def
return unless Avo.plugin_manager.installed?("avo-menu")
return Avo::Menu::Builder.new.build unless
Avo::Menu::Builder.(&Avo.configuration.)
end
|
.root_path(paths: [], query: {}, **args) ⇒ Object
Generate a dynamic root path using the URIService
82
83
84
85
86
87
|
# File 'lib/avo.rb', line 82
def root_path(paths: [], query: {}, **args)
Avo::Services::URIService.parse(Avo::Current.view_context.avo.root_url.to_s)
.append_paths(paths)
.append_query(query)
.to_s
end
|