Class: Tabulatr::Data

Inherits:
Object
  • Object
show all
Defined in:
lib/tabulatr/data/data.rb

Overview

– Copyright © 2010-2014 Peter Horn & Florian Thomas, metaminded UG

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ++

Defined Under Namespace

Modules: DSL, Filtering, Formatting, Pagination, Sorting Classes: ButtonBuilder, Invoker, Proxy

Instance Method Summary collapse

Constructor Details

#initialize(relation) ⇒ Data

Returns a new instance of Data.



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

def initialize(relation)
  @relation   = relation
  @base       = self.class.main_class rescue nil
  @base       ||= relation.respond_to?(:klass) ? relation.klass : relation
  @table_name = @base.table_name
  @search     = self.class.instance_variable_get('@search')     || HashWithIndifferentAccess.new
  @includes   = Set.new()
  @cname      = @base.name.downcase
  @batch_actions = nil
  @row = self.class.instance_variable_get('@row')
  table_columns.map do |col|
    next if col.is_a? Tabulatr::Renderer::Checkbox
    col.klass = @base.reflect_on_association(col.table_name).try(:klass) || @base
    col.determine_appropriate_filter! if col.col_options.filter === true
  end
end

Instance Method Details

#batch_params(params) ⇒ Object 



116
 
# File 'lib/tabulatr/data/data.rb', line 116

def batch_params(params)  params["#{Tabulatr::Utility.formatted_name(@base.name)}_batch"] end

#check_params(params) ⇒ Object 



117
118
119
120
121
122
 
# File 'lib/tabulatr/data/data.rb', line 117

def check_params(params)
  tabulatr_checked = params["tabulatr_checked"]
  if tabulatr_checked.present?
    tabulatr_checked['checked_ids'].split(',')
  end
end

#data_for_table(params, locals: {}, default_order: nil, controller: nil, &block) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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
 
# File 'lib/tabulatr/data/data.rb', line 43

def data_for_table(params, locals: {}, default_order: nil, controller: nil, &block)

  @batch_actions = block if block_given?
  @controller    = controller
  @default_order = default_order

  # count
  total = @relation.count

  # prepare the query
  apply_filters(filter_params params)
  apply_search(search_param params)
  apply_sorting(sort_params params)
  join_required_tables(params)

  batch_result = execute_batch_actions(batch_params(params), check_params(params))
  return batch_result if batch_result.is_a? Tabulatr::Responses::DirectResponse

  pagination = compute_pagination(params[:page], params[:pagesize])
  apply_pagination(pagination.slice(:offset, :pagesize))

  # get the records
  found = apply_formats(locals: locals, controller: controller)

  append = params[:append].present? ? Tabulatr::Utility.string_to_boolean(params[:append]) : false

  # prepare result for rendering
  found.define_singleton_method(:__pagination) do
    { :page => pagination[:page],
      :pagesize => pagination[:pagesize],
      :count => pagination[:count],
      :pages => pagination[:pages],
      :total => total,
      :append => append,
      :table_id => params[:table_id]
    }
  end


  found.define_singleton_method(:to_tabulatr_json) do |klass=nil|
    Tabulatr::JsonBuilder.build found, klass, params[:arguments]
  end

  found
end

#execute_batch_actions(batch_param, selected_ids) ⇒ Object 



89
90
91
92
93
94
95
 
# File 'lib/tabulatr/data/data.rb', line 89

def execute_batch_actions batch_param, selected_ids
  if batch_param.present? && @batch_actions.present?
    batch_param = batch_param.keys.first.to_sym if batch_param.is_a?(Hash)
    selected_ids = @relation.map(&:id) if selected_ids.empty?
    @batch_actions.yield(Invoker.new(batch_param, selected_ids))
  end
end

#filter_params(params) ⇒ Object

– Params ++



113
 
# File 'lib/tabulatr/data/data.rb', line 113

def filter_params(params) params["#{Tabulatr::Utility.formatted_name(@base.name)}_filter"] end

#filters ⇒ Object 



101
102
103
 
# File 'lib/tabulatr/data/data.rb', line 101

def filters
  self.class.instance_variable_get('@filters')
end

#join_required_tables(params) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/tabulatr/data/data.rb', line 124

def join_required_tables(params)
  if params[:arguments].present?
    tt = (params[:arguments].split(",").select{|s| s[':']}.map do |s|
          s.split(':').first
        end.uniq.map(&:to_sym))
    tt.delete(@table_name.to_sym)
    @includes = @includes + tt
  end
  # @relation = @relation.includes(@includes.map(&:to_sym)).references(@includes.map(&:to_sym))
  @relation = @relation.eager_load(@includes.map(&:to_sym))
  # @relation = @relation.group("#{@table_name}.#{@base.primary_key}")
end

#search? ⇒ Boolean

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/tabulatr/data/data.rb', line 105

def search?
  self.class.instance_variable_get('@search')
end

#search_param(params) ⇒ Object 



114
 
# File 'lib/tabulatr/data/data.rb', line 114

def search_param(params)  params["#{Tabulatr::Utility.formatted_name(@base.name)}_search"] end

#sort_params(params) ⇒ Object 



115
 
# File 'lib/tabulatr/data/data.rb', line 115

def sort_params(params)   params["#{Tabulatr::Utility.formatted_name(@base.name)}_sort"] end

#table_columns ⇒ Object 



97
98
99
 
# File 'lib/tabulatr/data/data.rb', line 97

def table_columns
  self.class.instance_variable_get("@table_columns")
end

#table_name_for_association(assoc) ⇒ Object 



137
138
139
140
 
# File 'lib/tabulatr/data/data.rb', line 137

def table_name_for_association(assoc)
  @base.reflect_on_association(assoc.to_sym).table_name
  # assoc.to_sym
end