wice_grid 3.6.0.pre3 → 3.6.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5936c2e90c4c4cd00e4ad4a623940ec625deda5f
-  data.tar.gz: dc2a80945a98aa315dd4dda9c58a45d40b093539
+  metadata.gz: 51966eb69a24d7359b29c5444a4d3ee0ff2f9adc
+  data.tar.gz: 269e2b5b4feff23be4cb2bce0d91cbd5c286a71a
 SHA512:
-  metadata.gz: 43f3f8b93e70324e8b6b7ffd536cbff5eba87e0a406dca3828dab8335c7ca7f95737a5b4c01ccae229efc252a879a6d1c8bfb5e5242c493ec901a940675ca7be
-  data.tar.gz: fdfac052949ebe4af5e34031b3adb614a8349916b63154bace94acbb6ce8ec3593235ac9623c980f4038396eeef0a86cebf38d6059a48eea1a414471ee8044a5
+  metadata.gz: 574f2658fbba701f1e961485471021f298f52bdee520d0da5a84938a29aac5fbcd8748b9a1e5d450bf8b9863622e5bec1c5884bc7a8000850c758cb35ed894f3
+  data.tar.gz: 3942adfa077d76cf601f0af82b840e28f9d29a29180a93e04b55fcc1cbeee4c507ea21dc07fea766899b96f14231dc65b8c91e171d09c393a9fb435a3fb2222a

data/CHANGELOG.md

@@ -1,68 +1,126 @@
 # 3.6.0
 
+## New API For Joined Tables
 
-* There is no more :helper_style in column definitions and no more Wice::Defaults:HELPER_STYLE.
-  Instead there is a number of filter types:
+Before 3.6.0 `:model_class` was used in column definitions for columns from joined tables.
 
-    * rails_datetime_helper
-    * rails_date_helper
-    * jquery_datepicker
-    * bootstrap_datepicker
+In 3.6.0 the API has changed to use associations.
+If, say, a `Task` `belongs_to` a `Priority`, a column definition should specify this association using `:assoc`:
 
-  and new configuration values Wice::Defaults:DEFAULT_FILTER_FOR_DATE and Wice::Defaults:DEFAULT_FILTER_FOR_DATETIME
+```ruby
+g.column name:  'Priority', attribute: 'name',  assoc: :priority do |task|
+  task.priority.name if task.priority
+end
+```
 
+If, say, a `Task` `belongs_to` a `Project`, and a `Project` belongs to a `Customer`,
+`assoc:` should be a list of these associations:
 
-* No more
+```ruby
+g.column name:  'Customer', attribute: 'name', assoc: [:project, :customer]  do |task|
+  task.project.customer.name if task.project && task.project.customer
+end
+```
 
-        column model: 'ModelClass' do
 
-  Instead:
+## Blockless Columns For Joined Tables
 
-        column assoc: :association_name do
+Blockless columns used to only work for the main model.
+Now they can be used for joined tables, too.
 
-  or
+Instead of
 
-        column assoc: [:association_x, association_in_association_x_model, ...]  do
+```ruby
+g.column name:  'Priority', attribute: 'name',  assoc: :priority do |task|
+  task.priority.name if task.priority
+end
+```
 
-  If associations have been mentioned in :assoc, it is not necessary to list them in :include!
+you can write
 
-  Blockless column definitions now work for columns from joined tables!
+```ruby
+g.column name:  'Priority', attribute: 'name',  assoc: :priority
+```
 
-* No jpg/png icons, the plugin uses Font Awesome
-* CSS is not copied to the app. It is included by @import "wice_grid" in your application.scss.
+Instead of
 
-* Blockless columns now work for joined tables, too:
+```ruby
+g.column name:  'Customer', attribute: 'name', assoc: [:project, :customer]  do |task|
+  task.project.customer.name if task.project && task.project.customer
+end
+```
 
-  Instead of
+you can write
 
-        g.column name:  'Priority', attribute: 'name',  assoc: :priority do |task|
-          task.priority.name if task.priority
-        end
+```ruby
+  g.column name:  'Customer', attribute: 'name', assoc: [:project, :customer]
+```
 
-  you can write
 
-        g.column name:  'Priority', attribute: 'name',  assoc: :priority
+## New Way To Choose Datepickers
 
