Module: AdminCore

Defined in:
lib/admin_core.rb,
lib/admin_core/engine.rb,
lib/admin_core/errors.rb,
lib/admin_core/version.rb,
lib/admin_core/configuration.rb,
lib/admin_core/rspec/matchers.rb,
lib/admin_core/base_controller.rb,
lib/admin_core/resource_router.rb,
lib/admin_core/resource_search.rb,
lib/admin_core/resource_page/new.rb,
lib/admin_core/resource_page/base.rb,
lib/admin_core/resource_page/edit.rb,
lib/admin_core/resource_page/show.rb,
lib/admin_core/resource_field/base.rb,
lib/admin_core/resource_field/date.rb,
lib/admin_core/resource_field/enum.rb,
lib/admin_core/resource_field/text.rb,
lib/admin_core/resource_page/index.rb,
lib/admin_core/resource_filter/base.rb,
lib/admin_core/base_resource_manager.rb,
lib/admin_core/resource_field/number.rb,
lib/admin_core/resource_field/string.rb,
lib/admin_core/resource_field/boolean.rb,
lib/admin_core/resource_field_builder.rb,
lib/admin_core/resource_filter/number.rb,
lib/admin_core/resource_filter/string.rb,
lib/admin_core/resource_filter/boolean.rb,
lib/admin_core/resource_filter_builder.rb,
lib/admin_core/resource_field/date_time.rb,
lib/admin_core/resource_manager/convert.rb,
lib/admin_core/view_object/sidebar_link.rb,
lib/admin_core/resource_field/belongs_to.rb,
lib/admin_core/view_object/sidebar_title.rb,
lib/admin_core/resource_manager/buildable.rb,
lib/admin_core/resource_manager/permission.rb,
lib/admin_core/resource_manager/searchable.rb,
lib/admin_core/view_object/sidebar_dropdown.rb,
lib/generators/admin_core/install_generator.rb,
lib/admin_core/resource_manager/has_many_fields.rb,
lib/admin_core/rspec/resource_field_spec_helper.rb,
lib/admin_core/view_object/sidebar_resource_link.rb,
lib/generators/admin_core/resource_manager_generator.rb

Defined Under Namespace

Modules: Generators, RSpec, ResourceField, ResourceFilter, ResourceManager, ResourcePage, Version, ViewObject Classes: BaseController, BaseResourceManager, Configuration, Engine, Error, InvalidResourceFieldDefinition, ResourceFieldAlreadyRegistered, ResourceFieldBuilder, ResourceFieldNotFound, ResourceFilterAlreadyRegistered, ResourceFilterBuilder, ResourceFilterNotFound, ResourceManagerAlreadyRegistered, ResourceRouter, ResourceSearch

Class Method Summary collapse

Class Method Details

.config ⇒ AdminCore::Configuration

Returns:



4
5
6
 
# File 'lib/admin_core.rb', line 4

def config
  @configuration ||= AdminCore::Configuration.new
end

.configure {|AdminCore::Configuration| ... } ⇒ Object

Examples:

AdminCore.configure do |config|
  config.route_name_prefix = "admin_core"
end

Yields:



13
14
15
 
# File 'lib/admin_core.rb', line 13

def configure
  yield config if block_given?
end

.register_resource_field(field_class) ⇒ Object

Parameters:

Raises:



32
33
34
35
36
37
 
# File 'lib/admin_core.rb', line 32

def register_resource_field(field_class)
  if resource_field_map.key?(field_class.type)
    raise AdminCore::ResourceFieldAlreadyRegistered, field_class.type
  end
  resource_field_map[field_class.type] = field_class
end

.register_resource_filter(filter_class) ⇒ Object

Parameters:

Raises:



49
50
51
52
53
54
 
# File 'lib/admin_core.rb', line 49

def register_resource_filter(filter_class)
  if resource_filter_map.key?(filter_class.type)
    raise AdminCore::ResourceFilterAlreadyRegistered, filter_class.type
  end
  resource_filter_map[filter_class.type] = filter_class
end

.register_resource_manager(manager_class) ⇒ Object

Parameters:



18
19
20
21
22
23
 
# File 'lib/admin_core.rb', line 18

def register_resource_manager(manager_class)
  if resource_managers.include?(manager_class)
    raise AdminCore::ResourceManagerAlreadyRegistered, manager_class.resource_name
  end
  resource_managers.push(manager_class)
end

.resolve_resource_field(type) ⇒ Class

Parameters:

Returns:

Raises:



42
43
44
45
 
# File 'lib/admin_core.rb', line 42

def resolve_resource_field(type)
  raise AdminCore::ResourceFieldNotFound, type unless resource_field_map.key?(type)
  resource_field_map[type]
end

.resolve_resource_filter(type) ⇒ Class

Parameters:

Returns:

Raises:



59
60
61
62
 
# File 'lib/admin_core.rb', line 59

def resolve_resource_filter(type)
  raise AdminCore::ResourceFilterNotFound, type unless resource_filter_map.key?(type)
  resource_filter_map[type]
end

.resource_managers ⇒ Array<Class>

Returns:



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

def resource_managers
  @resource_managers ||= []
end