trk_datatables 0.2.6 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40eeba5483cf896ad0df528f5b329a0bdfd7b2a7d78ab18df295f1b30737ba8f
-  data.tar.gz: 7e9c1cd8f4c9fcf942dd5639b7f406e85ccb6c0c037e2dd6a3a7b42ece5d641b
+  metadata.gz: 3b31d7018f64f25ae41952d0540e64ef9686e28a2aec737c4d2b2fd7efd0fd3c
+  data.tar.gz: 2ba8567079e3d578705dde71ee0388679bb005b4466d534297615cd837490eb2
 SHA512:
-  metadata.gz: b29ccb1148bb7b4782b4cf5d466330d241bbc90c5554129b4d243833d5585a2fad599fbf6e518e62a08db487e32adcdf0ebd65232592f9d01fe048a4898f0310
-  data.tar.gz: 3b3f65377b9bc66f33874abcbe231fc6e5ace020b82526fb8edbab5b697085bcf1f3bd48c2bc8f7d42873770a6c61e2096716a3bf95343dad20aa9c2947ee0dd
+  metadata.gz: c6004c6612c6389eac26063c4bd8ae4988c368d06315914c5636eb98dbc620101cfc68483fb7cada302b79c83007aab49c6f357e0de45dc9d2cd10eafd1ff800
+  data.tar.gz: d9e416dba7a23a0c4f1b8d8880a5460fbee44892993718dcea325fe92f89b579c70df9d7ba46d2dd5e37b752ad963d3b173dfa8e48bc489ecd52e4484ed1d770

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trk_datatables (0.2.6)
+    trk_datatables (0.2.11)
       activesupport
 
 GEM
@@ -30,6 +30,7 @@ GEM
     rake (10.5.0)
     sqlite3 (1.4.1)
     thread_safe (0.3.6)
+    timecop (0.9.4)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     zeitwerk (2.1.10)
@@ -47,6 +48,7 @@ DEPENDENCIES
   pg
   rake (~> 10.0)
   sqlite3
+  timecop
   trk_datatables!
 
 BUNDLED WITH

data/README.md

@@ -256,7 +256,7 @@ For specific columns you can use following keys
 * `order: false` disable ordering for this column
 * `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
+* `hide: true` hide column with display none, for example `{ hide: @view.params[:user_id].present? }`
 * `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`,
@@ -332,7 +332,7 @@ def columns
 end
 
 # in view
-link_to 'Active', search_posts_path(PostsDatatable.param_set('posts.status':
+link_to 'Active', search_posts_path(PostsDatatable.param_set('posts.status',
 Post.statues.values_at(:published, :promoted)))
 ```
 
@@ -552,12 +552,30 @@ class PostsDatatable
 end
 ```
 
+### Render html with additional css class and different DOM
+
+To add additional styling to your datatable you can use `:class` option when you
+are calling `@datatable.render_html url, options` for example
+
+```
+<%= @datatable.render_html search_posts_path(format: :json), class: 'table-hover' %>
+```
+
+Default [DOM](https://datatables.net/reference/option/dom) is
+`<"trk-global-search-wrapper"f>rtp<"trk-move-up"il>` which includes global
+**f**iltering, p**r**ocessing loader, **t**able search, **p**agination, table
+**i**nformation and **l**ength changing control. To override you can use
+
+```
+<%= @datatable.render_html search_posts_path(format: :json), 'data-datatable-dom': 'rt' %>
+```
+
 ### Params
 
 To set parameters that you can use for links to set column search value, use
 this `PostsDatatable.param_set 'users.email', 'my@email.com'`. For between
 search you can use range `Time.zone.today..(Time.zone.today + 1.year)` and for
-in multiple values use array `[Post.statuses[:draft]]`.
+in multiple values use array `[Post.statuses[:draft]]`:
 
 ```
 <%= link_to 'Active posts for my@email.com', \
@@ -573,6 +591,15 @@ in multiple values use array `[Post.statuses[:draft]]`.
 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)`)
+Please note that user_id is not inside datatable params so it will not be used
+for next search params (all other search params are used with Datatables and
+will remain on next search) so you need to manually add that param
+```
+<%= @datatable.render_html search_posts_path(user_id: params[:user_id], format: :json) %>
+```
+
+You can use generic name `params[:non_table_filter]` and split with colon
+`user_id:123` but that is not needed.
 
 For form fields you can use similar helper that will return name which points to
 specific column, for example:
@@ -596,10 +623,39 @@ For global search you can use `[search][value]` for example
 <% end %>
 ```
 
-If you need, you can fetch params with this helper
+If you need, you can fetch params with this helper and for example, show the
+link for that record
+
+```
+if @datatable.param_get("locations.name").present? &&
+   (location = Location.find_by(name: @datatable.param_get("locations.name")))
+  page_description "For <a href='#{location_path(location)}'>#{location.name}</a>"
+  breadcrumb "Dashboard": dashboard_path, location.name => location_path(location), "Package Sales": nil
+else
+  breadcrumb "Dashboard": dashboard_path, "Package Sales": nil
+end
+```
 
+For other filter params which are not in columns you can use non table params
 ```
-PostsDatatable.param_get('users.email', params)
+# on dashboard
+  <%= link_to 'Locations', isp_locations_path(non_table_filter: "reseller_operator_id:#{@reseller_operator.id}") %>
+
+# on index
+  if params[:non_table_filter].present? &&
+    (reseller_operator = ResellerOperator.find(params[:non_table_filter].split(":").second))
+    page_description "For <a href='#{reseller_operator_path(reseller_operator)}'>#{reseller_operator.company_name}</a>"
+    breadcrumb 'Dashboard' => isp_dashboard_path, reseller_operator.company_name => reseller_operator_path(reseller_operator), 'Locations' => nil
+  else
+    breadcrumb 'Dashboard' => isp_dashboard_path, 'Locations' => nil
+  end
+
+# in datatables
+    case @view.params[:non_table_filter].to_s.split(':').first
+    when 'reseller_operator_id'
+      reseller_operator = ResellerOperator.find @view.params[:non_table_filter].split(':').second
+      all_isp_locations = all_isp_locations.where(reseller_operator: reseller_operator)
+    end
 ```
 
 You can set filters on datatable even params are blank, for example
@@ -661,7 +717,9 @@ end
 
 You can use condition to provide different data, for example let's assume
 `@view.api_user?` returns true for json requests from mobile app. Here is
-example that provides different columns for normal and api_user:
+example that provides different columns for normal and api_user.
+Note that when you are using different columns for some reason in `@view` you
+need to provide view in `param_set` so it can check the same conditionals.
 
 ```
 # app/datatables/posts_datatable.rb
@@ -671,8 +729,14 @@ class PostsDatatable < TrkDatatables::ActiveRecord
   end
 
   def columns_for_html
+    balance = @view.current_location
+                {}
+              else
+                { 'integer_calculated_in_db.balance_amount_in_cents': { search: false, title: 'Balance' } }
+              end
     {
       'subscribers.subscriberid': {},
+      **balance,
       'subscribers.name': {},
     }
   end
@@ -691,8 +755,14 @@ class PostsDatatable < TrkDatatables::ActiveRecord
 
   def rows_for_html(filtered)
     filtered.map do |subscriber|
+      balance = if Constant.STILL_WITH_OLD_CODE
+                  []
+                else
+                  [@view.humanized_money_with_symbol(Money.new(location.balance_amount_in_cents)) : 'NA']
+                end
       [
         @view.link_to(subscriber.subscriberid, subscriber),
+        *balance,
         subscriber.name,
       ]
     end
@@ -712,6 +782,10 @@ class PostsDatatable < TrkDatatables::ActiveRecord
     @view.api_user? ? columns_for_api : nil
   end
 end
+
+# On some dashboard page provide @view using `self` to param_set
+link_to 'Active', search_posts_path(PostsDatatable.param_set('posts.status',
+:active, self))
 ```
 
 ## Test your datatables

data/lib/trk_datatables/base.rb

@@ -7,7 +7,7 @@ module TrkDatatables
   class Error < StandardError
   end
 
-  class Base
+  class Base # rubocop:todo Metrics/ClassLength
     extend TrkDatatables::BaseHelpers
 
     attr_accessor :column_key_options
@@ -97,8 +97,6 @@ module TrkDatatables
       raise 'order_and_paginate_items_is_defined_in_specific_orm'
     end
 
-    # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
-
     # Returns dt_orders or default as array of index and direction
     # https://datatables.net/reference/option/order
     # @return
@@ -114,12 +112,11 @@ 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) }
+        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 }
         @dt_orders_or_default = @preferences.get(:order, check_value) || default_order
       end
       @dt_orders_or_default
     end
-    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
     def default_order
       [[0, :desc]].freeze
@@ -226,7 +223,7 @@ module TrkDatatables
       }
     end
 
-    def predefined_date_ranges
+    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],
@@ -236,12 +233,13 @@ module TrkDatatables
       }
     end
 
-    def predefined_datetime_ranges
+    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': Time.zone.today.prev_month.beginning_of_month.beginning_of_day...Time.zone.today.prev_month.end_of_month.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

data/lib/trk_datatables/base_helpers.rb

@@ -13,8 +13,8 @@ module TrkDatatables
     # @example
     #   link_to 'Published posts for user1',
     #   posts_path(PostsDatatable.param_set('posts.status', :published).merge(user_id: user1.id))
-    def param_set(column_key, value)
-      datatable = new OpenStruct.new(params: {})
+    def param_set(column_key, value, view = nil)
+      datatable = new view || OpenStruct.new(params: {})
       value = value.join MULTIPLE_OPTION_SEPARATOR if value.is_a? Array
       value = [value.first, value.last].join BETWEEN_SEPARATOR if value.is_a? Range
       column_index = datatable.index_by_column_key column_key

data/lib/trk_datatables/column_key_options.rb

@@ -172,7 +172,12 @@ module TrkDatatables
     # This is helper
     def _determine_string_type_cast # :nodoc:
       if defined?(::ActiveRecord::Base)
-        DB_ADAPTER_STRING_TYPE_CAST[::ActiveRecord::Base.connection_config[:adapter].to_sym]
+        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
+        DB_ADAPTER_STRING_TYPE_CAST[current_adapter.to_sym]
       else
         'not_used'
       end

data/lib/trk_datatables/dt_params.rb

@@ -117,7 +117,7 @@ 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 = {})

data/lib/trk_datatables/render_html.rb

@@ -4,8 +4,8 @@ module TrkDatatables
     def initialize(search_link, datatable, html_options = {})
       @search_link = search_link
       @datatable = datatable
-      @html_options = html_options
-      self.class.indent = -1
+      @html_options = html_options.symbolize_keys
+      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
@@ -89,6 +89,7 @@ module TrkDatatables
         # 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>',
       ) do
         thead << "\n".html_safe << tbody
       end +

data/lib/trk_datatables/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.2.6'.freeze
+  VERSION = '0.2.11'.freeze
 end

data/trk_datatables.gemspec

@@ -46,6 +46,7 @@ Gem::Specification.new do |spec|
   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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.11
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-29 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Gem that simplify using datatables with Ruby on Rails and Sinatra.