Module: EffectiveResourcesHelper

Defined in:
app/helpers/effective_resources_helper.rb

Instance Method Summary collapse

Instance Method Details

#edit_effective_wizard?Boolean

Returns:

  • (Boolean)


264
265
266
# File 'app/helpers/effective_resources_helper.rb', line 264

def edit_effective_wizard?
  controller.class.try(:effective_wizard_controller?) && defined?(resource) && resource.draft?
end

#effective_submit(form, options = {}, &block) ⇒ Object

effective_bootstrap



6
7
8
9
10
11
12
13
14
15
16
# File 'app/helpers/effective_resources_helper.rb', line 6

def effective_submit(form, options = {}, &block)
  actions = (controller.respond_to?(:effective_resource) ? controller.class : find_effective_resource).submits
  actions = actions.select { |k, v| v[:default] != true } if options.delete(:defaults) == false
  actions = permitted_resource_actions(form.object, actions)

  submits = actions.map { |name, opts| form.save(name, opts.except(:action, :title, 'data-method') ) }.join.html_safe

  form.submit('', options) do
    (block_given? ? capture(&block) : ''.html_safe) + submits
  end
end

#format_resource_value(value) ⇒ Object



257
258
259
260
261
262
# File 'app/helpers/effective_resources_helper.rb', line 257

def format_resource_value(value)
  @format_resource_tags ||= ActionView::Base.sanitized_allowed_tags.to_a + ['table', 'thead', 'tbody', 'tfoot', 'tr', 'td', 'th']
  @format_resource_atts ||= ActionView::Base.sanitized_allowed_attributes.to_a + ['colspan', 'rowspan']

  simple_format(sanitize(value.to_s, tags: @format_resource_tags, attributes: @format_resource_atts), {}, sanitize: false)
end

#render_if_exists(partial, atts = {}) ⇒ Object



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'app/helpers/effective_resources_helper.rb', line 210

def render_if_exists(partial, atts = {})
  raise('expected a path') unless partial.kind_of?(String)
  raise('path should not include spaces') if partial.include?(' ')

  pieces = partial.to_s.split('/') - [nil, '']

  file = pieces.last
  path = pieces[0..-2].join('/')

  if lookup_context.exists?(file, [path], :partial)
    render(partial, atts)
  else
    Rails.logger.info "Skipped Render (effective_resources) render_if_exists: #{partial}"
    nil
  end
end

#render_resource_actions(resource, atts = {}, &block) ⇒ Object

partial: :dropleft|:glyphicons|string locals: {} render locals you can also pass all action names and true/false such as edit: true, show: false



61
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'app/helpers/effective_resources_helper.rb', line 61

def render_resource_actions(resource, atts = {}, &block)
  return ''.html_safe if resource.blank?

  unless resource.kind_of?(ActiveRecord::Base) || resource.kind_of?(Class) || resource.kind_of?(Array) || resource.class.ancestors.include?(ActiveModel::Model)
    raise 'expected first argument to be an ActiveRecord::Base object or Array of objects'
  end

  raise 'expected attributes to be a Hash' unless atts.kind_of?(Hash)

  btn_class = atts[:btn_class]
  effective_resource = atts[:effective_resource]
  namespace = atts[:controller_namespace] || atts[:namespace]
  locals = atts[:locals] || {}
  partial = atts[:partial]
  spacer_template = locals[:spacer_template]

  effective_resource ||= find_effective_resource(resource)
  namespace ||= (effective_resource.namespace.to_sym if effective_resource.namespace)

  # Assign actions
  # We filter out any actions passed to us that aren't supported
  actions = if atts.key?(:actions)
    {}.tap do |actions|
      atts[:actions].each do |commit, opts|
        actions[commit] = opts if (effective_resource.actions.include?(opts[:action]) || opts[:path]).present?
      end
    end
  else
    (resource.kind_of?(Class) ? effective_resource.resource_klass_actions : effective_resource.resource_actions)
  end

  # Consider only, except, false and proc false
  only = Array(atts[:only]) if atts[:only].present?
  except = Array(atts[:except]) if atts[:except].present?

  actions.select! do |_, opts|
    action = opts[:action]

    if only.present? && !only.include?(action)
      false
    elsif except.present? && except.include?(action)
      false
    elsif atts[action].respond_to?(:call)
      Effective::ResourceExec.new(self, resource).instance_exec(&atts[action])
    else
      atts[action] != false
    end
  end

  # Select Partial
  partial = if partial.kind_of?(Symbol)
    "effective/resource/actions_#{partial}"
  else
    partial.presence || 'effective/resource/actions'
  end

  # Assign Locals
  locals = {
    resource: resource,
    effective_resource: effective_resource,
    format_block: (block if block_given?),
    namespace: namespace,
    actions: actions,
    btn_class: (btn_class || '')
  }.compact.merge(locals)

  if resource.kind_of?(Array)
    render(
      partial: partial,
      formats: [:html],
      collection: resource,
      as: :resource,
      locals: locals.except(:resource),
      spacer_template: spacer_template
    )
  else
    render(partial: partial, formats: [:html], locals: locals)
  end
