8000 Updates documentation and CHANGELOG · HaikalM/ajax-datatables-rails@53b2fdc · GitHub
[go: up one dir, main page]
Skip to content

Commit 53b2fdc

Browse files
antillas21antillas21
committed
Updates documentation and CHANGELOG
1 parent 74f47c7 commit 53b2fdc

File tree

2 files changed

+166
-64
lines changed

2 files changed

+166
-64
lines changed

‎CHANGELOG.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,33 @@
11
# CHANGELOG
22

3-
## 0.3.0
4-
* Changes to the `sortable_columns` and `searchable_columns` syntax as it required us to do unnecessary guessing.
5-
Thanks to [M. Saiqul Haq](https://github.com/saiqulhaq) for pointing this.
6-
* Adds support to discover from received params if a column should be really considered for sorting purposes.
7-
Thanks to [Zachariah Clay](https://github.com/mebezac) for this contribution.
3+
## 0.3.0 (unreleased yet)
4+
* Changes to the `sortable_columns` and `searchable_columns` syntax as it
5+
required us to do unnecessary guessing. New syntax is `ModelName.column_name`
6+
or `Namespace::ModelName.column_name`. Old syntax of `table_name.column_name`
7+
is still available to use, but prints a deprecation warning. Thanks to
8+
[M. Saiqul Haq](https://github.com/saiqulhaq) for pointing this.
9+
* Adds support to discover from received params if a column should be really
10+
considered for sorting purposes. Thanks to [Zachariah Clay](https://github.com/mebezac)
11+
for this contribution.
12+
* Moves paginator settings to configuration initializer.
813

914
## 0.2.1
10-
* Fix count method to work with select statements under Rails 4.1. Thanks to [Jason Mitchell](https://github.com/mitchej123) for the contribution.
11-
* Edits to `README` documentation about the `options` hash. Thanks to [Jonathan E Hogue](https://github.com/hoguej) for pointing out that previous documentation was confusing and didn't address its usage properly.
12-
* Edits to `README` documentation on complex model queries inside the `get_raw_records` method. A round of applause to [Zoltan Paulovics](https://github.com/zpaulovics) for contributing this awesome piece of documentation. :smile:
13-
* Adds typecast step to `search_condition` method, so now we support having non-text columns inside the `searchable_columns` array.
14-
* Adds support for multi-column sorting and multi-term search. Thanks to [Zoltan Paulovics](https://github.com/zpaulovics) for contributing this feature.
15-
* Adds optional config initializer, so we can have a base to typecast non text-based columns and perform searches depending on the use of `:mysql2`, `:sqlite3` or `:pg`. Thanks to [M. Saiqul Haq](https://github.com/saiqulhaq) for contributing this feature.
15+
* Fix count method to work with select statements under Rails 4.1. Thanks to
16+
[Jason Mitchell](https://github.com/mitchej123) for the contribution.
17+
* Edits to `README` documentation about the `options` hash. Thanks to
18+
[Jonathan E Hogue](https://github.com/hoguej) for pointing out that previous
19+
documentation was confusing and didn't address its usage properly.
20+
* Edits to `README` documentation on complex model queries inside the
21+
`get_raw_records` method. A round of applause to [Zoltan Paulovics](https://github.com/zpaulovics)
22+
for contributing this awesome piece of documentation. :smile:
23+
* Adds typecast step to `search_condition` method, so now we support having
24+
non-text columns inside the `searchable_columns` array.
25+
* Adds support for multi-column sorting and multi-term search. Thanks to
26+
[Zoltan Paulovics](https://github.com/zpaulovics) for contributing this feature.
27+
* Adds optional config initializer, so we can have a base to typecast non
28+
text-based columns and perform searches depending on the use of `:mysql2`,
29+
`:sqlite3` or `:pg`. Thanks to [M. Saiqul Haq](https://github.com/saiqulhaq)
30+
for contributing this feature.
1631

1732
## 0.2.0
1833
* This version works with jQuery dataTables ver. 1.10 and it's new API syntax.
@@ -35,12 +50,15 @@ Thanks to [iruca3](https://github.com/iruca3) for the fix.
3550
* A user would have the option to stick to the base
3651
`AjaxDatatablesRails::Extensions::SimplePaginator` or replace it with
3752
`AjaxDatatablesRails::Extensions::Kaminari` or
38-
`AjaxDatatablesRails::Extensions::WillPaginate`, depending on what he/she is using to handle record pagination.
53+
`AjaxDatatablesRails::Extensions::WillPaginate`, depending on what he/she
54+
is using to handle record pagination.
3955
* Removes dependency to pass in a model name to the generator. This way,
40-
the developer has more flexibility to implement whatever datatable feature is required.
56+
the developer has more flexibility to implement whatever datatable feature is
57+
required.
4158
* Datatable constructor accepts an optional `options` hash to provide
4259
more flexibility.
43-
See [README](https://github.com/antillas21/ajax-datatables-rails/blob/master/README.mds#options) for examples.
60+
See [README](https://github.com/antillas21/ajax-datatables-rails/blob/master/README.mds#options)
61+
for examples.
4462
* Sets generator inside the `Rails` namespace. To generate an
4563
`AjaxDatatablesRails` child class, just execute the
4664
generator like this: `$ rails generate datatable NAME`.

0 commit comments

Comments
 (0)
0