wice_grid 3.0.4 → 3.2.0.pre1

data/RELEASE_NOTES_3.2.pre1.rdoc

@@ -0,0 +1,82 @@
+1. Support for Prototype has been dropped. No hard feelings, Prototype, no matter what
+   others say, I liked you :)
+
+2. All assets are in the asset pipeline. All javascript is now coffeescript. No more Rails
+   2 legacy in the form of obtrusive javascript in the HTML page. The styles file is copied
+   to the application asset directory by a generate task so that is it easy to modify it to
+   the application needs. The javascript and images are loaded from the plugin. Read the
+   Installation section in README for details. Thanks to the asset pipeline taking care of
+   loading assets for us, methods +include_wice_grid_assets+, +names_of_wice_grid_stylesheets+,
+   and +names_of_wice_grid_javascripts+ have been removed
+
+3. ERB mode has been removed. It had never been used by anyone and is bad style anyway. In
+   case you have no idea what it was, here's what it was:
+
+      <% grid(@countries_grid, :erb_mode => true) do |g| %>
+        <% g.column :column_name => 'Name', :attribute_name => 'name' do |country| %>
+          <b>Name: <%= link_to(country.name, country_path(country)) %></b>
+        <% end %>
+      <% end -%>
+
+4. WiceGrid is compatible with Twitter Bootstrap out of the box.
+
+5. Paths to various images used by WiceGrid have been removed from the configuration file
+   and are now defined only in the css file. Developers are encouraged to modify
+   <tt>wice_grid.css.scss</tt> to use other images and to change the styles in general.
+
+6. The markup and css classes that WiceGrid generates have changed, and CSS for older versions
+   of WiceGrid might not work. Inspect the source code.
+
+7. Parameter names in the grid helper have been renamed:
+   * <tt>:table_html_attrs</tt> becomes <tt>:html</tt>
+   * <tt>:header_tr_html_attrs</tt> becomes <tt>:header_tr_html</tt>
+
+8. Parameter names in column definitions have been renamed:
+   * <tt>:column_name</tt> becomes <tt>:name</tt>
+   * <tt>:attribute_name</tt> becomes <tt>:attribute</tt>
+   * <tt>:model_class</tt> becomes <tt>:model</tt>
+   * <tt>:allow_ordering</tt>  becomes <tt>:ordering</tt>
+   * <tt>:td_html_attrs</tt>  becomes <tt>:html</tt>
+   * Negation in the parameter name does not contribute to the simplicity of an API, so
+     <tt>:no_filter</tt> in  becomes <tt>:filter</tt>. Consequently, <tt>:no_filter => true</tt>
+     becomes <tt>:filter => false</tt>
+   * <tt>:negation_in_filter</tt> becomes <tt>:negation</tt>
+
+
+9. New configuration parameter <tt>DEFAULT_TABLE_CLASSES</tt> contains CSS classes added to
+   all WiceGrid tables by default.
+
+10. In previous versions of WiceGrid in the jQuery mode DateTime filters used to automatically
+    fall back on Rails DateTime helpers due to absence of time controls in jQuery DatePicker.
+    In version 3.2 this behavior has been changed to always use jQuery DatePicker, even with
+    DateTime filters. Of course it is possible to force  Rails DateTime with
+    <tt>:helper_style => :standard</tt> in the column definition.
+
+11. The second variable injected into to <tt>before_row</tt> and <tt>after_row</tt> block,
+    and the first parameter injected into the <tt>last_row</tt> is the number of columns in
+    the current grid.
+
+12. <tt>:csv_field_separator</tt> is a new parameter for +initialize_grid+ defining the field
+    separator in CSV files. The default separator is defined by +CSV_FIELD_SEPARATOR+ in the
+    config file.
+
+13. New parameter +:confirm+ for +saved_queries_panel+ which turns on or off the JS confirm
+    dialogs when deleting saved queries.
+
+14. Instead of the old rake task creating a table for serialized queries a generator has been
+    added which adds a migration file to +db/migrations+.
+
+15. Instead of using helpers +submit_grid_javascript+ and +reset_grid_javascript+ to create
+    external Submit and Reset buttons all you have to do is add a button or any other
+    clickable HTML element with class +wg-external-submit-button+ or +wg-external-reset-button+,
+    and attribute +data-grid-name+ whose value is the name of the grid:
+
+      <button class="wg-external-submit-button" data-grid-name="grid">Submit</button>
+      <button class="wg-external-reset-button" data-grid-name="grid">Reset</button>
+
+
+    The same goes for the external CSV export button, only the CSS class is
+    +wg-external-csv-export-button+:
+
+      <button class="wg-external-csv-export-button" data-grid-name="grid">Export To CSV</button>
+

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -19,11 +19,13 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('SAVED_QUERIES_HOWTO.rdoc')
+  rdoc.rdoc_files.include('RELEASE_NOTES_3.2.pre1.rdoc')
   rdoc.rdoc_files.include('CHANGELOG')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
 begin
