trk_datatables 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6567d47eb0ced6f562a01e2c706bb7b56089f8e33ee6a3236e0becf23577cea1
-  data.tar.gz: 81e71aea8bd52a67c6566fa226b11f52190bf3c09c31bb070245c6db34171c82
+  metadata.gz: 689f7693808d3e9a2401c9b6fdbb6481b8d2d642e31064eb2f38e704ed95c5a2
+  data.tar.gz: b5f6ba211d7fcec99e9025a51bd0f6fc83d69ee3e10eeb6e1df10f2c41ddf3e2
 SHA512:
-  metadata.gz: bf8a9d267d2e4db6a41051cb219016fdc4adde2fe4c663f67cad7c8eb0657820df810ef9780e60fdeb514d459e19f18cf573505deb7f1ad61f1f30c37de9d51d
-  data.tar.gz: e94e94b04cd08ef33882a4eff9ec8643c4adc2430a5080a9b36fcc6162809f19562d85e24c460cbfbe632ed28837099a69687b87ed7b2a4554657473fab5b31b
+  metadata.gz: 566e9b5010b7b75bb0a1cc4ee3adf937a9cdfde97826007665a4e4b5edf80d4a970a1705700e66bf30a3c629da5bc3da66a069858e3670343284f66075b06d90
+  data.tar.gz: '08e33268ee12bb569476fafb899c8938ef7b272d3ea7272e4c851113ffde0b6fba94630f6363dd61e874f465622ab94c9fff638b7ab48c186c8c21a96c127fcc'

data/Gemfile.lock

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

data/README.md

@@ -141,20 +141,39 @@ end
 
 ### Column 'ILIKE' search
 
-All columns are by default caster to string and `ILIKE` is perfomed.
-There is short notation if you do not need any specific column configuration,
-for example custom title (in which case you need to define columns as key/value
-pairs).
+All columns are by default casted to string and `ILIKE` is perfomed.
+
+If you do not need any specific column configuration,
+for example custom `title`, than instead of defining columns as key/value
+pairs, you can define them in one line as array of column_key.
 
 ```
 # app/datatables/posts_datatable.rb
 class PostsDatatable < TrkDatatables::ActiveRecord
   def columns
-    # %w[posts.id posts.title posts.body] or even shorter using map
+    # instead of
+    # {
+    #   id: {},
+    #   title: {},
+    #   body: {},
+    # }.each_with_object({}) { |(key, value), obj| obj["posts.#{key}"] = value }
+    # you can use one liner
+    # %w[posts.id posts.title posts.body]
+    # or even shorter using map
     %i[id title body].map { |col| "posts.#{col}" }
   end
 end
 ```
+
+For specific columns you can use following keys
+
+* `title: 'My Title'` set up column header
+* `search: false` disable searching for this column
+* `order: false` disable ordering for this column
+* `predefined_ranges: {}` add ranges for datetime fields
+* `select_options: Post.statuses` generate select box
+* `hide: true` hide column
+
 ### Column 'BETWEEN' search
 
 For column search when search string contains BETWEEN_SEPARATOR (` - `) and
@@ -240,7 +259,7 @@ def columns
 end
 
 # in view
