Class: SimpleDrilldown::Controller

Inherits:
ApplicationController
  • Object
show all
Defined in:
lib/simple_drilldown/controller.rb

Defined Under Namespace

Classes: ScopeHolder

Constant Summary collapse

LIST_LIMIT = 
10_000

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Controller

Returns a new instance of Controller.



370
371
372
373
 
# File 'lib/simple_drilldown/controller.rb', line 370

def initialize
  super()
  @history_fields = c_fields.select { |_k, v| v[:list_change_times] }.map { |k, _v| k.to_s }
end

Class Method Details

.base_condition(base_condition) ⇒ Object 



42
43
44
 
# File 'lib/simple_drilldown/controller.rb', line 42

def base_condition(base_condition)
  self.c_base_condition = base_condition
end

.base_group(base_group) ⇒ Object 



50
51
52
 
# File 'lib/simple_drilldown/controller.rb', line 50

def base_group(base_group)
  self.c_base_group = base_group
end

.base_includes(*base_includes) ⇒ Object 



46
47
48
 
# File 'lib/simple_drilldown/controller.rb', line 46

def base_includes(*base_includes)
  self.c_base_includes = base_includes.flatten
end

.default_fields(default_fields) ⇒ Object 



54
55
56
 
# File 'lib/simple_drilldown/controller.rb', line 54

def default_fields(default_fields)
  self.c_default_fields = default_fields.flatten
end

.default_select_value(default_select_value) ⇒ Object 



58
59
60
 
# File 'lib/simple_drilldown/controller.rb', line 58

def default_select_value(default_select_value)
  self.c_default_select_value = default_select_value.to_sym
end

.dimension(name, select_expression = name.to_s, options = {}) ⇒ Object 



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
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/simple_drilldown/controller.rb', line 87

def dimension(name, select_expression = name.to_s, options = {})
  if select_expression.is_a?(Hash)
    unless options.blank?
      raise "select_expression should be a string: #{select_expression.class}, options: #{options.inspect}"
    end

    options = select_expression
    select_expression = name.to_s
  end
  interval = options.delete(:interval)
  label_method = options.delete(:label_method)
  legal_values = options.delete(:legal_values) || legal_values_for(name)
  reverse = options.delete(:reverse)
  row_class = options.delete(:row_class)
  if select_expression.is_a?(Array)
    queries = select_expression
  else
    includes = options.delete(:includes)
    conditions = options.delete(:where)
    queries = [{
      select: select_expression,
      includes: includes,
      where: conditions
    }]
  end
  raise "Unexpected options: #{options.inspect}" if options.present?

  queries.each do |query_opts|
    unless (query_opts.keys - %i[select includes where]).empty?
      raise "Unknown options: #{query_opts.keys.inspect}"
    end
  end

  pretty_name = I18n.t(:"simple_drilldown.dimension.#{name}",
                       default: [:"simple_drilldown.#{name}", :"activerecord.models.#{name}", name.to_sym,
                                 name.to_s.titleize])
  c_dimension_defs[name.to_s] = {
    includes: queries.inject(nil) do |a, e|
      i = e[:includes]
      next a unless i
      next a if a&.include?(i)

      case a
      when nil
        i
      when Symbol
        [a, *i]
      else
        a.concat(*i)
      end
    end,
    interval: interval,
    label_method: label_method,
    legal_values: legal_values,
    pretty_name: pretty_name,
    queries: queries,
    reverse: reverse,
    select_expression:
      queries.size == 1 ? queries[0][:select] : "COALESCE(#{queries.map { |q| q[:select] }.join(',')})",
    row_class: row_class,
    url_param_name: name.to_s
  }
end

.field(name, **options) ⇒ Object 



79
80
81
 
# File 'lib/simple_drilldown/controller.rb', line 79

def field(name, **options)
  c_fields[name] = options
end

.hash_includes(*args) ⇒ Object 



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/simple_drilldown/controller.rb', line 343

def hash_includes(*args)
  args.inject({}) do |h, inc|
    case inc
    when Array
      inc.each do |v|
        h = hash_includes(h, v)
      end
    when Hash
      inc.each do |k, v|
        h[k] = merge_includes(h[k], v)
      end
    when NilClass, FalseClass
      # Leave as it is
    when String, Symbol
      h[inc] ||= []
    else
      raise "Unknown include type: #{inc.inspect}"
    end
    h
  end
end

.inherited(base) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/simple_drilldown/controller.rb', line 26

def inherited(base)
  super
  base.c_dimension_defs = Concurrent::Hash.new
  base.c_fields = {}
  begin
    base.c_target_class = base.name.chomp('DrilldownController').constantize
  rescue NameError
    begin
      base.c_target_class = base.name.chomp('Controller').constantize
    rescue NameError
      # No default target class found
    end
  end
  base.update_base_condition
