trk_datatables 0.2.4 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94acc0f23e22979cbdfbbd78356012328d0da999b00706bee6b8feb28e98c7bb
-  data.tar.gz: 458f2c1fdb9400faf491b494d5866b17397643464431bf8e6a4e115211cbbaca
+  metadata.gz: 520b6d86f27312cd4c8bb89e62943f542be727954446ce8c4be03790727f7a4d
+  data.tar.gz: dd881cc122ffd0cbec3eca16db24ed65cfc98921d22080920d8df167a8c7260c
 SHA512:
-  metadata.gz: b48507c0815c0ab7946eb4fd770cdd317d5fceca8845c1f007556b627cfc5f77d5816497ed2825d1dce4974aa530def7bd455441e2f785131a6cd11fb1281614
-  data.tar.gz: 609e99cc22a0a195f3903af22f214d9ce8d6e5ffbf221862844389d3af3f0e90c30e82f66ad830d808bf97023f146655d2df55d76638033a2e4c3b733b0ab6e0
+  metadata.gz: f7f62cc8d55ca17597c9c65d3aaf646f16f92a94873b97c83847e6e01f843f951ec74796e8064ed81cab802a404599006b3a7c321ecb672fc909c9f5e669724c
+  data.tar.gz: 27ea4d1cf61af80539f66502256a173c603416030da3943947fcf5d43eaefd068fe0112a7fa0d87aa2cca493f77b759c76f3c151afd1ecd3d85c44b1804e7216

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trk_datatables (0.2.4)
+    trk_datatables (0.2.9)
       activesupport
 
 GEM
@@ -30,6 +30,7 @@ GEM
     rake (10.5.0)
     sqlite3 (1.4.1)
     thread_safe (0.3.6)
+    timecop (0.9.4)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     zeitwerk (2.1.10)
@@ -47,6 +48,7 @@ DEPENDENCIES
   pg
   rake (~> 10.0)
   sqlite3
+  timecop
   trk_datatables!
 
 BUNDLED WITH

data/README.md

@@ -18,7 +18,7 @@ you can get something like
 
 ![trk-datatables](test/trk_datatables_with_daterangepicker.png "TRK Datatables")
 
-Currenlty it supports:
+Currently supports:
 * ActiveRecord
 * Neo4j
 
@@ -284,47 +284,32 @@ class PostsDatatable < TrkDatatables::ActiveRecord
 end
 ```
 
-To enable shortcuts for selecting ranges, you can override predefined ranges and
-enable for all `date` and `datetime` column
-
-```
-# 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 enable for all `date` and `datetime columns` for specific datatable
-by defining `predefined_ranges` on that datatable. You can disable for specific columns also
+By default, predefined ranges are enabled. You can find source for
+`predefined_date_ranges` and `predefined_datetime_ranges` in
+[base.rb](https://github.com/trkin/trk_datatables/blob/master/lib/trk_datatables/base.rb)
+You can overwrite them in BaseTrkDatable or your trk datatable class.
+You can disable or enable for specific columns like in this example:
 ```
 class PostsDatatable < TrkDatatables::ActiveRecord
-  def predefined_ranges
+  def predefined_datetime_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,
-    }
+   }.transform_values do |range|
+     # datepicker expects format 2020-11-29 11:59:59
+     range.first.strftime('%F %T')..range.last.strftime('%F %T')
+   end
   end
 
   def columns
     {
-      'posts.created_at': {}, # this column will have predefined_ranges
-      'posts.published_on': { predefined_ranges: false }
-  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 } },
-    }
+      'posts.created_at': {}, # this column will have predefined_datetime_ranges
+      'posts.published_on': { predefined_ranges: false },
+      'posts.updated_at': { predefined_ranges: { 'Today': Time.zone.now.beginning_of_day...Time.zone.now.end_of_day } },
+   }
   end
 end
 ```
@@ -567,6 +552,24 @@ class PostsDatatable
 end
 ```
 
+### Render html with additional css class and different DOM
+
+To add additional styling to your datatable you can use `:class` option when you
+are calling `@datatable.render_html url, options` for example
+
+```
+<%= @datatable.render_html search_posts_path(format: :json), class: 'table-hover' %>
+```
+
+Default [DOM](https://datatables.net/reference/option/dom) is
+`<"trk-global-search-wrapper"f>rtp<"trk-move-up"il>` which includes global
+**f**iltering, p**r**ocessing loader, **t**able search, **p**agination, table
+**i**nformation and **l**ength changing control. To override you can use
+
+```
+<%= @datatable.render_html search_posts_path(format: :json), 'data-datatable-dom': 'rt' %>
+```
+
 ### Params
 
 To set parameters that you can use for links to set column search value, use
@@ -589,8 +592,12 @@ This will fill proper column search values so you do not need to do it manually
 (`post_path(:columns=>{"3"=>{:search=>{:value=>"my@email.com"}},
 "2"=>{:search=>{:value=>"1|2"}}}, :user_id=>1)`)
 
-For form fields you can use similar helper `PostsDatatable.form_field_name
-'users.email'`
+For form fields you can use similar helper that will return name which points to
+specific column, for example:
+```
+PostsDatatable.form_field_name('users.email'`) # => 'columns[3][search][value]'
+```
+Usefull when you want to provide a form for a user to search on specific column
 ```
 <%= form_tag url: posts_path, method: :get do |f| %>
   <%= f.text_field PostsDatatable.form_field_name('users.email'), 'my@email.com' %>
@@ -598,10 +605,19 @@ For form fields you can use similar helper `PostsDatatable.form_field_name
 <% end %>
 ```
 
+For global search you can use `[search][value]` for example
+
+```
+<%= form_tag url: posts_path, method: :get do |f| %>
+  <%= f.text_field '[search][value]', 'my@email.com' %>
+  <%= f.submit 'Search' %>
+<% end %>
+```
+
 If you need, you can fetch params with this helper
 
 ```
-PostsDatatable.param_get('users.email', params)
+datatable.param_get 'users.email'
 ```
 
 You can set filters on datatable even params are blank, for example

data/lib/trk_datatables/active_record.rb

@@ -1,9 +1,12 @@
 module TrkDatatables
   class ActiveRecord < Base
+    # there is a stack level too deep exception for more than 190 strings
+    MAX_NUMBER_OF_STRINGS = 190
+
     # Global search. All columns are typecasted to string. Search string is
     # splited by space and "and"-ed.
     def filter_by_search_all(filtered)
-      conditions = @dt_params.search_all.split(' ').map do |search_string|
+      conditions = @dt_params.search_all.split(' ').first(MAX_NUMBER_OF_STRINGS).map do |search_string|
         @column_key_options.searchable_and_global_search.map do |column_key_option|
           _filter_column_as_string column_key_option, search_string
         end.reduce(:or) # any searchable column is 'or'-ed
@@ -45,7 +48,7 @@ module TrkDatatables
     end
 
     def _filter_column_as_string(column_key_option, search_value)
-      search_value.split(' ').map do |search_string|
+      search_value.split(' ').first(MAX_NUMBER_OF_STRINGS).map do |search_string|
         casted_column = ::Arel::Nodes::NamedFunction.new(
           'CAST',
           [_arel_column(column_key_option).as(@column_key_options.string_cast)]

data/lib/trk_datatables/base.rb

@@ -7,7 +7,7 @@ module TrkDatatables
   class Error < StandardError
   end
 
-  class Base
+  class Base # rubocop:todo Metrics/ClassLength
     extend TrkDatatables::BaseHelpers
 
     attr_accessor :column_key_options
@@ -97,8 +97,6 @@ module TrkDatatables
       raise 'order_and_paginate_items_is_defined_in_specific_orm'
     end
 
-    # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
-
     # Returns dt_orders or default as array of index and direction
     # https://datatables.net/reference/option/order
     # @return
@@ -114,12 +112,11 @@ module TrkDatatables
         @dt_orders_or_default = @dt_params.dt_orders
         @preferences.set :order, @dt_params.dt_orders
       else
-        check_value = ->(r) { r.is_a?(Array) && r[0].is_a?(Array) && r[0][0].is_a?(Integer) }
+        check_value = ->(r) { r.is_a?(Array) && r[0].is_a?(Array) && r[0][0].is_a?(Integer) && r[0][0] < @column_key_options.size }
         @dt_orders_or_default = @preferences.get(:order, check_value) || default_order
       end
       @dt_orders_or_default
     end
-    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
     def default_order
       [[0, :desc]].freeze
@@ -219,18 +216,35 @@ module TrkDatatables
     end
 
     def predefined_ranges
-      {}
+      Time.zone ||= 'UTC'
+      {
+        date: predefined_date_ranges,
+        datetime: predefined_datetime_ranges,
+      }
     end
 
-    def default_predefined_ranges
-      Time.zone ||= 'UTC'
+    def predefined_date_ranges # rubocop:todo Metrics/AbcSize
+      {
+        'Today': Time.zone.today..Time.zone.today,
+        'Yesterday': [Time.zone.today - 1.day, Time.zone.today - 1.day],
+        'This Month': Time.zone.today.beginning_of_month...Time.zone.today,
+        'Last Month': Time.zone.today.prev_month.beginning_of_month...Time.zone.today.prev_month.end_of_month,
+        'This Year': Time.zone.today.beginning_of_year...Time.zone.today,
+      }
+    end
+
+    def predefined_datetime_ranges # rubocop:todo Metrics/AbcSize
       {
         '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,
-      }
+        'This Month': Time.zone.today.beginning_of_month.beginning_of_day...Time.zone.now.end_of_day,
+        'Last Month':
+          Time.zone.today.prev_month.beginning_of_month.beginning_of_day...Time.zone.today.prev_month.end_of_month.end_of_day,
+        'This Year': Time.zone.today.beginning_of_year.beginning_of_day...Time.zone.today.end_of_day,
+      }.transform_values do |range|
+        # datepicker expects format 2020-11-29 11:59:59
+        range.first.strftime('%F %T')..range.last.strftime('%F %T')
+      end
     end
   end
 end

data/lib/trk_datatables/base_helpers.rb

@@ -22,11 +22,15 @@ module TrkDatatables
     end
 
     # Get the form field name for column. This is class method so you do not
-    # need datatable instance.
+    # need datatable instance. It returns something like
+    # 'column[3][search][value]`. For global search you can use
+    # '[search][value]`
     #
     # @example
     # form_tag url: posts_path, method: :get do |f|
     #   f.text_field PostsDatatable.form_field_name('users.email'), 'my@email.com'
+    #   # it is the same as
+    #   f.text_field 'columns[3][search][value]', 'my@email.com'
     def form_field_name(column_key)
       datatable = new OpenStruct.new(params: {})
       column_index = datatable.index_by_column_key column_key

data/lib/trk_datatables/column_key_options.rb

@@ -244,11 +244,11 @@ module TrkDatatables
       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? && column_options[PREDEFINED_RANGES] != false)
+            (@predefined_ranges.try(:[], column_type_in_db).present? && column_options[PREDEFINED_RANGES] != false)
           res['data-datatable-predefined-ranges'] = if column_options[PREDEFINED_RANGES].is_a? Hash
                                                       column_options[PREDEFINED_RANGES]
                                                     else
-                                                      @predefined_ranges
+                                                      @predefined_ranges[column_type_in_db]
                                                     end
           res['data-datatable-predefined-ranges'].transform_values! do |range|
             [range.first.to_s, range.last.to_s]

data/lib/trk_datatables/dt_params.rb

@@ -117,7 +117,7 @@ module TrkDatatables
     def param_get(column_index)
       @params.dig :columns, column_index.to_s, :search, :value
     rescue TypeError => e
-      raise Error, e.message + '. Column search is in a format: { "columns": { "0": { "search": { "value": { "ABC" } } } } }'
+      raise Error, "#{e.message}. Column search is in a format: { \"columns\": { \"0\": { \"search\": { \"value\": { \"ABC\" } } } } }"
     end
 
     def self.sample_view_params(options = {})

data/lib/trk_datatables/render_html.rb

@@ -4,8 +4,8 @@ module TrkDatatables
     def initialize(search_link, datatable, html_options = {})
       @search_link = search_link
       @datatable = datatable
-      @html_options = html_options
-      self.class.indent = -1
+      @html_options = html_options.symbolize_keys
+      self.class.indent = 0
     end
 
     def result
@@ -53,7 +53,7 @@ module TrkDatatables
               else
                 ">\n".html_safe << yield << "\n#{'  ' * self.class.indent}</#{tag}>".html_safe
               end
-      self.class.indent -= 1
+      self.class.indent -= 1 if self.class.indent > 1
       html
     end
     # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity
@@ -89,6 +89,7 @@ module TrkDatatables
         # for initial page load we do not have ability to show recordsTotal
         # https://github.com/trkin/trk_datatables_js/issues/1
         'data-datatable-total-length': @datatable.filtered_items_count,
+        'data-datatable-dom': @html_options[:'data-datatable-dom'] || '<"trk-global-search-wrapper"f>rtp<"trk-move-up"il>',
       ) do
         thead << "\n".html_safe << tbody
       end +
