trk_datatables 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d75c4de5838a5899996deab1a0737969b6a04294f0de0e7a0e2af1c82713f01
-  data.tar.gz: a307532660a052632e782a2a47d837b6b22c6071c30ee18027b0020084cc275b
+  metadata.gz: 3ccb77ab8bb5b29b22c346044bdb06171bed27a50721873cd1d5ec619c8ef1f1
+  data.tar.gz: 0d747920ac2dd280c0274dd46af82c59afd7c55151910e598d97d64ac2447a6d
 SHA512:
-  metadata.gz: 11532df36b2a5be0a3b942112943bbb1d6f4aeb229c986435e11316a826aab8c82117b9e4550334988ef0b06ab5ce19368db7dbc691aff49802a6cedf02b2d67
-  data.tar.gz: a59f1cd547aad4b95be0859aade92c9d1fc49e6d031bc09fdfc790f0742ee17b28644121dab6d5cbdc6e1dcaa5883557c088ea4f1345ca0f3f0fae4a4d395d63
+  metadata.gz: a2ce8344fdb8912d0116b5c21695b62cc83292f91a2987917ac78b3ff30c45793be8634b46354d9bb50e5181fa30469d4dcfddf4ed8de64deaba938eaaac29d4
+  data.tar.gz: a4e65f172f9916df7b79fcfc9d084975564623f915dacbfef017521dd8c7a66a5b54a885fab14362b049a6f43b9f30caa1f7e2e4d13e4b16aaed0e145a40dc86

data/Gemfile.lock

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

data/README.md

@@ -245,11 +245,13 @@ For specific columns you can use following keys
 * `title: 'My Title'` set up column header
 * `search: false` disable searching for this column
 * `order: false` disable ordering for this column
-* `predefined_ranges: {}` for datetime fiels add ranges to pick up from
 * `select_options: Post.statuses` generate select box instead of text input
+* `predefined_ranges: {}` for datetime fiels add ranges to pick up from
 * `hide: true` hide column with display none
 * `class_name: 'Admin::User'` use different class name than
   `table_name.classify` (in this case of `admin_users` will be `AdminUser`)
+* `column_type_in_db` one of the: `:string`, `:integer`, `:date`, `:datetime`,
+  `:boolean`
 
 ### Column 'BETWEEN' search with js daterangepicker
 
@@ -372,9 +374,10 @@ use empty column_key
 
 If you have more columns that are not actually columns in database (for example
 links or Ruby calculated values) than you can not use empty column_key since
