Class: Effective::Datatable

Inherits:
Object
  • Object
show all
Extended by:
EffectiveDatatable::Dsl::ClassMethods
Includes:
EffectiveDatatable::Ajax, EffectiveDatatable::Dsl, EffectiveDatatable::Hooks, EffectiveDatatable::Options, EffectiveDatatable::Rendering
Defined in:
app/models/effective/datatable.rb

Constant Summary

Constants included from EffectiveDatatable::Rendering

EffectiveDatatable::Rendering::BLANK

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from EffectiveDatatable::Dsl::ClassMethods

datatable

Methods included from EffectiveDatatable::Options

#initialize_options, #quote_sql

Methods included from EffectiveDatatable::Hooks

#finalize, #order_column, #search_column

Methods included from EffectiveDatatable::Ajax

#display_entries, #display_table_columns, #order_direction, #order_index, #order_name, #page, #per_page, #per_page=, #search_terms

Methods included from EffectiveDatatable::Dsl

#actions_column, #array_column, #bulk_actions_column, #default_entries, #default_order, #table_column

Constructor Details

#initialize(*args) ⇒ Datatable

Returns a new instance of Datatable.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'app/models/effective/datatable.rb', line 18

def initialize(*args)
  if args.present? && args.first != nil
    raise "#{self.class.name}.new() can only be initialized with a Hash like arguments" unless args.first.kind_of?(Hash)
    args.first.each { |k, v| self.attributes[k] = v }
  end

  initialize_datatable  # This creates @table_columns based on the DSL datatable do .. end block
  initialize_options    # This normalizes all the options

  unless active_record_collection? || array_collection?
    raise "Unsupported collection type. Should be ActiveRecord class, ActiveRecord relation, or an Array of Arrays [[1, 'something'], [2, 'something else']]"
  end

  if @default_order.present? && !table_columns.key?((@default_order.keys.first rescue nil))
    raise "default_order :#{(@default_order.keys.first rescue 'nil')} must exist as a table_column or array_column"
  end
end

Instance Attribute Details

#attributes ⇒ Object

Any attributes set on initialize will be echoed back and available to the class



41
42
43
 
# File 'app/models/effective/datatable.rb', line 41

def attributes
  @attributes
end

#display_records ⇒ Object

Returns the value of attribute display_records.



3
4
5
 
# File 'app/models/effective/datatable.rb', line 3

def display_records
  @display_records
end

#simple ⇒ Object

These two options control the render behaviour of a datatable



6
7
8
 
# File 'app/models/effective/datatable.rb', line 6

def simple
  @simple
end

#table_html_class ⇒ Object

These two options control the render behaviour of a datatable



6
7
8
 
# File 'app/models/effective/datatable.rb', line 6

def table_html_class
  @table_html_class
end

#view ⇒ Object

Returns the value of attribute view.



3
4
5
 
# File 'app/models/effective/datatable.rb', line 3

def view
  @view
end

Class Method Details

.model_name ⇒ Object

Searching & Filters



52
53
54
 
# File 'app/models/effective/datatable.rb', line 52

def self.model_name # Searching & Filters
  @model_name ||= ActiveModel::Name.new(self)
end

Instance Method Details

#collection ⇒ Object 



60
61
62
 
# File 'app/models/effective/datatable.rb', line 60

def collection
  raise "You must define a collection. Something like an ActiveRecord User.all or an Array of Arrays [[1, 'something'], [2, 'something else']]"
end

#collection_class ⇒ Object 



64
65
66
 
# File 'app/models/effective/datatable.rb', line 64

def collection_class
  @collection_class ||= (collection.respond_to?(:klass) ? collection.klass : self.class)
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
 
# File 'app/models/effective/datatable.rb', line 83

def empty?
  total_records.to_i == 0
end

#model_name ⇒ Object

Instance method. In Rails 4.2 this needs to be defined on the instance, before it was on the class



48
49
50
 
# File 'app/models/effective/datatable.rb', line 48

def model_name # Searching & Filters
  @model_name ||= ActiveModel::Name.new(self.class)
end

#present? ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
 
# File 'app/models/effective/datatable.rb', line 79

def present?
  total_records.to_i > 0
end

#simple? ⇒ Boolean

When simple only a table will be rendered with no sorting, no filtering, no export buttons, no pagination, no per page, no colReorder default sorting only, default visibility only, all records returned, and responsive enabled

Returns:

  • (Boolean) 


132
133
134
 
# File 'app/models/effective/datatable.rb', line 132

def simple?
  @simple == true
end

#table_columns ⇒ Object 



36
37
38
 
# File 'app/models/effective/datatable.rb', line 36

def table_columns
  @table_columns
end

#to_json ⇒ Object 



68
69
70
71
72
73
74
75
76
77
 
# File 'app/models/effective/datatable.rb', line 68

def to_json
  raise 'Effective::Datatable to_json called with a nil view.  Please call render_datatable(@datatable) or @datatable.view = view before this method' unless view.present?

  @json ||= {
    :draw => (params[:draw] || 0),
    :data => (table_data || []),
    :recordsTotal => (total_records || 0),
    :recordsFiltered => (display_records || 0)
  }
end

#to_key ⇒ Object

Searching & Filters



45
 
# File 'app/models/effective/datatable.rb', line 45

def to_key; []; end

#to_param ⇒ Object 



56
57
58
 
# File 'app/models/effective/datatable.rb', line 56

def to_param
  @to_param ||= self.class.name.underscore.sub('effective/datatables/', '')
end

#total_records ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'app/models/effective/datatable.rb', line 87

def total_records
  @total_records ||= (
    if active_record_collection?
      # https://github.com/rails/rails/issues/15331
      if collection_class.connection.respond_to?(:unprepared_statement)
        collection_sql = collection_class.connection.unprepared_statement { collection.to_sql }
        (collection_class.connection.execute("SELECT COUNT(*) FROM (#{collection_sql}) AS datatables_total_count").first.values.first rescue 1).to_i
      else
        (collection_class.connection.execute("SELECT COUNT(*) FROM (#{collection.to_sql}) AS datatables_total_count").first.values.first rescue 1).to_i
      end
    else
      collection.size
    end
  )
end