trk_datatables 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df8bfddf3658f2462c4aedc466514453d6b28745b80fa54a76e92321004090b2
-  data.tar.gz: 43af45648ffbbb57db38547ee2487cb11be6abb660be9eb7a8a405c485e1f293
+  metadata.gz: 40eeba5483cf896ad0df528f5b329a0bdfd7b2a7d78ab18df295f1b30737ba8f
+  data.tar.gz: 7e9c1cd8f4c9fcf942dd5639b7f406e85ccb6c0c037e2dd6a3a7b42ece5d641b
 SHA512:
-  metadata.gz: 8e3173a1237202c8949f77594922d98f4dbf98e869f74660f708d0c81b3c3869c9a1e48e351ffba5c694826c27df60e5394c5513338e6be356d0efda58eee857
-  data.tar.gz: 10da1a1ebcd9a4d725ee16b6876df0eae18ea4feaa36f3c8a2128637bdf48ed2042ba9ffcb410626ad2beba60c20a07d5e6d76ddccef109c490259d4098ee596
+  metadata.gz: b29ccb1148bb7b4782b4cf5d466330d241bbc90c5554129b4d243833d5585a2fad599fbf6e518e62a08db487e32adcdf0ebd65232592f9d01fe048a4898f0310
+  data.tar.gz: 3b3f65377b9bc66f33874abcbe231fc6e5ace020b82526fb8edbab5b697085bcf1f3bd48c2bc8f7d42873770a6c61e2096716a3bf95343dad20aa9c2947ee0dd

data/Gemfile.lock

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

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
 ```
@@ -602,6 +587,15 @@ Usefull when you want to provide a form for a user to search on specific column
 <% 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
 
 ```

data/lib/trk_datatables/base.rb

@@ -219,18 +219,34 @@ 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
+      {
+        '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
       {
         '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/render_html.rb

@@ -128,6 +128,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.5'.freeze
+  VERSION = '0.2.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -206,7 +206,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.