Class: ActiveScaffold::Config::Core

Inherits:
Base show all
Includes:
Bridges::Ancestry::AncestryBridge, Bridges::DatePicker::DatePickerBridge, Bridges::FileColumn::FileColumnBridge, Bridges::PaperTrail::PaperTrailBridge, OrmChecks
Defined in:
lib/active_scaffold/config/core.rb

Overview

to fix the ckeditor bridge problem inherit from full class name

Defined Under Namespace

Classes: UserColumns, UserSettings

Constant Summary collapse

@@plugin_directory = 
File.expand_path(__FILE__).match(%{(^.*)/lib/active_scaffold/config/core.rb})[1]
@@theme = 
:default
true
@@cache_association_options = 
true
@@conditional_get_support = 
false
@@store_user_settings = 
true
@@dhtml_history = 
true
ActiveScaffold::DataStructures::ActionLinks.new
@@ignore_columns = 
ActiveScaffold::DataStructures::Set.new
true
@@timestamped_messages = 
false
@@highlight_messages = 
nil
@@after_config_callbacks = 
[:_configure_sti]

Constants inherited from Base

Base::NO_FORMATS

Instance Attribute Summary collapse

Attributes included from Bridges::FileColumn::FileColumnBridge

#file_column_fields

Attributes inherited from Base

#action_group, #core, #formats, #user_settings_key

Class Method Summary collapse

Instance Method Summary collapse

Methods included from OrmChecks

active_record?, cast, #cast, column_type, columns, columns_hash, content_columns, default_value, mongoid?, quoted_table_name, reflect_on_all_associations, table_name, tableless?, type_for_attribute

Methods included from Bridges::FileColumn::FileColumnBridge

#configure_file_column_field

Methods inherited from Base

#crud_type, inherited, #new_user_settings, #setup_user_setting_key, #user

Methods included from ActiveScaffold::Configurable

#configure

Constructor Details

#initialize(model_id) ⇒ Core

internal usage only below this point

[View source]

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
 
# File 'lib/active_scaffold/config/core.rb', line 161

def initialize(model_id) # rubocop:disable Lint/MissingSuper
  # model_id is the only absolutely required configuration value. it is also not publicly accessible.
  @model_id = model_id
  setup_user_setting_key

  # inherit the actions list directly from the global level
  @actions = self.class.actions.clone

  # create a new default columns datastructure, since it doesn't make sense before now
  attribute_names = _columns.collect { |c| c.name.to_sym }.sort_by(&:to_s)
  association_column_names = _reflect_on_all_associations.collect { |a| a.name.to_sym }
  if defined?(ActiveMongoid) && model < ActiveMongoid::Associations
    association_column_names.concat model.am_relations.keys.map(&:to_sym)
  end
  @columns = ActiveScaffold::DataStructures::Columns.new(model, attribute_names + association_column_names.sort_by(&:to_s))

  # and then, let's remove some columns from the inheritable set.
  content_columns = Set.new(_content_columns.map(&:name))
  @columns.exclude(*self.class.ignore_columns)
  @columns.exclude(*@columns.find_all { |c| c.column && content_columns.exclude?(c.column.name) }.collect(&:name))
  @columns.exclude(*model.reflect_on_all_associations.filter_map { |a| a.foreign_type.to_sym if a.options[:polymorphic] })

  @theme = self.class.theme
  @cache_action_link_urls = self.class.cache_action_link_urls
  @cache_association_options = self.class.cache_association_options
  @conditional_get_support = self.class.conditional_get_support
  @store_user_settings = self.class.
  @sti_create_links = self.class.sti_create_links

  # inherit from the global set of action links
  @action_links = self.class.action_links.clone
  @timestamped_messages = self.class.timestamped_messages
  @highlight_messages = self.class.highlight_messages
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object

configuration routing. we want to route calls named like an activated action to that action’s global or local Config class.

[View source]

234
235
236
 
# File 'lib/active_scaffold/config/core.rb', line 234

def method_missing(name, *args)
  self[name] || super
end

Instance Attribute Details

action links are used by actions to tie together. they appear as links for each record, or general links for the ActiveScaffold.


139
140
141
 
# File 'lib/active_scaffold/config/core.rb', line 139

def action_links
  @action_links
end

#actions ⇒ Object

provides read/write access to the local Actions DataStructure


101
102
103
 
# File 'lib/active_scaffold/config/core.rb', line 101

def actions
  @actions
end

#cache_action_link_urls ⇒ Object

enable caching of action link urls


120
121
122
 
# File 'lib/active_scaffold/config/core.rb', line 120

def cache_action_link_urls
  @cache_action_link_urls
end

