Class: Apotomo::DatatableWidget

Inherits:
Widget
  • Object
show all
Defined in:
lib/apotomo/datatable_widget.rb

Overview

Apotomo-Datatables

Basic usage with default options:

Gemfile
  gem 'apotomo-datatables'

items_controller.rb
  root << items_datatable=widget('apotomo/datatable',:items_datatable)

index.html.haml
  #render as HTML like a partial
  =render_widget :items_datatable,:display

  #render via AJAX
  %div#parentDiv
    =link_to "Create table from options set in the URL", items_path+'.js?template[parent]=parentDiv, :remote=>true

index.js.haml #used to render via AJAX
  =render_widget :items_datatable,:display

Instance Method Summary collapse

Instance Method Details

#create ⇒ Object 



143
144
145
 
# File 'lib/apotomo/datatable_widget.rb', line 143

def create

end

#data ⇒ Object 



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/apotomo/datatable_widget.rb', line 112

def data
  is_searching = (params[:sSearch] and params[:sSearch].length>0)
  @records=datasource
  @data={
    :iTotalRecords=>@merged_options[:widget][:model].count,
    :iTotalDisplayRecords=>is_searching ? @records.count : @merged_options[:widget][:model].count,
    :aaData=>@records
  }
  render text: @data.to_json
end

#datasource ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/apotomo/datatable_widget.rb', line 123

def datasource
  #datatable passes something like
  #"sEcho"=>"1", "iColumns"=>"5", "sColumns"=>"", "iDisplayStart"=>"0", "iDisplayLength"=>"10", "mDataProp_0"=>"id", "mDataProp_1"=>"text", "mDataProp_2"=>"created_at", "mDataProp_3"=>"updated_at", "mDataProp_4"=>"like", "sSearch"=>"", "bRegex"=>"false", "sSearch_0"=>"", "bRegex_0"=>"false", "bSearchable_0"=>"true", "sSearch_1"=>"", "bRegex_1"=>"false", "bSearchable_1"=>"true", "sSearch_2"=>"", "bRegex_2"=>"false", "bSearchable_2"=>"true", "sSearch_3"=>"", "bRegex_3"=>"false", "bSearchable_3"=>"true", "sSearch_4"=>"", "bRegex_4"=>"false", "bSearchable_4"=>"true", "iSortCol_0"=>"0", "sSortDir_0"=>"asc", "iSortingCols"=>"1", "bSortable_0"=>"true", "bSortable_1"=>"true", "bSortable_2"=>"true", "bSortable_3"=>"true", "bSortable_4"=>"true"
  filter={}
  is_searching = (params[:sSearch] and params[:sSearch].length>0)
  if is_searching
    filter[:conditions]=[@merged_options[:widget][:model].column_names.join(' LIKE :sSearch OR ')+' LIKE :sSearch',{:sSearch=>"%#{params[:sSearch]}%"}]
  end
  if params[:iDisplayStart] and params[:iDisplayLength]
    filter[:limit]=params[:iDisplayLength]
    filter[:offset]=params[:iDisplayStart]
  end
  if @merged_options[:widget][:controller].respond_to?('apotomo_datatable_datasource')
    @records=@merged_options[:widget][:controller].apotomo_datatable_datasource(filter)
  else
    @records=@merged_options[:widget][:model].find(:all,filter)
  end
  return @records
end

#datatable_init_vars ⇒ Object

def view_for_state(state)

  "app/widgets/apotomo/datatable/#{state}"
end



105
106
 
# File 'lib/apotomo/datatable_widget.rb', line 105

def datatable_init_vars
end

#destroy ⇒ Object 



155
156
157
 
# File 'lib/apotomo/datatable_widget.rb', line 155

def destroy

end

#display(view_options = {}) ⇒ Object 



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
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/apotomo/datatable_widget.rb', line 59

def display(view_options={})
  if view_options && view_options.respond_to?('each_pair')
    ## merge options provided by the render_widget method call in the view
    @merged_options.deep_merge!(view_options)      
  end

  ## merge options from the URL params
  merge_url_param_options(params)
  process_boolean_options

  ##Build json string to pass plugin options to the client
  ##and command to merge with client-side plugin_options if provided
  datatable_options=@merged_options[:plugin].to_json    
  if @merged_options[:template][:plugin_options] 
    datatable_options="$.extend(#{datatable_options},#{@merged_options[:template][:plugin_options]})"
  end

  #make sure :header and :footer are arrays
  if @merged_options[:template][:header] && ! @merged_options[:template][:header].respond_to?('each') then @merged_options[:template][:header]=[@merged_options[:template][:header]] end
  if @merged_options[:template][:footer] && ! @merged_options[:template][:footer].respond_to?('each') then @merged_options[:template][:footer]=[@merged_options[:template][:footer]] end


  @init_datatable_js= "$(\"##{@merged_options[:template][:id]}\").dataTable(#{datatable_options});"

  #this is just a test firing an event
  @evt_test='empty'
  self.fire :test_evt
  if @merged_options[:params][:format]=='js'
    #TODO: search the app's widget path for this template before using the default version
    @html=render_to_string :file => File.expand_path('../../apotomo/datatable/display_html', __FILE__)
    #escape double quotes and new lines, then make string safe so it's rendered properly
    @html=@html.gsub(/[\n\r]/,' ').gsub(/"/,'\\\\"').html_safe
    render :view=>:display_js
#      render (replace :view=>:display_html, :selector=>'div#parent')+@init_datatable_js
  else 
    render :view=>:display_html
#      render :view=>File.expand_path('./datatable/display_html', __FILE__)
#      render :view=>'app/widgets/apotomo/datatable/display_html'
  end
end

#edit ⇒ Object 



147
148
149
 
# File 'lib/apotomo/datatable_widget.rb', line 147

def edit

end

#head_foot(merged_options, section) ⇒ Object 



108
109
110
 
# File 'lib/apotomo/datatable_widget.rb', line 108

def head_foot(merged_options,section)
  render :locals=>{:merged_options=>merged_options,:section=>section}
end

#increment_test_val ⇒ Object 



45
46
47
 
# File 'lib/apotomo/datatable_widget.rb', line 45

def increment_test_val
  @test_val=@test_val+1
end

#make_bool(val) ⇒ Object 



290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/apotomo/datatable_widget.rb', line 290

def make_bool(val)
  if !!val==val 
    return val 
  else
    if val.is_a?(String) && val.downcase=="true"
      return true
    else
      return false
    end
  end
end

#merge_url_param_options(url_param_options) ⇒ Object 



249
250
251
252
253
254
255
256
257
 
# File 'lib/apotomo/datatable_widget.rb', line 249

def merge_url_param_options(url_param_options)
  #:widget options are not accepted from URL parameters - accepting them would be a security hole
  if url_param_options.has_key?(:template) && url_param_options[:template].respond_to?('each_pair')
    @merged_options[:template].deep_merge!(url_param_options[:template])
  end
  if url_param_options.has_key?(:plugin) && url_param_options[:plugin].respond_to?('each_pair')
    @merged_options[:plugin].deep_merge!(url_param_options[:plugin])
  end
end

#merged_options ⇒ Object 



55
56
57
 
# File 'lib/apotomo/datatable_widget.rb', line 55

def merged_options
  @merged_options
end

#process_boolean_options ⇒ Object 



259
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
 
# File 'lib/apotomo/datatable_widget.rb', line 259

def process_boolean_options
  #some options accept boolean options to indicate the default value (true) or undefined (false or nil)
  #these must be processed after options from all sources have been merged
  #Some true values are converted to default parameters for the plugin
  #Some false values are deleted from the hash to allow the plugin to apply its own default options

  ## if options[:plugin][:sAjaxSource] is boolean or nil, derive default if true and delete option value from controller
  if @merged_options[:plugin].has_key?(:sAjaxSource) 
    sAjaxSource_bool=make_bool(@merged_options[:plugin][:sAjaxSource])
    if sAjaxSource_bool
      @merged_options[:plugin][:sAjaxSource]=url_for_event(:data)
      unless @merged_options[:plugin].has_key?(:bServerSide) 
        @merged_options[:plugin][:bServerSide]=true # User server-side processing: http://datatables.net/ref#bServerSide
      end
    else
      @merged_options[:plugin].delete(:sAjaxSource) #delete false or nil value to prevent invalid option from passing to plugin
    end
  end
  ## profide column mapping if using ajax or aaData
  ## provide aaData if requested
  if sAjaxSource_bool || @merged_options[:plugin][:aaData]==true
    if @merged_options[:plugin][:aaData]==true
      records=datasource
      @merged_options[:plugin][:aaData]=records
    end
  else
    @merged_options[:plugin].delete(:aoColumns)
  end
  @merged_options[:plugin][:sAjaxSourceBOOL]=sAjaxSource_bool
end

#set_options(controller_options) ⇒ Object 



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
187
188
189
190
191
192
193
194
195
196
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
 
# File 'lib/apotomo/datatable_widget.rb', line 159

def set_options(controller_options)
=begin
Options:

The @merged_options hash includes primary keys for the widget, templates and client-side plugin
  @merged_options={:widget=>{...}, :template=>{...}, :plugin=>{...}}

Default options are generated in Apotomo::DatatableWidget.set_options

Default options may be overridden from the controller, view, by URL parameters and by a client-side javascript hash, as seen in the example above,  
with the client-side javascript hash taking the highest precedence
  client_side_options -> url_param_options -> view_options -> controller_options -> default_options

URL parameters may only define template and plugin options. Defining widget options from the URL would present a security hole
The client-side hash may only define plugin options. Since it is not passed to the server, template and widget options would be irrelevant 

$.extend(@merged_options[:widget].to_json,client_side_options) constitutes the arguments passed to the datatable initialization function. 
See http://datatables.net/usage/options for options.  As such, any option specified in the jquery datatables API may be set in this sub hash


=end
  #initialize @merged_options, which will contain the final merged hash of options
  @merged_options={:widget=>{},:template=>{},:plugin=>{}}.with_indifferent_access

  #make sure options (passed by controller in has_widgets) has the basic hash structure
  controller_options=controller_options.respond_to?(:each_pair) ? controller_options : {}.with_indifferent_access
  controller_options=@merged_options.deep_merge(controller_options)
  controller=parent_controller
  if match=/(\w+?)sController/.match(controller.class.name.to_s)
    controller_model_name=match[1]
  end

  #get model first since it is used to build other default options
  model=nil
  if controller_options[:widget].has_key?(:model)
    if controller_options[:widget][:model].respond_to?("columns_hash")
      model=controller_options[:widget][:model]
    end
  elsif controller_model_name
    #derive the model from the controller name
    if defined?(controller_model_name) && eval(controller_model_name+'.respond_to?("columns_hash")')
      model=eval(controller_model_name)
    end
  end
  if model==nil then
    raise "Cannot use apotomo-datatable without a model. Either pass a model in the has_widgets method call or make sure a model exists with a name corresponding to the controller from which has_widgets is called"
  end

  default_options={
    :widget=>{
      :name=>"#{model.name}DatatableWidget",
      :model=>model,
      :controller=>controller,
      :datasource=>self.method(:datasource),
      :test_option=>'default'
    },
    :template=>{
      #The header and footer have the same set of options.
      #Each may contain multiple rows. Each row may define an array of options for each cell
      #:header=

      #Each may be a single value, an array or a hash
      #If a single value or array, all columns are rendered with the provided options in order
      #If a hash, each key should match column field names. Each key-value is a value or array as above
      #single value or array options are: nil: ommited, label: label, input: input column filter, select: select column filter
#        :header=>{:default=>:label,:name=>[:label,:input],:value=>[:label,:input]}, 
      :header=>{:default=>:label}, 
      :footer=>nil, 
      :id=>"#{model.name}Datatable",
      :excluded_columns=>[:id,:created_at,:updated_at], #set to a list of field names to exclude from display
      :included_columns=>[], #set to a list of columns to include even if they are excluded in :excluded_columns
      :test_option=>'default'
    },
    :plugin=>{
      :iDisplayStart=>0,
      :bProcessing=>true,
      :bJQueryUI=>true,
      :test_option=>'default'
    }
  }.with_indifferent_access
  default_options[:plugin][:aoColumns]=[]
  model.column_names.each do |name|
    default_options[:plugin][:aoColumns].push({'mDataProp'=>name})
  end

  # merge default options with options provided by the controller
  @merged_options=default_options.deep_merge(controller_options)
  @merged_options[:params]=params
end

#test_evt(event) ⇒ Object 



49
50
51
52
53
 
# File 'lib/apotomo/datatable_widget.rb', line 49

def test_evt(event)
  if @merged_options[:widget][:controller].respond_to?(:apotomo_datatable_event)
    @evt_test=@merged_options[:widget][:controller].apotomo_datatable_event(event)
  end
end

#test_val ⇒ Object 



41
42
43
 
# File 'lib/apotomo/datatable_widget.rb', line 41

def test_val
  @test_val
end

#update ⇒ Object 



151
152
153
 
# File 'lib/apotomo/datatable_widget.rb', line 151

def update

end