trk_datatables 0.1.23 → 0.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be66386c1790e311f2569103b47de86bf98d5a7a97e55cfd2e74208476192fb5
-  data.tar.gz: b5f32eb60f84a619bcbbb689c3caeaeb8ed359d7de024eb862ac1e3c4a892c4e
+  metadata.gz: 63b484a61536f738a27bc1011d30e4e51f784f07468f13b66ad18912137159a1
+  data.tar.gz: 85d5c270f493090bcb6c0f177d2b71c26fa950adb181a6268747adf05491bc91
 SHA512:
-  metadata.gz: 52d265632b49ace4ff5ff878eb7efa108920f4f53436aab5249ab0632731a1a7b796eb5d37a11dcedfc30609350a2f74fbfdac42518a3ea3402c8a1ee99f7c1d
-  data.tar.gz: 0a6826db86f23223a2c95722c39f558e5516cfa9549d1616f0b6ed909d45f4808ded85954cdf05ecef94533caf6e55c1598bb03eae05a10b320c7d26d94231f0
+  metadata.gz: 1f0e940deeb4eebc8e227080a51e95c84f5038b54f00186bd273ac771abac4672d5c7cf262ce12cd653d22328c38f2a8bedf53f8b5f6deb50143233b1dc65349
+  data.tar.gz: eb84cc60601fd30ec87bcaf5c6c3812688ca0d15b7a53ea19f73a06290865fdbe0d72dcb62f7d1e4cdd52cd20fc7c538bbfe037b36e385629b0ad2ab80b1ee3c

data/Gemfile.lock

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

data/README.md

@@ -5,10 +5,10 @@ used with [trk_datatables npm package](https://www.npmjs.com/package/trk_datatab
 
 Instead of using Rails scaffold generator you can use advanced [Datatables plug-in for jQuery library](https://datatables.net).
 
-After [few lines of code](https://github.com/trkin/trk_datatables#installation) you can use
-one line commands `@datatable.render_html` to generate index page that supports:
-global search, filtering and sorting, first page is prerendered (so non-js
-crawlers can see it), adding map and other interesting features.
+After [few lines of code](https://github.com/trkin/trk_datatables#installation)
+you can use one line commands `@datatable.render_html` to generate index page
+that supports: global search, filtering and sorting, first page is prerendered
+(so non-js crawlers can see it), adding map and other interesting features.
 
 So instead of basic Rails scaffold with a lot of html code
 
@@ -26,13 +26,19 @@ You can get something like
       * [Usage example in Ruby on Rails](#usage-example-in-ruby-on-rails)
       * [Configuration](#configuration)
          * [Global search](#global-search)
-         * [Column 'ILIKE' and 'BETWEEN' search](#column-ilike-and-between-search)
-         * [Column 'IN' search](#column-in-search)
-         * [Action column](#action-column)
+         * [Column 'ILIKE' search with text input](#column-ilike-search-with-text-input)
+         * [Column 'BETWEEN' search with js daterangepicker](#column-between-search-with-js-daterangepicker)
+         * [Column 'IN' search with select tag](#column-in-search-with-select-tag)
+         * [Boolean column with checkbox](#boolean-column-with-checkbox)
+         * [Action and non database columns](#action-and-non-database-columns)
+         * [Values calculated in database](#values-calculated-in-database)
+         * [Default order and page length](#default-order-and-page-length)
          * [Params](#params)
          * [Saved Preferences (optional)](#saved-preferences-optional)
          * [Additional data to json response](#additional-data-to-json-response)
       * [Different response for mobile app](#different-response-for-mobile-app)
+      * [Test your datatables](#test-your-datatables)
+      * [Exceptions](#exceptions)
       * [Debug](#debug)
       * [Alternatives](#alternatives)
       * [Development](#development)
@@ -40,7 +46,7 @@ You can get something like
       * [License](#license)
       * [Code of Conduct](#code-of-conduct)
 
-<!-- Added by: orlovic, at: Mon Sep  9 09:38:44 CEST 2019 -->
+<!-- Added by: orlovic, at: Sat Aug 29 05:26:19 CEST 2020 -->
 
 <!--te-->
 
@@ -207,9 +213,10 @@ class PostsDatatable < TrkDatatables::ActiveRecord
 end
 ```
 
-### Column 'ILIKE' search
+### Column 'ILIKE' search with text input
 
-All columns are by default casted to string and `ILIKE` is perfomed.
+All columns are by default casted to `:string` (you can manually cast with
+`column_type_in_db: :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
@@ -244,7 +251,7 @@ For specific columns you can use following keys
 * `class_name: 'Admin::User'` use different class name than
   `table_name.classify` (in this case of `admin_users` will be `AdminUser`)
 
-### Column 'BETWEEN' search
+### Column 'BETWEEN' search with js daterangepicker
 
 For column search when search string contains BETWEEN_SEPARATOR (` - `) and
 column_type_in_db as one of the: `:date`, `:datetime`, `:integer` and
@@ -315,7 +322,7 @@ We use
 [ActiveSupport::TimeZone](https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html)
 so if you use different than UTC you need to set `Time.zone =` in your app [example values](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/values/time_zone.rb#L31). Whenever Time.parse is used (and we use `Time.zone.parse` for params) it needs correct zone (in Rails you can set timezone in `config.time_zone` or use [browser timezone rails gem](https://github.com/kbaum/browser-timezone-rails)).
 
-### Column 'IN' search
+### Column 'IN' search with select tag
 
 You can use column_option `select_options: [['name1', 'value1']]` so select box
 will be loaded and match if `col IN (value1|value2)`.
@@ -333,9 +340,11 @@ link_to 'Active', search_posts_path(PostsDatatable.param_set('posts.status':
 Post.statues.values_at(:published, :promoted)))
 ```
 
-You can use column_option `search: :checkbox` so for column_type_in_db `:boolean`
-it will provide checkbox. For other column_type_in_db it will match if value is
-NULL or NOT NULL.
+### Boolean column with checkbox
+
+For column_type_in_db `:boolean` it will generate checkbox and use
+http://vanderlee.github.io/tristate/ so you can filter for `true`, `false` or
+`any` (in this case we ignore this column in filtering)
 
 ### Action and non database columns
 
@@ -583,7 +592,7 @@ class PostsDatatableTest < ActiveSupport::TestCase
 end
 ```
 
-# Exceptions
+## Exceptions
 
 To catch errors from TrkDatables you can
 
@@ -627,7 +636,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 rake
 # specific file
 ruby -I test test/trk_datatables/base_test.rb
-# only mathing
+# specific test that matches additional
 ruby -I test test/trk_datatables/base_test.rb -n /additional/
 ```
 

data/lib/trk_datatables/active_record.rb

@@ -33,6 +33,8 @@ module TrkDatatables
       select_options = column_key_option[:column_options][ColumnKeyOptions::SELECT_OPTIONS]
       if select_options.present?
         filter_column_as_in(column_key_option, search_value)
+      elsif %i[boolean].include?(column_key_option[:column_type_in_db])
+        filter_column_as_boolean(column_key_option, search_value)
       elsif %i[date datetime integer float].include?(column_key_option[:column_type_in_db]) && \
             search_value.include?(BETWEEN_SEPARATOR)
         from, to = search_value.split BETWEEN_SEPARATOR
@@ -52,6 +54,13 @@ module TrkDatatables
       end.reduce(:and)
     end
 
+    def filter_column_as_boolean(column_key_option, search_value)
+      # return true relation in case we ignore
+      return Arel::Nodes::SqlLiteral.new('1').eq(1) if search_value == 'any'
+
+      _arel_column(column_key_option).eq(search_value == 'true')
+    end
+
     def filter_column_as_between(column_key_option, from, to)
       from, to = _parse_from_to(from, to, column_key_option)
       if from.present? && to.present?
@@ -86,7 +95,6 @@ module TrkDatatables
       [parsed_from, parsed_to]
     end
 
-    # rubocop:disable Rails/TimeZone
     def _parse_in_zone(time)
       return nil if time.blank?
 
@@ -95,7 +103,6 @@ module TrkDatatables
     rescue ArgumentError
       nil
     end
-    # rubocop:enable Rails/TimeZone
 
     def order_and_paginate_items(filtered)
       filtered = order_items filtered

data/lib/trk_datatables/column_key_options.rb

@@ -1,5 +1,5 @@
 module TrkDatatables
-  # rubocop:disable ClassLength
+  # rubocop:disable Metrics/ClassLength
   class ColumnKeyOptions
     include Enumerable
 
@@ -16,6 +16,7 @@ module TrkDatatables
     ORDER_OPTION = :order
     TITLE_OPTION = :title
     SELECT_OPTIONS = :select_options
+    CHECKBOX_OPTION = :checkbox_option
     PREDEFINED_RANGES = :predefined_ranges
     HIDE_OPTION = :hide
     CLASS_NAME = :class_name
@@ -23,9 +24,11 @@ module TrkDatatables
     # 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, HIDE_OPTION, CLASS_NAME,
-                      COLUMN_TYPE_IN_DB].freeze
+    COLUMN_OPTIONS = [
+      SEARCH_OPTION, ORDER_OPTION, TITLE_OPTION, SELECT_OPTIONS,
+      CHECKBOX_OPTION, PREDEFINED_RANGES, HIDE_OPTION, CLASS_NAME,
+      COLUMN_TYPE_IN_DB
+    ].freeze
 
     # for columns that as calculated in db query
     STRING_CALCULATED_IN_DB = :string_calculcated_in_db
@@ -96,7 +99,10 @@ module TrkDatatables
         else
           table_class = _determine_table_class table_name, column_options[CLASS_NAME]
 
-          column_type_in_db = column_options[COLUMN_TYPE_IN_DB] || _determine_db_type_for_column(table_class, column_name) unless column_options[SEARCH_OPTION] == false && column_options[ORDER_OPTION] == false
+          unless column_options[SEARCH_OPTION] == false && column_options[ORDER_OPTION] == false
+            column_type_in_db = column_options[COLUMN_TYPE_IN_DB] || _determine_db_type_for_column(table_class, column_name)
+            column_options[CHECKBOX_OPTION] = true if column_type_in_db == :boolean && column_options[CHECKBOX_OPTION].nil?
+          end
         end
         arr << {
           column_key: column_key.to_sym,
@@ -208,10 +214,11 @@ module TrkDatatables
       res['data-searchable'] = false if column_options[SEARCH_OPTION] == false
       res['data-orderable'] = false if column_options[ORDER_OPTION] == false
       res['data-datatable-hidden-column'] = true if column_options[HIDE_OPTION] == true
+      res['data-datatable-checkbox'] = true if column_options[CHECKBOX_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? ||
-            (@predefined_ranges.present? && column_options[PREDEFINED_RANGES] != false)
+           (@predefined_ranges.present? && column_options[PREDEFINED_RANGES] != false)
           res['data-datatable-predefined-ranges'] = if column_options[PREDEFINED_RANGES].is_a? Hash
                                                       column_options[PREDEFINED_RANGES]
                                                     else
@@ -225,5 +232,5 @@ module TrkDatatables
       res
     end
   end
-  # rubocop:enable ClassLength
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/trk_datatables/dt_params.rb

@@ -107,7 +107,7 @@ module TrkDatatables
     end
 
     def self.param_set(column_index, value)
-      { columns: { column_index.to_s => { search: { value: value } } } }
+      {columns: {column_index.to_s => {search: {value: value}}}}
     end
 
     def self.form_field_name(column_index)
@@ -135,7 +135,7 @@ module TrkDatatables
           value: '', regex: 'false'
         },
         order: {
-          '0': { column: '0', dir: 'desc' }
+          '0': {column: '0', dir: 'desc'}
         },
         # [:columns] should have the same size as column_key_options since we
         # ignore keys, and use positions

data/lib/trk_datatables/preferences.rb

@@ -21,7 +21,7 @@ module TrkDatatables
     def set(key, value)
       return unless @holder
 
-      h = { KEY_IN_PREFERENCES => { @class_name => { key => value } } }
+      h = {KEY_IN_PREFERENCES => {@class_name => {key => value}}}
       @holder.send("#{@field}=", {}) if @holder.send(@field).nil?
       @holder.send(@field).deep_merge! h
       @holder.save!

data/lib/trk_datatables/render_html.rb

@@ -1,5 +1,4 @@
 module TrkDatatables
-  # rubocop:disable Rails/OutputSafety
   class RenderHtml
     @indent = 0
     def initialize(search_link, datatable, html_options = {})
@@ -28,7 +27,7 @@ module TrkDatatables
       array.map { |i| ERB::Util.unwrapped_html_escape(i) }.join(sep).html_safe
     end
 
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
     #
     # _content_tag :p, 'Hi'
     # _content_tag :p, class: 'button', 'Hi'
@@ -57,13 +56,13 @@ module TrkDatatables
       self.class.indent -= 1
       html
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity
 
     def _select_tag(options, search_value)
       selected = search_value.to_s.split(MULTIPLE_OPTION_SEPARATOR)
       _content_tag :select, multiple: 'multiple' do
         safe_join(options.map do |key, value|
-          _content_tag :option, { value: value }.merge(selected.include?(value.to_s) ? { selected: 'selected' } : {}), key
+          _content_tag :option, {value: value}.merge(selected.include?(value.to_s) ? {selected: 'selected'} : {}), key
         end)
       end
     end
@@ -93,7 +92,8 @@ module TrkDatatables
         'data-datatable-total-length': @datatable.filtered_items_count,
       ) do
         thead << "\n".html_safe << tbody
-      end
+      end +
+        "\n" # add new line at the end so we can test with HERE_DOC </table>
     end
 
     def thead
@@ -132,5 +132,4 @@ module TrkDatatables
       ''
     end
   end
-  # rubocop:enable Rails/OutputSafety
 end

data/lib/trk_datatables/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.1.23'.freeze
+  VERSION = '0.1.24'.freeze
 end

data/trk_datatables.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Dusan Orlovic']
   spec.email         = ['duleorlovic@gmail.com']
 
-  spec.summary       = %q(Gem that simplify using datatables with Ruby on Rails and Sinatra.)
-  spec.description   = %q(Html render first page, sort and filter...)
+  spec.summary       = 'Gem that simplify using datatables with Ruby on Rails and Sinatra.'
+  spec.description   = 'Html render first page, sort and filter...'
   spec.homepage      = 'https://github.com/trkin/trk_datatables'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.1.23
+  version: 0.1.24
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2020-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport