trk_datatables 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 520b6d86f27312cd4c8bb89e62943f542be727954446ce8c4be03790727f7a4d
-  data.tar.gz: dd881cc122ffd0cbec3eca16db24ed65cfc98921d22080920d8df167a8c7260c
+  metadata.gz: 03d60af4ffecbd22baf81e7700ab5e3ec8b32e85ad7daa91017621ad972667d6
+  data.tar.gz: d6e0f467c5cda0e6ad41019d0eb23505a65194759c6c25d1dee3a7d441d23fe1
 SHA512:
-  metadata.gz: f7f62cc8d55ca17597c9c65d3aaf646f16f92a94873b97c83847e6e01f843f951ec74796e8064ed81cab802a404599006b3a7c321ecb672fc909c9f5e669724c
-  data.tar.gz: 27ea4d1cf61af80539f66502256a173c603416030da3943947fcf5d43eaefd068fe0112a7fa0d87aa2cca493f77b759c76f3c151afd1ecd3d85c44b1804e7216
+  metadata.gz: 6a98588013bfa4d99ccbbb55691cb7f028551f8d784ee869bf8dec2e9f4d68d8f4c8b4f36369bf0b7c56d49bafbef9b9b94933a52260b94c292c530fd21bfbaa
+  data.tar.gz: 1f5566bb0db920cb827a19b9bf0109a3e247a176e7310e57f05a608647a477d97d1e883d4e4e1dca4b6af520fdc620c5de041f65fcc7bd60206975549eaa4f08

data/Gemfile.lock

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

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)))
 ```
 
@@ -575,7 +575,7 @@ Default [DOM](https://datatables.net/reference/option/dom) is
 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', \
@@ -591,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:
@@ -614,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
 ```
-datatable.param_get 'users.email'
+# 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
@@ -679,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
@@ -689,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
@@ -709,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
@@ -730,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_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/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.2.9'.freeze
+  VERSION = '0.2.10'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport