Class: ActiveScaffold::Config::Core

Inherits:
Base show all
Includes:
OrmChecks
Defined in:
lib/active_scaffold/config/core.rb,
lib/active_scaffold/bridges/file_column/as_file_column_bridge.rb,
lib/active_scaffold/bridges/calendar_date_select/as_cds_bridge.rb

Overview

to fix the ckeditor bridge problem inherit from full class name

Constant Summary

@@plugin_directory =
File.expand_path(__FILE__).match(%{(^.*)/lib/active_scaffold/config/core.rb})[1]
@@frontend =
:default
@@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

Instance Attribute Summary collapse

Attributes inherited from Base

#action_group, #core, #formats, #user

Class Method Summary collapse

Instance Method Summary collapse

Methods included from OrmChecks

#_columns, #_columns_hash, #_content_columns, #_quoted_table_name, #_table_name, #active_record?, #mongoid?, #tableless?

Methods inherited from Base

#crud_type, inherited

Methods included from ActiveScaffold::Configurable

#configure

Constructor Details

#initialize(model_id) ⇒ Core

internal usage only below this point




149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/active_scaffold/config/core.rb', line 149

def initialize(model_id)
  # model_id is the only absolutely required configuration value. it is also not publicly accessible.
  @model_id = model_id

  # 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 = model.reflect_on_all_associations.collect { |a| a.name.to_sym }.sort_by(&:to_s)
  @columns = ActiveScaffold::DataStructures::Columns.new(model, attribute_names + association_column_names)

  # 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.collect { |a| a.foreign_type.to_sym if a.options[:polymorphic] }.compact)

  # inherit the global frontend
  @frontend = self.class.frontend
  @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
   = 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.




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

def method_missing(name, *args)
  @action_configs ||= {}
  titled_name = name.to_s.camelcase
  underscored_name = name.to_s.underscore.to_sym
  klass = "ActiveScaffold::Config::#{titled_name}".constantize rescue nil
  if klass
    if @actions.include? underscored_name
      return @action_configs[underscored_name] ||= klass.new(self)
    else
      raise "#{titled_name} is not enabled. Please enable it or remove any references in your configuration (e.g. config.#{underscored_name}.columns = [...])."
    end
  end
  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.



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

def action_links
  @action_links
end

#actionsObject

provides read/write access to the local Actions DataStructure



90
91
92
# File 'lib/active_scaffold/config/core.rb', line 90

def actions
  @actions
end

enable caching of action link urls



110
111
112
# File 'lib/active_scaffold/config/core.rb', line 110

def cache_action_link_urls
  @cache_action_link_urls
end

#cache_association_optionsObject

enable caching of association options



113
114
115
# File 'lib/active_scaffold/config/core.rb', line 113

def cache_association_options
  @cache_association_options
end

#columnsObject

provides read/write access to the local Columns DataStructure



96
97
98
# File 'lib/active_scaffold/config/core.rb', line 96

def columns
  @columns
end

#conditional_get_supportObject

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



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

def conditional_get_support
  @conditional_get_support
end

#file_column_fieldsObject

Returns the value of attribute file_column_fields



7
8
9
# File 'lib/active_scaffold/bridges/file_column/as_file_column_bridge.rb', line 7

def file_column_fields
  @file_column_fields
end

#frontendObject

lets you override the global ActiveScaffold frontend for a specific controller



104
105
106
# File 'lib/active_scaffold/config/core.rb', line 104

def frontend
  @frontend
end

#highlight_messagesObject

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



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

def highlight_messages
  @highlight_messages
end

#label(options = {}) ⇒ Object



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

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

#model_idObject (readonly)

some utility methods




231
232
233
# File 'lib/active_scaffold/config/core.rb', line 231

def model_id
  @model_id
end

#sti_childrenObject

STI children models, use an array of model names



137
138
139
# File 'lib/active_scaffold/config/core.rb', line 137

def sti_children
  @sti_children
end

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



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

def sti_create_links
  @sti_create_links
end

#store_user_settingsObject

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



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

def 
  
end

#themeObject

lets you override the global ActiveScaffold theme for a specific controller



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

def theme
  @theme
end

#timestamped_messagesObject

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



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

def timestamped_messages
  @timestamped_messages
end

Class Method Details

.actions=(val) ⇒ Object



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

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

.asset_path(filename, frontend = self.frontend) ⇒ Object

must be a class method so the layout doesn't depend on a controller that uses active_scaffold note that this is unaffected by per-controller frontend configuration.



245
246
247
# File 'lib/active_scaffold/config/core.rb', line 245

def self.asset_path(filename, frontend = self.frontend)
  "active_scaffold/#{frontend}/#{filename}"
end

.available_frontendsObject



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

def self.available_frontends
  frontends_dir = File.join(Rails.root, 'vendor', 'plugins', ActiveScaffold::Config::Core.plugin_directory, 'frontends')
  Dir.entries(frontends_dir).reject { |e| e.match(/^\./) } # Get rid of files that start with .
end

.dhtml_history=(val) ⇒ Object

lets you disable the DHTML history



44
45
46
# File 'lib/active_scaffold/config/core.rb', line 44

def self.dhtml_history=(val)
  @@dhtml_history = val
end

.dhtml_history?Boolean

Returns:

  • (Boolean)


47
48
49
# File 'lib/active_scaffold/config/core.rb', line 47

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

.ignore_columnsObject

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.



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

def self.ignore_columns
  @@ignore_columns
end

.ignore_columns=(val) ⇒ Object



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

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

.javascripts(frontend = self.frontend) ⇒ Object

must be a class method so the layout doesn't depend on a controller that uses active_scaffold note that this is unaffected by per-controller frontend configuration.



251
252
253
254
# File 'lib/active_scaffold/config/core.rb', line 251

def self.javascripts(frontend = self.frontend)
  javascript_dir = File.join(Rails.public_path, 'javascripts', asset_path('', frontend))
  Dir.entries(javascript_dir).reject { |e| !e.match(/\.js$/) || (!self.dhtml_history? && e.match('dhtml_history')) }
end

.method_missing(name, *args) ⇒ Object



223
224
225
226
227
# File 'lib/active_scaffold/config/core.rb', line 223

def self.method_missing(name, *args)
  klass = "ActiveScaffold::Config::#{name.to_s.camelcase}".constantize rescue nil
  return klass if @@actions.include?(name.to_s.underscore) && klass
  super
end

.securityObject

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


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

def self.security
  ActiveScaffold::ActiveRecordPermissions
end

Instance Method Details

#_configure_stiObject

To be called after your finished configuration



192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/active_scaffold/config/core.rb', line 192

def _configure_sti
  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

#_load_action_columnsObject

To be called after your finished configuration



183
184
185
186
187
188
189
# File 'lib/active_scaffold/config/core.rb', line 183

def _load_action_columns
  # then, register the column objects
  actions.each do |action_name|
    action = send(action_name)
    action.columns.set_columns(columns) if action.respond_to?(:columns)
  end
end

#add_sti_create_links?Boolean

Returns:

  • (Boolean)


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

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

#configure_file_column_field(field) ⇒ Object



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/active_scaffold/bridges/file_column/as_file_column_bridge.rb', line 27

def configure_file_column_field(field)
  # set list_ui first because it gets its default value from form_ui
  columns[field].list_ui ||= model.field_has_image_version?(field, 'thumb') ? :thumbnail : :download_link_with_filename
  columns[field].form_ui ||= :file_column

  # these 2 parameters are necessary helper attributes for the file column that must be allowed to be set to the model by active scaffold.
  columns[field].params.add "#{field}_temp", "delete_#{field}"

  # set null to false so active_scaffold wont set it to null
  # delete_file_column will take care of deleting a file or not.
  _columns_hash[field.to_s].instance_variable_set('@null', false)

rescue
  false
end

#inherited_view_pathsObject

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



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

def inherited_view_paths
  @inherited_view_paths ||= []
end

#initialize_with_calendar_date_select(model_id) ⇒ Object



3
4
5
6
7
8
9
10
11
12
# File 'lib/active_scaffold/bridges/calendar_date_select/as_cds_bridge.rb', line 3

def initialize_with_calendar_date_select(model_id)
  initialize_without_calendar_date_select(model_id)

  calendar_date_select_fields = _columns.collect { |c| c.name.to_sym if [:date, :datetime].include?(c.type) }.compact
  # check to see if file column was used on the model
  return if calendar_date_select_fields.empty?

  # automatically set the forum_ui to a file column
  calendar_date_select_fields.each { |field| columns[field].form_ui = :calendar_date_select }
end

#initialize_with_file_column(model_id) ⇒ Object



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# File 'lib/active_scaffold/bridges/file_column/as_file_column_bridge.rb', line 8

def initialize_with_file_column(model_id)
  initialize_without_file_column(model_id)

  return unless ActiveScaffold::Bridges::FileColumn::FileColumnHelpers.klass_has_file_column_fields?(model)

  model.send :extend, ActiveScaffold::Bridges::FileColumn::FileColumnHelpers

  # include the "delete" helpers for use with active scaffold, unless they are already included
  model.generate_delete_helpers

  # switch on multipart
  update.multipart = true
  create.multipart = true

  model.file_column_fields.each { |field| configure_file_column_field(field) }
end

#modelObject Also known as: active_record_class



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

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