end

.legal_values_for(field, preserve_filter: false) ⇒ Object 



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
181
182
183
184
185
186
 
# File 'lib/simple_drilldown/controller.rb', line 151

def legal_values_for(field, preserve_filter: false)
  lambda do |search|
    filter = search.filter.dup
    filter.delete(field.to_s) unless preserve_filter
    filter_conditions, _t, includes = make_conditions(filter)
    dimension_def = c_dimension_defs[field.to_s]
    result_sets = dimension_def[:queries].map do |query|
      includes = merge_includes(includes, query[:includes]) if query[:includes]
      rows_query = c_target_class.unscoped.where(realized_where(c_base_condition))
                                 .select("#{query[:select]} AS value")
                                 .joins(make_join([], c_target_class.name.underscore.to_sym, includes))
                                 .order('value')
                                 .group(:value)
      rows_query = rows_query.without_deleted if c_target_class.try :paranoid?
      rows_query = rows_query.where(filter_conditions) if filter_conditions
      if (where = query[:where])
        where_mapped = realized_where(where)
        rows_query = rows_query.where(where_mapped)
      end
      rows = rows_query.to_a
      filter_fields = search.filter[field.to_s]
      filter_fields&.each do |selected_value|
        next if rows.find { |r| r[:value].to_s == selected_value }

        # FIXME(uwe):  Convert the selected value to same data type as legal values
        rows << { value: selected_value }
        # EMXIF
      end
      rows.map { |r| [dimension_def[:label_method]&.call(r[:value]) || r[:value], r[:value]] }
    end
    values = result_sets.inject(&:+).uniq
    values.sort! if dimension_def[:queries].size > 1
    values.reverse! if dimension_def[:reverse]
    values
  end
end

.list_includes(*list_includes) ⇒ Object 



71
72
73
 
# File 'lib/simple_drilldown/controller.rb', line 71

def list_includes(*list_includes)
  self.c_list_includes = list_includes.flatten
end

.list_order(list_order) ⇒ Object 



75
76
77
 
# File 'lib/simple_drilldown/controller.rb', line 75

def list_order(list_order)
  self.c_list_order = list_order
end

.make_conditions(search_filter) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
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
256
257
258
 
# File 'lib/simple_drilldown/controller.rb', line 197

def make_conditions(search_filter)
  includes = c_base_includes.dup
  if search_filter
    condition_strings = []
    condition_values = []

    filter_texts = []
    search_filter.each do |field, values|
      dimension_def = c_dimension_defs[field]
      raise "Unknown filter field: #{field.inspect}" if dimension_def.nil?

      dimension_def[:queries].each do |query|
        next unless (where = query[:where])

        where_mapped = [*where].map { |e| e.respond_to?(:call) ? e.call : e }
        condition_strings << where_mapped[0]
        condition_values += where_mapped[1..]
      end
      values = Array(values)
      if dimension_def[:interval]
        if values[0].present? && values[1].present?
          condition_strings << "#{dimension_def[:select_expression]} BETWEEN ? AND ?"
          condition_values += values
          filter_texts << <<~TEXT
            #{dimension_def[:pretty_name]} #{dimension_def[:label_method]&.call(values) || "from #{values[0]} to #{values[1]}"}
          TEXT
        elsif values[0].present?
          condition_strings << "#{dimension_def[:select_expression]} >= ?"
          condition_values << values[0]
          filter_texts <<
            "#{dimension_def[:pretty_name]} #{dimension_def[:label_method]&.call(values) || "from #{values[0]}"}"
        elsif values[1].present?
          condition_strings << "#{dimension_def[:select_expression]} <= ?"
          condition_values << values[1]
          filter_texts <<
            "#{dimension_def[:pretty_name]} #{dimension_def[:label_method]&.call(values) || "to #{values[1]}"}"
        end
        includes << dimension_def[:includes] if dimension_def[:includes]
      else
        condition_strings << values.map do |value|
          if dimension_def[:condition_values_method]
            condition_values += dimension_def[:condition_values_method].call(value)
          else
            condition_values << value
          end
          filter_texts <<
            "#{dimension_def[:pretty_name]} #{dimension_def[:label_method]&.call(value) || value}"
          includes << dimension_def[:includes] if dimension_def[:includes]
          "(#{dimension_def[:select_expression]}) = ?"
        end.join(' OR ')
      end
    end
    filter_text = filter_texts.join(' and ')
    conditions = [condition_strings.map { |c| "(#{c})" }.join(' AND '), *condition_values]
    includes.keep_if(&:present?).uniq!
  else
    filter_text = nil
    conditions = nil
  end
  conditions = nil if conditions == ['']
  [conditions, filter_text, includes]
