forked from jbox-web/ajax-datatables-rails
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathindex.html
248 lines (185 loc) · 17.5 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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
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
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
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
248
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Rails & DataTables by ajahongir</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen">
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
</head>
<body>
<section class="page-header">
<h1 class="project-name">Rails & DataTables</h1>
<h2 class="project-tagline">A wrapper around datatable's ajax methods that allow server-side pagination, ordering & searching out of box in a rails app</h2>
<a href="https://github.com/ajahongir/ajax-datatables-rails" class="btn">View on GitHub</a>
<a href="https://github.com/ajahongir/ajax-datatables-rails/zipball/master" class="btn">Download .zip</a>
<a href="https://github.com/ajahongir/ajax-datatables-rails/tarball/master" class="btn">Download .tar.gz</a>
</section>
<section class="main-content">
<h2>
<a id="welcome-to-ajax-datatables-rails" class="anchor" href="#welcome-to-ajax-datatables-rails" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Welcome to ajax-datatables-rails</h2>
<p>DataTables is a plug-in for the jQuery Javascript library. It is a highly flexible tool, based upon the foundations of progressive enhancement, and will add advanced interaction controls to any HTML table. For more details look at home <a href="https://datatables.net/">page</a>
This gem fully supports DataTables behavior and easily integrates to rails app. No more need to write JS or Ruby code, just setup your model datatable. </p>
<h2>
<a id="description" class="anchor" href="#description" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Description</h2>
<p>This gem is based on DataTables idiom so It fully supports DataTable.</p>
<h2>
<a id="how-to-project" class="anchor" href="#how-to-project" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>How-to project</h2>
<p>I always build admin page with some data presenting and I love to use DataTable in my projects. But It's to hard to build so many table with server-side pagination, ordering & searching. But now we have this tool! And Today I am going to show usage of this gem with a super easy <a href="https://github.com/ajahongir/ajax-datatables-rails-v-0-4-0-how-to">pattern</a>.</p>
<h2>
<a id="basic-usage" class="anchor" href="#basic-usage" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Basic usage</h2>
<p>Let's suppose that we have 2 models: countries and cities. So every country has many cities.
we build rails app.</p>
<p><code>$ rails new how-to</code></p>
<p><code>$ bin/rails g model country name:string iata:string</code></p>
<p><code>$ bin/rails g model city name:string iata:string timezone:string country:references</code></p>
<p><code>$ bin/rails g controller cities index</code></p>
<p><code>$ rake db:migrate</code></p>
<h3>
<a id="gemfile" class="anchor" href="#gemfile" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Gemfile</h3>
<div class="highlight highlight-source-ruby"><pre><span class="pl-k">gem</span> <span class="pl-s"><span class="pl-pds">'</span>ajax-datatables-rails<span class="pl-pds">'</span></span>, <span class="pl-c1">github:</span> <span class="pl-s"><span class="pl-pds">'</span>ajahongir/ajax-datatables-rails<span class="pl-pds">'</span></span>, <span class="pl-c1">branch:</span> <span class="pl-s"><span class="pl-pds">'</span>v-0-4-0<span class="pl-pds">'</span></span>
<span class="pl-k">gem</span> <span class="pl-s"><span class="pl-pds">'</span>rails_script<span class="pl-pds">'</span></span>
<span class="pl-k">gem</span> <span class="pl-s"><span class="pl-pds">'</span>js-routes<span class="pl-pds">'</span></span>
<span class="pl-k">gem</span> <span class="pl-s"><span class="pl-pds">'</span>responders<span class="pl-pds">'</span></span> <span class="pl-c"># if you are using rails 4.2+</span></pre></div>
<p>And then execute:</p>
<p><code>$ bundle</code></p>
<h3>
<a id="initialization-third-party-libs" class="anchor" href="#initialization-third-party-libs" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Initialization third-party libs</h3>
<p><strong>rails_script</strong></p>
<p>After bundling you need to run the initial installation generator for <a href="https://github.com/gemgento/rails_script">rails_script</a>:</p>
<p><code>$ rails g rails_script:install</code>
and include <code><%= include_rails_script %></code> in application layout.</p>
<p><strong>js-routes</strong></p>
<p>Add <code>//= require js-routes</code> in your <code>application.js</code> and after clear your cache <code>$ rake tmp:cache:clear</code></p>
<p><strong>DataTables</strong></p>
<p>Adding latest version of <a href="https://datatables.net">DataTables</a> and style in application layout:</p>
<div class="highlight highlight-text-html-basic"><pre><<span class="pl-ent">link</span> <span class="pl-e">rel</span>=<span class="pl-s"><span class="pl-pds">"</span>stylesheet<span class="pl-pds">"</span></span> <span class="pl-e">href</span>=<span class="pl-s"><span class="pl-pds">"</span>//cdn.datatables.net/1.10.12/css/jquery.dataTables.min.css<span class="pl-pds">"</span></span> >
<<span class="pl-ent">script</span> <span class="pl-e">src</span>=<span class="pl-s"><span class="pl-pds">"</span>//cdn.datatables.net/1.10.12/js/jquery.dataTables.min.js<span class="pl-pds">"</span></span>></<span class="pl-ent">script</span>></pre></div>
<h3>
<a id="javascript" class="anchor" href="#javascript" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Javascript</h3>
<p>I add some defaults for my DataTables in global.coffee:</p>
<div class="highlight highlight-source-coffee"><pre>$ <span class="pl-k">-></span>
$.extend $.fn.DataTable.defaults,
<span class="pl-v">searching</span>: <span class="pl-c1">true</span>
<span class="pl-v">ordering</span>: <span class="pl-c1">true</span>
<span class="pl-v">deferRender</span>: <span class="pl-c1">true</span>
<span class="pl-v">lengthMenu</span>: [<span class="pl-c1">10</span>, <span class="pl-c1">25</span>, <span class="pl-c1">50</span>, <span class="pl-c1">100</span>]
<span class="pl-v">serverSide</span>: <span class="pl-c1">true</span>
<span class="pl-en">initComplete</span><span class="pl-k">:</span> <span class="pl-k"><span class="pl-k">-></span></span>
$(<span class="pl-s"><span class="pl-pds">'</span>.filters input, .filters select<span class="pl-pds">'</span></span>, <span class="pl-smi">@</span>).<span class="pl-en">on</span> <span class="pl-s"><span class="pl-pds">'</span>change<span class="pl-pds">'</span></span>, <span class="pl-smi">(e)</span> <span class="pl-k">=></span>
<span class="pl-v">th</span> <span class="pl-k">=</span> $(e.target).<span class="pl-en">closest</span>(<span class="pl-s"><span class="pl-pds">"</span>th<span class="pl-pds">"</span></span>)
@<span class="pl-en">api</span>().<span class="pl-en">column</span>(th.<span class="pl-en">index</span>()).<span class="pl-en">search</span>($(e.target).<span class="pl-en">val</span>()).<span class="pl-en">draw</span>()</pre></div>
<p>and add these lines in to cities.coffee </p>
<div class="highlight highlight-source-coffee"><pre><span class="pl-k">class</span> <span class="pl-en">App.Cities</span> <span class="pl-k">extends</span> <span class="pl-e">App.Base</span>
<span class="pl-en">index</span><span class="pl-k">:</span> <span class="pl-k"><span class="pl-k">-></span></span>
$ <span class="pl-k">-></span>
$(<span class="pl-s"><span class="pl-pds">'</span>#dataTable<span class="pl-pds">'</span></span>).dataTable
<span class="pl-v">ajax</span>: Routes.<span class="pl-en">cities_index_path</span>()
<span class="pl-v">columns</span>: [
<span class="pl-v">data</span>: <span class="pl-s"><span class="pl-pds">"</span>id<span class="pl-pds">"</span></span>
,
<span class="pl-v">data</span>: <span class="pl-s"><span class="pl-pds">"</span>name<span class="pl-pds">"</span></span>
,
<span class="pl-v">data</span>: <span class="pl-s"><span class="pl-pds">"</span>iata<span class="pl-pds">"</span></span>
,
<span class="pl-v">data</span>: <span class="pl-s"><span class="pl-pds">"</span>custom_column<span class="pl-pds">"</span></span>
,
<span class="pl-v">data</span>: <span class="pl-s"><span class="pl-pds">"</span>country_name<span class="pl-pds">"</span></span>
]</pre></div>
<h3>
<a id="model-datatable" class="anchor" href="#model-datatable" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Model Datatable</h3>
<p>Generating Datatable for model City:</p>
<p><code>$ bin/rails generate datatable City</code></p>
<p>Well, we have a app/datatables/city_datatatble.rb file, lets define model fields:</p>
<div class="highlight highlight-source-ruby"><pre><span class="pl-k">class</span> <span class="pl-en">CityDatatable<span class="pl-e"> < AjaxDatatablesRails::Base</span></span>
<span class="pl-k">def</span> <span class="pl-en">view_columns</span>
<span class="pl-smi">@view_columns</span> <span class="pl-k">||=</span> {
<span class="pl-c1">id:</span> { <span class="pl-c1">source:</span> <span class="pl-s"><span class="pl-pds">"</span>City.id<span class="pl-pds">"</span></span>, <span class="pl-c1">cond:</span> <span class="pl-c1">:eq</span> },
<span class="pl-c1">name:</span> { <span class="pl-c1">source:</span> <span class="pl-s"><span class="pl-pds">"</span>City.name<span class="pl-pds">"</span></span> },
<span class="pl-c1">custom_column:</span> { <span class="pl-c1">source:</span> <span class="pl-s"><span class="pl-pds">"</span>custom_column<span class="pl-pds">"</span></span>, <span class="pl-c1">cond:</span> filter_custom_column_condition },
<span class="pl-c1">iata:</span> { <span class="pl-c1">source:</span> <span class="pl-s"><span class="pl-pds">"</span>City.iata<span class="pl-pds">"</span></span> },
<span class="pl-c1">country_name:</span> { <span class="pl-c1">source:</span> <span class="pl-s"><span class="pl-pds">"</span>City.country_id<span class="pl-pds">"</span></span>, <span class="pl-c1">cond:</span> filter_country_condition },
}
<span class="pl-k">end</span>
<span class="pl-k">private</span>
<span class="pl-k">def</span> <span class="pl-en">data</span>
records.map <span class="pl-k">do </span>|<span class="pl-smi">city</span>|
{
<span class="pl-c1">id:</span> city.id,
<span class="pl-c1">name:</span> city.name,
<span class="pl-c1">iata:</span> city.iata,
<span class="pl-c1">country_name:</span> city.country.try(<span class="pl-c1">:name</span>),
<span class="pl-c1">custom_column:</span> city[<span class="pl-c1">:custom_column</span>]
}
<span class="pl-k">end</span>
<span class="pl-k">end</span>
<span class="pl-k">def</span> <span class="pl-en">get_raw_records</span>
<span class="pl-c1">City</span>.select(<span class="pl-s"><span class="pl-pds">'</span>cities.*, timezone AS custom_column<span class="pl-pds">'</span></span>).includes(<span class="pl-c1">:country</span>)
<span class="pl-k">end</span>
<span class="pl-k">def</span> <span class="pl-en">filter_country_condition</span>
<span class="pl-k">-</span><span class="pl-k">></span>(column) { column.table[column.field].eq(column.search.value.to_i <span class="pl-k">+</span> <span class="pl-c1">1</span>) }
<span class="pl-k">end</span>
<span class="pl-k">def</span> <span class="pl-en">filter_custom_column_condition</span>
<span class="pl-k">-</span><span class="pl-k">></span>(column) { ::<span class="pl-c1">Arel</span>::<span class="pl-c1">Nodes</span>::<span class="pl-c1">SqlLiteral</span>.<span class="pl-k">new</span>(column.field.to_s).matches(<span class="pl-s"><span class="pl-pds">"</span><span class="pl-pse">#{</span><span class="pl-s1"> column.search.value </span><span class="pl-pse"><span class="pl-s1">}</span></span>%<span class="pl-pds">"</span></span>) }
<span class="pl-k">end</span>
<span class="pl-k">end</span></pre></div>
<h3>
<a id="controller" class="anchor" href="#controller" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Controller</h3>
<p>Don't forget to return response with our Datatable in controller:</p>
<div class="highlight highlight-source-ruby"><pre><span class="pl-k">class</span> <span class="pl-en">CitiesController<span class="pl-e"> < ApplicationController</span></span>
respond_to <span class="pl-c1">:html</span>, <span class="pl-c1">:json</span>
<span class="pl-k">def</span> <span class="pl-en">index</span>
respond_to <span class="pl-k">do </span>|<span class="pl-smi">format</span>|
format.html
format.json <span class="pl-k">do</span>
render <span class="pl-c1">json:</span> <span class="pl-c1">CityDatatable</span>.<span class="pl-k">new</span>(view_context)
<span class="pl-k">end</span>
<span class="pl-k">end</span>
<span class="pl-k">end</span>
<span class="pl-k">end</span></pre></div>
<h3>
<a id="view" class="anchor" href="#view" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>View</h3>
<p>Last thing to is adding table in out cities/index.html.erb</p>
<div class="highlight highlight-text-html-basic"><pre><<span class="pl-ent">div</span> <span class="pl-e">class</span>=<span class="pl-s"><span class="pl-pds">"</span>table-responsive<span class="pl-pds">"</span></span>>
<<span class="pl-ent">table</span> <span class="pl-e">id</span>=<span class="pl-s"><span class="pl-pds">"</span>dataTable<span class="pl-pds">"</span></span> <span class="pl-e">class</span>=<span class="pl-s"><span class="pl-pds">"</span>table table-striped table-bordered<span class="pl-pds">"</span></span> <span class="pl-e">cellspacing</span>=<span class="pl-s"><span class="pl-pds">"</span>0<span class="pl-pds">"</span></span> <span class="pl-e">width</span>=<span class="pl-s"><span class="pl-pds">"</span>100%<span class="pl-pds">"</span></span>>
<<span class="pl-ent">thead</span>>
<<span class="pl-ent">tr</span> <span class="pl-e">class</span>=<span class="pl-s"><span class="pl-pds">"</span>filters<span class="pl-pds">"</span></span>>
<<span class="pl-ent">th</span>><<span class="pl-ent">input</span>/></<span class="pl-ent">th</span>>
<<span class="pl-ent">th</span>><<span class="pl-ent">input</span>/></<span class="pl-ent">th</span>>
<<span class="pl-ent">th</span>><<span class="pl-ent">input</span>/></<span class="pl-ent">th</span>>
<<span class="pl-ent">th</span>><<span class="pl-ent">input</span>/></<span class="pl-ent">th</span>>
<<span class="pl-ent">th</span>>
<%= collection_select(:city, :country_id, Country.all, :id, :name, include_blank: true) %>
</<span class="pl-ent">th</span>>
</<span class="pl-ent">tr</span>>
<<span class="pl-ent">tr</span>>
<<span class="pl-ent">th</span>>Id</<span class="pl-ent">th</span>>
<<span class="pl-ent">th</span>>Name</<span class="pl-ent">th</span>>
<<span class="pl-ent">th</span>>IATA</<span class="pl-ent">th</span>>
<<span class="pl-ent">th</span>>Timezone</<span class="pl-ent">th</span>>
<<span class="pl-ent">th</span>>Country</<span class="pl-ent">th</span>>
</<span class="pl-ent">tr</span>>
</<span class="pl-ent">thead</span>>
<<span class="pl-ent">tbody</span>></<span class="pl-ent">tbody</span>>
</<span class="pl-ent">table</span>>
</<span class="pl-ent">div</span>></pre></div>
<p><code>$ bin/rails s</code></p>
<p>That is it!</p>
<h2>
<a id="requirements" class="anchor" href="#requirements" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Requirements</h2>
<p>The gem supports ruby 2.0 and higher, rails 3.2 and higher versions.</p>
<h2>
<a id="sample-project" class="anchor" href="#sample-project" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Sample project</h2>
<p>Here is <a href="https://github.com/ajahongir/ajax-datatables-rails-v-0-4-0-how-to">how-to</a> project</p>
<h3>
<a id="authors-and-contributors" class="anchor" href="#authors-and-contributors" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Authors and Contributors</h3>
<p>Feel free to fork & contribute or leave a feedback if you have any issues.</p>
<footer class="site-footer">
<span class="site-footer-owner"><a href="https://github.com/ajahongir/ajax-datatables-rails">Rails & DataTables</a> is maintained by <a href="https://github.com/ajahongir">ajahongir</a>.</span>
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the <a href="https://github.com/jasonlong/cayman-theme">Cayman theme</a> by <a href="https://twitter.com/jasonlong">Jason Long</a>.</span>
</footer>
</section>
</body>
</html>