trk_datatables 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 845e7639e8e44a0180ebbe05a91ef31d03a0f0327f60d7ffa42a7dd3c60947bd
-  data.tar.gz: 738323a675316e90362f9722aab3a136dff221611308b39720b676c797314e5d
+  metadata.gz: 1364b277e524ba846d027f01c3411715423f6947525154f96711eb3fabade651
+  data.tar.gz: d97b863eb1497fa9c9ee894fc0406f2986003a72a927bbc7fff00ccde255007a
 SHA512:
-  metadata.gz: 656e6d0feb437a80fd492c98eca387df3b90a12740a3c4557ff93a8ad4db8701906546262f77e59f92b981a079a90fa785c008d33f01021d6a782b61d790f91b
-  data.tar.gz: 7c8a74a2559784d4652fee86ee0b34a1ef34237fc598a535c1b2523ceb74c6e386d544095ff1c5732b6bafc4ad6f81bcf8fc82b484315a3691219c2b90f7da88
+  metadata.gz: 2545a0e9c8aa3dfc4215c99f0be6cd2123e9178397b4c2eb74b3f5dbe0f89be3d0df410626512ddf5eb667f7731c1029ae2c3da73e9bc8123d755d9672cbdee4
+  data.tar.gz: 7dd7f80721e171e207fb237f051f4884eec69584972344f67981dd46f0e3e502052c1393e11c51221ffe017d18c0b64c0a23d45ce3b6104533873d460b3f8039

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trk_datatables (0.1.6)
+    trk_datatables (0.1.7)
       activesupport
 
 GEM

data/README.md

@@ -1,16 +1,34 @@
 # Trk Datatables
 
-This is a [trk_datatables gem](https://github.com/trkin/trk_datatables) that you
+This is a [trk_datatables gem](https://rubygems.org/gems/trk_datatables) that you
 can use with trk_datatables npm package for easier usage of [Datatables js library](https://datatables.net)
 
-It gives you one liner command to generate first page in html (so non-js
-crawlers can see it), global search, filtering and sorting by one or more
-columns, adding map and other complex listing based on GET params.
-
-There are alternatives, for example:
-* [jbox-web/ajax-datatables-rails](https://github.com/jbox-web/ajax-datatables-rails)
-excellent gem but it's scope is only to produce JSON. I wanted to have server
-side rendering and more advance listing
+After [configuring one
+datatable](https://github.com/trkin/trk_datatables#configuration), it gives you
+one liner command to generate first page in html (so non-js crawlers can see
+it), global search, filtering and sorting by one or more columns, adding map and
+other complex listing based on GET params.
+
+Table of Contents
+=================
+
+   * [Trk Datatables](#trk-datatables)
+   * [Table of Contents](#table-of-contents)
+      * [Installation](#installation)
+      * [Usage example in Ruby on Rails](#usage-example-in-ruby-on-rails)
+      * [Configuration](#configuration)
+         * [Global search](#global-search)
+         * [Column 'ILIKE' and 'BETWEEN' search](#column-ilike-and-between-search)
+         * [Column 'IN' search](#column-in-search)
+         * [Action column](#action-column)
+         * [Params](#params)
+         * [Saved Preferences (optional)](#saved-preferences-optional)
+      * [Debug](#debug)
+      * [Alternatives](#alternatives)
+      * [Development](#development)
+      * [Contributing](#contributing)
+      * [License](#license)
+      * [Code of Conduct](#code-of-conduct)
 
 ## Installation
 
@@ -97,13 +115,13 @@ And finally in a view, use `render_html` to have first page show up prerendered
 
 ## Configuration
 
-### Global search
+Datatable will search all columns that you defined as keys in `columns` using a
+`ILIKE` (ie `.matches` in Arel ActiveRecord).
 
-There are two types of search: global (search all columns) and column search
-(search is done for specific columns).
+On frontend there are two types of search: global (search all columns) and
+column search (search is done for specific columns).
 
-For global search any type of a column is casted to a string and we use `ILIKE`
-(ie `.matches`).
+### Global search
 
 You can add more columns to global search by overriding `global_search_columns`
 method.
@@ -151,7 +169,7 @@ You can use column_option `search: :checkbox` so for column_type_in_db `:boolean
 it will provide checkbox. For other column_type_in_db it will match if value is
 NULL or NOT NULL.
 
-## Action column
+### Action column
 
 You can use one column for actions (so it is not related to any db column) just
 use empty column_key
@@ -174,7 +192,7 @@ use empty column_key
   end
 ```
 
-## Params
+### Params
 
 To set parameters that you can use for links to set column search value, use
 this `PostsDatatable.param_set` for example
@@ -194,7 +212,7 @@ If you need, you can fetch params with this helper
 PostsDatatable.param_get('users.email', params)
 ```
 
-## Saved Preferences (optional)
+### Saved Preferences (optional)
 
 You can save column order and page length in User.preferences field so
 next time user navigate to same page will see the same order and page length. It
@@ -225,6 +243,76 @@ end
 It will store order and page lenght inside `dt_preferences` on
 `user.preferences`.
 
+### Additional data to json response
+
+You can override `additional_data_for_json` that will be included in json
+response
+```
+# app/datatables/posts_datatable.rb
+class PostsDatatable < TrkDatatables::ActiveRecord
+  def additional_data_for_json
+    { columns: columns }
+  end
+end
+```
+
+## Different response for mobile app
+
+You can use condition to provide different data, for example let's assume
+`@view.api_user?` returns true for json requests from mobile app. Here is
+example that provides different columns for normal and api_user:
+
+```
+# app/datatables/posts_datatable.rb
+class PostsDatatable < TrkDatatables::ActiveRecord
+  def columns
+    @view.api_user? ? columns_for_api : columns_for_html
+  end
+
+  def columns_for_html
+    {
+      'subscribers.subscriberid': {},
+      'subscribers.name': {},
+    }
+  end
+
+  def columns_for_api
+    {
+      'subscribers.id': {},
+      'subscribers.subscriberid': {},
+      'subscribers.name': {},
+    }
+  end
+
+  def rows(filtered)
+    @view.api_user? ? rows_for_api(filtered) : rows_for_html(filtered)
+  end
+
+  def rows_for_html(filtered)
+    filtered.map do |subscriber|
+      [
+        @view.link_to(subscriber.subscriberid, subscriber),
+        subscriber.name,
+      ]
+    end
+  end
+
+  def rows_for_api(filtered)
+    filtered.map do |subscriber|
+      [
+        subscriber.id,
+        subscriber.subscriberid,
+        subscriber.name,
+      ]
+    end
+  end
+
+  def additional_data_for_json
+    @view.api_user? ? columns_for_api : nil
+  end
+end
+```
+
 ## Debug
 
 You can override some of the methos and put byebug, for example
@@ -239,6 +327,13 @@ end
 
 ```
 
+## Alternatives
+
+There are alternatives, for example:
+* [jbox-web/ajax-datatables-rails](https://github.com/jbox-web/ajax-datatables-rails)
+excellent gem but it's scope is only to produce JSON. I wanted to have server
+side rendering and more advance listing
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/trk_datatables/base.rb

@@ -169,11 +169,15 @@ module TrkDatatables
       @dt_params.as_json(
         all_items.count,
         filtered_items.count,
-        columns,
         rows(ordered_paginated_filtered_items),
+        additional_data_for_json
       )
     end
 
+    def additional_data_for_json
+      {}
+    end
+
     def filtered_items
       filter_by_search_all filter_by_columns all_items
     end

data/lib/trk_datatables/dt_params.rb

@@ -89,15 +89,14 @@ module TrkDatatables
       @params.dig(:search, :value) || ''
     end
 
-    def as_json(all_count, filtered_items_count, columns, data)
+    def as_json(all_count, filtered_items_count, data, additional = {})
       draw = @params[:draw].to_i
       {
         draw: draw,
         recordsTotal: all_count,
         recordsFiltered: filtered_items_count,
-        columns: columns,
         data: data,
-      }
+      }.merge additional
     end
 
     def self.param_set(column_index, value)

data/lib/trk_datatables/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.1.6'.freeze
+  VERSION = '0.1.7'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Dusan Orlovic