-  Instead of
+Before 3.6.0 to choose a datepicker type we used `:helper_style` in column definitions and `Wice::Defaults:HELPER_STYLE` in the configuration_file.
+
+In 3.6.0 `:helper_style` and `Wice::Defaults:HELPER_STYLE` are gone.
+
+Now each datepicker is simply a separate filter type, and to pick a datepicker we can use `:filter_type`, just like other filter types are chosen.
+
+Filter types for dates and datetimes are
+
+* `:rails_datetime_helper`
+* `:rails_date_helper`
+* `:jquery_datepicker`
+* `:bootstrap_datepicker`
+
+Example:
+
+```ruby
+g.column name:  'Updated', attribute: 'updated_at', filter_type: :rails_datetime_helper do |task|
+  task.updated_at.to_s(:db)
+end
+```
+
+Default filter types for date and datetime columns are set by `Wice::Defaults:DEFAULT_FILTER_FOR_DATE` and `Wice::Defaults:DEFAULT_FILTER_FOR_DATETIME`.
+
+
+## Icons
+
+There are no more icons inside of the gem. Instead, [Font Awesome](https://github.com/FortAwesome/font-awesome-sass) is used.
+
+## CSS
+
+CSS is no longer copied to the applications asset directory. Instead the user is supposed to add
+
+```sass
+@import "wice_grid";
+@import "font-awesome-sprockets";
+@import "font-awesome";
+```
+
+to `application.scss`.
+
+`font-awesome-sass` is not a dependency of WiceGrid in case you decide to style WiceGrid icons differently,
+so you need to add it explicitly to your Gemfile:
+
+```ruby
+gem 'font-awesome-sass',  '~> 4.3'
+```
 
-        g.column name:  'Customer', attribute: 'name', assoc: [:project, :customer]  do |task|
-          task.project.customer.name if task.project && task.project.customer
-        end
 
-  you can write
+## CI_LIKE
 
-        g.column name:  'Customer', attribute: 'name', assoc: [:project, :customer]
+Setting a configuration value in Wice::Defaults::STRING_MATCHING_OPERATORS to CI_LIKE will result in the following SQL generated for string filters:
 
-*  CI_LIKE feature from @nathanvda for string filters:
+```sql
+UPPER(table.field) LIKE UPPER(?)"
+```
 
-   Setting a configuration value in Wice::Defaults::STRING_MATCHING_OPERATORS to CI_LIKE will result in
-   the following SQL:
 
-        UPPER(table.field) LIKE  UPPER(?)"
+## USE_DEFAULT_SCOPE
 
-*  New USE_DEFAULT_SCOPE configuration value from @nathanvda.
-   By default ActiveRecord calls are always executed inside Model.unscoped{}.
-   Setting USE_DEFAULT_SCOPE to true will use the default scope for all queries.
+New `USE_DEFAULT_SCOPE` configuration value from @nathanvda.
+By default ActiveRecord calls are always executed inside `Model.unscoped{}`.
+Setting `USE_DEFAULT_SCOPE` to `true` will use the default scope for all queries.
 
 
 # 3.5.0

data/README.md

@@ -93,12 +93,12 @@ WARNING: Since 3.2.pre2 WiceGrid is not compatible with `will_paginate` because
 
 Add the following to your Gemfile:
 
-```
-gem 'font-awesome-sass', '~> 4.3.0'
-gem "wice_grid", '3.6.0.pre2'
+```ruby
+gem "wice_grid", '3.6.0.pre4'
+gem 'font-awesome-sass',  '~> 4.3'
 ```
 
-and run the `bundle` command.
+and run the `bundle` command. `font-awesome-sass` is not a dependency of WiceGrid in case you decide to style WiceGrid icons differently.
 
 Run the generator:
 
@@ -109,7 +109,6 @@ rails g wice_grid:install
 This adds the following files:
 * config/initializers/wice_grid_config.rb
 * config/locales/wice_grid.yml
-* app/assets/stylesheets/wice_grid.scss
 
 
 Require WiceGrid javascript in your js index file:
@@ -144,21 +143,21 @@ Here is `application.js` if [Bootstrap Datepicker](https://github.com/Nerian/boo
 //= require_tree .
 ```
 
-Require WiceGrid CSS in your `application.scss`:
+Require WiceGrid and [Font Awesome](http://fortawesome.github.io/Font-Awesome/) CSS in your `application.scss`:
 
 ```
   @import "wice_grid";
+  @import "font-awesome-sprockets";
+  @import "font-awesome";
 ```
 
 This will provide very basic styles, not specifying exactly how the table should look like, but if
 the application uses Twitter Bootstrap, the markup generated by WiceGrid will have correct classes and
 will fit nicely.
 
-WiceGrid uses icons from [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
+WiceGrid uses icons from [Font Awesome](http://fortawesome.github.io/Font-Awesome/).
 
-Should you decide to write you own styles for WiceGrid, the suggested way is to copy wice_grid.scss
-from the plugin into `app/assets/stylesheets`, rename it to avoid loading name clashes, and replace
-`@import "wice_grid";` by a directive to load your own SASS file.
+Should you decide to write you own styles for WiceGrid, you can just remove these imports and write your own styles.
 
 
 ## Basics

data/lib/wice_grid.rb

@@ -23,10 +23,6 @@ require 'wice/columns/common_js_date_datetime_conditions_generator_mixin.rb'
 require 'wice/columns/common_rails_date_datetime_conditions_generator_mixin.rb'
 require 'kaminari.rb'
 
-# unless Kernel.const_defined?(:FontAwesome)
-#   gem 'font-awesome-sass'
-#   require 'font-awesome-sass.rb'
-# end
 
 ActionController::Base.send(:helper_method, :wice_grid_custom_filter_params)
 

data/vendor/assets/stylesheets/wice_grid.scss

@@ -1,6 +1,3 @@
-@import "font-awesome-sprockets";
-@import "font-awesome";
-
 .wg-detached-filter, .wice-grid{
 
   .text-filter-container {

data/wice_grid.gemspec

@@ -1,7 +1,7 @@
 # encoding: utf-8
 Gem::Specification.new do |s|
   s.name          = 'wice_grid'
-  s.version       = '3.6.0.pre3'
+  s.version       = '3.6.0.pre4'
   s.authors       = ['Yuri Leikind']
   s.email         = ['yuri.leikind@gmail.com']
   s.homepage      = 'https://github.com/leikind/wice_grid'
@@ -20,10 +20,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'kaminari',          ['~> 0.16']
   s.add_dependency 'coffee-rails',      ['> 3.2']
 
-  # s.add_dependency 'font-awesome-sass', ['~> 4.3']
-  # s.add_runtime_dependency 'sass', '~> 3.2'
-  # s.add_development_dependency 'sass-rails'
-
   s.add_development_dependency('rake',  '~> 10.1')
   s.add_development_dependency('rspec', '~> 3.2.0')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wice_grid
 version: !ruby/object:Gem::Version
-  version: 3.6.0.pre3
+  version: 3.6.0.pre4
 platform: ruby
 authors:
 - Yuri Leikind