trk_datatables 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c62f6190d44143f7d76ef88fce49357c06a2e693bc96164cb678f0f5935f817
-  data.tar.gz: 3a5ab2c6e062acd588484e3907e135875ab688c5ff88b4c075f0e42f785a00b8
+  metadata.gz: 13f7157e06eae31d336fcd8c561a1e681922f3b940677821012443fb6f4fd504
+  data.tar.gz: 7648806094e45b2be4b2838180150284d8e05aa78764456267ac539fc7ff59d4
 SHA512:
-  metadata.gz: 22dc186b88537bab98e1b36981fcce153e325252935e873b8007a176943e7e48caf5c90868e2bdffe6055bdc171a06f9ed9367fe821eb07bbd801b9e0a9e48a2
-  data.tar.gz: c6d7304344a2f174444cc5d6de704d68e4ef6af4ea6a611cd1d5aca7ded896abdd279721245ef9ff2fbe8268af88c02ecdc97a26e79348d96e57e8da2242ed52
+  metadata.gz: 04fde516dc05e4833d70bce836a91d6ce46aee65072065c22ab801f8878ab4665bf5af3d22b679aa6452750150328d246ee33cd900ccbac9daf246b3c95ffdea
+  data.tar.gz: 6b72c1393c14ce9d567c349cc2a56e2d816478dfc768a39df4bf3c91f5f33347f8b4457e61bd0fd69c4b79325db8963b69c7e0b8a04a936ab037fdde8f5711b7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trk_datatables (0.1.14)
+    trk_datatables (0.1.15)
       activesupport
 
 GEM
@@ -23,7 +23,7 @@ GEM
     database_cleaner (1.7.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
+    minitest (5.12.0)
     minitest-color (0.0.2)
       minitest (~> 5)
     pg (1.1.4)
@@ -32,7 +32,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    zeitwerk (2.1.9)
+    zeitwerk (2.1.10)
 
 PLATFORMS
   ruby

data/README.md

@@ -66,6 +66,10 @@ class PostsDatatable < TrkDatatables::ActiveRecord
     }
   end
 
+  def all_items
+    Post.left_joins(:user)
+  end
+
   def rows(filtered)
     filtered.map do |post|
       [
@@ -74,10 +78,6 @@ class PostsDatatable < TrkDatatables::ActiveRecord
       ]
     end
   end
-
-  def all_items
-    Post.left_joins(:user)
-  end
 end
 ```
 
@@ -343,18 +343,30 @@ end
 ### Params
 
 To set parameters that you can use for links to set column search value, use
-this `PostsDatatable.param_set` for example
+this `PostsDatatable.param_set 'users.email', 'my@email.com'` for example
 
 ```
