Module: EffectiveDatatablesHelper

Defined in:
app/helpers/effective_datatables_helper.rb

Instance Method Summary collapse

Instance Method Details

#datatable_bulk_actions(datatable) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
 
# File 'app/helpers/effective_datatables_helper.rb', line 76

def datatable_bulk_actions(datatable)
  bulk_actions_column = datatable.table_columns.find { |_, options| options[:bulk_actions_column] }.try(:second)
  return false unless bulk_actions_column

  {
    dropdownHtml: render(
      partial: bulk_actions_column[:dropdown_partial],
      locals: { datatable: datatable, dropdown_block: bulk_actions_column[:dropdown_block] }.merge(bulk_actions_column[:partial_locals])
    )
  }.to_json()
end

#datatable_columns(datatable) ⇒ Object

datatables.net/reference/option/columns



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'app/helpers/effective_datatables_helper.rb', line 57

def datatable_columns(datatable)
  form = nil
  simple_form_for(:datatable_filter, url: '#', html: {id: "#{datatable.to_param}-form"}) { |f| form = f }

  datatable.table_columns.map do |name, options|
    {
      name: options[:name],
      title: content_tag(:span, options[:label], class: 'filter-label'),
      className: options[:class],
      width: options[:width],
      responsivePriority: (options[:responsivePriority] || 10000),  # 10,000 is datatables default
      sortable: (options[:sortable] && !datatable.simple?),
      visible: (options[:visible].respond_to?(:call) ? datatable.instance_exec(&options[:visible]) : options[:visible]),
      filterHtml: (datatable_header_filter(form, name, datatable.search_terms[name], options) unless datatable.simple?),
      filterSelectedValue: options[:filter][:selected]
    }
  end.to_json()
end

#datatable_default_order(datatable) ⇒ Object 



52
53
54
 
# File 'app/helpers/effective_datatables_helper.rb', line 52

def datatable_default_order(datatable)
  [datatable.order_index, datatable.order_direction.downcase].to_json()
end

#datatable_header_filter(form, name, value, opts) ⇒ Object 



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
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'app/helpers/effective_datatables_helper.rb', line 88

def datatable_header_filter(form, name, value, opts)
  return render(partial: opts[:header_partial], locals: {form: form, name: (opts[:label] || name), column: opts}) if opts[:header_partial].present?

  include_blank = opts[:filter].key?(:include_blank) ? opts[:filter][:include_blank] : (opts[:label] || name.titleize)
  pattern = opts[:filter].key?(:pattern) ? opts[:filter][:pattern] : nil
  placeholder = opts[:filter].key?(:placeholder) ? opts[:filter][:placeholder] : (opts[:label] || name.titleize)
  title = opts[:filter].key?(:title) ? opts[:filter][:title] : (opts[:label] || name.titleize)

  case opts[:filter][:as]
  when :string, :text, :number
    form.input name, label: false, required: false, value: value,
      as: :string,
      placeholder: placeholder,
      input_html: { name: nil, value: value, title: title, pattern: pattern, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} }
  when :obfuscated_id
    pattern ||= "[0-9]{3}-?[0-9]{4}-?[0-9]{3}"
    title = opts[:filter].key?(:title) ? opts[:filter][:title] : "Expected format: XXX-XXXX-XXX"

    form.input name, label: false, required: false, value: value,
      as: :string,
      placeholder: placeholder,
      input_html: { name: nil, value: value, title: title, pattern: pattern, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} }
  when :date
    form.input name, label: false, required: false, value: value,
      as: (ActionView::Helpers::FormBuilder.instance_methods.include?(:effective_date_picker) ? :effective_date_picker : :string),
      placeholder: placeholder,
      input_group: false,
      input_html: { name: nil, value: value, title: title, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} },
      input_js: { useStrict: true, keepInvalid: true }
  when :datetime
    form.input name, label: false, required: false, value: value,
      as: (ActionView::Helpers::FormBuilder.instance_methods.include?(:effective_date_time_picker) ? :effective_date_time_picker : :string),
      placeholder: placeholder,
      input_group: false,
      input_html: { name: nil, value: value, title: title, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} },
      input_js: { useStrict: true, keepInvalid: true } # Keep invalid format like "2015-11" so we can still filter by year, month or day
  when :select, :boolean
    form.input name, label: false, required: false, value: value,
      as: (ActionView::Helpers::FormBuilder.instance_methods.include?(:effective_select) ? :effective_select : :select),
      collection: opts[:filter][:collection],
      selected: opts[:filter][:selected],
      multiple: opts[:filter][:multiple] == true,
      include_blank: include_blank,
      input_html: { name: nil, value: value, title: title, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} },
      input_js: { placeholder: placeholder }
  when :grouped_select
    form.input name, label: false, required: false, value: value,
      as: (ActionView::Helpers::FormBuilder.instance_methods.include?(:effective_select) ? :effective_select : :grouped_select),
      collection: opts[:filter][:collection],
      selected: opts[:filter][:selected],
      multiple: opts[:filter][:multiple] == true,
      include_blank: include_blank,
      grouped: true,
      polymorphic: opts[:filter][:polymorphic] == true,
      group_label_method: opts[:filter][:group_label_method] || :first,
      group_method: opts[:filter][:group_method] || :last,
      input_html: { name: nil, value: value, title: title, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} },
      input_js: { placeholder: placeholder }
  when :bulk_actions_column
    form.input name, label: false, required: false, value: nil,
      as: :boolean,
      input_html: { name: nil, value: nil, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index], 'role' => 'bulk-actions-all'} }
  end