end

#render_resource_buttons(resource, atts = {}, &block) ⇒ Object



39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'app/helpers/effective_resources_helper.rb', line 39

def render_resource_buttons(resource, atts = {}, &block)
  effective_resource = find_effective_resource
  actions = (controller.respond_to?(:effective_resource) ? controller.class : effective_resource).buttons

  actions = if resource.kind_of?(Class)
    actions.select { |_, v| effective_resource.collection_get_actions.include?(v[:action]) }
  elsif resource.respond_to?(:persisted?) && resource.persisted?
    actions.select { |_, v| effective_resource.member_actions.include?(v[:action]) }
  else
    {}
  end

  render_resource_actions(resource, atts.merge(actions: actions), &block)
end

#render_resource_form(resource, atts = {}) ⇒ Object

When called from /admin/things/new.html.haml this will render ‘admin/things/form’, or ‘things/form’, or ‘thing/form’



142
143
144
145
146
147
148
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
# File 'app/helpers/effective_resources_helper.rb', line 142

def render_resource_form(resource, atts = {})
  unless resource.kind_of?(ActiveRecord::Base) || resource.class.ancestors.include?(ActiveModel::Model)
    raise 'expected first argument to be an ActiveRecord or ActiveModel object'
  end

  raise 'expected attributes to be a Hash' unless atts.kind_of?(Hash)

  effective_resource = (atts.delete(:effective_resource) || find_effective_resource)

  action = atts.delete(:action)
  safe = atts.delete(:safe)
  atts = { :namespace => (effective_resource.namespace.to_sym if effective_resource.namespace), effective_resource.name.to_sym => resource }.compact.merge(atts)

  if lookup_context.template_exists?("form_#{action}", controller._prefixes, :partial)
    return render("form_#{action}", atts)
  end

  if lookup_context.template_exists?('form', controller._prefixes, :partial)
    return render('form', atts)
  end

  effective_resource.view_paths.each do |view_path|
    if lookup_context.template_exists?("form_#{action}", [view_path], :partial)
      return render(view_path + '/' + "form_#{action}", atts)
    end

    if lookup_context.template_exists?('form', [view_path], :partial)
      return render(view_path + '/' + 'form', atts)
    end
  end

  # Will raise the regular error
  return ''.html_safe if safe

  render('form', atts)
end

#render_resource_partial(resource, atts = {}) ⇒ Object Also known as: render_resource

Similar to render_resource_form



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'app/helpers/effective_resources_helper.rb', line 180

def render_resource_partial(resource, atts = {})
  unless resource.kind_of?(ActiveRecord::Base) || resource.class.ancestors.include?(ActiveModel::Model)
    raise 'expected first argument to be an ActiveRecord or ActiveModel object'
  end

  raise 'expected attributes to be a Hash' unless atts.kind_of?(Hash)

  effective_resource = (atts.delete(:effective_resource) || find_effective_resource)

  action = atts.delete(:action)
  safe = atts.delete(:safe)
  atts = { :namespace => (effective_resource.namespace.to_sym if effective_resource.namespace), effective_resource.name.to_sym => resource }.compact.merge(atts)

  if lookup_context.template_exists?(effective_resource.name, controller._prefixes, :partial)
    return render(effective_resource.name, atts)
  end

  effective_resource.view_paths.each do |view_path|
    if lookup_context.template_exists?(effective_resource.name, [view_path], :partial)
      return render(view_path + '/' + effective_resource.name, atts)
    end
  end

  # Will raise the regular error
  return ''.html_safe if safe

  render(resource, atts)
end

#simple_form_submit(form, options = {}, &block) ⇒ Object

effective_form_inputs



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# File 'app/helpers/effective_resources_helper.rb', line 19

def simple_form_submit(form, options = {}, &block)
  actions = (controller.respond_to?(:effective_resource) ? controller.class : find_effective_resource).submits
  actions = permitted_resource_actions(form.object, actions)

  submits = actions.map { |name, opts| form.button(:submit, name, opts.except(:action, :title, 'data-method')) }

  # I think this is a bug. I can't override default button class when passing my own class: variable. it merges them.
  if (btn_class = SimpleForm.button_class).present?
    submits = submits.map { |submit| submit.sub(btn_class, '') }
  end

  submits = submits.join(' ').html_safe

  wrapper_options = { class: 'form-actions' }.merge(options.delete(:wrapper_html) || {})

  (:div, wrapper_options) do
    (block_given? ? capture(&block) : ''.html_safe) + submits
  end
end

#tableize_hash(obj, table: 'table', th: true, sub_table: 'table', sub_th: true, flatten: true) ⇒ Object

Tableize attributes This is used by effective_orders, effective_logging, effective_trash and effective_mergery



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'app/helpers/effective_resources_helper.rb', line 229

def tableize_hash(obj, table: 'table', th: true, sub_table: 'table', sub_th: true, flatten: true)
  case obj
  when Hash
    if flatten && obj[:attributes].kind_of?(Hash)
      obj = obj[:attributes].merge(obj.except(:attributes))
    end

    (:table, class: table.presence) do
      (:tbody) do
        obj.map do |key, value|
          (:tr, class: key.to_param) do
            ((th == true ? :th : :td), key) +
            (:td) { tableize_hash(value, table: sub_table, th: sub_th, sub_table: sub_table, sub_th: sub_th, flatten: flatten) }
          end
        end.join.html_safe
      end
    end
  when Array
    obj.map { |value| tableize_hash(value, table: sub_table, th: sub_th, sub_table: sub_table, sub_th: sub_th, flatten: flatten) }.join('<br>')
  when Symbol
    ":#{obj}"
  when NilClass
    '-'
  else
    obj.to_s.presence || '""'
  end.html_safe
end

#wizard_card(resource, &block) ⇒ Object



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'app/helpers/effective_resources_helper.rb', line 268

def wizard_card(resource, &block)
  raise('expected a block') unless block_given?
  raise('expected an acts_as_wizard resource') unless resource.class.respond_to?(:acts_as_wizard?)

  step = resource.render_step
  raise('expected a render_step') unless step.present?

  title = resource.wizard_step_title(step)
  raise("expected a title for step #{step}") unless title.present?

  link = if edit_effective_wizard? && resource.can_visit_step?(step)
    link_to('Edit', wizard_path(step), title: "Edit #{title}")
  end

  (:div, class: 'card') do
    (:div, class: 'card-body yo') do
      (:div, class: 'row') do
        (:div, class: 'col-sm') do
          (:h5, title, class: 'card-title')
        end +
        (:div, class: 'col-sm-auto text-right') do
          (link || '')
        end
      end + capture(&block)
    end
  end
end