+  require 'git'
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "wice_grid"
@@ -32,7 +34,7 @@ begin
     gem.email = "yuri.leikind@gmail.com"
     gem.homepage = "http://github.com/lekind/wice_grid"
     gem.authors = ["Yuri Leikind"]
-    gem.add_development_dependency "will_paginate", ">= 3.0.pre2"
+    gem.add_development_dependency "will_paginate", ">= 3.0.3"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/SAVED_QUERIES_HOWTO.rdoc

@@ -4,29 +4,13 @@ WiceGrid allows to save the state of filters as a custom query and later restore
 
 === Step 1: Create the database table to store queries
 
-To get started really fast create the database table to store queries with the following command:
+To get started create the database table to store queries. Run the following generator:
 
-  rake wice_grid:create_queries_table
+  rails g wice_grid:add_migration_for_serialized_queries
 
-This will create the table, but it is preferred to manually create and run a migration in <tt>db/migrate</tt>:
+This add a migration file with the definition of the table. Run the migrate task:
 
-  class CreateWiceGridSerializedQueriesTable < ActiveRecord::Migration
-    def self.up
-      create_table :wice_grid_serialized_queries do |t|
-        t.column :name,      :string
-        t.column :grid_name, :string
-        t.column :query,     :text
-
-        t.timestamps
-      end
-      add_index :wice_grid_serialized_queries, :grid_name
-      add_index :wice_grid_serialized_queries, [:grid_name, :id]
-    end
-
-    def self.down
-      drop_table :wice_grid_serialized_queries
-    end
-  end
+  bundle 'rake db:migrate'
 
 === Step 2: Create the controller to handle AJAX queries.
 
@@ -58,11 +42,11 @@ Just like WiceGrid itself, the query panel contains no forms and is thus form-fr
 *Important*: Saved queries of all grids in the application are stored in one table and differentiated by the name of the grid, thus, for all forms
 with saved queries it is important to define different names! (use parameter <tt>:name</tt> in +initialize_grid+)
 
-It is also possible to initialize a grid with an initial saved query providing the id of the query record or the ActiveRecord 
+It is also possible to initialize a grid with an initial saved query providing the id of the query record or the ActiveRecord
 itself to parameter <tt>saved_query</tt>:
 
-  @products_grid = initialize_grid(Product, 
-    :name => 'prod_grid', 
+  @products_grid = initialize_grid(Product,
+    :name => 'prod_grid',
     :saved_query =>  SavedQuery.find_by_id_and_grid_name(12, 'prod_grid') )
 
 
@@ -70,15 +54,17 @@ itself to parameter <tt>saved_query</tt>:
 
 WiceGrid allows to add application specific logic to saving and restoring queries by substituting the default ActiveRecord model provided by WiceGrid with a custom model.
 
-Copy <tt>vendor/plugins/wice_grid/lib/wice_grid_serialized_query.rb</tt> to <tt>app/models/</tt>, rename the file and the class to your liking.
+Copy <tt>lib/wice_grid_serialized_query.rb</tt> from the gem to <tt>app/models/</tt>, rename the file and the class to your liking.
 
-Next, modify the model to suit your needs. Right after copying  and renaming the model to SavedQuery it looks like this:
+After renaming the model to SavedQuery it looks like this:
 
   class SavedQuery < ActiveRecord::Base  #:nodoc:
     serialize :query
 
-    validates_uniqueness_of :name, :scope => :grid_name, :on => :create, :message => ::Wice::Defaults::VALIDATES_UNIQUENESS_ERROR
-    validates_presence_of :name, :message => ::Wice::Defaults::VALIDATES_PRESENCE_ERROR
+    validates_uniqueness_of :name, :scope => :grid_name, :on => :create,
+      :message => 'A query with this name already exists'
+
+    validates_presence_of :name, :message => 'Please submit the name of the custom query'
 
     def self.list(name, controller)
       conditions = {:grid_name => name}
@@ -93,9 +79,10 @@ store queries for each user, we could add +user_id+ to the table and modify the
   class SavedQuery < ActiveRecord::Base
     serialize :query
 
-    # the scope is changed to include user_id
-    validates_uniqueness_of :name, :scope => [:grid_name, :user_id], :on => :create, :message => 'A query with this name already exists'
-    validates_presence_of :name, :message => 'Please submit the name of the query'
+    validates_uniqueness_of :name, :scope => :grid_name, :on => :create,
+      :message => 'A query with this name already exists'
+
+    validates_presence_of :name, :message => 'Please submit the name of the custom query'
 
     belongs_to :identity # !
 
@@ -114,7 +101,7 @@ The following step is to make sure that a new query is saved with the correct +u
 
    <%= saved_queries_panel(@identities_grid, :extra_parameters => {:user_id => @current_user.id}) %>
 
-For every key in has :extra_parameters there must exist a field in the model - this hash will be used as a parameter to 
+For every key in has :extra_parameters there must exist a field in the model - this hash will be used as a parameter to
 <tt>attributes=</tt> method of the query object.
 
 Finally, let WiceGrid know which model to use for saving queries by changing constant  +QUERY_STORE_MODEL+

data/VERSION

@@ -1 +1 @@
-3.0.4
+3.2.0.pre1

data/lib/generators/wice_grid/add_migration_for_serialized_queries_generator.rb

@@ -0,0 +1,22 @@
+module WiceGrid #:nodoc:
+  module Generators #:nodoc:
+
+    class AddMigrationForSerializedQueriesGenerator < Rails::Generators::Base
+
+      include Rails::Generators::Migration
+
+      desc 'Add a migration which creates a table for serialized queries'
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      def create_model_file
+        migration_template "create_wice_grid_serialized_queries.rb", "db/migrate/create_wice_grid_serialized_queries.rb"
+      end
+    end
+
+  end
+end

data/lib/generators/wice_grid/install_generator.rb

@@ -0,0 +1,20 @@
+module WiceGrid #:nodoc:
+  module Generators #:nodoc:
+    class InstallGenerator < Rails::Generators::Base #:nodoc:
+
+      desc 'Copy WiceGrid wice_grid_config.rb to config/initializers, ' +
+        'wice_grid.yml to config/locales/, and wice_grid.css.scss to assets/stylesheets'
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_stuff #:nodoc:
+        template 'wice_grid_config.rb', 'config/initializers/wice_grid_config.rb'
+
+        copy_file 'wice_grid.yml',  'config/locales/wice_grid.yml'
+
+        copy_file 'wice_grid.css.scss',  'app/assets/stylesheets/wice_grid.css.scss'
+
+      end
+    end
+  end
+end

data/lib/generators/wice_grid/templates/create_wice_grid_serialized_queries.rb

@@ -0,0 +1,13 @@
+class CreateWiceGridSerializedQueries < ::ActiveRecord::Migration
+  def change
+    create_table :wice_grid_serialized_queries do |t|
+      t.column :name,      :string
+      t.column :grid_name, :string
+      t.column :query,     :text
+
+      t.timestamps
+    end
+    add_index :wice_grid_serialized_queries, :grid_name
+    add_index :wice_grid_serialized_queries, [:grid_name, :id]
+  end
+end

data/lib/generators/wice_grid/templates/wice_grid.css.scss

@@ -0,0 +1,139 @@
+@mixin icon-dimensions {
+  width: 16px;
+  height: 16px;
+}
+
+.wg-detached-filter{
+  a.date-label {text-decoration: none;}
+  a.date-label:hover {text-decoration: line-through;}
+}
+
+.wice-grid{
+
+  .clickable{
+    cursor: pointer;
+    margin-bottom: 2px;
+    margin-right: 2px;
+  }
+
+
+  a.date-label {text-decoration: none;}
+  a.date-label:hover {text-decoration: line-through;}
+
+  .ui-datepicker-trigger, .wg-detached-filter .ui-datepicker-trigger{
+    cursor: pointer;
+  }
+
+  .desc,  .asc{
+    padding-right: 18px;
+    text-decoration:none;
+  }
+
+  .desc {
+    background: transparent url(/assets/icons/grid/arrow_down.gif) right no-repeat
+  }
+  .asc  {
+    background: transparent url(/assets/icons/grid/arrow_up.gif)   right no-repeat
+  }
+
+  .submit.clickable{
+    background: transparent url(/assets/icons/grid/table_refresh.png) no-repeat;
+    @include icon-dimensions;
+  }
+
+  .reset.clickable{
+    background: transparent url(/assets/icons/grid/table.png) no-repeat;
+    @include icon-dimensions;
+  }
+
+
+  .wg-show-filter.clickable,
+  .wg-hide-filter.clickable{
+    background: transparent url(/assets/icons/grid/page_white_find.png) no-repeat;
+    @include icon-dimensions;
+  }
+
+
+  .export-to-csv-button.clickable{
+    background: transparent url(/assets/icons/grid/page_white_excel.png) no-repeat;
+    @include icon-dimensions;
+  }
+
+  .clickable.select-all{
+    background: transparent url(/assets/icons/grid/tick_all.png) no-repeat;
+    @include icon-dimensions;
+    float:left;
+  }
+
+  .clickable.deselect-all{
+    background: transparent url(/assets/icons/grid/untick_all.png) no-repeat;
+    @include icon-dimensions;
+    float:left;
+  }
+
+  .custom-dropdown-container {
+    position: relative;
+    padding-right: 18px;
+
+
+    .collapse-multi-select-icon, .expand-multi-select-icon{
+      width: 12px;
+      height: 12px;
+      position:absolute;
+      top:0;
+      right:0;
+    }
+
+    .collapse-multi-select-icon{
+      background: transparent url(/assets/icons/grid/collapse.gif) no-repeat;
+    }
+
+    .expand-multi-select-icon{
+      background: transparent url(/assets/icons/grid/expand.gif) no-repeat;
+    }
+
+  }
+
+  .text-filter-container {
+    position: relative; padding-right: 13px;
+    .negation-checkbox {
+      position:absolute;
+      top:0;
+      right:0;
+    }
+  }
+
+
+  /* in case of twitter bootstrap :) */
+  thead th select{
+    width: auto;
+  }
+
+  .pagination{
+    margin: 0px;
+    float: left;
+  }
+
+
+  tr.wg-filter-row  input[type=text] {
+    width: 100px;
+  }
+
+  .pagination_status {
+    font-weight: bold;
+    float: right;
+  }
+
+}
+
+.wice-grid-query-panel{
+  li {list-style-type: none; }
+
+  ul {margin-left: 0 }
+
+  a.wice-grid-delete-query .delete-icon{
+    background: transparent url(/assets/icons/grid/delete.png) no-repeat;
+    float: left;
+    @include icon-dimensions;
+  }
+}

data/lib/generators/wice_grid/templates/wice_grid.yml

@@ -12,8 +12,8 @@ en:
     reset_filter_tooltip: Reset
     boolean_filter_true_label: "yes"
     boolean_filter_false_label: "no"
-    previous_label: « Previous
-    next_label: Next »
+    previous_label: «
+    next_label: »
     # Title of the icon clicking on which will show the calendar to set the FROM date.
     date_selector_tooltip_from: From
     # Title of the icon clicking on which will show the calendar to set the TO date.
@@ -43,6 +43,8 @@ en:
     query_saved_message: Query saved.
     select_all: Select all
     deselect_all: Remove selection
+    expand: Expand
+    collapse: Collapse
 
 
 is:
@@ -59,8 +61,8 @@ is:
     reset_filter_tooltip: Hreinsa
     boolean_filter_true_label: Já
     boolean_filter_false_label: Nei
-    previous_label: « Fyrri síða
-    next_label: Næsta síða »
+    previous_label: «
+    next_label: »
     # Title of the icon clicking on which will show the calendar to set the FROM date.
     date_selector_tooltip_from: Frá
     # Title of the icon clicking on which will show the calendar to set the TO date.
@@ -106,8 +108,8 @@ nl:
     reset_filter_tooltip: Terugstellen
     boolean_filter_true_label: ja
     boolean_filter_false_label: neen
-    previous_label: « Vorige
-    next_label: Volgende »
+    previous_label: «
+    next_label: »
     # Title of the icon clicking on which will show the calendar to set the FROM date.
     date_selector_tooltip_from: Vanaf
     # Title of the icon clicking on which will show the calendar to set the TO date.
@@ -152,8 +154,8 @@ fr:
     reset_filter_tooltip: Effacer
     boolean_filter_true_label: oui
     boolean_filter_false_label: non
-    previous_label: « Page précédente
-    next_label: Page suivante »
+    previous_label: «
+    next_label: »
     # Title of the icon clicking on which will show the calendar to set the FROM date.
     date_selector_tooltip_from: De
     # Title of the icon clicking on which will show the calendar to set the TO date.
@@ -198,8 +200,8 @@ ru:
     reset_filter_tooltip: Сброс
     boolean_filter_true_label: да
     boolean_filter_false_label: нет
-    previous_label: « Предыдущая
-    next_label: Следующая »
+    previous_label: «
+    next_label: »
     # Title of the icon clicking on which will show the calendar to set the FROM date.
     date_selector_tooltip_from: С
     # Title of the icon clicking on which will show the calendar to set the TO date.
@@ -245,8 +247,8 @@ pt:
     reset_filter_tooltip: Reinicializar
     boolean_filter_true_label: sim
     boolean_filter_false_label: não
-    previous_label: « Página precedente
-    next_label: Página seguinte »
+    previous_label: «
+    next_label: »
     # Title of the icon clicking on which will show the calendar to set the FROM date.
     date_selector_tooltip_from: De
     # Title of the icon clicking on which will show the calendar to set the TO date.
@@ -291,8 +293,8 @@ pt-BR:
     reset_filter_tooltip: Reinicializar
     boolean_filter_true_label: sim
     boolean_filter_false_label: não
-    previous_label: « Anterior
-    next_label: Próximo »
+    previous_label: «
+    next_label: »
     date_selector_tooltip_from: De
     date_selector_tooltip_to: a
     negation_checkbox_title: Excluir
@@ -329,8 +331,8 @@ sk:
     reset_filter_tooltip: Zrušiť filtre
     boolean_filter_true_label: "áno"
     boolean_filter_false_label: "nie"
-    previous_label: « Predchádzajúci
-    next_label: Následujúci »
+    previous_label: «
+    next_label: »
     # Title of the icon clicking on which will show the calendar to set the FROM date.
     date_selector_tooltip_from: Dátum od
     # Title of the icon clicking on which will show the calendar to set the TO date.
@@ -375,8 +377,8 @@ cz:
     reset_filter_tooltip: Zrušit filtr
     boolean_filter_true_label: "áno"
     boolean_filter_false_label: "ne"
-    previous_label: « Předešlý
-    next_label: Následující »
+    previous_label: «
+    next_label: »
     # Title of the icon clicking on which will show the calendar to set the FROM date.
     date_selector_tooltip_from: Dátum od
     # Title of the icon clicking on which will show the calendar to set the TO date.
@@ -405,4 +407,96 @@ cz:
     query_deleted_message: Uložený filtr byl smazán.
     query_saved_message: Filtr byl uložen.
     select_all: Vyber všechno
-    deselect_all: Zrušit výběr
+    deselect_all: Zrušit výběr
+
+de:
+  date:
+    order:
+      - :year
+      - :month
+      - :day
+  wice_grid:
+    show_filter_tooltip: Filter einblenden
+    hide_filter_tooltip: Filter ausblenden
+    csv_export_tooltip: CSV Export
+    filter_tooltip: Filter
+    reset_filter_tooltip: Reset
+    boolean_filter_true_label: "Ja"
+    boolean_filter_false_label: "Nein"
+    previous_label: «
+    next_label: »
+    # Title of the icon clicking on which will show the calendar to set the FROM date.
+    date_selector_tooltip_from: Von
+    # Title of the icon clicking on which will show the calendar to set the TO date.
+    date_selector_tooltip_to: Bis
+    # The title of the checkox to turn on negation
+    negation_checkbox_title: Ausschließen
+    # link to switch to show all records
+    show_all_records_label: Alle anzeigen
+    # tooltip for the link to switch to show all records
+    show_all_records_tooltip: Alle anzeigen
+    # Warning message shown when the user wants to switch to all-records mode
+    all_queries_warning: Wollen Sie wirkliche alle Einträge anzeigen?
+    # link to paginated view
+    switch_back_to_paginated_mode_label: Zurück zur seitenbasierten Ansicht
+    # tooltip for the link to paginated view
+    switch_back_to_paginated_mode_tooltip: Zurück zur seitenbasierten Ansicht
+    # Title of the date string.
+    date_string_tooltip: Löschen
+    saved_query_panel_title: Gespeicherte Abfragen
+    save_query_button_label: Filter speichern
+    saved_query_deletion_confirmation: Sind Sie sicher?
+    saved_query_deletion_link_title: Abfrage löschen
+    saved_query_link_title: Abfrage laden
+    validates_uniqueness_error: Eine Abfrage mit dieser Bezeichnung existiert bereits!
+    validates_presence_error: Bitte vergeben Sie einen Namen!
+    query_deleted_message: Abfrage gelöscht.
+    query_saved_message: Abfrage gespeichert.
+    select_all: Alle auswählen
+    deselect_all: Auswahl aufheben
+
+zh:
+  date:
+    order:
+      - :year
+      - :month
+      - :day
+  wice_grid:
+    show_filter_tooltip: 显示过滤
+    hide_filter_tooltip: 隐藏过滤
+    csv_export_tooltip: 输出CSV档
+    filter_tooltip: 过滤
+    reset_filter_tooltip: 清除过滤
+    boolean_filter_true_label: "是"
+    boolean_filter_false_label: "否"
+    previous_label: «
+    next_label: »
+    # Title of the icon clicking on which will show the calendar to set the FROM date.
+    date_selector_tooltip_from: 从
+    # Title of the icon clicking on which will show the calendar to set the TO date.
+    date_selector_tooltip_to: 至
+    # The title of the checkox to turn on negation
+    negation_checkbox_title: 排除
+    # link to switch to show all records
+    show_all_records_label: 显示全部
+    # tooltip for the link to switch to show all records
+    show_all_records_tooltip: 显示全部记录
+    # Warning message shown when the user wants to switch to all-records mode
+    all_queries_warning: 确定要显示全部记录？
+    # link to paginated view
+    switch_back_to_paginated_mode_label: 回到分页显示
+    # tooltip for the link to paginated view
+    switch_back_to_paginated_mode_tooltip: 切换到分页显示
+    # Title of the date string.
+    date_string_tooltip: 按下以清除
+    saved_query_panel_title: 查询存储
+    save_query_button_label: 储存查询状态
+    saved_query_deletion_confirmation: 确定删除？
+    saved_query_deletion_link_title: 删除查询
+    saved_query_link_title: 读取查询
+    validates_uniqueness_error: 已存在相同名称的查询
+    validates_presence_error: 请为此查询命名
+    query_deleted_message: 查询已删除
+    query_saved_message: 查询已储存
+    select_all: 全选
+    deselect_all: 全清