trk_datatables 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd503b00264e92d4ef4c55c30507288ea014180615b594e3403afa07e1e84aee
+  data.tar.gz: bc7883edb1bcb2c828dda4c7d3f7094cfb4a1ab462e70cf912ac03c1e80f0199
+SHA512:
+  metadata.gz: 1b8c68037f5ade06d24b01f25fb2159a39f2e57bacbbb6d8f34ce5b2447c3e33223bad2ef613b36aa452fdcb816f9d3a6de2ad31ace78e26c476a9bd64113acc
+  data.tar.gz: caee91e2838d5eea03798d383faccc057ff147f2f86e3c62064bd1f97504ff0efdab44edb1cfa030760c93353e2be04eeb3d95418dc900bd4e25d1c81ba3a75c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/node_modules/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+Add basic ActiveRecord sort and paginate filter

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at duleorlovic@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trk_datatables.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    trk_datatables (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    database_cleaner (1.7.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    minitest-around (0.5.0)
+      minitest (~> 5.0)
+    minitest-color (0.0.2)
+      minitest (~> 5)
+    pg (1.1.4)
+    rake (10.5.0)
+    sqlite3 (1.4.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6.0)
+  bundler (~> 2.0)
+  byebug
+  database_cleaner
+  minitest (~> 5.0)
+  minitest-around
+  minitest-color
+  pg
+  rake (~> 10.0)
+  sqlite3
+  trk_datatables!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Dusan Orlovic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,267 @@
+# Trk Datatables
+
+This is a [trk_datatables gem](https://github.com/trkin/trk_datatables) that you
+can use with trk_datatables npm package for easier usage of [Datatables js library](https://datatables.net)
+
+It gives you one liner command to generate first page in html (so non-js
+crawlers can see it), global search, filtering and sorting by one or more
+columns, adding map and other complex listing based on GET params.
+
+There are alternatives, for example:
+* [jbox-web/ajax-datatables-rails](https://github.com/jbox-web/ajax-datatables-rails)
+excellent gem but it's scope is only to produce JSON. I wanted to have server
+side rendering and more advance listing
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+gem 'trk_datatables'
+```
+
+You need to create a class that inherits from `TrkDatatables::ActiveRecord` (you
+can use Rails generator)
+
+```
+```
+
+## Usage example in Ruby on Rails
+
+For a table you need to define `rows` and `columns` (well that is obvious 😌).
+In datatable class you also need to define `all_items` method which will  be
+used to populate `rows` with paginated, sorted and filtered items (we will call
+them `filtered`)
+
+```
+# app/datatables/posts_datatable.rb
+class PostsDatatable < TrkDatatables::ActiveRecord
+  def all_items
+    Post.left_joins(:user)
+  end
+
+  def columns
+    {
+      'posts.title': {},
+      'users.email': {},
+    }
+  end
+
+  def rows(filtered)
+    filtered.map do |post|
+      [
+        @view.link_to(post.title, post),
+        post.user&.email,
+      ]
+    end
+  end
+end
+```
+
+In controller you need to initialize with `view_context`
+
+```
+# app/controllers/posts_controller.rb
+class PostsController < ApplicationController
+  def index
+    @datatable = PostsDatatable.new view_context
+  end
+
+  def search
+    render json: PostsDatatable.new(view_context).as_json
+  end
+end
+```
+
+In controller add a route to `:search`
+
+```
+# config/routes.rb
+Rails.application.routes.draw do
+  resources :posts do
+    colletion do
+      get :search
+    end
+  end
+end
+```
+
+And finally in a view, use `render_html` to have first page show up prerendered
+
+```
+# app/views/posts/index.html
+<h1>Posts</h1>
+<%= @datatable.render_html search_posts_path(format: :json) %>
+```
+
+## Configuration
+
+### Global search
+
+There are two types of search: global (search all columns) and column search
+(search is done for specific columns).
+
+For global search any type of a column is casted to a string and we use `ILIKE`
+(ie `.matches`).
+
+You can add more columns to global search by overriding `global_search_columns`
+method.
+
+```
+class PostsDatatable < TrkDatatables::ActiveRecord
+  def global_search_columns
+    # those fields will be used only to match global search
+    %w[posts.body users.name]
+  end
+end
+```
+
+### Column 'ILIKE' and 'BETWEEN' search
+
+For column search when search string does not contain BETWEEN_SEPARATOR (` - `) than
+all columns are casted to string and `ILIKE` is perfomed.
+
+When column_type_in_db as one of the: `:date`, `:datetime`, `:integer` and
+`:float` than `BETWEEN` is perfomed (when search contains BETWEEN_SEPARATOR,
+otherwise it is `ILIKE`).
+
+For columns `:date` and `:datetime` there will be `data-datatable-range='true'`
+attribute so bootstrap datepicker will be automatically loaded.
+
+### Column 'IN' search
+
+You can use column_option `select_options: [['name1', 'value1']]` so select box
+will be loaded and match if `col IN (value1|value2)`.
+
+```
+def columns
+  {
+    'posts.title': {},
+    'posts.status': { select_options: Post.statuses },
+  }
+end
+
+# in view
+link_to 'Active', search_posts_path(PostsDatatable.params_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.
+
+## Action column
+
+You can use one column for actions (so it is not related to any db column) just
+use empty column_key
+
+```
+  def columns
+    {
+      'posts.title': {},
+      '': { title: "<a href='#'>Check all</a>" },
+    }
+  end
+
+  def rows(filtered)
+    filtered.each do |post|
+      [
+        post.title,
+        "@view"
+      ]
+    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', \
+  posts_path(
+    PostsDatatable.params_set('users.email': 'my@email.com', 'posts.title': 'my_title')
+      .merge(user_id: 1)
+  )
+# will generate
+```
+
+If you need, you can fetch params with this helper
+
+```
+PostsDatatable.param_get('users.email', params)
+```
+
+## Saved Preferences (optional)
+
+You can save column order and page length in User.preferences field so
+next time user navigate to same page will see the same order and page length. It
+can be `string` or `text`, or some advance `hstore` or `jsonb`.
+
+```
+rails g migration add_preferences_to_users preferences:string
+
+# app/models/user.rb
+class User
+  # no need to serialize if it is hstore or jsonb
+  serialize :preferences, Hash
+end
+
+# app/datatables/posts_datatable.rb
+class PostsDatatable
+  def preferences_holder
+    @view.current_user
+  end
+
+  def preferences_field
+    # this is default so do not need to define unless you use different field
+    :preferences
+  end
+end
+```
+
+It will store order and page lenght inside `dt_preferences` on
+`user.preferences`.
+
+## Debug
+
+You can override some of the methos and put byebug, for example
+```
+# app/datatables/posts_datatable.rb
+class PostsDatatable < TrkDatatables::ActiveRecord
+  def as_json(_ = nil)
+    byebug
+    super
+  end
+end
+
+```
+
+## 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.
+
+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).
+
+To generate docs you can run
+
+```
+yard server
+
+# clear cache
+rm -rf .yardoc/
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trkin/trk_datatables. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TrkDatatables project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/trkin/trk_datatables/blob/master/CODE_OF_CONDUCT.md).