trk_datatables 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77300955004aaab10aa5709dc4879d106c68eabe398b64d404dc12486b270e29
-  data.tar.gz: 64145170a26243653b16114c10e2915ca41043174b9a7f6f7be78b40affdf6bd
+  metadata.gz: 68552088303bb4189ce3e56623313eacf5e0b3d9f4af72ab75209c9caa2d92fc
+  data.tar.gz: a0af9029d761be77f52c4fdac363fd8c193eca9329d8ec6e2436cbcffbcb8d0a
 SHA512:
-  metadata.gz: 84a24f2a2541ce046bcfab7549f5d4b9e70b5b8bfb63dc7c88b368207bb15d5be7ca5792652fcacc7891e99997b9babc277e62037b7e22cc84ac0f6cedf4a51c
-  data.tar.gz: 375b132fc647e77513821691f25336613349ee7e96bfe5dbfd07f437622d23af8d7eaee8323a979d61d1543cb83e060738d5641b77720248ba900b0544fae628
+  metadata.gz: c20174324e50a8de14ceb878e2051ccdad5f4eca4e9585b8955c59db8e1249be636deb009ba922db481635613b155760dcf0f972fbb536126933352da5cd987f
+  data.tar.gz: edb6ea4d2f16b0e84b30d91ab35d202894cca49c917a5a2efbc81b32c5a5888ab57f55b0cdaa342695d118c78fe1a05e7d33553e67317d13ffea5a7dce121088

data/Gemfile.lock

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

data/README.md

@@ -1,12 +1,23 @@
 # Trk Datatables
 
-This is a source for [trk_datatables gem](https://rubygems.org/gems/trk_datatables) that you
-can use with [trk_datatables npm package](https://www.npmjs.com/package/trk_datatables) for easier usage of [Datatables plug-in for jQuery library](https://datatables.net)
+This is a source for [trk_datatables gem](https://rubygems.org/gems/trk_datatables) that is
+used with [trk_datatables npm package](https://www.npmjs.com/package/trk_datatables) to render tables.
 
-After [configuration](https://github.com/trkin/trk_datatables#configuration) you can use
-one line commands (like `@datatable.render_html`) to generate first page in html
-(so non-js crawlers can see it), global search, filtering and sorting, adding
-map and other complex listing based on GET params.
+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.
+
+So instead of basic Rails scaffold with a lot of html code
+
+![rails scaffold](test/scaffold.png "Rails default scaffold")
+
+You can get something like
+
+
+![trk-datatables](test/trk_datatables_with_daterangepicker.png "TRK Datatables")
 
 ## Table of Contents
 <!--ts-->
@@ -36,18 +47,75 @@ map and other complex listing based on GET params.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Let's first add Boostrap js package and https://www.npmjs.com/package/trk_datatables
+```
+yarn add trk_datatables bootstrap jquery popper.js
 
-```ruby
-# Gemfile
-gem 'trk_datatables'
+# app/javascript/packs/application.js
+// node_modules
+import 'bootstrap'
+
+// our stuff
+import 'stylesheet/application'
+import 'turbolinks.load'
+
+# app/javascript/turbolinks.load.js
+const trkDatatables = require('trk_datatables')
+
+document.addEventListener('turbolinks:load', () => {
+  // this will initialise all data-datatables elements
+  trkDatatables.initialise()
+})
+
+# app/views/layouts/application.html.erb
+/* here we include other packages so postcss-import plugin will load css file from style attribute from package.json */
+@import 'bootstrap'
+
+# config/webpack/environment.js
+const { environment } = require('@rails/webpacker')
+const webpack = require('webpack');
+environment.plugins.append('Provide', new webpack.ProvidePlugin({
+  $: 'jquery',
+  jQuery: 'jquery',
+  Popper: ['popper.js', 'default']
+}));
+
+module.exports = environment
+
+# app/views/layouts/application.html.erb
+    <%= stylesheet_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
 ```
 
-You need to create a class that inherits from `TrkDatatables::ActiveRecord` (you
-can use Rails generator)
+To add a gem follow those instructions
 
 ```
-rails g trk_datatables user
+# Gemfile
+gem 'trk_datatables'
+
+# in console
+bundle
+rails g trk_datatables post
+vi app/datatables/posts_datatable.rb
+
+# config/routes.rb
+  resources :posts do
+    collection do
+      post :search
+    end
+  end
+
+# app/controllers/posts_controller.rb
+  def index
+    @datatable = PostsDatatable.new view_context
+  end
+
+  def search
+    render json: PostsDatatable.new(view_context)
+  end
+
+# app/views/posts/index.html.erb
+<h1>Posts</h1>
+<%= @datatable.render_html search_posts_path(format: :json) %>
 ```
 
 ## Usage example in Ruby on Rails

data/lib/trk_datatables/column_key_options.rb

@@ -19,10 +19,13 @@ module TrkDatatables
     PREDEFINED_RANGES = :predefined_ranges
     HIDE_OPTION = :hide
     CLASS_NAME = :class_name
+    COLUMN_TYPE_IN_DB = :column_type_in_db
     # 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].freeze
+    COLUMN_OPTIONS = [SEARCH_OPTION, ORDER_OPTION, TITLE_OPTION, SELECT_OPTIONS,
+                      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
@@ -93,7 +96,7 @@ module TrkDatatables
         else
           table_class = _determine_table_class table_name, column_options[CLASS_NAME]
 
-          column_type_in_db = _determine_db_type_for_column(table_class, column_name) 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) unless column_options[SEARCH_OPTION] == false && column_options[ORDER_OPTION] == false
         end
         arr << {
           column_key: column_key.to_sym,

data/lib/trk_datatables/version.rb

@@ -1,3 +1,3 @@
 module TrkDatatables
-  VERSION = '0.1.21'.freeze
+  VERSION = '0.1.22'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trk_datatables
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - Dusan Orlovic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2020-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport