trk_datatables 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b95bac52efa837430318bc3ef1f668ad3f328448d7f189f6b705253c5b6e538
-  data.tar.gz: e29b7990c7e8534e29c7a444755a61a74a2c900f1ab57176a2ca5aa4be825a27
+  metadata.gz: 2a02c05387d75bc6ec793abce56ca69ab8924d4aab84339fa04740dce0b00ebd
+  data.tar.gz: b983241edd1da7ed12438608591b8acdb96b4704df3bc54eb2193e42b408d5ff
 SHA512:
-  metadata.gz: 1cc6c6b47eabc5fa03058e6dee3de97337b2c5826b187a9b9e34805aaaf5ca4f4f3d61d6702277b5b0eafd8fbda2380b049b355ab3b11259ba2029d377c25911
-  data.tar.gz: f21d79a8926b850c03bc203dd16c0edb771a284f6f3a1caae42aaddd06f2114c7c293972d562b00ba0cd73a53028a8630d7fe9aa06ee0ea95c03fd87058a6819
+  metadata.gz: 64fe2c03de96d9a0cf700c06a1b1bd2560190d6c14abefd066209280e165aab4eda90d0939bf0ee33befc2792fd4034b7be075fbadf1dd481fd9ecc9529adb42
+  data.tar.gz: 4b58ddb0471ea682dc5e3c1ca7e28051ac2f965d9687e01cdd1223038f52c7c47dcbfbdcf3959f687c3d3de5da529b9048277e27fae4d88e68844af7da457cb1

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+# CHANGELOG
+
 ## 0.1.0
 
 Add basic ActiveRecord sort and paginate filter

data/Gemfile.lock

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

data/lib/trk_datatables/active_record.rb

@@ -2,17 +2,17 @@ module TrkDatatables
   class ActiveRecord < Base
     # Global search. All columns are typecasted to string. Search string is
     # splited by space and "and"-ed.
-    def filter_by_search_all(filtered_items)
+    def filter_by_search_all(filtered)
       conditions = @dt_params.search_all.split(' ').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
       end.reduce(:and) # 'and' for each search_string
 
-      filtered_items.where conditions
+      filtered.where conditions
     end
 
-    def filter_by_columns(filtered_items)
+    def filter_by_columns(filtered)
       conditions = @dt_params.dt_columns.each_with_object([]) do |dt_column, cond|
         next unless dt_column[:searchable] && dt_column[:search_value].present?
 
@@ -23,7 +23,7 @@ module TrkDatatables
         cond << build_condition_for_column(column_key_option, dt_column[:search_value])
       end.reduce(:and) # 'and' for each searchable column
 
-      filtered_items.where conditions
+      filtered.where conditions
     end
 
     def build_condition_for_column(column_key_option, search_value)
@@ -71,43 +71,46 @@ module TrkDatatables
 
     def _parse_from_to(from, to, column_key_option)
       case column_key_option[:column_type_in_db]
-      # when :integer, :float
-      # we do not need to cast from string since range will do automatically
+      when :integer, :float
+        # we do not need to cast from string since range will do automatically
+        parsed_from = from
+        parsed_to = to
       when :date, :datetime
-        from = _parse_in_zone(from) if from.present?
-        if to.present?
-          to = if to.include?('AM') || to.include?('PM')
-                 _parse_in_zone(to)
-               else
-                 # we need to add one day since it looks at begining of a day 2010-10-10 00:00:00
-                 _parse_in_zone(to) + 60 * 60 * 24 - 1
-               end
+        parsed_from = _parse_in_zone(from)
+        parsed_to = _parse_in_zone(to)
+        if parsed_to.present? && !to.match(/AM|PM/)
+          # we need to add one day since it looks at begining of a day 2010-10-10 00:00:00
+          parsed_to += 60 * 60 * 24 - 1
         end
       end
-      [from, to]
+      [parsed_from, parsed_to]
     end
 
     # rubocop:disable Rails/TimeZone
     def _parse_in_zone(time)
+      return nil if time.blank?
+
       # without rails we will parse without zone so make sure params are correct
       Time.zone ? Time.zone.parse(time) : Time.parse(time)
+    rescue ArgumentError
+      nil
     end
     # rubocop:enable Rails/TimeZone
 
