wice_grid 3.6.2 → 4.1.0

data/README.md

@@ -1,22 +1,13 @@
 [![Version](http://img.shields.io/gem/v/wice_grid.svg)](https://rubygems.org/gems/wice_grid)
-[![Build](https://travis-ci.org/leikind/wice_grid.svg)](https://travis-ci.org/leikind/wice_grid)
-[![Inline docs](http://inch-ci.org/github/leikind/wice_grid.svg?branch=rails3)](http://inch-ci.org/github/leikind/wice_grid/branch/rails3)
+[![CircleCI](https://circleci.com/gh/patricklindsay/wice_grid.svg?style=svg)](https://circleci.com/gh/patricklindsay/wice_grid)
+[![Inline docs](http://inch-ci.org/github/patricklindsay/wice_grid.svg)](http://inch-ci.org/github/patricklindsay/wice_grid)
 [![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
 
-<!-- let's disable for a while ;-)
-[![Coverage Status](https://coveralls.io/repos/leikind/wice_grid/badge.svg?branch=development&service=github)](https://coveralls.io/github/leikind/wice_grid?branch=development)
--->
-
-THE PROJECT IS LOOKING FOR CONTRIBUTORS. THE AUTHOR WILL NOT WORK ON IT ANYMORE!
-
-* Yuri Leikind, yuri.leikind at gmail dot com
-* Version 3.6.0.pre3; [What's New In 3.6.0](https://github.com/leikind/wice_grid/wiki/What's-New-In-3.6.0)
-* This tutorial is accompanied by a sample application with WiceGrid examples which you can browse online:
-http://wicegrid.herokuapp.com, or just view the code: https://github.com/leikind/wice_grid_testbed.
-
+# WiceGrid
 
+THE PROJECT IS LOOKING FOR CONTRIBUTORS.
 
-# WiceGrid
+Check out this [sample application](http://wicegrid.herokuapp.com) which demos all features & includes code samples.
 
 - [Intro](#intro)
 - [Requirements and Rails versions](#requirements-and-rails-versions)
@@ -30,12 +21,14 @@ http://wicegrid.herokuapp.com, or just view the code: https://github.com/leikind
   - [Joined associations referring to the same table](#joined-associations-referring-to-the-same-table)
   - [More than one grid on a page](#more-than-one_grid-on-a-page)
   - [Custom Ordering](#custom-ordering)
+  - [Custom Sorting](#custom-sorting)
 - [Filters](#filters)
   - [Custom dropdown filters](#custom-dropdown-filters)
   - [Numeric Filters](#numeric-filters)
   - [Date and DateTime Filters](#date-and-datetime-filters)
   - [Detached Filters](#detached-filters)
 - [Defaults](#defaults)
+- [Testing](#testing)
 - [Bug reports](#bug-reports)
 
 
@@ -71,15 +64,18 @@ WiceGrid views do not contain forms so you can include it in your own forms.
 
 WiceGrid is known to work with MySQL, Postgres, and Oracle.
 
+Continue reading for more information or check out our [CHANGELOG](https://github.com/patricklindsay/wice_grid/blob/master/CHANGELOG.md) to find out whats been going on.
 
-## Requirements and Rails versions
 
-For rails 2 use version 0.6 in [the master branch](https://github.com/leikind/wice_grid/tree/master).
-That branch is hardly supported.
+## Requirements and Rails versions
 
-The main supported branch is `rails3`. Latest Rails 3.2.x and Rails 4.x.x are supported in this branch.
+```
+# Rails => 5
+gem 'wice_grid'
 
-If you need to use the plugin in with Rails 3.0.x and 3.1.x versions, please use WiceGrid version 3.0.4.
+# Rails 4
+gem 'wice_grid', '3.6.2'
+```
 
 WiceGrid relies on jQuery.
 
@@ -93,14 +89,14 @@ WARNING: Since 3.2.pre2 WiceGrid is not compatible with `will_paginate` because
 
 ## Installation
 
-Add the following to your Gemfile:
+Add the following to your Gemfile & run `bundle`:
 
 ```ruby
-gem "wice_grid", '3.6.0.pre4'
+gem "wice_grid"
 gem 'font-awesome-sass',  '~> 4.3'
 ```
 
-and run the `bundle` command. `font-awesome-sass` is not a dependency of WiceGrid in case you decide to style WiceGrid icons differently.
+Note: `font-awesome-sass` is not a dependency of WiceGrid in case you decide to style WiceGrid icons differently.
 
 Run the generator:
 
@@ -109,7 +105,7 @@ rails g wice_grid:install
 ```
 
 This adds the following file:
-* config/initializers/wice_grid_config.rb
+* `config/initializers/wice_grid_config.rb`
 
 
 Require WiceGrid javascript in your js index file:
@@ -550,37 +546,71 @@ The name can only contain alphanumeric characters.
 It is possible to change the way results are ordered injecting a chunk of SQL code, for example, use
 `ORDER BY INET_ATON(ip_address)` instead of `ORDER BY ip_address`.
 
-To do so, provide parameter `:custom_order` in the initialization of the grid with a hash where
-keys are fully qualified names of database columns, and values the required chunks of SQL to use in the
-`ORDER BY` clause.
+To do so, provide parameter `:custom_order` in the initialization of the grid with a `Hash` where
+keys are fully qualified names of database columns, and values are anything that can be passed to ActiveRecord's
+`order` method (without specifying `ASC` or `DESC`.)
 
-For example:
+#### String
+
+Starting in Rails 5.2, you may need to whitelist `String` values with `Arel.sql`
+to avoid a warning or error.
 
 ```ruby
 @hosts_grid = initialize_grid(Host,
   custom_order: {
-    'hosts.ip_address' => 'INET_ATON(hosts.ip_address)'
+    'hosts.ip_address' => Arel.sql('INET_ATON(hosts.ip_address)')
   })
 ```
 
-It is possible to use the '?' character instead of the name of the column in the hash value:
+It is possible to use `?` instead of the name of the column in the `Hash` value:
 
 ```ruby
 @hosts_grid = initialize_grid(Host,
   custom_order: {
-    'hosts.ip_address' => 'INET_ATON( ? )'
+    'hosts.ip_address' => Arel.sql('INET_ATON( ? )')
   })
 ```
 
-Values can also be Proc objects. The parameter supplied to such a Proc object is the name of the column:
+#### Arel::Attributes::Attribute
+
+Assuming you wish to display `hosts.ip_address` but sort by another column named `hosts.ip_address_number`:
 
 ```ruby
 @hosts_grid = initialize_grid(Host,
   custom_order: {
-    'hosts.ip_address' => lambda{|f| "INET_ATON( #{f} )"}
+    'hosts.ip_address' => Arel::Table.new(:hosts)[:ip_address_number]
   })
 ```
 
+#### Proc
+
+You can use a `Proc` to return a `String` or `Arel::Attributes::Attribute` as above.
+
+```ruby
+@hosts_grid = initialize_grid(Host,
+  custom_order: {
+    'hosts.ip_address' => lambda{|f| Arel.sql(request[:numeric_sorting] ? "INET_ATON( #{f} )" : f) }
+  })
+```
+
+### Custom Sorting
+
+While `:custom_order` lets you define SQL that determines the results order, you may want to sort the result by arbritrary Ruby code. The `:sort_by` option on columns lets you define a `Proc` that determines the sorting on that column. This `Proc` is passed to Ruby's `Enumerable#sort_by`.
+
+```ruby
+grid.column name:  'Status Name', attribute: 'name', sort_by: ->(status) { [status.number_of_vowels, status] }
+```
+
+You can also use `:sort_by` to add sorting on values that are not columns in the database. In this case, you must also define an arbitrary `:attribute` option that serves as the request's sort key parameter.
+
+```ruby
+grid.column name: 'Task Count', attribute: 'task_count', sort_by: ->(status) { status.tasks.count } do |status|
+  status.tasks.count
+end
+```
+
+Note that `sort_by` will load all records into memory to sort them (even the ones not on the current page), so it may not be appropriate for use with a large number of results.
+
 ## Filters
 
 Each column filter type is supported by a `column processor`. Each `column processor` is
@@ -1512,7 +1542,20 @@ def index
 end
 ```
 
+## Testing
+
+To run tests:
+
+1. `git clone https://github.com/patricklindsay/wice_grid.git`
+2. `cd wice_grid`
+3. `bundle`
+4. Install phantomjs (e.g. `brew install phantomjs` or `apt-get install phantomjs` or something else)
+5. `bundle exec appraisal rspec`
+
+Tests against Rails 5.0, 5.1 & 5.2. To test against a specific version, for example Rails 5.2 run `bundle exec appraisal rails-5.2 rspec`
+
+This repository contains a Rails application for testing purposes. To fire up this application manually, run `cd spec/support/test_app/bin; RAILS_ENV=test rails s`.
+
 ## Bug reports
 
-The author of the plugin welcomes any contribution.
-Please follow [these guidelines](https://github.com/leikind/wice_grid/wiki/How-to-submit-a-bug-report-or-a-question) when submitting a bug report.
+If you discover a problem with Wicegrid, we would love to know about it. Please use the [GitHub issue tracker](https://github.com/patricklindsay/wice_grid/issues)

data/config/locales/ja.yml

@@ -1,9 +1,9 @@
 ja:
   date:
     order:
-      - :年
-      - :月
-      - :日
+      - ":年"
+      - ":月"
+      - ":日"
   wice_grid:
     show_filter_tooltip: フィルタ表示
     hide_filter_tooltip: フィルタ非表示

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.0.gemfile.lock

@@ -0,0 +1,291 @@
+PATH
+  remote: ..
+  specs:
+    wice_grid (4.0.1)
+      coffee-rails (> 3.2)
+      kaminari (~> 0.16)
+      rails (~> 5.0, < 5.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.7)
+      actionpack (= 5.0.7)
+      nio4r (>= 1.2, < 3.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.7)
+      actionpack (= 5.0.7)
+      actionview (= 5.0.7)
+      activejob (= 5.0.7)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.7)
+      actionview (= 5.0.7)
+      activesupport (= 5.0.7)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.7)
+      activesupport (= 5.0.7)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.7)
+      activesupport (= 5.0.7)
+      globalid (>= 0.3.6)
+    activemodel (5.0.7)
+      activesupport (= 5.0.7)
+    activerecord (5.0.7)
+      activemodel (= 5.0.7)
+      activesupport (= 5.0.7)
+      arel (~> 7.0)
+    activesupport (5.0.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (7.1.4)
+    bootstrap-sass (3.1.1.1)
+      sass (~> 3.2)
+    builder (3.2.3)
+    byebug (10.0.2)
+    capybara (2.2.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    capybara-screenshot (1.0.21)
+      capybara (>= 1.0, < 4)
+      launchy
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    cliver (0.3.2)
+    coderay (1.1.2)
+    coffee-rails (4.2.2)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    erubis (2.7.0)
+    execjs (2.7.0)
+    faker (1.8.7)
+      i18n (>= 0.7)
+    ffi (1.9.25)
+    font-awesome-sass (4.4.0)
+      sass (>= 3.2)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    haml (5.0.4)
+      temple (>= 0.8.0)
+      tilt
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    inch (0.6.4)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.8.7.5)
+    jquery-rails (4.3.3)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    jquery-ui-rails (5.0.5)
+      railties (>= 3.2.16)
+    jquery-ui-themes (0.0.12)
+      httparty
+    json (1.8.6)
+    kaminari (0.17.0)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    libv8 (3.16.14.19)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    nio4r (2.3.1)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    poltergeist (1.9.0)
+      capybara (~> 2.1)
+      cliver (~> 0.3.1)
+      multi_json (~> 1.0)
+      websocket-driver (>= 0.2.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rack (2.0.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.7)
+      actioncable (= 5.0.7)
+      actionmailer (= 5.0.7)
+      actionpack (= 5.0.7)
+      actionview (= 5.0.7)
+      activejob (= 5.0.7)
+      activemodel (= 5.0.7)
+      activerecord (= 5.0.7)
+      activesupport (= 5.0.7)
+      bundler (>= 1.3.0)
+      railties (= 5.0.7)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.0.7)
+      actionpack (= 5.0.7)
+      activesupport (= 5.0.7)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    ref (2.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-rails (3.6.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubyzip (1.2.1)
+    sass (3.5.6)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    sass-rails (5.0.7)
+      railties (>= 4.0.0, < 6)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    selenium-webdriver (2.51.0)
+      childprocess (~> 0.5)
+      multi_json (~> 1.0)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sparkr (0.4.1)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    temple (0.8.0)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    therubyracer (0.12.3)
+      libv8 (~> 3.16.14.15)
+      ref
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tins (1.16.3)
+    turbolinks (5.1.1)
+      turbolinks-source (~> 5.1)
+    turbolinks-source (5.1.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket (1.2.8)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+    xpath (2.1.0)
+      nokogiri (~> 1.3)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bootstrap-sass (= 3.1.1.1)
+  bundler (~> 1.3)
+  byebug
+  capybara (~> 2.2.0)
+  capybara-screenshot (~> 1.0.11)
+  coderay (~> 1.1.0)
+  faker (~> 1.8.7)
+  font-awesome-sass (= 4.4.0)
+  haml (~> 5.0.4)
+  inch (~> 0.6.4)
+  jquery-rails (~> 4.3.3)
+  jquery-ui-rails (~> 5.0.5)
+  jquery-ui-themes (~> 0.0.11)
+  poltergeist (~> 1.9.0)
+  rails (~> 5.0.0)
+  rake (~> 10.1)
+  rdoc (~> 4.2.0)
+  rspec (~> 3.6.0)
+  rspec-rails (~> 3.6.0)
+  sass-rails (>= 3.2)
+  selenium-webdriver (~> 2.51.0)
+  shoulda-matchers (= 2.8.0)
+  simplecov (~> 0.7)
+  sqlite3 (~> 1.3)
+  therubyracer
+  turbolinks (~> 5.1.1)
+  wice_grid!
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.16.2