end

.make_join(joins, model, include, model_class = model.to_s.camelize.constantize) ⇒ Object 



260
261
262
263
264
265
266
267
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/simple_drilldown/controller.rb', line 260

def make_join(joins, model, include, model_class = model.to_s.camelize.constantize)
  case include
  when Array
    include.map { |i| make_join(joins, model, i) }.join(' ')
  when Hash
    sql = +''
    include.each do |parent, child|
      sql << " #{make_join(joins, model, parent)}"
      ass = model.to_s.camelize.constantize.reflect_on_association parent
      sql << case ass.macro
             when :has_many
               " #{make_join(joins, ass.class_name.underscore, child, ass.class_name.constantize)}"
             else
               " #{make_join(joins, parent, child, ass.class_name.constantize)}"
             end
    end
    sql
  when Symbol
    return '' if joins.include?(include)

    joins = joins.dup
    joins << include
    ass = model_class.reflect_on_association include
    raise "Unknown association: #{model} => #{include}" unless ass

    model_table = model.to_s.pluralize
    include_table = ass.table_name
    include_alias = include.to_s.pluralize
    case ass.macro
    when :belongs_to
      pk_col = ass.association_primary_key
      fk_col = ass.options[:foreign_key] || "#{include}_id"
      "LEFT JOIN #{include_table} #{include_alias} ON #{include_alias}.#{pk_col} = #{model_table}.#{fk_col}"
    when :has_one, :has_many
      fk_col = ass.options[:foreign_key] || "#{model}_id"
      sql = +"LEFT JOIN #{include_table} #{include_alias} ON #{include_alias}.#{fk_col} = #{model_table}.id"
      sql << " AND #{include_alias}.deleted_at IS NULL" if ass.klass.paranoid?
      if ass.scope && (base_ass_order = ScopeHolder.new(ass.scope).to_s)
        /^(?<ass_order>.*?)(?<ass_order_desc>\s+DESC)?$/i =~ base_ass_order
        ass_order_prefixed = ass_order.dup
        ActiveRecord::Base.connection.columns(include_table).map(&:name).each do |cname|
          ass_order_prefixed.gsub!(/\b#{cname}\b/, "#{include_alias}.#{cname}")
        end
        paranoid_clause = 'AND t2.deleted_at IS NULL' if ass.klass.paranoid?
        # FIXME(uwe):  Should we add "where" from the ScopeHolder here as well?
        #              Ref: SimpleDrilldown::Changes#changes_for
        aggregate_query = <<~SQL
          SELECT #{ass_order_desc ? :MAX : :MIN}(#{ass_order}) FROM #{include_table} t2 WHERE t2.#{fk_col} = #{model_table}.id #{paranoid_clause}
        SQL
        sql << " AND  #{ass_order_prefixed} = (#{aggregate_query})"
      end
      sql
    else
      raise "Unknown association type: #{ass.macro}"
    end
  when String
    include
  when nil
    ''
  else
    raise "Unknown join class: #{include.inspect}"
  end
end

.merge_includes(*args) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/simple_drilldown/controller.rb', line 324

def merge_includes(*args)
  hash = hash_includes(*args)
  result = hash.dup.map do |k, v|
    if v.blank?
      hash.delete(k)
      k
    end
  end.compact
  result << hash unless hash.blank?
  case result.size
  when 0
    nil
  when 1
    result[0]
  else
    result
  end
end

.realized_where(where) ⇒ Object 



188
189
190
191
192
193
194
195
 
# File 'lib/simple_drilldown/controller.rb', line 188

def realized_where(where)
  case where
  when Array
    where.map { |e| e.respond_to?(:call) ? e.call : e }
  else
    where
  end
end

.select(select) ⇒ Object 



67
68
69
 
# File 'lib/simple_drilldown/controller.rb', line 67

def select(select)
  self.c_select = select
end

.summary_fields(*summary_fields) ⇒ Object 



83
84
85
 
# File 'lib/simple_drilldown/controller.rb', line 83

def summary_fields(*summary_fields)
  self.c_summary_fields = summary_fields.flatten
end

.target_class(target_class) ⇒ Object 



62
63
64
65
 
# File 'lib/simple_drilldown/controller.rb', line 62

def target_class(target_class)
  self.c_target_class = target_class
  update_base_condition
end

.update_base_condition ⇒ Object 



365
366
367
 
# File 'lib/simple_drilldown/controller.rb', line 365

def update_base_condition
  self.c_base_condition = "#{c_target_class.table_name}.deleted_at IS NULL" if c_target_class.try :paranoid?
end

Instance Method Details

#choices ⇒ Object 



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/simple_drilldown/controller.rb', line 439

def choices
  @search = new_search_object
  dimension_name = params[:dimension_name]
  dimension = c_dimension_defs[dimension_name]
  selected = @search.filter[dimension_name] || []
  raise "Unknown dimension #{dimension_name.inspect}: #{c_dimension_defs.keys.inspect}" unless dimension

  choices = [[t(:all), nil]] + (legal_values_for_dimension(dimension) || [])
  choices_html = choices.map do |c|
    %(<option value="#{c[1]}"#{' SELECTED' if selected.include?(c[1])}>#{c[0]}</option>)
  end.join("\n")
  render html: choices_html.html_safe
end

#excel_export ⇒ Object 



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/simple_drilldown/controller.rb', line 458

def excel_export
  index(do_render: false)
  respond_to do |format|
    format.xlsx do
      render xlsx: c_target_class.table_name, template: 'simple_drilldown/excel_export_xlsx'
    end
    format.xml do
      set_excel_headers
      if params.dig(:search, :list) == '1'
        @records = get_records(@result)
        render template: 'simple_drilldown/excel_export_records', layout: false
      else
        render template: 'simple_drilldown/excel_export', layout: false
      end
    end
  end
end

#excel_export_records ⇒ Object 



476
477
478
479
480
 
# File 'lib/simple_drilldown/controller.rb', line 476

def excel_export_records
  params[:search] ||= {}
  params[:search][:list] = '1'
  excel_export
end

#html_export ⇒ Object 



453
454
455
456
 
# File 'lib/simple_drilldown/controller.rb', line 453

def html_export
  index(do_render: false)
  render template: '/simple_drilldown/html_export', layout: 'simple_drilldown/print'
end

#index(do_render: true) ⇒ Object

?dimension=supplier&dimension=transaction_type& filter=2009&filter[0]=Shell&filter[1]=Statoil



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/simple_drilldown/controller.rb', line 377

def index(do_render: true)
  @search = new_search_object

  @transaction_fields = (@search.fields + (c_fields.keys.map(&:to_s) - @search.fields))

  select = c_select.dup
  includes = c_base_includes.dup

  @dimensions = []
  select << ", 'All'#{'::text' if c_target_class.connection.adapter_name == 'PostgreSQL'} as value0"
  @dimensions += @search.dimensions.map do |dn|
    raise "Unknown distribution field: #{dn.inspect}" if c_dimension_defs[dn].nil?

    c_dimension_defs[dn]
  end
  @dimensions.each_with_index do |d, i|
    select << ", #{d[:select_expression]} as value#{i + 1}"
    includes << d[:includes] if d[:includes]
  end

  conditions, @filter_text, filter_includes = self.class.make_conditions(@search.filter)
  includes += filter_includes
  includes.flatten!
  includes.keep_if(&:present?).uniq!
  if @search.order_by_value && @dimensions.size <= 1
    order = "#{c_summary_fields.find { |f| f == @search.select_value } || 'count'} DESC"
  else
    order = (1..@dimensions.size).map { |i| "value#{i}" }.join(',')
    order = nil if order.empty?
  end
  group = (c_base_group + (1..@dimensions.size).map { |i| "value#{i}" }).join(',')
  group = nil if group.empty?

  joins = self.class.make_join([], c_target_class.name.underscore.to_sym, includes)
  row_query = c_target_class.unscoped.where(self.class.realized_where(c_base_condition)).select(select)
  row_query = row_query.where(conditions) if conditions
  rows = row_query.joins(joins).group(group).order(order).to_a
  if rows.empty?
    @result = { value: 'All', count: 0, row_count: 0, nodes: 0, rows: [] }
    c_summary_fields.each { |f| @result[f] = 0 }
  else
    if do_render && @search.list && rows.inject(0) { |sum, r| sum + r[:count].to_i } > LIST_LIMIT
      @search.list = false
      flash.now[:notice] = "More than #{LIST_LIMIT} records.  List disabled."
    end
    @result = result_from_rows(rows, 0, 0, ['All'])
  end

  remove_duplicates(@result) unless c_base_group.empty?

  @remaining_dimensions = c_dimension_defs.dup
  @remaining_dimensions.each_key do |dim_name|
    if (@search.filter[dim_name] && @search.filter[dim_name].size == 1) ||
       (@dimensions.any? { |d| d[:url_param_name] == dim_name })
      @remaining_dimensions.delete(dim_name)
    end
  end

  populate_list(conditions, includes, @result, []) if @search.list
  render template: '/simple_drilldown/index' if do_render
end