trk_datatables 0.2.8 → 0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bbcc94c87611e1aaa08588c6599df2c691192850905da3b981a69d908ffb981
-  data.tar.gz: ac998b4e62500caf9be81419909a8c1d530f64c7737330c0fd4de22a40a082df
+  metadata.gz: dfebccd40ad802ae6e7e6beb1eebec9099f9ede5bf4ed4d2f6f9ed92a08a8f03
+  data.tar.gz: 0fcb0efd54b898d2d2aa68ff76c095293fa0b57abb48a37bd893aa59a676ff4e
 SHA512:
-  metadata.gz: 2adca44aac667b274f31b374f2914a9499f2c37294ef3d308ac45fd0fd0da26e0545093d62c508d42b5c78638e181e10b1c1f3b252396c0ca8a5a952a54dd509
-  data.tar.gz: c1b6ab154c81408296714795d68521135da81bb0ca5226b9407c600f824cc566333f1f022cbd088d71629be94d83494ab2c94d41d71c178a2034e94b697288fd
+  metadata.gz: fa204f488a45f055b602e9baf8504cd64e8a91404a69800588065fcabbfa5a85ce2ae9220751fdf7633facdfe1627a98bae33354eabfaf6c64e9053f20f6472a
+  data.tar.gz: ba2fbe421642ed72bff9e023b541c4321c56baa653f54f1ac372d3e7d43233691a7316040340ff20c94e1d4fab6ceb5ce314fe0efeadfa65240e2dee2042593e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trk_datatables (0.2.8)
+    trk_datatables (0.2.13)
       activesupport
 
 GEM
@@ -52,4 +52,4 @@ DEPENDENCIES
   trk_datatables!
 
 BUNDLED WITH
-   2.1.4
+   2.2.15

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)))
 ```
 
@@ -531,6 +531,94 @@ class MostLikedPostsDatatable < TrkDatatables::ActiveRecord
 end
 ```
 
+### Table less models
+
+You can use raw sql to fetch the data and use it as a model.
+Here is an example when there is no relations to other models
+```
+# app/models/table_less.rb
+class TableLess < ApplicationRecord
+  self.abstract_class = true
+
+  def self.load_schema!
+    @columns_hash ||= {}
+
+    # From active_record/attributes.rb
+    attributes_to_define_after_schema_loads.each do |name, (type, options)|
+      type = ActiveRecord::Type.lookup(type, **options.except(:default)) if type.is_a?(Symbol)
+
+      define_attribute(name, type, **options.slice(:default))
+
+      # Improve Model#inspect output
+      @columns_hash[name.to_s] = ActiveRecord::ConnectionAdapters::Column.new(name.to_s, options[:default])
+    end
+  end
+end
+```
+
+```
+# app/models/translation.rb
+class Translation < TableLess
+  self.table_name = :translations
+
+  attribute :translateable_type, :string, default: nil
+  attribute :translateable_id, :string, default: nil
+  attribute :column_name, :string, default: nil
+  attribute :column_value, :string, default: nil
+
+  belongs_to :translateable, polymorphic: true
+end
+```
+
+```
+# app/datatables/translations_datatable.rb
+# rubocop:disable Layout/LineLength
+class TranslationsDatatable < BaseDatatable
+  def columns
+    {
+      'translations.translateable_id': {},
+      'translations.translateable_type': {hide: true},
+      'translations.column_name': {},
+      'translations.column_value': {},
+      '': {},
+    }
+  end
+
+  def all_items
+    sql = <<~SQL.squish
+      (
+        (SELECT 'Activity' AS translateable_type, id AS translateable_id, 'name' AS column_name, name AS column_value FROM activities)
+        UNION
+        (SELECT 'Activity' AS translateable_type, id AS translateable_id, 'description' AS column_name, description AS column_value FROM activities)
+      ) as translations
+    SQL
+    Translation.from([Arel.sql(sql)])
+  end
+
+  def rows(filtered)
+    filtered.map do |translation|
+      edit_link = @view.button_tag_open_modal(
+        @view.edit_translation_path(translation.translateable_id, translateable_type: translation.translateable_type, column_name: translation.column_name), title: @view.t_crud('edit', Translation)
+      )
+      [
+        @view.link_to(translation.translateable, translation.translateable),
+        translation.translateable_type,
+        translation.column_name,
+        translation.column_value,
+        edit_link,
+      ]
+    end
+  end
+end
+# rubocop:enable Layout/LineLength
+```
+
+For column title we use `table_class.human_attribute_name column_name`. When
+calculated_ columns is used than it can not find translation so better is to:
+```
+      'string_calculated_in_db.column_value_translated': {search: false, title: @view.t('activerecord.attributes.translation.column_value_translated')},
+```
+
 ### Default order and page length
 
 You can override default order (index and direction) and default page length so
@@ -552,12 +640,41 @@ 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]]`. Note that in Rails
+`Time.zone.now.to_s` usually returns seconds ('23:59:59') but if you change
+default format like in `config/initializers/time_formats.rb` with
+`Time::DATE_FORMATS[:default] = '%d-%b-%Y %I:%M %p'` than range
+`Time.zone.now.at_beginning_of_day..Time.zone.now.at_end_of_day` will not
+include those at end of day since param will not include seconds ('23:59') so in
+this case you can use range for strings
+`Time.zone.now.at_beginning_of_day.to_s..Time.zone.now.at_end_of_day.to_s(:with_seconds)`
+and config/initializers/time_formats.rb `Time::DATE_FORMATS[:with_seconds] = '%d-%b-%Y %I:%M:%S %p'`
+
+(or use date `Time.zone.today..Time.zone.today` but that will not populate
+datetime fields in dateRangePicker correctly)
 
 ```
 <%= link_to 'Active posts for my@email.com', \
@@ -573,6 +690,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 +722,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
 
 ```
-PostsDatatable.param_get('users.email', params)
+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
+```
+# 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 +816,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 +828,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 +854,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 +881,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/active_record.rb

@@ -87,12 +87,15 @@ module TrkDatatables
         # we do not need to cast from string since range will do automatically
         parsed_from = from
         parsed_to = to
-      when :date, :datetime
+      when :date
+        parsed_from = _parse_in_zone(from).to_date
+        parsed_to = _parse_in_zone(to).to_date
+      when :datetime
         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
+        if parsed_to.present? && !to.match(/:/)
+          # Use end of a day if time is not defined, for example 2020-02-02
+          parsed_to = parsed_to.at_end_of_day
         end
       end
       [parsed_from, parsed_to]

data/lib/trk_datatables/base.rb

@@ -241,10 +241,7 @@ module TrkDatatables
         '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

@@ -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,7 +4,7 @@ module TrkDatatables
     def initialize(search_link, datatable, html_options = {})
       @search_link = search_link
       @datatable = datatable
-      @html_options = html_options
+      @html_options = html_options.symbolize_keys
       self.class.indent = 0
     end
 
@@ -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.8'.freeze
+  VERSION = '0.2.13'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.13
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -220,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.2.15
 signing_key: 
 specification_version: 4
 summary: Gem that simplify using datatables with Ruby on Rails and Sinatra.