end

#datatables_active_admin_path? ⇒ Boolean

TODO: Improve on this

Returns:

  • (Boolean) 


162
163
164
 
# File 'app/helpers/effective_datatables_helper.rb', line 162

def datatables_active_admin_path?
  attributes[:active_admin_path] rescue false
end

#datatables_admin_path? ⇒ Boolean

Returns:

  • (Boolean) 


153
154
155
156
157
158
159
 
# File 'app/helpers/effective_datatables_helper.rb', line 153

def datatables_admin_path?
  @datatables_admin_path ||= (
    path = request.path.to_s.downcase.chomp('/') + '/'
    referer = request.referer.to_s.downcase.chomp('/') + '/'
    (attributes[:admin_path] || referer.include?('/admin/') || path.include?('/admin/')) rescue false
  )
end

#render_datatable(datatable, input_js_options = nil) ⇒ Object 



2
3
4
5
6
7
8
 
# File 'app/helpers/effective_datatables_helper.rb', line 2

def render_datatable(datatable, input_js_options = nil)
  return if datatable.nil?
  datatable.view ||= self

  render partial: 'effective/datatables/datatable',
    locals: { datatable: datatable, input_js_options: input_js_options.try(:to_json) }
end

#render_datatable_chart(datatable, name) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'app/helpers/effective_datatables_helper.rb', line 24

def render_datatable_chart(datatable, name)
  return unless datatable.charts.present?
  return unless datatable.charts[name].present?
  datatable.view ||= self

  unless @effective_datatables_chart_javascript_rendered
    concat javascript_include_tag('https://www.google.com/jsapi')
    concat javascript_tag("if(google && google.visualization === undefined) { google.load('visualization', '1', {packages:#{EffectiveDatatables.google_chart_packages}}); }")

    @effective_datatables_chart_javascript_rendered = true
  end

  options = datatable.charts[name]
  chart = datatable.to_json[:charts][name]

  render partial: (options[:partial] || 'effective/datatables/chart'),
    locals: { datatable: datatable, chart: chart }
end

#render_datatable_charts(datatable) ⇒ Object 



17
18
19
20
21
22
 
# File 'app/helpers/effective_datatables_helper.rb', line 17

def render_datatable_charts(datatable)
  return unless datatable.charts.present?
  datatable.view ||= self

  datatable.charts.map { |name, _| render_datatable_chart(datatable, name) }.join.html_safe
end

#render_datatable_scopes(datatable) ⇒ Object 



10
11
12
13
14
15
 
# File 'app/helpers/effective_datatables_helper.rb', line 10

def render_datatable_scopes(datatable)
  return unless datatable.scopes.present?
  datatable.view ||= self

  render partial: 'effective/datatables/scopes', locals: { datatable: datatable }
end

#render_simple_datatable(datatable, input_js_options = nil) ⇒ Object 



43
44
45
46
47
48
49
50
 
# File 'app/helpers/effective_datatables_helper.rb', line 43

def render_simple_datatable(datatable, input_js_options = nil)
  return if datatable.nil?
  datatable.view ||= self
  datatable.simple = true

  render partial: 'effective/datatables/datatable',
    locals: {datatable: datatable, input_js_options: input_js_options.try(:to_json) }
end