-there could be only one in hash. When you disable `order` and `search` than you
-can use any column name since that column will not be used in queries. For
-example this column key `posts.body_size` is not in database nor in Ruby code.
+there could be only one (keys in the hash should be unique). When you disable
+`order` and `search` than you can use any column name since that column will not
+be used in queries. For example column key `posts.body_size` is not in database
+nor in Ruby code.
 
 ```
   def columns
@@ -396,7 +399,131 @@ example this column key `posts.body_size` is not in database nor in Ruby code.
 
 ### Values calculated in database
 
-For values that
+There are three types of calculated values (new custom fields that are
+generated based on other columns):
+* simple calculations like `SELECT *, quantity * price as full_price`
+* subqueries like `SELECT *, (SELECT COUNT(*) FROM posts WHERE users.id =
+  posts.user_id) AS posts_count`
+* aggregate functions in joins/group_by `SELECT users.*, COUNT(posts.id) AS
+  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
+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 }`).
+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`).
+
+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
+method is the same as column name `title_and_body` or `comments_count`. For table
+name you should use one of:
+`:string_calculated_in_db`, `:integer_calculated_in_db`,
+`: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
+```
+# config/initializers/active_record_group_count.rb
+# When you are using subquery or joins/group_by than all.count does not work
+# so we need to wrap sql in returns_count_sum
+# all.returns_count_sum.count # => 123
+# https://stackoverflow.com/a/21031792/287166
+# https://github.com/mrbrdo/active_record_group_count/blob/master/lib/active_record_group_count/scope.rb
+module ActiveRecordGroupCount
+  module Scope
+    extend ActiveSupport::Concern
+
+    module ExtensionMethods
+      def count(*_args)
+        scope = except(:select).select('1')
+        scope_sql = if scope.klass.connection.respond_to?(:unprepared_statement)
+                      scope.klass.connection.unprepared_statement { scope.to_sql }
+                    else
+                      scope.to_sql
+                    end
+        query = "SELECT count(*) AS count_all FROM (#{scope_sql}) x"
+        first_result = ActiveRecord::Base.connection.execute(query).first
+        if first_result.is_a? Array
+          first_result.first
+        else
+          first_result['count_all']
+        end
+      end
+    end
+
+    module ClassMethods
+      def returns_count_sum
+        all.extending(ExtensionMethods)
+      end
+    end
+  end
+end
+# https://github.com/mrbrdo/active_record_group_count/blob/master/lib/active_record_group_count/railtie.rb
+ActiveSupport.on_load :active_record do
+  include ActiveRecordGroupCount::Scope
+end
+```
+
+So now we can use `all_items.returns_count_sum.count`. Here is example of simple
+calulation and subquery
+
+```
+class MostLikedPostsDatatable < TrkDatatables::ActiveRecord
+  def columns
+    {
+      'posts.id': {},
+      'string_calculated_in_db.title_and_body': {},
+      'integer_calculated_in_db.comments_count': {},
+    }
+  end
+
+  def all_items
+    Post.select(%(
+                posts.*,
+                #{title_and_body} AS title_and_body,
+                (#{comments_count}) AS comments_count
+                ))
+  end
+
+  def title_and_body
+    "concat(posts.title, ' ', posts.body)"
+  end
+
+  def comments_count
+    <<~SQL
+      (SELECT COUNT(*) FROM comments
+      WHERE comments.post_id = posts.id)
+    SQL
+  end
+
+  def all_items_count
+    all_items.returns_count_sum.count
+  end
+
+  def filtered_items_count
+    filtered_items.returns_count_sum.count
+  end
+
+  def rows(filtered)
+    # you can use @view.link_to and other helpers
+    filtered.map do |post|
+      [
+        @view.link_to(post.id, post),
+        post.title_and_body,
+        post.comments_count,
+      ]
+    end
+  end
+
+  def default_order
+    [[2, :desc]]
+  end
+end
+```
 
 ### Default order and page length
 

data/lib/trk_datatables/active_record.rb

@@ -121,7 +121,11 @@ module TrkDatatables
     end
 
     def _arel_column(column_key_option)
-      column_key_option[:table_class].arel_table[column_key_option[:column_name]]
+      if column_key_option[:table_class] < TrkDatatables::CalculatedInDb
+        Arel.sql send(column_key_option[:column_key])
+      else
+        column_key_option[:table_class].arel_table[column_key_option[:column_name]]
+      end
     end
   end
 end

data/lib/trk_datatables/column_key_options.rb

@@ -1,5 +1,18 @@
 module TrkDatatables
   # rubocop:disable Metrics/ClassLength
+  class CalculatedInDb
+    def self.human_attribute_name(column_name)
+      column_name
+    end
+
+    def self.determine_db_type_for_column
+      # converts TrkDatatables::IntegerCalculatedInDb to :integer
+      name.sub('TrkDatatables::', '').sub('CalculatedInDb', '').downcase.to_sym
+    end
+  end
+  class StringCalculatedInDb < CalculatedInDb; end
+  class IntegerCalculatedInDb < CalculatedInDb; end
+
   class ColumnKeyOptions
     include Enumerable
 
@@ -12,11 +25,10 @@ module TrkDatatables
     #     {
     #       'users.name': { search: false }
     #     }
+    TITLE_OPTION = :title
     SEARCH_OPTION = :search
     ORDER_OPTION = :order
-    TITLE_OPTION = :title
     SELECT_OPTIONS = :select_options
-    CHECKBOX_OPTION = :checkbox_option
     PREDEFINED_RANGES = :predefined_ranges
     HIDE_OPTION = :hide
     CLASS_NAME = :class_name
@@ -26,15 +38,16 @@ module TrkDatatables
     # SEARCH_OPTION_DATETIME_VALUE = :datetime
     COLUMN_OPTIONS = [
       SEARCH_OPTION, ORDER_OPTION, TITLE_OPTION, SELECT_OPTIONS,
-      CHECKBOX_OPTION, PREDEFINED_RANGES, HIDE_OPTION, CLASS_NAME,
+      PREDEFINED_RANGES, HIDE_OPTION, CLASS_NAME,
       COLUMN_TYPE_IN_DB
     ].freeze
 
     # for columns that as calculated in db query
-    STRING_CALCULATED_IN_DB = :string_calculcated_in_db
+    STRING_CALCULATED_IN_DB = :string_calculated_in_db
     INTEGER_CALCULATED_IN_DB = :integer_calculated_in_db
     DATE_CALCULATED_IN_DB = :date_calculated_in_db
-    DATETIME_CALCULATED_IN_DB = :datetime_calculcated_in_db
+    DATETIME_CALCULATED_IN_DB = :datetime_calculated_in_db
+    BOOLEAN_CALCULATED_IN_DB = :boolean_calculated_in_db
 
     # for 'columns' that are calculated in Ruby you need to disable search and
     # order and than it will not be used in queries
@@ -90,7 +103,12 @@ module TrkDatatables
 
         column_options.assert_valid_keys(*COLUMN_OPTIONS)
         table_name, column_name = column_key.to_s.split '.'
-        raise Error, 'Column key needs to have one dot for example: posts.name' if table_name.present? && column_name.nil?
+        if table_name.present? && table_name.ends_with?('_calculated_in_db')
+          # 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'
+        end
 
         if table_name.blank?
           column_name = column_options[TITLE_OPTION] || 'actions' # some default name for a title
@@ -101,7 +119,6 @@ module TrkDatatables
 
           unless column_options[SEARCH_OPTION] == false && column_options[ORDER_OPTION] == false
             column_type_in_db = column_options[COLUMN_TYPE_IN_DB] || _determine_db_type_for_column(table_class, column_name)
-            column_options[CHECKBOX_OPTION] = true if column_type_in_db == :boolean && column_options[CHECKBOX_OPTION].nil?
           end
         end
         arr << {
@@ -120,11 +137,13 @@ module TrkDatatables
     def _determine_table_class(table_name, class_name = nil)
       # post_users -> PostUser
       # but also check if admin_posts -> Admin::Post so user can defined
-      # class_name: 'Admin::Ppost'
+      # class_name: 'Admin::Post'
       # https://github.com/duleorlovic/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L289
       # note that when class is not eager loaded than const_defined? returns false
       if class_name.present?
         class_name.constantize
+      elsif table_name.ends_with? '_calculated_in_db'
+        "TrkDatatables::#{table_name.classify}".constantize
       else
         table_name.classify.constantize
       end
@@ -157,7 +176,9 @@ module TrkDatatables
     # @return
     #   :string, :integer, :date, :datetime
     def _determine_db_type_for_column(table_class, column_name)
-      if defined?(::ActiveRecord::Base)
+      if table_class < TrkDatatables::CalculatedInDb
+        table_class.determine_db_type_for_column
+      elsif defined?(::ActiveRecord::Base)
         ar_column = table_class.columns_hash[column_name]
         raise Error, "Can't find column #{column_name} in #{table_class.name}" unless ar_column
 
@@ -214,7 +235,7 @@ module TrkDatatables
       res['data-searchable'] = false if column_options[SEARCH_OPTION] == false
       res['data-orderable'] = false if column_options[ORDER_OPTION] == false
       res['data-datatable-hidden-column'] = true if column_options[HIDE_OPTION] == true
-      res['data-datatable-checkbox'] = true if column_options[CHECKBOX_OPTION] == true
+      res['data-datatable-checkbox'] = true if column_type_in_db == :boolean
       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? ||

data/lib/trk_datatables/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport