trk_datatables 0.2.2 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ccb77ab8bb5b29b22c346044bdb06171bed27a50721873cd1d5ec619c8ef1f1
-  data.tar.gz: 0d747920ac2dd280c0274dd46af82c59afd7c55151910e598d97d64ac2447a6d
+  metadata.gz: 25c48f4088f3f708eaa1dc7d464e0daaad342e57cdeca53c2d1a6b53cf317e6e
+  data.tar.gz: 3ab420703241cd84845e88890027840a48c70f203363e2799322837963d47e73
 SHA512:
-  metadata.gz: a2ce8344fdb8912d0116b5c21695b62cc83292f91a2987917ac78b3ff30c45793be8634b46354d9bb50e5181fa30469d4dcfddf4ed8de64deaba938eaaac29d4
-  data.tar.gz: a4e65f172f9916df7b79fcfc9d084975564623f915dacbfef017521dd8c7a66a5b54a885fab14362b049a6f43b9f30caa1f7e2e4d13e4b16aaed0e145a40dc86
+  metadata.gz: 7244afc3f897a92c6ea63b5b21721398a70ba5882a19a5296e79396c87df287fc9d257aa5a6a1efe99162ae31f673c5bb1400d4aa457236e8068ad6aac2b6aa1
+  data.tar.gz: 4a9dd2fc25a1ad1be8f2ccab02409a7f0c00f38ba4dffe8d25eb0ebce308c29190e6043e955e352f17d12f4b432061a8baa763b53b1c8e6b4f8b9082d1c613d8

data/Gemfile.lock

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

data/README.md

@@ -18,6 +18,10 @@ you can get something like
 
 ![trk-datatables](test/trk_datatables_with_daterangepicker.png "TRK Datatables")
 
+Currently supports:
+* ActiveRecord
+* Neo4j
+
 ## Table of Contents
 <!--ts-->
    * [Trk Datatables](#trk-datatables)
@@ -62,9 +66,10 @@ import 'bootstrap'
 
 // our stuff
 import 'stylesheet/application'
-import 'turbolinks.load'
 
-# app/javascript/turbolinks.load.js
+// attach jQuery so it is available for javascript included with asset pipeline
+window.$ = window.jQuery = jQuery;
+
 const trkDatatables = require('trk_datatables')
 
 document.addEventListener('turbolinks:load', () => {
@@ -88,7 +93,11 @@ environment.plugins.append('Provide', new webpack.ProvidePlugin({
 module.exports = environment
 
 # app/views/layouts/application.html.erb
+    <%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+    <%# we need stylesheet for production server, locally it could work without stylesheet_pack_tag even in production mode %>
     <%= stylesheet_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+    <%# we use jQuery from wepbacker so asset pipeline should be included later %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
 ```
 
 Than add a gem and sample PostsDatatable
@@ -275,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
 ```
@@ -408,13 +402,17 @@ generated based on other columns):
   posts_count FROM "users" LEFT OUTER JOIN "posts" ON "posts"."user_id" =
   "users"."id" GROUP BY users.id`
 
-Since in SQL you can not use aggregate functions in WHERE (we can repeat
+Since in SQL you can not use aggregate functions in WHERE (we should repeat
 calculation and subqueries), currently TrkDatatables does not support using
 aggregate functions since it requires implementation of `HAVING` (unless you
-disable search and order `'users.posts_count': { search: false, order: false }`).
+disable search and order for those fields with aggregate functions
+`'users.posts_count': { search: false, order: false }`).
 You can use concatenation aggregate function: in postgres `STRING_AGG`, in mysql
-`GROUP_CONCAT` since we search in real columns and show concatenation (we do not
-search concatenation like we need to search new field `post_count`).
+`GROUP_CONCAT` so in this case we search on real columns. For example let's we
+have `Post.select(%(posts.*, GROUP_CONCAT(comments.body) AS
+comments_body)).left_outer_joins(:comments) .group('posts.id')` and that we have
+a row `postName, comment1, comment2` than when we searh for `comment2` we will
+get a row `postName, comment2`.
 
 Simple calculations and subqueries works fine, just you have to use public
 method to define calculation (that method is also used in filtering). Name of
@@ -424,8 +422,12 @@ name you should use one of:
 `:date_calculated_in_db`, `:datetime_calculated_in_db` or
 `:boolean_calculated_in_db`.
 
-Before we give an example there is an issue in calling `all.count` if you are
-using subquery so we need to patch ActiveRecord
+There is an issue in calling `all.count` when you are using subquery, or
+selecting two columns `User.select(:id, :email).count`, or using star in string
+`User.select('users.*').count` (although `User.select(Arel.star).count` works),
+using AS `User.select('users.id AS i').count` (here arel does not help, still
+raise exception `User.select(User.arel_table[:email].as('imejl')).count`).
+We need to patch ActiveRecord to define `returns_count_sum`:
 ```
 # config/initializers/active_record_group_count.rb
 # When you are using subquery or joins/group_by than all.count does not work
@@ -489,10 +491,14 @@ class MostLikedPostsDatatable < TrkDatatables::ActiveRecord
                 ))
   end
 
+  # This is used for filtering so you can move this to main query if
+  # you have { search: false }
   def title_and_body
     "concat(posts.title, ' ', posts.body)"
   end
 
+  # This is used for filtering so you can move this to main query if
+  # you have { search: false }
   def comments_count
     <<~SQL
       (SELECT COUNT(*) FROM comments
@@ -568,8 +574,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' %>
@@ -577,6 +587,15 @@ 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
 
 ```
@@ -747,6 +766,36 @@ end
 
 ```
 
+## Neo4j
+
+User `.as(:users)` so we know which node us used
+
+```
+class UsersDatatable < TrkDatatables::Neo4j
+  def columns
+    {
+      'users.email': {},
+      'users.created_at': {},
+    }
+  end
+
+  def all_items
+    User
+      .as(:users)
+      .with_associations(moves: { from_group: [:location], to_groups: [:location] })
+  end
+
+  def rows(filtered)
+    filtered.map do |user|
+      [
+        @view.link_to(user.email, @view.admin_user_path(user)),
+        user.created_at.to_s(:long),
+      ]
+    end
+  end
+end
+```
+
 ## Alternatives
 
 There are alternatives, for example:
@@ -774,8 +823,8 @@ release a new version, update the version number and then publish with
 
 ```
 vi lib/trk_datatables/version.rb
-git commit -am'...'
 bundle
+git commit -am'...'
 bundle exec rake release
 ```
 

data/lib/trk_datatables/active_record.rb

@@ -1,11 +1,14 @@
 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
+          _filter_column_as_string column_key_option, search_string
         end.reduce(:or) # any searchable column is 'or'-ed
       end.reduce(:and) # 'and' for each search_string
 
@@ -40,12 +43,12 @@ module TrkDatatables
         from, to = search_value.split BETWEEN_SEPARATOR
         filter_column_as_between(column_key_option, from, to)
       else
-        filter_column_as_string(column_key_option, search_value)
+        _filter_column_as_string(column_key_option, search_value)
       end
     end
 
-    def filter_column_as_string(column_key_option, search_value)
-      search_value.split(' ').map do |search_string|
+    def _filter_column_as_string(column_key_option, search_value)
+      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

@@ -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

@@ -12,6 +12,9 @@ module TrkDatatables
   end
   class StringCalculatedInDb < CalculatedInDb; end
   class IntegerCalculatedInDb < CalculatedInDb; end
+  class DateCalculatedInDb < CalculatedInDb; end
+  class DatetimeCalculatedInDb < CalculatedInDb; end
+  class BooleanCalculatedInDb < CalculatedInDb; end
 
   class ColumnKeyOptions
     include Enumerable
@@ -107,7 +110,7 @@ module TrkDatatables
           # in calculated columns table_name is used only to determine type
           column_key = column_name
         elsif table_name.present? && column_name.nil?
-          raise Error, 'Unless table name ends with _calculad_in_db, column key needs to have one dot for example: posts.name'
+          raise Error, 'Unless table name ends with _calculated_in_db, column key needs to have one dot for example: posts.name'
         end
 
         if table_name.blank?
@@ -150,6 +153,8 @@ module TrkDatatables
     end
 
     def _set_global_search_cols(global_search_cols)
+      raise Error, 'global_search_cols should be array, for example %w[users.name]' unless global_search_cols.is_a? Array
+
       @global_search_cols = global_search_cols.each_with_object([]) do |column_key, arr|
         table_name, column_name = column_key.to_s.split '.'
         table_class = _determine_table_class table_name
@@ -191,7 +196,7 @@ module TrkDatatables
     end
 
     def _determine_column_name(table_class, column_name)
-      return column_name.humanize if table_class.blank?
+      return column_name.titleize if table_class.blank?
 
       # maybe we should check if human_attribute_name exists
       table_class.human_attribute_name column_name
@@ -239,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/neo4j.rb

@@ -1,7 +1,14 @@
 module TrkDatatables
   class Neo4j < Base
     def filter_by_search_all(filtered)
-      filtered
+      return filtered unless @dt_params.search_all.present?
+
+      # https://neo4jrb.readthedocs.io/en/stable/QueryClauseMethods.html?highlight=where#where
+      sql = @column_key_options.searchable_and_global_search.map do |column_key_option|
+        "#{column_key_option[:column_key]} =~ ?"
+      end.join(' or ')
+
+      filtered.where sql, ".*#{@dt_params.search_all}.*"
     end
 
     def filter_by_columns(all)
@@ -15,7 +22,13 @@ module TrkDatatables
     end
 
     def order_items(filtered)
-      filtered
+      order_by = dt_orders_or_default_index_and_direction.each_with_object([]) do |(index, direction), queries|
+        column_key_option = @column_key_options[index]
+        next if column_key_option[:column_options][ColumnKeyOptions::ORDER_OPTION] == false
+
+        queries << "#{column_key_option[:column_key]} #{direction}"
+      end
+      filtered.order(order_by.join(', '))
     end
   end
 end

data/lib/trk_datatables/render_html.rb

@@ -5,7 +5,7 @@ module TrkDatatables
       @search_link = search_link
       @datatable = datatable
       @html_options = html_options
-      self.class.indent = -1
+      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
@@ -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.2'.freeze
+  VERSION = '0.2.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.7
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2021-01-28 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.