Class: AdminIt::Resource

Inherits:
Object
  • Object
show all
Extended by:
ExtendIt::Class, ExtendIt::Dsl
Includes:
FieldsHolder, FiltersHolder, ExtendIt::Asserts, ExtendIt::Callbacks
Defined in:
lib/admin_it/resource.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, entity_class = nil, menu: true, destroyable: true, auto_filters: true) ⇒ Resource

Returns a new instance of Resource.



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
 
# File 'lib/admin_it/resource.rb', line 62

def initialize(
  name,
  entity_class = nil,
  menu: true,
  destroyable: true,
  auto_filters: true
)
  assert_symbol(:name)

  @name, @entity_class = name, entity_class
  if @entity_class.nil?
    begin
      @entity_class = Object.const_get(name.to_s.camelize) # !PORTABLE
    rescue NameError
      fail ArgumentError, "Can't find entity class for #{name}"
    end
  end

  import_data_module

  run_callbacks :initialize do
    @fields = Hash[default_fields.map { |f| [f.field_name, f] }]

    @filters =
      if auto_filters
        Hash[default_filters.map { |f| [f.filter_name, f] }]
      else
        {}
      end

    @contexts = Hash[default_contexts.map { |c| [c.context_name, c] }]

    @menu = menu == true
    @destroyable = destroyable == true
    @plural = name.to_s.pluralize # !POTABLE
    @default_context = nil
  end
end

Instance Attribute Details

#entity_class ⇒ Object (readonly)

Returns the value of attribute entity_class.



54
55
56
 
# File 'lib/admin_it/resource.rb', line 54

def entity_class
  @entity_class
end

#menu ⇒ Object (readonly)

Returns the value of attribute menu.



54
55
56
 
# File 'lib/admin_it/resource.rb', line 54

def menu
  @menu
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



54
55
56
 
# File 'lib/admin_it/resource.rb', line 54

def name
  @name
end

#plural ⇒ Object (readonly)

Returns the value of attribute plural.



54
55
56
 
# File 'lib/admin_it/resource.rb', line 54

def plural
  @plural
end

Class Method Details

.call_inherited(method_name, *args, base_first: false, &block) ⇒ Object Originally defined in module ExtendIt::Class

.class_attr_reader(*attrs) ⇒ Object Originally defined in module ExtendIt::Class

.dsl_accessor(*names, default: nil, &setter) ⇒ Object Originally defined in module ExtendIt::Dsl

.dsl_block(*names) ⇒ Object Originally defined in module ExtendIt::Dsl

.dsl_boolean(*names, default: true) ⇒ Object Originally defined in module ExtendIt::Dsl

.dsl_use_hash(hash_name) ⇒ Object Originally defined in module ExtendIt::Dsl

.inherited_class_reader(*names) ⇒ Object Originally defined in module ExtendIt::Class

Instance Method Details

#[](name) ⇒ Object 



113
114
115
116
 
# File 'lib/admin_it/resource.rb', line 113

def [](name)
  assert_symbol(:name)
  @contexts[name]
end

#collection(&block) ⇒ Object 



150
151
152
153
154
155
 
# File 'lib/admin_it/resource.rb', line 150

def collection(&block)
  return unless block_given?
  contexts.select { |c| c.collection? }.each do |c|
    c.instance_eval(&block)
  end
end

#collection_path ⇒ Object 



189
190
191
 
# File 'lib/admin_it/resource.rb', line 189

def collection_path
  AdminIt::Engine.routes.url_helpers.send("#{plural}_path")
end

#collections ⇒ Object 



197
198
199
 
# File 'lib/admin_it/resource.rb', line 197

def collections
  contexts.select { |c| c.collection? }
end

#context(*names, context_class: nil, &block) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/admin_it/resource.rb', line 118

def context(*names, context_class: nil, &block)
  names.ensure_symbols.each do |name|
    if @contexts.key?(name)
      context = @contexts[name]
    else
      if context_class.nil? || !context_class <= Context
        context_class = Context
      end
      context = @contexts[name] = context_class.create(name, entity_class)
    end
    context.instance_eval(&block) if block_given?
  end
end

#contexts ⇒ Object 



132
133
134
 
# File 'lib/admin_it/resource.rb', line 132

def contexts
  @contexts.values
end

#contexts_names ⇒ Object 



177
178
179
 
# File 'lib/admin_it/resource.rb', line 177

def contexts_names
  @contexts.map(&:context_name)
end

#default_context(value = nil) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/admin_it/resource.rb', line 164

def default_context(value = nil)
  if value.nil?
    return @default_context unless @default_context.nil?
    if collections.size > 0
      @default_context = collections.first.context_name
    elsif singles.size > 0
      @default_context = singles.first.context_name
    end
  else
    @default_context = @contexts.keys.include?(value) ? value : default_context
  end
end

#define_controller ⇒ Object 



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
 
# File 'lib/admin_it/resource.rb', line 205

def define_controller
  c_name = "#{name.to_s.camelize}Controller" # !PORTABLE
  resource = self
  c_class = Class.new(AdminIt.config.controller) do
    @resource = resource
    include AdminIt::Controller

    resource.contexts.each do |_context|
      define_method(_context.context_name) { load_context(_context) }

      if _context < SavableSingleContext
        define_method _context.save_action do
          load_context(_context) { context.save_entity }
        end
      end
    end

    if resource.destroyable?
      define_method :destroy do
        load_context(resource[:show]) { context.destroy_entity }
      end
    end
  end
  AdminIt.const_set(c_name, c_class)
  contexts.each { |c| c.controller_class = c_class }
end

#destroyable? ⇒ Boolean

Returns:

  • (Boolean) 


185
186
187
 
# File 'lib/admin_it/resource.rb', line 185

def destroyable?
  @destroyable
end

#display_name ⇒ Object 



181
182
183
 
# File 'lib/admin_it/resource.rb', line 181

def display_name
  plural.split('_').map { |s| s.capitalize }.join(' ')
end

#field(*names, field_class: nil, &block) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/admin_it/resource.rb', line 101

def field(*names, field_class: nil, &block)
  names.ensure_symbols.each do |name|
    if @fields.key?(name)
      field = @fields[name]
    else
      field_class = Field if field_class.nil? || !field_class <= Field
      field = @fields[name] = field_class.create(name, entity_class)
    end
    field.instance_eval(&block) if block_given?
  end
end

#fields(scope: :visible) ⇒ Object Originally defined in module FieldsHolder

#filter(name, filter_class: nil, &block) ⇒ Object 



138
139
140
141
142
143
144
145
146
 
# File 'lib/admin_it/resource.rb', line 138

def filter(name, filter_class: nil, &block)
  assert_symbol(:name)
  filter = @filters[name]
  if filter.nil?
    filter_class = Filter if filter_class.nil? || !filter_class <= Filter
    filter = @filters[name] = filter_class.create(name, self)
  end
  filter.instance_eval(&block) if block_given?
end

#filters(scope: :all) ⇒ Object Originally defined in module FiltersHolder

#hide_fields(*names) ⇒ Object Originally defined in module FieldsHolder

#run_callbacks(*names, arguments: [], original_context: false) ⇒ Object Originally defined in module ExtendIt::Callbacks

#show_fields(*names) ⇒ Object Originally defined in module FieldsHolder

#single(&block) ⇒ Object 



157
158
159
160
161
162
 
# File 'lib/admin_it/resource.rb', line 157

def single(&block)
  return unless block_given?
  contexts.select { |c| c.single? }.each do |c|
    c.instance_eval(&block)
  end
end

#single_path(entity) ⇒ Object 



193
194
195
 
# File 'lib/admin_it/resource.rb', line 193

def single_path(entity)
  AdminIt::Engine.routes.url_helpers.send("#{name}_path", entity)
end

#singles ⇒ Object 



201
202
203
 
# File 'lib/admin_it/resource.rb', line 201

def singles
  contexts.select { |c| c.single? }
end