-link_to 'Active posts for my@email.com', \
-  posts_path(
-    PostsDatatable.param_set('users.email', 'my@email.com')
-      .deep_merge(PostsDatatable.param_set('posts.status', Post.statuses.values_at(:published, :promoted))
-      .deep_merge(user_id: 1)
-  )
+<%= link_to 'Active posts for my@email.com', \
+      posts_path(
+        PostsDatatable.param_set('users.email', 'my@email.com')
+          .deep_merge(PostsDatatable.param_set('posts.status', Post.statuses.values_at(:published, :promoted))
+          .deep_merge(user_id: 1)
+      )
+%>
 ```
 
-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)`)
+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)`)
+
+For form fields you can use similar helper `PostsDatatable.form_field_name
+'users.email'`
+```
+<%= form_tag url: posts_path, method: :get do |f| %>
+  <%= f.text_field PostsDatatable.form_field_name('users.email'), 'my@email.com' %>
+  <%= f.submit 'Search' %>
+<% end %>
+```
 
 If you need, you can fetch params with this helper
 
@@ -486,7 +498,18 @@ side rendering and more advance listing
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run all tests.
+
+```
+# all
+rake
+# specific file
+ruby -I test test/trk_datatables/base_test.rb
+# only mathing
+ruby -I test test/trk_datatables/base_test.rb -n /additional/
+```
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To
 release a new version, update the version number in

data/lib/trk_datatables/base.rb

@@ -8,6 +8,8 @@ module TrkDatatables
   end
 
   class Base
+    extend TrkDatatables::BaseHelpers
+
     attr_accessor :column_key_options
 
     # In tests you can use `spy(:view)` when you want to initialize without
@@ -95,6 +97,8 @@ 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
@@ -104,7 +108,9 @@ module TrkDatatables
     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?
+      if columns.blank?
+        @dt_orders_or_default = []
+      elsif @dt_params.dt_orders.present?
         @dt_orders_or_default = @dt_params.dt_orders
         @preferences.set :order, @dt_params.dt_orders
       else
@@ -113,6 +119,7 @@ module TrkDatatables
       end
       @dt_orders_or_default
     end
+    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
     def default_order
       [[0, :desc]].freeze
@@ -134,26 +141,6 @@ module TrkDatatables
         end
     end
 
-    # Set params for columns. This is class method so you do not need datatable
-    # instance.
-    #
-    # @example
-    #   link_to 'Published posts for my@email.com',
-    #   posts_path(PostsDatatable.params('posts.status': :published,
-    #   'users.email: 'my@email.com')
-    #
-    # You can always use your params for filtering outside of datatable and
-    # merge to params
-    # @example
-    #   link_to 'Published posts for user1',
-    #   posts_path(PostsDatatable.param_set('posts.status', :published).merge(user_id: user1.id))
-    def self.param_set(column_key, value)
-      datatable = new OpenStruct.new(params: {})
-      value = value.join MULTIPLE_OPTION_SEPARATOR if value.is_a? Array
-      column_index = datatable.index_by_column_key column_key
-      DtParams.param_set column_index, value
-    end
-
     # We need this method publicly available since we use it for class method
     # param_set
     def index_by_column_key(column_key)

data/lib/trk_datatables/base_helpers.rb

@@ -0,0 +1,44 @@
+module TrkDatatables
+  module BaseHelpers
+    # Set params for column search. This is class method so you do not need
+    # datatable instance.
+    #
+    # @example
+    #   link_to 'Published posts for my@email.com',
+    #   posts_path(PostsDatatable.params('posts.status': :published,
+    #   'users.email: 'my@email.com')
+    #
+    # You can always use your params for filtering outside of datatable and
+    # merge to params
+    # @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: {})
+      value = value.join MULTIPLE_OPTION_SEPARATOR if value.is_a? Array
+      column_index = datatable.index_by_column_key column_key
+      DtParams.param_set column_index, value
+    end
+
+    # Get the form field name for column. This is class method so you do not
+    # need datatable instance.
+    #
+    # @example
+    # form_tag url: posts_path, method: :get do |f|
+    #   f.text_field PostsDatatable.form_field_name('users.email'), 'my@email.com'
+    def form_field_name(column_key)
+      datatable = new OpenStruct.new(params: {})
+      column_index = datatable.index_by_column_key column_key
+      DtParams.form_field_name column_index
+    end
+
+    # For range you can this helper to insert BETWEEN_SEPARATOR
+    def range_string(range)
+      raise ArgumentError, "#{range} is not a Range" unless range.is_a? Range
+
+      from = range.min
+      to = range.max
+      "#{from} #{BETWEEN_SEPARATOR} #{to}"
+    end
+  end
+end

data/lib/trk_datatables/dt_params.rb

@@ -108,6 +108,10 @@ module TrkDatatables
       { columns: { column_index.to_s => { search: { value: value } } } }
     end
 
+    def self.form_field_name(column_index)
+      "columns[#{column_index}][search][value]"
+    end
+
     def param_get(column_index)
       @params.dig :columns, column_index.to_s, :search, :value
     end

data/lib/trk_datatables/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.1.14'.freeze
+  VERSION = '0.1.15'.freeze
 end

data/lib/trk_datatables.rb

@@ -1,7 +1,7 @@
 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2019-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -171,6 +171,7 @@ files:
 - lib/trk_datatables.rb
 - lib/trk_datatables/active_record.rb
 - lib/trk_datatables/base.rb
+- lib/trk_datatables/base_helpers.rb
 - lib/trk_datatables/column_key_options.rb
 - lib/trk_datatables/dt_params.rb
 - lib/trk_datatables/neo4j.rb