trk_datatables 0.2.14 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f8339f6cc77f6372dff2350851b738f1c02bc157496a23fe371795df5c7e379
-  data.tar.gz: a6f7b37a8fb9c7b5a21f3fda2edd5a3a01f4f34a3c209ceb324ea7cdd8c15be2
+  metadata.gz: 3fecf0c6923b35099111fc74976cf13d26087c42e7bb4461f7c91f540c5a2123
+  data.tar.gz: 1be013aa2381e6f79fec4c84a2913eb1de087649e971cbfb42b7b4fc8c0e97d8
 SHA512:
-  metadata.gz: a6c9d856519bf89090cdb4fb5b6856b3eb59568f816ffeed838425e23f9bb75a57c94be9afb0155b0064a2c4fa69568d426c949cf5847fb5bdc35577c148e824
-  data.tar.gz: 88432304b3a19c6ac6cb7a683d6ed01919494f61f9b45050b6c3ee7102ef3f610a15852a47f8ce1282fca2d1c24d4192b895e6c66f2b1c92ceb9b4abd706c03f
+  metadata.gz: c8d596f8b8c4ff323ca473d0d10d5cb55c991c815d936765e51ab3144ca08b71e003a01729b3ff112028555ca8fd87488b541278bc358d40e008e554e2b533d6
+  data.tar.gz: f8296c711ce5bfed1a6a6aa222dd669bd1b92bf92858a4ab2c31ae544c470d8863172573de21cc3f85514251a356748ad1b24c36f847645cbc7361a2803df2d6

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in trk_datatables.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trk_datatables (0.2.14)
+    trk_datatables (0.2.16)
       activesupport
 
 GEM
@@ -18,6 +18,7 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    ast (2.4.2)
     byebug (11.1.3)
     concurrent-ruby (1.2.0)
     database_cleaner (2.0.1)
@@ -28,17 +29,58 @@ GEM
     database_cleaner-core (2.0.1)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
     mini_portile2 (2.8.1)
     minitest (5.17.0)
     minitest-color (0.0.2)
       minitest (~> 5)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
     pg (1.4.5)
+    racc (1.7.3)
+    rainbow (3.1.1)
     rake (10.5.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
     sqlite3 (1.6.0)
       mini_portile2 (~> 2.8.0)
+    standard (1.35.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.62.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
     timecop (0.9.6)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
     zeitwerk (2.6.6)
 
 PLATFORMS
@@ -54,6 +96,7 @@ DEPENDENCIES
   pg
   rake (~> 10.0)
   sqlite3
+  standard
   timecop
   trk_datatables!
 

data/README.md

@@ -372,11 +372,11 @@ 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 (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.
+links or Ruby calculated in ruby values) than you can not use empty column_key
+since 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
@@ -418,14 +418,14 @@ generated based on other columns):
 
 Simple calculations and subqueries works fine, you can search and order by them.
 Note that when you use join with other table, than you should group by all
-columns that you have used as columns, for example
+columns that you have used as columns which can be ordered by, for example
 ```
 # app/datatables/member_profiles_datatable.rb
   def columns
     {
       'member_profiles.full_name': {},
       'users.email': {},
-      'users.current_sign_in_at': { },
+      'users.current_sign_in_at': {},
     }
   end
   def all_items
@@ -543,7 +543,7 @@ class MostLikedPostsDatatable < TrkDatatables::ActiveRecord
     Post.select(%(
                 posts.*,
                 #{title_and_body} AS title_and_body,
-                (#{comments_count}) AS comments_count
+                #{comments_count} AS comments_count
                 ))
   end
 
@@ -557,8 +557,10 @@ class MostLikedPostsDatatable < TrkDatatables::ActiveRecord
   # you have { search: false }
   def comments_count
     <<~SQL
+     (
       SELECT COUNT(*) FROM comments
       WHERE comments.post_id = posts.id
+     )
     SQL
   end
 
@@ -865,6 +867,15 @@ You can set filters on datatable even params are blank, for example
 
 Inside datatable you can access params using `@view.params`
 
+To set the order (custom sort) in a link you can use:
+```
+<%= link_to 'Sort by email', \
+      posts_path(
+        PostsDatatable.order_set('users.email', :desc)
+      )
+%>
+```
+
 ### Saved Preferences (optional)
 
 You can save column order and page length in User.preferences field so
@@ -1150,6 +1161,12 @@ Column filtering with dropdowns https://datatables.net/extensions/searchpanes/ex
 Adding graphs https://datatables.net/forums/discussion/comment/123621/#Comment_123621
 https://datatables.net/examples/api/highcharts.html
 
+Run custom JS on next page or search, for example load tooltip.
+
+
+Check issue when we use param_set for select_options field since select option
+does not get selected and next page will show all items instead of only ones
+with selected field.
 
 ## License
 

data/Rakefile

@@ -1,10 +1,10 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
 task default: :test

data/lib/generators/templates/trk_datatable.rb

@@ -3,7 +3,7 @@ class <%= @trk_class_name %> < TrkDatatables::ActiveRecord
     {
 <% @skip_model || class_name.constantize.columns.each do |column| -%>
 <% next if %w[created_at updated_at].include? column.name -%>
-      '<%= table_name %>.<%= column.name %>': {},
+      "<%= table_name %>.<%= column.name %>": {},
 <% end -%>
     }
   end
@@ -19,7 +19,7 @@ class <%= @trk_class_name %> < TrkDatatables::ActiveRecord
       [
 <% @skip_model || class_name.constantize.columns.each do |column| -%>
 <% next if %w[created_at updated_at].include? column.name -%>
-<% if column.name == 'id' -%>
+<% if column.name == "id" -%>
         @view.link_to(<%= singular_table_name %>.id, <%= singular_table_name %>),
 <% else -%>
         <%= singular_table_name %>.<%= column.name %>,

data/lib/generators/trk_datatables/trk_datatables_generator.rb

@@ -2,10 +2,10 @@ module TrkDatatables
   module Generators
     class TrkDatatablesGenerator < Rails::Generators::NamedBase
       # we can call with `rails g trk_datatables` instead of: `rails g trk_datatables:trk_datatables`
-      namespace 'trk_datatables'
-      source_root File.expand_path('../templates', __dir__)
+      namespace "trk_datatables"
+      source_root File.expand_path("../templates", __dir__)
 
-      desc 'Generates datatables file for a give NAME'
+      desc "Generates datatables file for a give NAME"
       def create
         begin
           class_name.constantize
@@ -18,7 +18,7 @@ module TrkDatatables
           @trk_file_name = "#{singular_name}_datatable"
         end
 
-        template 'trk_datatable.rb', "app/datatables/#{@trk_file_name}.rb"
+        template "trk_datatable.rb", "app/datatables/#{@trk_file_name}.rb"
 
         say <<~TEXT
           ======================================================================

data/lib/trk_datatables/active_record.rb

@@ -6,7 +6,7 @@ module TrkDatatables
     # 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(' ').first(MAX_NUMBER_OF_STRINGS).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
@@ -38,8 +38,8 @@ module TrkDatatables
         filter_column_as_in(column_key_option, search_value)
       elsif %i[boolean].include?(column_key_option[:column_type_in_db])
         filter_column_as_boolean(column_key_option, search_value)
-      elsif %i[date datetime integer float].include?(column_key_option[:column_type_in_db]) && \
-            search_value.include?(BETWEEN_SEPARATOR)
+      elsif %i[date datetime integer float].include?(column_key_option[:column_type_in_db]) &&
+          search_value.include?(BETWEEN_SEPARATOR)
         from, to = search_value.split BETWEEN_SEPARATOR
         filter_column_as_between(column_key_option, from, to)
       else
@@ -48,9 +48,9 @@ module TrkDatatables
     end
 
     def _filter_column_as_string(column_key_option, search_value)
-      search_value.split(' ').first(MAX_NUMBER_OF_STRINGS).map do |search_string|
+      search_value.split(" ").first(MAX_NUMBER_OF_STRINGS).map do |search_string|
         casted_column = ::Arel::Nodes::NamedFunction.new(
-          'CAST',
+          "CAST",
           [_arel_column(column_key_option).as(@column_key_options.string_cast)]
         )
         casted_column.matches("%#{search_string}%")
@@ -59,9 +59,9 @@ module TrkDatatables
 
     def filter_column_as_boolean(column_key_option, search_value)
       # return true relation in case we ignore
-      return Arel::Nodes::SqlLiteral.new('1').eq(1) if search_value == 'any'
+      return Arel::Nodes::SqlLiteral.new("1").eq(1) if search_value == "any"
 
-      _arel_column(column_key_option).eq(search_value == 'true')
+      _arel_column(column_key_option).eq(search_value == "true")
     end
 
     def filter_column_as_between(column_key_option, from, to)
@@ -88,8 +88,8 @@ module TrkDatatables
         parsed_from = from
         parsed_to = to
       when :date
-        parsed_from = _parse_in_zone(from).to_date
-        parsed_to = _parse_in_zone(to).to_date
+        parsed_from = _parse_in_zone(from)&.to_date
+        parsed_to = _parse_in_zone(to)&.to_date&.end_of_day
       when :datetime
         parsed_from = _parse_in_zone(from)
         parsed_to = _parse_in_zone(to)
@@ -112,8 +112,7 @@ module TrkDatatables
 
     def order_and_paginate_items(filtered)
       filtered = order_items filtered
-      filtered = filtered.offset(@dt_params.dt_offset).limit(dt_per_page_or_default)
-      filtered
+      filtered.offset(@dt_params.dt_offset).limit(dt_per_page_or_default)
     end
 
     def order_items(filtered)
@@ -122,12 +121,12 @@ module TrkDatatables
         next if column_key_option[:column_options][ColumnKeyOptions::ORDER_OPTION] == false
 
         queries << if column_key_option[:table_class] < TrkDatatables::CalculatedInDb
-                     "#{send(column_key_option[:column_key])} #{direction}"
-                   else
-                     "#{column_key_option[:column_key]} #{direction}"
-                   end
+          "#{send(column_key_option[:column_key])} #{direction}"
+        else
+          "#{column_key_option[:column_key]} #{direction}"
+        end
       end
-      filtered.order(Arel.sql(order_by.join(', ')))
+      filtered.order(Arel.sql(order_by.join(", ")))
     end
 
     def _arel_column(column_key_option)

data/lib/trk_datatables/base.rb

@@ -1,7 +1,7 @@
 module TrkDatatables
   # TODO: extract those to configuration options
-  BETWEEN_SEPARATOR = ' - '.freeze
-  MULTIPLE_OPTION_SEPARATOR = '|'.freeze
+  BETWEEN_SEPARATOR = " - ".freeze
+  MULTIPLE_OPTION_SEPARATOR = "|".freeze
   # maximum page length = 100 (we should not believe params)
 
   class Error < StandardError
@@ -85,16 +85,16 @@ module TrkDatatables
     end
 
     def filter_by_search_all(_all)
-      raise 'filter_by_columns_is_defined_in_specific_orm'
+      raise "filter_by_columns_is_defined_in_specific_orm"
     end
 
     def filter_by_columns(_all)
-      raise 'filter_by_columns_is_defined_in_specific_orm' \
+      raise "filter_by_columns_is_defined_in_specific_orm" \
         "\n  Extent from TrkDatatables::ActiveRecord instead of TrkDatatables::Base"
     end
 
     def order_and_paginate_items(_filtered_items)
-      raise 'order_and_paginate_items_is_defined_in_specific_orm'
+      raise "order_and_paginate_items_is_defined_in_specific_orm"
     end
 
     # Returns dt_orders or default as array of index and direction
@@ -112,7 +112,9 @@ 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) && r[0][0] < @column_key_options.size }
+        check_value = lambda { |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
@@ -129,7 +131,7 @@ module TrkDatatables
     def dt_per_page_or_default
       return @dt_per_page_or_default if defined? @dt_per_page_or_default
 
-      @dt_per_page_or_default = \
+      @dt_per_page_or_default =
         if @dt_params.dt_per_page.present?
           @preferences.set :per_page, @dt_params.dt_per_page
           @dt_params.dt_per_page
@@ -216,31 +218,31 @@ module TrkDatatables
     end
 
     def predefined_ranges
-      Time.zone ||= 'UTC'
+      Time.zone ||= "UTC"
       {
         date: predefined_date_ranges,
-        datetime: predefined_datetime_ranges,
+        datetime: predefined_datetime_ranges
       }
     end
 
     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,
+        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.beginning_of_day...Time.zone.now.end_of_day,
-        'Last Month':
+        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.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,
+        "This Year": Time.zone.today.beginning_of_year.beginning_of_day...Time.zone.today.end_of_day
       }
     end
   end

data/lib/trk_datatables/base_helpers.rb

@@ -21,6 +21,18 @@ module TrkDatatables
       DtParams.param_set column_index, value
     end
 
+    # Set sort for column. This is class method so you do not need
+    # datatable instance.
+    #
+    # @example
+    #   link_to 'Sort by email',
+    #   posts_path(PostsDatatable.order_set('users.email', :desc)
+    def order_set(column_key, direction = :asc, view = nil)
+      datatable = new view || OpenStruct.new(params: {})
+      column_index = datatable.index_by_column_key column_key
+      DtParams.order_set column_index, direction
+    end
+
     # Get the form field name for column. This is class method so you do not
     # need datatable instance. It returns something like
     # 'column[3][search][value]`. For global search you can use

data/lib/trk_datatables/column_key_options.rb

@@ -7,13 +7,18 @@ module TrkDatatables
 
     def self.determine_db_type_for_column
       # converts TrkDatatables::IntegerCalculatedInDb to :integer
-      name.sub('TrkDatatables::', '').sub('CalculatedInDb', '').downcase.to_sym
+      name.sub("TrkDatatables::", "").sub("CalculatedInDb", "").downcase.to_sym
     end
   end
+
   class StringCalculatedInDb < CalculatedInDb; end
+
   class IntegerCalculatedInDb < CalculatedInDb; end
+
   class DateCalculatedInDb < CalculatedInDb; end
+
   class DatetimeCalculatedInDb < CalculatedInDb; end
+
   class BooleanCalculatedInDb < CalculatedInDb; end
 
   class ColumnKeyOptions
@@ -55,10 +60,10 @@ module TrkDatatables
     # for 'columns' that are calculated in Ruby you need to disable search and
     # order and than it will not be used in queries
 
-    STRING_TYPE_CAST_POSTGRES = 'VARCHAR'.freeze
-    STRING_TYPE_CAST_MYSQL    = 'CHAR'.freeze
-    STRING_TYPE_CAST_SQLITE   = 'TEXT'.freeze
-    STRING_TYPE_CAST_ORACLE   = 'VARCHAR2(4000)'.freeze
+    STRING_TYPE_CAST_POSTGRES = "VARCHAR".freeze
+    STRING_TYPE_CAST_MYSQL = "CHAR".freeze
+    STRING_TYPE_CAST_SQLITE = "TEXT".freeze
+    STRING_TYPE_CAST_ORACLE = "VARCHAR2(4000)".freeze
 
     DB_ADAPTER_STRING_TYPE_CAST = {
       postgresql: STRING_TYPE_CAST_POSTGRES,
@@ -88,12 +93,12 @@ module TrkDatatables
       # In case first element is hash than we will use that hash
       if cols.is_a? Array
         cols = if cols.first.is_a? Hash
-                 cols.first
-               else
-                 cols.each_with_object({}) do |column_key, hash|
-                   hash[column_key.to_sym] = {}
-                 end
-               end
+          cols.first
+        else
+          cols.each_with_object({}) do |column_key, hash|
+            hash[column_key.to_sym] = {}
+          end
+        end
       end
       _set_data(cols)
       _set_global_search_cols(global_search_cols)
@@ -102,26 +107,28 @@ module TrkDatatables
 
     def _set_data(cols)
       @data = cols.each_with_object([]) do |(column_key, column_options), arr|
-        raise Error, 'Column options needs to be a Hash' unless column_options.is_a? Hash
+        raise Error, "Column options needs to be a Hash" unless column_options.is_a? Hash
 
         column_options.assert_valid_keys(*COLUMN_OPTIONS)
-        table_name, column_name = column_key.to_s.split '.'
-        if table_name.present? && table_name.ends_with?('_calculated_in_db')
+        table_name, column_name = column_key.to_s.split "."
+        if table_name.present? && table_name.end_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 _calculated_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?
-          column_name = column_options[TITLE_OPTION] || 'actions' # some default name for a title
+          column_name = column_options[TITLE_OPTION] || "actions" # some default name for a title
           column_options[SEARCH_OPTION] = false
           column_options[ORDER_OPTION] = false
         else
           table_class = _determine_table_class table_name, column_options[CLASS_NAME]
 
           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_type_in_db = column_options[COLUMN_TYPE_IN_DB] || _determine_db_type_for_column(table_class,
+              column_name)
           end
         end
         arr << {
@@ -132,7 +139,7 @@ module TrkDatatables
           column_type_in_db: column_type_in_db,
           # the following are used for RenderHtml
           title: column_options[TITLE_OPTION] || _determine_column_name(table_class, column_name),
-          html_options: html_options(column_options, column_type_in_db),
+          html_options: html_options(column_options, column_type_in_db)
         }
       end
     end
@@ -145,7 +152,7 @@ module TrkDatatables
       # 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'
+      elsif table_name.end_with? "_calculated_in_db"
         "TrkDatatables::#{table_name.classify}".constantize
       else
         table_name.classify.constantize
@@ -153,10 +160,13 @@ 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
+      unless global_search_cols.is_a? Array
+        raise Error,
+          "global_search_cols should be array, for example %w[users.name]"
+      end
 
       @global_search_cols = global_search_cols.each_with_object([]) do |column_key, arr|
-        table_name, column_name = column_key.to_s.split '.'
+        table_name, column_name = column_key.to_s.split "."
         table_class = _determine_table_class table_name
         column_type_in_db = _determine_db_type_for_column(table_class, column_name)
         arr << {
@@ -164,7 +174,7 @@ module TrkDatatables
           column_options: {},
           table_class: table_class,
           column_name: column_name,
-          column_type_in_db: column_type_in_db,
+          column_type_in_db: column_type_in_db
         }
       end
     end
@@ -173,13 +183,13 @@ module TrkDatatables
     def _determine_string_type_cast # :nodoc:
       if defined?(::ActiveRecord::Base)
         current_adapter = if ::ActiveRecord::Base.respond_to?(:connection_db_config)
-                            ::ActiveRecord::Base.connection_db_config.configuration_hash[:adapter]
-                          else
-                            ::ActiveRecord::Base.connection_config[:adapter]
-                          end
+          ::ActiveRecord::Base.connection_db_config.configuration_hash[:adapter]
+        else
+          ::ActiveRecord::Base.connection_config[:adapter]
+        end
         DB_ADAPTER_STRING_TYPE_CAST[current_adapter.to_sym]
       else
-        'not_used'
+        "not_used"
       end
     end
 
@@ -196,7 +206,7 @@ module TrkDatatables
       elsif defined?(::Neo4j::ActiveNode)
         (table_class.declared_properties[column_name][:type] || String).name.downcase
       else
-        raise NotImplementedError, 'I work only with ActiveRecord and Neo4j'
+        raise NotImplementedError, "I work only with ActiveRecord and Neo4j"
       end
     end
 
@@ -235,27 +245,27 @@ module TrkDatatables
       i = @data.find_index do |column_key_option|
         column_key_option[:column_key] == column_key.to_sym
       end
-      raise Error, "Can't find index for #{column_key} in #{@data.map { |d| d[:column_key] }.join(', ')}" if i.nil?
+      raise Error, "Can't find index for #{column_key} in #{@data.map { |d| d[:column_key] }.join(", ")}" if i.nil?
 
       i
     end
 
     def html_options(column_options, column_type_in_db)
       res = {}
-      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_type_in_db == :boolean
+      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_type_in_db == :boolean
       if %i[date datetime].include? column_type_in_db
-        res['data-datatable-range'] = column_type_in_db == :datetime ? :datetime : true
+        res["data-datatable-range"] = (column_type_in_db == :datetime) ? :datetime : true
         if column_options[PREDEFINED_RANGES].present? ||
             (@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[column_type_in_db]
-                                                    end
-          res['data-datatable-predefined-ranges'].transform_values! do |range|
+          res["data-datatable-predefined-ranges"] = if column_options[PREDEFINED_RANGES].is_a? Hash
+            column_options[PREDEFINED_RANGES]
+          else
+            @predefined_ranges[column_type_in_db]
+          end
+          res["data-datatable-predefined-ranges"].transform_values! do |range|
             [range.first.to_s, range.last.to_s]
           end
         end

data/lib/trk_datatables/dt_params.rb

@@ -40,12 +40,12 @@ module TrkDatatables
       @dt_orders = []
       return @dt_orders if @params[:order].blank?
 
-      @dt_orders = \
+      @dt_orders =
         @params[:order].each_with_object([]) do |(_index, dt_order), a|
           # for order we ignore key (_index) since order is preserved
           a << [
             dt_order[:column].to_i,
-            dt_order[:dir]&.to_s&.casecmp('ASC')&.zero? ? :asc : :desc,
+            dt_order[:dir]&.to_s&.casecmp("ASC")&.zero? ? :asc : :desc
           ]
         end
       @dt_orders
@@ -69,9 +69,9 @@ module TrkDatatables
       @params[:columns].each.map do |(dt_position, dt_column)|
         @dt_columns[dt_position.to_i] = {
           index: dt_position.to_i,
-          searchable: dt_column[:searchable].to_s != 'false', # if nil as it is in set_params, than use true
-          orderable: dt_column[:orderable].to_s != 'false', # if nil as it is in set_params, than use true
-          search_value: (dt_column[:search] && dt_column[:search][:value]) || '',
+          searchable: dt_column[:searchable].to_s != "false", # if nil as it is in set_params, than use true
+          orderable: dt_column[:orderable].to_s != "false", # if nil as it is in set_params, than use true
+          search_value: (dt_column[:search] && dt_column[:search][:value]) || ""
         }
       end
       @dt_columns.each_with_index do |dt_column, i|
@@ -81,20 +81,20 @@ module TrkDatatables
           index: i,
           searchable: true,
           orderable: true,
-          search_value: '',
+          search_value: ""
         }
       end
     end
 
     def search_all
-      @params.dig(:search, :value) || ''
+      @params.dig(:search, :value) || ""
     rescue TypeError => e
       raise Error, e.message + '. Global search is in a format: { "search": { "value": "ABC" } }'
     end
 
     def as_json(all_count, filtered_count, data, additional = {})
       additional = {} if additional.nil?
-      raise Error, 'additional_data_for_json needs to be a hash' unless additional.is_a? Hash
+      raise Error, "additional_data_for_json needs to be a hash" unless additional.is_a? Hash
 
       draw = @params[:draw].to_i
       {
@@ -102,7 +102,7 @@ module TrkDatatables
         recordsTotal: all_count,
         recordsFiltered: filtered_count,
         **additional,
-        data: data,
+        data: data
       }
     end
 
@@ -110,6 +110,10 @@ module TrkDatatables
       {columns: {column_index.to_s => {search: {value: value}}}}
     end
 
+    def self.order_set(column_index, direction)
+      {order: {"0": {column: column_index, dir: direction}}}
+    end
+
     def self.form_field_name(column_index)
       "columns[#{column_index}][search][value]"
     end
@@ -117,51 +121,52 @@ 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 = {})
       OpenStruct.new(
-        params: sample_params(options),
+        params: sample_params(options)
       )
     end
 
     def self.sample_params(options = {})
       HashWithIndifferentAccess.new(
-        draw: '1',
-        start: '0',
-        length: '10',
+        draw: "1",
+        start: "0",
+        length: "10",
         search: {
-          value: '', regex: 'false'
+          value: "", regex: "false"
         },
         order: {
-          '0': {column: '0', dir: 'desc'}
+          "0": {column: "0", dir: "desc"}
         },
         # [:columns] should have the same size as column_key_options since we
         # ignore keys, and use positions
         columns: {
-          '0': {
-            searchable: 'true',
-            orderable: 'true',
+          "0": {
+            searchable: "true",
+            orderable: "true",
             search: {
-              value: '', regex: 'false'
+              value: "", regex: "false"
             }
           },
-          '1': {
-            searchable: 'true',
-            orderable: 'true',
+          "1": {
+            searchable: "true",
+            orderable: "true",
             search: {
-              value: '', regex: 'false'
+              value: "", regex: "false"
             }
           },
-          '2': {
-            searchable: 'true',
-            orderable: 'false',
+          "2": {
+            searchable: "true",
+            orderable: "false",
             search: {
-              value: '', regex: 'false'
+              value: "", regex: "false"
             }
-          },
-        },
+          }
+        }
       ).merge options
     end
   end

data/lib/trk_datatables/neo4j.rb

@@ -6,7 +6,7 @@ module TrkDatatables
       # 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 ')
+      end.join(" or ")
 
       filtered.where sql, ".*#{@dt_params.search_all}.*"
     end
@@ -17,8 +17,7 @@ module TrkDatatables
 
     def order_and_paginate_items(filtered)
       filtered = order_items filtered
-      filtered = filtered.offset(@dt_params.dt_offset).limit(dt_per_page_or_default)
-      filtered
+      filtered.offset(@dt_params.dt_offset).limit(dt_per_page_or_default)
     end
 
     def order_items(filtered)
@@ -28,7 +27,7 @@ module TrkDatatables
 
         queries << "#{column_key_option[:column_key]} #{direction}"
       end
-      filtered.order(order_by.join(', '))
+      filtered.order(order_by.join(", "))
     end
   end
 end

data/lib/trk_datatables/preferences.rb

@@ -1,6 +1,6 @@
 module TrkDatatables
   class Preferences
-    KEY_IN_PREFERENCES = :trk_datatables
+    KEY_IN_PREFERENCES = "trk_datatables"
     def initialize(holder, field, class_name)
       @holder = holder
       @field = field
@@ -15,14 +15,14 @@ module TrkDatatables
 
       result = @holder.send(@field).dig KEY_IN_PREFERENCES, @class_name, key
       return result if check_value.nil?
-      return result if check_value.call result
+      result if check_value.call result
     end
 
     def set(key, value)
       return unless @holder
 
       h = {KEY_IN_PREFERENCES => {@class_name => {key => value}}}
-      @holder.send("#{@field}=", {}) if @holder.send(@field).nil?
+      @holder.send(:"#{@field}=", {}) if @holder.send(@field).nil?
       @holder.send(@field).deep_merge! h
       @holder.save!
     end

data/lib/trk_datatables/render_html.rb

@@ -43,16 +43,16 @@ module TrkDatatables
         inline = true
       end
       self.class.indent += 1
-      html = "#{'  ' * self.class.indent}<#{tag}".html_safe
+      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
-                '>'.html_safe << content.to_s << "</#{tag}>\n".html_safe
-              else
-                ">\n".html_safe << yield << "\n#{'  ' * self.class.indent}</#{tag}>".html_safe
-              end
+        ">".html_safe << content.to_s << "</#{tag}>\n".html_safe
+      else
+        ">\n".html_safe << yield << "\n#{"  " * self.class.indent}</#{tag}>".html_safe
+      end
       self.class.indent -= 1 if self.class.indent > 1
       html
     end
@@ -62,7 +62,7 @@ module TrkDatatables
     def _select_find_options(options, search_value)
       selected = search_value.to_s.split(MULTIPLE_OPTION_SEPARATOR)
       options.map do |key, value|
-        {key: key, value: value}.merge(selected.include?(value.to_s) ? {selected: 'selected'} : {})
+        {key: key, value: value}.merge(selected.include?(value.to_s) ? {selected: "selected"} : {})
       end
     end
 
@@ -82,14 +82,14 @@ module TrkDatatables
       _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,
+        "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,
-        'data-datatable-dom': @html_options[:'data-datatable-dom'] || '<"trk-global-search-wrapper"f>rtp<"trk-move-up"il>',
+        "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 +
@@ -102,11 +102,14 @@ module TrkDatatables
           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?
+            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_find_options select_options, search_value if select_options.present?
+            if select_options.present?
+              options["data-datatable-multiselect"] =
+                _select_find_options select_options, search_value
+            end
             # all other options are pulled from column_key_option[:html_options]
             _content_tag :th, options, column_key_option[:title]
           end)
@@ -148,7 +151,7 @@ module TrkDatatables
       #   # https://github.com/trkin/trk_datatables_js/issues/1
       #   'data-datatable-total-length': @datatable.filtered_items_count,
       # ) do
-      ''
+      ""
     end
   end
 end

data/lib/trk_datatables/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.2.14'.freeze
+  VERSION = "0.2.16".freeze
 end

data/lib/trk_datatables.rb

@@ -1,22 +1,23 @@
-require 'trk_datatables/version'
-# modules
-require 'trk_datatables/preferences.rb'
-require 'trk_datatables/base_helpers'
-require 'trk_datatables/base'
-require 'trk_datatables/active_record'
-require 'trk_datatables/neo4j'
-require 'trk_datatables/dt_params'
-require 'trk_datatables/column_key_options.rb'
-require 'trk_datatables/render_html.rb'
-
+require "trk_datatables/version"
 # libs
-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'
+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"
 
+require "ostruct"
 # we need to define here since some conventions will look for definition in this file
+# modules
+require "trk_datatables/preferences"
+require "trk_datatables/base_helpers"
+require "trk_datatables/base"
+require "trk_datatables/active_record"
+require "trk_datatables/neo4j"
+require "trk_datatables/dt_params"
+require "trk_datatables/column_key_options"
+require "trk_datatables/render_html"
+
 module TrkDatatables
   class Error < StandardError
     def message

data/trk_datatables.gemspec

@@ -1,31 +1,30 @@
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'trk_datatables/version'
+require "trk_datatables/version"
 
-# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
-  spec.name          = 'trk_datatables'
-  spec.version       = TrkDatatables::VERSION
-  spec.authors       = ['Dusan Orlovic']
-  spec.email         = ['duleorlovic@gmail.com']
+  spec.name = "trk_datatables"
+  spec.version = TrkDatatables::VERSION
+  spec.authors = ["Dusan Orlovic"]
+  spec.email = ["duleorlovic@gmail.com"]
 
-  spec.summary       = 'Gem that simplify using datatables with Ruby on Rails and Sinatra.'
-  spec.description   = 'Html render first page, sort and filter...'
-  spec.homepage      = 'https://github.com/trkin/trk_datatables'
-  spec.license       = 'MIT'
+  spec.summary = "Gem that simplify using datatables with Ruby on Rails and Sinatra."
+  spec.description = "Html render first page, sort and filter..."
+  spec.homepage = "https://github.com/trkin/trk_datatables"
+  spec.license = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = 'https://github.com/trkin/trk_datatables'
-    spec.metadata['changelog_uri'] = 'https://github.com/trkin/trk_datatables/blob/master/CHANGELOG.md'
-    spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/trkin/trk_datatables"
+    spec.metadata["changelog_uri"] = "https://github.com/trkin/trk_datatables/blob/master/CHANGELOG.md"
+    spec.metadata["yard.run"] = "yri" # use "yard" to build full HTML docs.
   else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -33,22 +32,22 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
   # for HashWithIndifferentAccess
-  spec.add_dependency 'activesupport'
+  spec.add_dependency "activesupport"
 
-  spec.add_development_dependency 'activerecord', '~> 6.0'
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'byebug'
-  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'
+  spec.add_development_dependency "activerecord", "~> 6.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-color"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "standard"
 end
-# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.2.14
+  version: 0.2.16
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-08 00:00:00.000000000 Z
+date: 2024-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,21 +151,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -172,6 +186,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md