-    def order_and_paginate_items(filtered_items)
-      filtered_items = order_items filtered_items
-      filtered_items = filtered_items.offset(@dt_params.dt_offset).limit(dt_per_page_or_default)
-      filtered_items
+    def order_and_paginate_items(filtered)
+      filtered = order_items filtered
+      filtered = filtered.offset(@dt_params.dt_offset).limit(dt_per_page_or_default)
+      filtered
     end
 
-    def order_items(filtered_items)
-      order_by = dt_orders_or_default.each_with_object([]) do |dt_order, queries|
-        column_key_option = @column_key_options[dt_order[:column_index]]
+    def order_items(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]} #{dt_order[:direction]}"
+        queries << "#{column_key_option[:column_key]} #{direction}"
       end
-      filtered_items.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,20 +1,20 @@
 module TrkDatatables
   BETWEEN_SEPARATOR = ' - '.freeze
   MULTIPLE_OPTION_SEPARATOR = '|'.freeze
-  DEFAULT_ORDER = [{ column_index: 0, direction: :desc }].freeze
+  DEFAULT_ORDER = [[0, :desc]].freeze
   DEFAULT_PAGE_LENGTH = 10
 
   class Error < StandardError
   end
 
   class Base
-    include TrkDatatables::Preferences
     attr_accessor :column_key_options
 
     def initialize(view)
       @view = view
       @dt_params = DtParams.new view.params
       @column_key_options = ColumnKeyOptions.new columns, global_search_columns
+      @preferences = Preferences.new preferences_holder, preferences_field
 
       # if @dt_params.dt_columns.size != @column_key_options.size
       #   raise Error, "dt_columns size of columns is #{@dt_params.dt_columns.size} \
@@ -93,19 +93,21 @@ module TrkDatatables
       raise 'order_and_paginate_items_is_defined_in_specific_orm'
     end
 
-    # Returns dt_orders or default
+    # Returns dt_orders or default as array of index and direction
+    # https://datatables.net/reference/option/order
     # @return
     #   [
-    #     { column_index: 0, direction: :desc },
+    #     [0, :desc],
     #   ]
-    def dt_orders_or_default
+    def dt_orders_or_default_index_and_direction
       return @dt_orders_or_default if defined? @dt_orders_or_default
 
       if @dt_params.dt_orders.present?
         @dt_orders_or_default = @dt_params.dt_orders
-        set_preference :order, @dt_params.dt_orders
+        @preferences.set :order, @dt_params.dt_orders
       else
-        @dt_orders_or_default = get_preference(:order) || DEFAULT_ORDER
+        check_value = ->(r) { r.is_a?(Array) && r[0].is_a?(Array) && r[0][0].is_a?(Integer) }
+        @dt_orders_or_default = @preferences.get(:order, check_value) || DEFAULT_ORDER
       end
       @dt_orders_or_default
     end
@@ -115,10 +117,10 @@ module TrkDatatables
 
       @dt_per_page_or_default = \
         if @dt_params.dt_per_page.present?
-          set_preference :per_page, @dt_params.dt_per_page
+          @preferences.set :per_page, @dt_params.dt_per_page
           @dt_params.dt_per_page
         else
-          get_preference(:per_page) || DEFAULT_PAGE_LENGTH
+          @preferences.get(:per_page) || DEFAULT_PAGE_LENGTH
         end
     end
 
@@ -164,7 +166,6 @@ module TrkDatatables
     def as_json(_attr = nil)
       # get the value if it is not a relation
       all_count = all_items.count
-      filtered_items = filter_by_search_all filter_by_columns all_items
       @dt_params.as_json(
         all_count,
         filtered_items.count,
@@ -172,6 +173,10 @@ module TrkDatatables
       )
     end
 
+    def filtered_items
+      filter_by_search_all filter_by_columns all_items
+    end
+
     def ordered_paginated_filtered_items
       order_and_paginate_items filter_by_search_all filter_by_columns all_items
     end
@@ -188,5 +193,22 @@ module TrkDatatables
       render = RenderHtml.new(search_link, self, html_options)
       render.result
     end
+
+    # Override this to set model where you can store order, index, page length
+    # @example
+    #   def preferences_holder
+    #     @view.current_user
+    #   end
+    def preferences_holder
+      nil
+    end
+
+    # Override if you use different than :preferences
+    # You can generate with this command:
+    # @code
+    #   rails g migration add_preferences_to_users preferences:jsonb
+    def preferences_field
+      :preferences
+    end
   end
 end

data/lib/trk_datatables/dt_params.rb

@@ -26,12 +26,12 @@ module TrkDatatables
     #   (dt_offset / dt_per_page) + 1
     # end
 
-    # Typecast so we can safelly use dt_order[:column_index] (Integer) and
-    # dt_order[:direction] (:asc/:desc)
+    # Typecast so we can safelly use dt_order[0] (Integer) and
+    # dt_order[1] (:asc/:desc)
     # @return
     #   [
-    #     { column_index: 2, direction: :asc }.
-    #     { column_index: 1, direction: :desc },
+    #     [ 2, :asc ],
+    #     [ 1, :desc ],
     #   ]
     def dt_orders
       return @dt_orders if defined? @dt_orders
@@ -41,11 +41,11 @@ module TrkDatatables
 
       @dt_orders = \
         @params[:order].each_with_object([]) do |(_index, dt_order), a|
-          # for order we ignore key (index) since order is preserved
-          a << {
-            column_index: dt_order[:column].to_i,
-            direction: dt_order[:dir]&.to_s&.casecmp('ASC')&.zero? ? :asc : :desc,
-          }
+          # 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,
+          ]
         end
       @dt_orders
     end

data/lib/trk_datatables/preferences.rb

@@ -1,35 +1,28 @@
 module TrkDatatables
-  module Preferences
-    # Override this to set model where you can store order, index, page length
-    # @example
-    #   def preferences_holder
-    #     @view.current_user
-    #   end
-    def preferences_holder
-      nil
+  class Preferences
+    def initialize(holder, field)
+      @holder = holder
+      @field = field
     end
 
-    # Override if you use different than :preferences
-    # You can generate with this command:
-    # @code
-    #   rails g migration add_preferences_to_users preferences:jsonb
-    def preferences_field
-      :preferences
-    end
-
-    def get_preference(key)
-      return unless preferences_holder
+    # Get the key from holder
+    # Use check_value proc to ignore wrong format. This is usefull when you
+    # change format and you do not want to clear all existing values
+    def get(key, check_value = nil)
+      return unless @holder
 
-      preferences_holder.send(preferences_field).dig :dt_preferences, self.class.name, key
+      result = @holder.send(@field).dig :dt_preferences, self.class.name, key
+      return result if check_value.nil?
+      return result if check_value.call result
     end
 
-    def set_preference(key, value)
-      return unless preferences_holder
+    def set(key, value)
+      return unless @holder
 
       h = { dt_preferences: { self.class.name => { key => value } } }
-      preferences_holder.send("#{preferences_field}=", {}) if preferences_holder.send(preferences_field).nil?
-      preferences_holder.send(preferences_field).deep_merge! h
-      preferences_holder.save!
+      @holder.send("#{@field}=", {}) if @holder.send(@field).nil?
+      @holder.send(@field).deep_merge! h
+      @holder.save!
     end
   end
 end

data/lib/trk_datatables/render_html.rb

@@ -85,10 +85,10 @@ module TrkDatatables
         '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.map do |dt_order|
-          [dt_order[:column_index], dt_order[:direction].to_s.html_safe]
-        end).to_json, # TODO: legacy, better is to use simple @datatable.dt_orders_or_default.to_json
-        'data-datatable-total-length': @datatable.all_items.count
+        '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
         thead << "\n".html_safe << tbody
       end

data/lib/trk_datatables/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

data/trk_datatables.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
     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/CHANGELOG.md'
+    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 ' \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2019-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -185,7 +185,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/trkin/trk_datatables
   source_code_uri: https://github.com/trkin/trk_datatables
-  changelog_uri: https://github.com/trkin/trk_datatables/CHANGELOG.md
+  changelog_uri: https://github.com/trkin/trk_datatables/blob/master/CHANGELOG.md
   yard.run: yri
 post_install_message: 
 rdoc_options: []