Class: ActiveScaffold::DataStructures::ActionLink

Inherits:
Object
  • Object
show all
Defined in:
lib/active_scaffold/data_structures/action_link.rb

Direct Known Subclasses

FilterOption

Constant Summary collapse

NO_OPTIONS = 
{}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action, options = {}) ⇒ ActionLink

provides a quick way to set any property of the object from a hash



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 6

def initialize(action, options = {})
  # set defaults
  @action = action
  @label = action
  @confirm = false
  @type = :collection
  @method = :get
  @crud_type =
    case action&.to_sym
    when :destroy then :delete
    when :create, :new then :create
    when :update, :edit then :update
    else :read
    end
  @column = nil
  @image = nil
  @controller = nil
  @parameters = nil
  @dynamic_parameters = nil
  @html_options = nil
  @weight = 0
  self.inline = true

  # apply quick properties
  options.each_pair do |k, v|
    setter = "#{k}="
    send(setter, v) if respond_to? setter
  end
  self.toggle = self.action&.to_sym == :index && !position && (parameters.present? || dynamic_parameters) unless options.include? :toggle
end

Instance Attribute Details

#action ⇒ Object

the action-path for this link. what page to request? this is required!



46
47
48
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 46

def action
  @action
end

#column ⇒ Object

nested action_links are referencing a column



230
231
232
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 230

def column
  @column
end

#confirm(label = '') ⇒ Object 



100
101
102
103
104
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 100

def confirm(label = '')
  return @confirm if !confirm? || @confirm.is_a?(String)

  ActiveScaffold::Registry.cache(:translations, @confirm) { as_(@confirm) } % {label: label}
end

#controller ⇒ Object 



51
52
53
54
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 51

def controller
  @controller = @controller.call if @controller.is_a?(Proc)
  @controller
end

#controller_actions ⇒ Object

for links in singular associations, copied from column.actions_for_association_links, excluding actions not available in association’s controller



242
243
244
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 242

def controller_actions
  @controller_actions
end

#crud_type ⇒ Object

the crud type of the (eventual?) action. different than :method, because this crud action may not be imminent. this is used to determine record-level authorization (e.g. record.authorized_for?(crud_type: link.crud_type). options are :create, :read, :update, and :delete



153
154
155
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 153

def crud_type
  @crud_type
end

#dynamic_parameters ⇒ Object

a block for dynamic_parameters



75
76
77
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 75

def dynamic_parameters
  @dynamic_parameters
end

#html_options ⇒ Object 



223
224
225
226
227
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 223

def html_options
  return @html_options || NO_OPTIONS if frozen?

  @html_options ||= NO_OPTIONS.dup
end

#ignore_method ⇒ Object

what method to call on the controller to see if this action_link should be visible if method return true, link won’t be displayed



148
149
150
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 148

def ignore_method
  @ignore_method
end

#image ⇒ Object

image to use ‘arrow.png’, size: ‘16x16’



95
96
97
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 95

def image
  @image
end

#keep_open=(value) ⇒ Object (writeonly)

don’t close the panel when another action link is open



233
234
235
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 233

def keep_open=(value)
  @keep_open = value
end

#label(record = nil) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 83

def label(record = nil)
  case @label
  when Symbol
    ActiveScaffold::Registry.cache(:translations, @label) { as_(@label) }
  when Proc
    @label.call(record)
  else
    @label
  end
end

#method ⇒ Object

the RESTful method



78
79
80
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 78

def method
  @method
end

#parameters ⇒ Object 



63
64
65
66
67
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 63

def parameters
  return @parameters || NO_OPTIONS if frozen?

  @parameters ||= NO_OPTIONS.dup
end

#position ⇒ Object 



209
210
211
212
213
214
215
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 209

def position
  return @position unless @position.nil? || @position == true
  return :replace if type == :member
  return :top if type == :collection

  raise "what should the default position be for #{type}?"
end

#prompt(label = '') ⇒ Object 



113
114
115
116
117
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 113

def prompt(label = '')
  return @prompt if !prompt? || @prompt.is_a?(String)

  ActiveScaffold::Registry.cache(:translations, @prompt) { as_(@prompt) } % {label: label}
end

#prompt_required=(value) ⇒ Object (writeonly)

if the prompt is required, empty value or cancel will prevent running the action



124
125
126
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 124

def prompt_required=(value)
  @prompt_required = value
end

#refresh_on_close ⇒ Object

enable it to refresh the parent row when the view is closed



144
145
146
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 144

def refresh_on_close
  @refresh_on_close
end

#security_method ⇒ Object 



135
136
137
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 135

def security_method
  @security_method || "#{action}_authorized?"
end

#toggle ⇒ Object

if active class is added to link when current request matches link enabled automatically for links to index with parameters or dynamic parameters disable when is not needed so current request match check is skipped



72
73
74
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 72

def toggle
  @toggle
end

#type ⇒ Object

what type of link this is. currently supported values are :collection and :member.



218
219
220
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 218

def type
  @type
end

#weight ⇒ Object

the weight for this link in the action links collection, it will be used to sort the collection



43
44
45
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 43

def weight
  @weight
end

Instance Method Details

#confirm? ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 106

def confirm?
  @confirm.present?
end

#freeze ⇒ Object 



262
263
264
265
266
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 262

def freeze
  # force generating cache_key, except for column's link without action, or polymorphic associations
  name_to_cache if action && !column&.association&.polymorphic?
  super
end

#initialize_copy(action_link) ⇒ Object 



37
38
39
40
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 37

def initialize_copy(action_link)
  self.parameters = parameters.clone if action_link.instance_variable_get(:@parameters)
  self.html_options = html_options.clone if action_link.instance_variable_get(:@html_options)
end

#inline=(val) ⇒ Object

an “inline” link is inserted into the existing page exclusive with popup? and page?



157
158
159
160
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 157

def inline=(val)
  @inline = (val == true)
  self.popup = self.page = false if @inline
end

#inline? ⇒ Boolean

Returns:

  • (Boolean) 


162
163
164
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 162

def inline?
  @inline
end

#keep_open? ⇒ Boolean

Returns:

  • (Boolean) 


235
236
237
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 235

def keep_open?
  @keep_open
end

#name_to_cache ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 249

def name_to_cache
  return @name_to_cache if defined? @name_to_cache

  [
    controller || 'self',
    type,
    action,
    *parameters.map { |k, v| "#{k}=#{v.is_a?(Array) ? v.join(',') : v}" }
  ].compact.join('_').tap do |name_to_cache|
    @name_to_cache = name_to_cache unless frozen?
  end
end

#nested_link? ⇒ Boolean

indicates that this a nested_link

Returns:

  • (Boolean) 


245
246
247
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 245

def nested_link?
  @column || parameters&.dig(:named_scope)
end

#page=(val) ⇒ Object

a “page” link displays by reloading the current page exclusive with inline? and popup?



185
186
187
188
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 185

def page=(val)
  @page = (val == true)
  self.inline = self.popup = false if @page
end

#page? ⇒ Boolean

Returns:

  • (Boolean) 


190
191
192
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 190

def page?
  @page
end

#popup=(val) ⇒ Object

a “popup” link displays in a separate (browser?) window. this will eventually take arguments. exclusive with inline? and page?



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 168

def popup=(val)
  @popup = (val == true)
  return unless @popup

  self.inline = self.page = false

  # the :method parameter doesn't mix with the :popup parameter
  # when/if we start using DHTML popups, we can bring :method back
  self.method = nil
end

#popup? ⇒ Boolean

Returns:

  • (Boolean) 


179
180
181
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 179

def popup?
  @popup
end

#prompt? ⇒ Boolean

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 119

def prompt?
  @prompt.present?
end

#prompt_required? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 126

def prompt_required?
  @prompt_required
end

#security_method_set? ⇒ Boolean

Returns:

  • (Boolean) 


139
140
141
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 139

def security_method_set?
  @security_method.present?
end

#static_controller? ⇒ Boolean

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/active_scaffold/data_structures/action_link.rb', line 56

def static_controller?
  !(@controller.is_a?(Proc) || (@controller == :polymorph))
end