#cache_association_options ⇒ Object

enable caching of association options


123
124
125
 
# File 'lib/active_scaffold/config/core.rb', line 123

def cache_association_options
  @cache_association_options
end

#columns ⇒ Object

provides read/write access to the local Columns DataStructure


108
109
110
 
# File 'lib/active_scaffold/config/core.rb', line 108

def columns
  @columns
end

#conditional_get_support ⇒ Object

enable setting ETag and LastModified on responses and using fresh_when/stale? to respond with 304 and avoid rendering views


126
127
128
 
# File 'lib/active_scaffold/config/core.rb', line 126

def conditional_get_support
  @conditional_get_support
end

#highlight_messages ⇒ Object

a hash of string (or array of strings) and highlighter string to highlight words in messages. It will use highlight rails helper


155
156
157
 
# File 'lib/active_scaffold/config/core.rb', line 155

def highlight_messages
  @highlight_messages
end

#label(options = {}) ⇒ Object 


144
145
146
 
# File 'lib/active_scaffold/config/core.rb', line 144

def label(options = {})
  as_(@label, options) || model.model_name.human(options.merge(options[:count].to_i == 1 ? {} : {default: model.name.pluralize}))
end

#model_id ⇒ Object (readonly)

some utility methods


279
280
281
 
# File 'lib/active_scaffold/config/core.rb', line 279

def model_id
  @model_id
end

#sti_children ⇒ Object

STI children models, use an array of model names


149
150
151
 
# File 'lib/active_scaffold/config/core.rb', line 149

def sti_children
  @sti_children
end

#sti_create_links ⇒ Object

lets you specify whether add a create link for each sti child for a specific controller


132
133
134
 
# File 'lib/active_scaffold/config/core.rb', line 132

def sti_create_links
  @sti_create_links
end

#store_user_settings ⇒ Object

enable saving user settings in session (per_page, limit, page, sort, search params)


129
130
131
 
# File 'lib/active_scaffold/config/core.rb', line 129

def 
  @store_user_settings
end

#theme ⇒ Object

lets you override the global ActiveScaffold theme for a specific controller


117
118
119
 
# File 'lib/active_scaffold/config/core.rb', line 117

def theme
  @theme
end

#timestamped_messages ⇒ Object

prefix messages with current timestamp, set the format to display (you can use I18n keys) or true and :short will be used


152
153
154
 
# File 'lib/active_scaffold/config/core.rb', line 152

def timestamped_messages
  @timestamped_messages
end

Class Method Details

.actions=(val) ⇒ Object

[View source]

10
11
12
 
# File 'lib/active_scaffold/config/core.rb', line 10

def self.actions=(val)
  @@actions = ActiveScaffold::DataStructures::Actions.new(*val)
end

.column ⇒ Object

access to default column configuration.

[View source]

60
61
62
 
# File 'lib/active_scaffold/config/core.rb', line 60

def self.column
  ActiveScaffold::DataStructures::Column
end

.config_class(name) ⇒ Object

[View source]

265
266
267
 
# File 'lib/active_scaffold/config/core.rb', line 265

def self.config_class(name)
  "ActiveScaffold::Config::#{name.to_s.camelcase}".constantize if config_class?(name)
end

.config_class?(name) ⇒ Boolean

Returns:

  • (Boolean)
[View source]

269
270
271
 
# File 'lib/active_scaffold/config/core.rb', line 269

def self.config_class?(name)
  ActiveScaffold::Config.const_defined? name.to_s.camelcase
end

.dhtml_history? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

42
43
44
 
# File 'lib/active_scaffold/config/core.rb', line 42

def self.dhtml_history?
  @@dhtml_history ? true : false
end

.freeze ⇒ Object

[View source]

91
92
93
94
95
 
# File 'lib/active_scaffold/config/core.rb', line 91

def self.freeze
  super
  security.freeze
  column.freeze
end

.ignore_columns ⇒ Object

columns that should be ignored for every model. these should be metadata columns like change dates, versions, etc. values in this array may be symbols or strings.

[View source]

66
67
68
 
# File 'lib/active_scaffold/config/core.rb', line 66

def self.ignore_columns
  @@ignore_columns
end

.ignore_columns=(val) ⇒ Object

[View source]

70
71
72
 
# File 'lib/active_scaffold/config/core.rb', line 70

def self.ignore_columns=(val)
  @@ignore_columns = ActiveScaffold::DataStructures::Set.new(*val)
end

.method_missing(name, *args) ⇒ Object

[View source]

261
262
263
 
# File 'lib/active_scaffold/config/core.rb', line 261

def self.method_missing(name, *args)
  config_class(name) || super
end

.respond_to_missing?(name, include_all = false) ⇒ Boolean

Returns:

  • (Boolean)
[View source]

273
274
275
 
# File 'lib/active_scaffold/config/core.rb', line 273

def self.respond_to_missing?(name, include_all = false)
  (config_class?(name) && @@actions.include?(name.to_s.underscore)) || super
end

.security ⇒ Object

access to the permissions configuration. configuration options include:

* current_user_method - what method on the controller returns the current user. default: :current_user
* default_permission - what the default permission is. default: true
[View source]

55
56
57
 
# File 'lib/active_scaffold/config/core.rb', line 55

def self.security
  ActiveScaffold::ActiveRecordPermissions
end

Instance Method Details

#[](action_name) ⇒ Object

[View source]

242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/active_scaffold/config/core.rb', line 242

def [](action_name)
  klass = self.class.config_class(action_name)
  return unless klass

  underscored_name = action_name.to_s.underscore.to_sym
  unless @actions.include? underscored_name
    raise "#{action_name.to_s.camelcase} is not enabled. Please enable it or remove any references in your configuration (e.g. config.#{underscored_name}.columns = [...])."
  end

  @action_configs ||= {}
  @action_configs[underscored_name] ||= klass.new(self)
end

#[]=(action_name, action_config) ⇒ Object

[View source]

255
256
257
258
 
# File 'lib/active_scaffold/config/core.rb', line 255

def []=(action_name, action_config)
  @action_configs ||= {}
  @action_configs[action_name] = action_config
end

#_cache_lazy_values ⇒ Object

To be called before freezing

[View source]

197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/active_scaffold/config/core.rb', line 197

def _cache_lazy_values
  action_links.collection # ensure the collection group exist although it's empty
  action_links.member # ensure the collection group exist although it's empty
  action_links.each(&:name_to_cache) if cache_action_link_urls
  columns.select(&:sortable?).each(&:sort)
  columns.select(&:searchable?).each(&:search_sql)
  actions.each do |action_name|
    action = send(action_name)
    Array(action.class.columns_collections).each { |method| action.send(method) }
  end
end

#_configure_sti ⇒ Object

To be called after your finished configuration

[View source]

210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/active_scaffold/config/core.rb', line 210

def _configure_sti
  return if sti_children.nil?

  column = model.inheritance_column
  if sti_create_links
    columns[column].form_ui ||= :hidden
  else
    columns[column].form_ui ||= :select
    columns[column].options ||= {}
    columns[column].options[:options] = sti_children.collect do |model_name|
      [model_name.to_s.camelize.constantize.model_name.human, model_name.to_s.camelize]
    end
  end
end

#_setup_action(action) ⇒ Object

[View source]

225
226
227
228
229
 
# File 'lib/active_scaffold/config/core.rb', line 225

def _setup_action(action)
  define_singleton_method action do
    self[action]
  end
end

#add_sti_create_links? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

134
135
136
 
# File 'lib/active_scaffold/config/core.rb', line 134

def add_sti_create_links?
  sti_create_links && !sti_children.nil?
end

#build_action_columns(action, columns) ⇒ Object

[View source]

295
296
297
298
299
300
301
302
303
304
 
# File 'lib/active_scaffold/config/core.rb', line 295

def build_action_columns(action, columns)
  action_columns =
    if columns.is_a?(ActiveScaffold::DataStructures::ActionColumns)
      columns.dup
    else
      ActiveScaffold::DataStructures::ActionColumns.new(*columns)
    end
  action_columns.action = action.is_a?(Symbol) ? send(action) : action
  action_columns
end

#inherited_view_paths ⇒ Object

warning - this won’t work as a per-request dynamic attribute in rails 2.0. You’ll need to interact with Controller#generic_view_paths

[View source]

291
292
293
 
# File 'lib/active_scaffold/config/core.rb', line 291

def inherited_view_paths
  @inherited_view_paths ||= []
end

#model ⇒ Object Also known as: active_record_class

[View source]

281
282
283
 
# File 'lib/active_scaffold/config/core.rb', line 281

def model
  @model ||= @model_id.to_s.camelize.constantize
end

#primary_key ⇒ Object

[View source]

286
287
288
 
# File 'lib/active_scaffold/config/core.rb', line 286

def primary_key
  mongoid? ? '_id' : model.primary_key
end

#respond_to_missing?(name, include_all = false) ⇒ Boolean

Returns:

  • (Boolean)
[View source]

238
239
240
 
# File 'lib/active_scaffold/config/core.rb', line 238

def respond_to_missing?(name, include_all = false)
  (self.class.config_class?(name) && @actions.include?(name.to_sym)) || super
end