trk_datatables 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc472e542b418135db2ce0eab6f8b98d9c32d75a17f714c21a8b18772bfc24eb
-  data.tar.gz: 1c80411cdd014fa67c246a682d51e5b3be08f96ba78211df1119a5cc7a6d895b
+  metadata.gz: 57e78f6b6116b69f62786d4c055b7ba4d13ea30e47c268d3de230e2bac8b9b2f
+  data.tar.gz: ec35ef831ff82b46b10b88d8f37415317db17966912ee2aae01870f6dd9db3d9
 SHA512:
-  metadata.gz: 60ab3e28c6af2d70fbff6f11bbadf915219797eca2a0833389bcf74a04162cbc4a873389c2af8ed43819617f2c2c0cc8945dfa31b0007a04e062be6590491d7c
-  data.tar.gz: 37369125ed9a3a7c8c404d916e6eb425cd75f0ad83a4c4f7b7d6d7597a8e27c3108c3c1b172ed19a29e06707b407dec2244c55457e0559876e8c187a324690af
+  metadata.gz: bdea7f9b9fe10cd4a61f43206756e129dc8fdb8ea9f53b7d5716933c9930909a69e4a100f23812975da067bfc734937d4423b661d548afc35b6647792ba4726a
+  data.tar.gz: 35bc6e872063f0a694b8b25f7b9c8dc4400141439eed414a18ab5740774c6ce2e8c4172265441a1fc37740085c5152cd102d479e557120c25c89397355f2846b

data/Gemfile.lock

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

data/README.md

@@ -1,19 +1,17 @@
 # Trk Datatables
 
-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)
+This is a source for [trk_datatables gem](https://rubygems.org/gems/trk_datatables) that you
+can use with [trk_datatables npm package](https://www.npmjs.com/package/trk_datatables) for easier usage of [Datatables plug-in for jQuery library](https://datatables.net)
 
-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
-=================
+After [configuration](https://github.com/trkin/trk_datatables#configuration) you can use
+one line commands (like `@datatable.render_html`) to generate first page in html
+(so non-js crawlers can see it), global search, filtering and sorting, adding
+map and other complex listing based on GET params.
 
+## Table of Contents
+<!--ts-->
    * [Trk Datatables](#trk-datatables)
-   * [Table of Contents](#table-of-contents)
+      * [Table of Contents](#table-of-contents)
       * [Installation](#installation)
       * [Usage example in Ruby on Rails](#usage-example-in-ruby-on-rails)
       * [Configuration](#configuration)
@@ -23,6 +21,8 @@ Table of Contents
          * [Action column](#action-column)
          * [Params](#params)
          * [Saved Preferences (optional)](#saved-preferences-optional)
+         * [Additional data to json response](#additional-data-to-json-response)
+      * [Different response for mobile app](#different-response-for-mobile-app)
       * [Debug](#debug)
       * [Alternatives](#alternatives)
       * [Development](#development)
@@ -30,6 +30,10 @@ Table of Contents
       * [License](#license)
       * [Code of Conduct](#code-of-conduct)
 
+<!-- Added by: orlovic, at: Mon Sep  9 09:38:44 CEST 2019 -->
+
+<!--te-->
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -47,7 +51,7 @@ can use Rails generator)
 
 ## Usage example in Ruby on Rails
 
-For a table you need to define `rows` and `columns` (well that is obvious 😌).
+For a table you need to define `columns` and `rows` (well that is obvious 😌).
 In datatable class you also need to define `all_items` method which will  be
 used to populate `rows` with paginated, sorted and filtered items (we will call
 them `filtered`)
@@ -55,10 +59,6 @@ them `filtered`)
 ```
 # app/datatables/posts_datatable.rb
 class PostsDatatable < TrkDatatables::ActiveRecord
-  def all_items
-    Post.left_joins(:user)
-  end
-
   def columns
     {
       'posts.title': {},
@@ -74,6 +74,10 @@ class PostsDatatable < TrkDatatables::ActiveRecord
       ]
     end
   end
+
+  def all_items
+    Post.left_joins(:user)
+  end
 end
 ```
 
@@ -115,10 +119,10 @@ And finally in a view, use `render_html` to have first page show up prerendered
 
 ## Configuration
 
-Datatable will search all columns that you defined as keys in `columns` using a
+Datatables will search all columns that you defined as keys in `columns` using a
 `ILIKE` (ie `.matches` in Arel ActiveRecord).
 
-On frontend there are two types of search: global (search all columns) and
+In datatables there are two types of search: global (search all columns) and
 column search (search is done for specific columns).
 
 ### Global search
@@ -129,23 +133,96 @@ method.
 ```
 class PostsDatatable < TrkDatatables::ActiveRecord
   def global_search_columns
-    # those fields will be used only to match global search
+    # in addition to columns those fields will be used to match global search
     %w[posts.body users.name]
   end
 end
 ```
 
-### Column 'ILIKE' and 'BETWEEN' search
+### Column 'ILIKE' search
 
-For column search when search string does not contain BETWEEN_SEPARATOR (` - `) than
-all columns are casted to string and `ILIKE` is perfomed.
+All columns are by default caster to string and `ILIKE` is perfomed.
+There is short notation if you do not need any specific column configuration,
+for example custom title (in which case you need to define columns as key/value
+pairs).
 
-When column_type_in_db as one of the: `:date`, `:datetime`, `:integer` and
-`:float` than `BETWEEN` is perfomed (when search contains BETWEEN_SEPARATOR,
-otherwise it is `ILIKE`).
+```
+# app/datatables/posts_datatable.rb
+class PostsDatatable < TrkDatatables::ActiveRecord
+  def columns
+    # %w[posts.id posts.title posts.body] or even shorter using map
+    %i[id title body].map { |col| "posts.#{col}" }
+  end
+end
+```
+### Column 'BETWEEN' search
+
+For column search when search string contains BETWEEN_SEPARATOR (` - `) and
+column_type_in_db as one of the: `:date`, `:datetime`, `:integer` and
+`:float` than `BETWEEN` is perfomed.
+
+For columns `:date` there will be `data-datatable-range='true'`
+attribute so [data range picker](http://www.daterangepicker.com/) will be
+automatically loaded. For `:datetime` you can enable time picker in addition to
+date.
+
+```
+# app/datatables/posts_datatable.rb
+class PostsDatatable < TrkDatatables::ActiveRecord
+  def columns
+    {
+      'posts.created_at': { time_picker: true },
+    }
+  end
+end
+```
+
+To enable shortcuts for selecting ranges, you can override predefined ranges
+
+```
+# app/datatables/base_trk_datatable.rb
+class BaseTrkDatable < TrkDatatables::ActiveRecord
+  def predefined_ranges
+    # defaults are defined in https://github.com/trkin/trk_datatables/blob/master/lib/trk_datatables/base.rb
+    default_predefined_ranges
+  end
+end
+```
+or you can override for specific datatable
+```
+class PostsDatatable < TrkDatatables::ActiveRecord
+  def columns
+    {
+      'posts.created_at': { predefined_ranges: true },
+    }
+  end
+
+  def predefined_ranges
+    {
+      'Today': Time.zone.now.beginning_of_day..Time.zone.now.end_of_day,
+      'Yesterday': [Time.zone.now.beginning_of_day - 1.day, Time.zone.now.end_of_day - 1.day],
+      'This Month': Time.zone.today.beginning_of_month...Time.zone.now.end_of_day,
+      'Last Month': Time.zone.today.prev_month.beginning_of_month...Time.zone.today.prev_month.end_of_month.end_of_day,
+      'This Year': Time.zone.today.beginning_of_year...Time.zone.today.end_of_day,
+    }
+  end
+end
+```
+or you can define for specific column
+```
+# app/datatables/posts_datatable.rb
+class PostsDatatable < TrkDatatables::ActiveRecord
+  def columns
+    {
+      'posts.created_at': { predefined_ranges: { 'Today': Time.zone.now.beginning_of_day...Time.zone.now.end_of_day } },
+    }
+  end
+end
+```
 
-For columns `:date` and `:datetime` there will be `data-datatable-range='true'`
-attribute so bootstrap datepicker will be automatically loaded.
+We use
+[ActiveSupport::TimeZone](https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html)
+so if you use different than UTC you need to set `Time.zone =` in your app [example values](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/values/time_zone.rb#L31). Whenever Time.parse is used (and we use `Time.zone.parse` for params) it needs correct zone (in Rails you can set timezone in `config.time_zone` or use [browser timezone rails gem](https://github.com/kbaum/browser-timezone-rails)).
 
 ### Column 'IN' search
 
@@ -184,9 +261,10 @@ use empty column_key
 
   def rows(filtered)
     filtered.each do |post|
+      actions = @view.link_to('View', post)
       [
         post.title,
-        "@view"
+        actions,
       ]
     end
   end

data/lib/trk_datatables/active_record.rb

@@ -90,7 +90,7 @@ module TrkDatatables
     def _parse_in_zone(time)
       return nil if time.blank?
 
-      # without rails we will parse without zone so make sure params are correct
+      # without zone we will parse without zone so make sure params are correct
       Time.zone ? Time.zone.parse(time) : Time.parse(time)
     rescue ArgumentError
       nil

data/lib/trk_datatables/base.rb

@@ -15,7 +15,7 @@ module TrkDatatables
     def initialize(view)
       @view = view
       @dt_params = DtParams.new view.params
-      @column_key_options = ColumnKeyOptions.new columns, global_search_columns
+      @column_key_options = ColumnKeyOptions.new columns, global_search_columns, predefined_ranges
       @preferences = Preferences.new preferences_holder, preferences_field
 
       # if @dt_params.dt_columns.size != @column_key_options.size
@@ -215,5 +215,20 @@ module TrkDatatables
     def preferences_field
       :preferences
     end
+
+    def predefined_ranges
+      {}
+    end
+
+    def default_predefined_ranges
+      Time.zone ||= 'UTC'
+      {
+        'Today': Time.zone.now.beginning_of_day..Time.zone.now.end_of_day,
+        'Yesterday': [Time.zone.now.beginning_of_day - 1.day, Time.zone.now.end_of_day - 1.day],
+        'This Month': Time.zone.today.beginning_of_month...Time.zone.now.end_of_day,
+        'Last Month': Time.zone.today.prev_month.beginning_of_month...Time.zone.today.prev_month.end_of_month.end_of_day,
+        'This Year': Time.zone.today.beginning_of_year...Time.zone.today.end_of_day,
+      }
+    end
   end
 end

data/lib/trk_datatables/column_key_options.rb

@@ -16,10 +16,11 @@ module TrkDatatables
     ORDER_OPTION = :order
     TITLE_OPTION = :title
     SELECT_OPTIONS = :select_options
+    PREDEFINED_RANGES = :predefined_ranges
     # this will load date picker
     # SEARCH_OPTION_DATE_VALUE = :date
     # SEARCH_OPTION_DATETIME_VALUE = :datetime
-    COLUMN_OPTIONS = [SEARCH_OPTION, ORDER_OPTION, TITLE_OPTION, SELECT_OPTIONS].freeze
+    COLUMN_OPTIONS = [SEARCH_OPTION, ORDER_OPTION, TITLE_OPTION, SELECT_OPTIONS, PREDEFINED_RANGES].freeze
 
     STRING_TYPE_CAST_POSTGRES = 'VARCHAR'.freeze
     STRING_TYPE_CAST_MYSQL    = 'CHAR'.freeze
@@ -48,11 +49,17 @@ module TrkDatatables
     #     title: 'Name',
     #     html_options: { class: 'my-class' },
     #   }
-    def initialize(cols, global_search_cols)
-      # if someone use Array instead of hash, we will use first element
+    def initialize(cols, global_search_cols, predefined_ranges = {})
+      @predefined_ranges = predefined_ranges
+      # short notation is when we use array of keys.
+      # In case first element is hash than we will use that hash
       if cols.is_a? Array
-        cols = cols.each_with_object({}) do |column_key, hash|
-          hash[column_key.to_sym] = {}
+        if cols.first.is_a? Hash
+          cols = cols.first
+        else
+          cols = cols.each_with_object({}) do |column_key, hash|
+            hash[column_key.to_sym] = {}
+          end
         end
       end
       _set_data(cols)
@@ -157,9 +164,22 @@ module TrkDatatables
       res = {}
       res['data-searchable'] = false if column_options[SEARCH_OPTION] == false
       res['data-orderable'] = false if column_options[ORDER_OPTION] == false
-      res['data-datatable-range'] = true if %i[date datetime].include? column_type_in_db
+      if %i[date datetime].include? column_type_in_db
+        res['data-datatable-range'] = column_type_in_db == :datetime ? :datetime : true
+        if column_options[PREDEFINED_RANGES].present? || @predefined_ranges.present?
+          res['data-datatable-predefined-ranges'] = if column_options[PREDEFINED_RANGES].is_a? Hash
+                                                      column_options[PREDEFINED_RANGES]
+                                                    else
+                                                      @predefined_ranges
+                                                    end
+          res['data-datatable-predefined-ranges'].transform_values! do |range|
+            [range.first.to_s, range.last.to_s]
+          end
+        end
+      end
       res
     end
+
   end
   # rubocop:enable ClassLength
 end

data/lib/trk_datatables/render_html.rb

@@ -45,6 +45,7 @@ module TrkDatatables
       self.class.indent += 1
       html = "#{'  ' * self.class.indent}<#{tag}".html_safe
       options.each do |attribute, value|
+        value = value.to_json if value.is_a?(Hash) || value.is_a?(Array)
         html << " #{attribute}='".html_safe << replace_quote(value) << "'".html_safe
       end
       html << if inline
@@ -99,10 +100,13 @@ module TrkDatatables
         _content_tag :tr do
           safe_join(@datatable.column_key_options.map do |column_key_option|
             options = column_key_option[:html_options]
+            # add eventual value from params
             search_value = @datatable.param_get(column_key_option[:column_key]) if options['data-searchable'] != false
             options['data-datatable-search-value'] = search_value if search_value.present?
+            # add eventual select element
             select_options = column_key_option[:column_options][ColumnKeyOptions::SELECT_OPTIONS]
             options['data-datatable-multiselect'] = _select_tag select_options, search_value if select_options.present?
+            # all other options are pulled from column_key_option[:html_options]
             _content_tag :th, options, column_key_option[:title]
           end)
         end

data/lib/trk_datatables/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.1.8'.freeze
+  VERSION = '0.1.9'.freeze
 end

data/lib/trk_datatables.rb

@@ -13,3 +13,8 @@ require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/string/output_safety'
+require 'active_support/core_ext/time/zones'
+
+# we need to define here since some conventions will look for definition in this file
+module TrkDatatables
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -202,8 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Gem that simplify using datatables with Ruby on Rails and Sinatra.