-link_to 'Active', search_posts_path(PostsDatatable.params_set('posts.status':
+link_to 'Active', search_posts_path(PostsDatatable.param_set('posts.status':
 Post.statues.values_at(:published, :promoted)))
 ```
 
@@ -272,20 +291,43 @@ use empty column_key
   end
 ```
 
+### Default order and page length
+
+You can override default order (index and direction) and default page length so
+if user did not request some order or page length (and if it is not found in
+save preferences) and this default values will be used
+
+```
+# app/datatables/posts_datatable.rb
+class PostsDatatable
+  # when we show some invoice_no on first column, and that is reset every year
+  # on first april, thatn it is better is to use date column ordering
+  def default_order
+    [[3, :desc]]
+  end
+
+  def default_page_length
+    20
+  end
+end
+```
+
 ### Params
 
 To set parameters that you can use for links to set column search value, use
 this `PostsDatatable.param_set` for example
 
 ```
-link_to 'Posts for my@email.com and my_title', \
+link_to 'Active posts for my@email.com', \
   posts_path(
-    PostsDatatable.params_set('users.email': 'my@email.com', 'posts.title': 'my_title')
-      .merge(user_id: 1)
+    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)
   )
-# will generate
 ```
 
+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)`)
+
 If you need, you can fetch params with this helper
 
 ```
@@ -420,6 +462,15 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+Instead of installing you can point directly to your path
+```
+# Gemfile
+# for index, ordering, pagination and searching
+# gem 'trk_datatables', '~>0.1'
+# no need to `bundle update trk_datatables` when switch to local
+gem 'trk_datatables', path: '~/gems/trk_datatables'
+```
+
 To generate docs you can run
 
 ```

data/lib/trk_datatables/base.rb

@@ -1,8 +1,8 @@
 module TrkDatatables
+  # TODO: extract those to configuration options
   BETWEEN_SEPARATOR = ' - '.freeze
   MULTIPLE_OPTION_SEPARATOR = '|'.freeze
-  DEFAULT_ORDER = [[0, :desc]].freeze
-  DEFAULT_PAGE_LENGTH = 10
+  # maximum page length = 100 (we should not believe params)
 
   class Error < StandardError
   end
@@ -109,11 +109,19 @@ module TrkDatatables
         @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) }
-        @dt_orders_or_default = @preferences.get(:order, check_value) || DEFAULT_ORDER
+        @dt_orders_or_default = @preferences.get(:order, check_value) || default_order
       end
       @dt_orders_or_default
     end
 
+    def default_order
+      [[0, :desc]].freeze
+    end
+
+    def default_page_length
+      10
+    end
+
     def dt_per_page_or_default
       return @dt_per_page_or_default if defined? @dt_per_page_or_default
 
@@ -122,7 +130,7 @@ module TrkDatatables
           @preferences.set :per_page, @dt_params.dt_per_page
           @dt_params.dt_per_page
         else
-          @preferences.get(:per_page) || DEFAULT_PAGE_LENGTH
+          @preferences.get(:per_page) || default_page_length
         end
     end
 
@@ -134,23 +142,20 @@ module TrkDatatables
     #   posts_path(PostsDatatable.params('posts.status': :published,
     #   'users.email: 'my@email.com')
     #
-    # You can always use your params for filtering outside of datatable
+    # 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.params_set('posts.status': :published).merge(user_id: user1.id))
-    def self.params_set(attr)
+    #   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: {})
-      result = {}
-      attr.each do |column_key, value|
-        value = value.join MULTIPLE_OPTION_SEPARATOR if value.is_a? Array
-        column_index = datatable.index_by_column_key column_key
-        result = result.deep_merge DtParams.param_set column_index, value
-      end
-      result
+      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
-    # params_set
+    # param_set
     def index_by_column_key(column_key)
       @column_key_options.index_by_column_key column_key
     end

data/lib/trk_datatables/column_key_options.rb

@@ -17,10 +17,11 @@ module TrkDatatables
     TITLE_OPTION = :title
     SELECT_OPTIONS = :select_options
     PREDEFINED_RANGES = :predefined_ranges
+    HIDE_OPTION = :hide
     # this will load date picker
     # SEARCH_OPTION_DATE_VALUE = :date
     # SEARCH_OPTION_DATETIME_VALUE = :datetime
-    COLUMN_OPTIONS = [SEARCH_OPTION, ORDER_OPTION, TITLE_OPTION, SELECT_OPTIONS, PREDEFINED_RANGES].freeze
+    COLUMN_OPTIONS = [SEARCH_OPTION, ORDER_OPTION, TITLE_OPTION, SELECT_OPTIONS, PREDEFINED_RANGES, HIDE_OPTION].freeze
 
     STRING_TYPE_CAST_POSTGRES = 'VARCHAR'.freeze
     STRING_TYPE_CAST_MYSQL    = 'CHAR'.freeze
@@ -170,6 +171,7 @@ module TrkDatatables
       res = {}
       res['data-searchable'] = false if column_options[SEARCH_OPTION] == false
       res['data-orderable'] = false if column_options[ORDER_OPTION] == false
+      res['data-datatable-hide-column'] = true if column_options[HIDE_OPTION] == true
       if %i[date datetime].include? column_type_in_db
         res['data-datatable-range'] = column_type_in_db == :datetime ? :datetime : true
         if column_options[PREDEFINED_RANGES].present? ||

data/lib/trk_datatables/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.1.11'.freeze
+  VERSION = '0.1.12'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-10 00:00:00.000000000 Z
+date: 2019-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -203,8 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Gem that simplify using datatables with Ruby on Rails and Sinatra.