@@ -128,6 +129,25 @@ module TrkDatatables
     end
 
     def table_tag_client
+      # Should we allow generating datatable only in view
+      # <%= ClientDatatable.new(self).render_html do %>
+      #    <thead>
+      #      <tr>
+      # so we do not need datatable and search route
+      # than we just need <table> tag, but it uses datatable to determine page
+      # length and order (which in turn it determines from params or
+      # preferences)
+      # _content_tag(
+      #   :table,
+      #   class: "table table-bordered table-striped #{@html_options[:class]}",
+      #   'data-datatable': true,
+      #   'data-datatable-ajax-url': @search_link,
+      #   'data-datatable-page-length': @datatable.dt_per_page_or_default,
+      #   'data-datatable-order': @datatable.dt_orders_or_default_index_and_direction.to_json,
+      #   # for initial page load we do not have ability to show recordsTotal
+      #   # https://github.com/trkin/trk_datatables_js/issues/1
+      #   'data-datatable-total-length': @datatable.filtered_items_count,
+      # ) do
       ''
     end
   end

data/lib/trk_datatables/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.2.4'.freeze
+  VERSION = '0.2.9'.freeze
 end

data/trk_datatables.gemspec

@@ -46,6 +46,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-color'
+  spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'pg'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'sqlite3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.9
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Gem that simplify using datatables with Ruby on Rails and Sinatra.