pwice_grid 5.0.0

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run RSpec with code coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+
+# Experimenting with documentation system we will keep both Yardoc and Rdoc for some time, plus Inch
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+desc 'Generate YARDOC documentation for the plugin'
+YARD::Rake::YardocTask.new(:yardoc) do |t|
+  OTHER_PATHS = %w()
+  t.files   = ['lib/**/*.rb', OTHER_PATHS]
+  t.options = %w(--main=README.md --file TODO.md,CHANGELOG.md,SAVED_QUERIES_HOWTO.md,MIT-LICENSE)
+  t.stats_options = ['--list-undoc']
+end
+
+gem 'rdoc'
+require 'rdoc/task'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'WiceGrid'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('SAVED_QUERIES_HOWTO.md')
+  rdoc.rdoc_files.include('CHANGELOG.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task default: [:spec, :yardoc]

data/SAVED_QUERIES_HOWTO.md

@@ -0,0 +1,113 @@
+## Saving Queries How-To
+
+WiceGrid allows to save the state of filters as a custom query and later restore it from the list of saved queries.
+
+### Step 1: Create the database table to store queries
+
+To get started create the database table to store queries. Run the following generator:
+```
+rails g wice_grid:add_migration_for_serialized_queries
+```
+This add a migration file with the definition of the table. Run the migrate task:
+```
+  bundle 'rake db:migrate'
+```
+### Step 2: Create the controller to handle AJAX queries.
+
+Creation and deletion of queries is implemented as AJAX calls, and a controller is needed to handle these calls. Create an empty controller
+with any name and add  method +save_wice_grid_queries+ to it:
+```
+  class QueriesController < ApplicationController
+    save_wice_grid_queries
+  end
+```
+This is it. The controller now has the required action methods.
+
+### Step 3: Add routes
+
+If the name of the query controller is QueriesController, add the following to `routes.rb`:
+```
+  Wice::define_routes(self, 'queries')
+```
+### Step 4: Add the saved query panel to the view.
+
+To show the list of saved queries and the form to create new queries in a view, add the following helper to the view:
+```
+  <%= saved_queries_panel(@grid_object) %>
+```
+Voila!
+
+Just like WiceGrid itself, the query panel contains no forms and is thus form-friendly.
+
+*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 `:name` 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
+itself to parameter `saved_query`:
+```
+  @products_grid = initialize_grid(Product,
+    name:        'prod_grid',
+    saved_query: SavedQuery.find_by_id_and_grid_name(12, 'prod_grid') )
+```
+
+## Adding Application Specific Logic to Saving/Restoring Queries
+
+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 `lib/wice_grid_serialized_query.rb` from the gem to `app/models/`, rename the file and the class to your liking.
+
+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: '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}
+      self.find(:all, conditions: conditions)
+    end
+  end
+```
+
+It is required that the model provides class method +list+ which accepts two parameters: the name of the WiceGrid instance and the controller
+object, and returns a list of queries. The controller object is needed to provide the application context. For instance, if it is needed to
+store queries for each user, we could add +user_id+ to the table and modify the code so it looks like the following:
+```
+  class SavedQuery < ActiveRecord::Base
+    serialize :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 # !
+
+    def self.list(name, controller)
+      conditions = {grid_name: name}
+      if controller.current_user # !
+        conditions[:user_id] = controller.current_user.id # provided that method current_user is defined in ApplicationController and returns the currrent user.
+      end
+      self.find(:all, conditions: conditions)
+    end
+  end
+```
+
+The following step is to make sure that a new query is saved with the correct +user_id+. To do so, change the helper
+`saved_queries_panel(@grid_object)` to the following:
+
+```
+   <%= 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
+`attributes=` method of the query object.
+
+Finally, let WiceGrid know which model to use for saving queries by changing constant  +QUERY_STORE_MODEL+
+in `lib/wice_grid_config.rb` to the name of the custom model (as a string), in the above example this would look like the following:
+```
+      QUERY_STORE_MODEL = 'SavedQuery'
+```

data/app/views/kaminari/wice_grid/_gap.html.erb

@@ -0,0 +1 @@
+<li class="disabled"><a href="#">...</a></li>

data/app/views/kaminari/wice_grid/_next_page.html.erb

@@ -0,0 +1 @@
+<li><%= link_to_unless current_page.last?, ::Wice::NlMessage['next_label'], url, rel: 'next', remote: remote %></li>

data/app/views/kaminari/wice_grid/_page.html.erb

@@ -0,0 +1 @@
+<li <%if page.current?%>class="active"<%end%>><%= link_to page, url, {remote: remote, rel: page.next? ? 'next' : page.prev? ? 'prev' : nil} %></li>

data/app/views/kaminari/wice_grid/_paginator.html.erb

@@ -0,0 +1,19 @@
+<%= paginator.render do %>
+  <div class="pagination">
+    <ul class="pagination">
+      <% unless current_page.first? %>
+        <%= prev_page_tag %>
+      <% end %>
+      <% each_page do |page| %>
+        <% if page.left_outer? || page.right_outer? || page.inside_window? %>
+          <%= page_tag page %>
+        <% elsif !page.was_truncated? %>
+          <%= gap_tag %>
+        <% end %>
+      <% end %>
+      <% unless current_page.last? %>
+        <%= next_page_tag %>
+      <% end %>
+    </ul>
+  </div>
+<% end %>

data/app/views/kaminari/wice_grid/_prev_page.html.erb

@@ -0,0 +1 @@
+<li><%= link_to_unless current_page.first?, ::Wice::NlMessage['previous_label'], url, rel: 'prev', remote: remote %></li>

data/config/locales/cz.yml

@@ -0,0 +1,40 @@
+cz:
+  wice_grid:
+    show_filter_tooltip: Zobrazit filtr
+    hide_filter_tooltip: Skrýt filtr
+    csv_export_tooltip: Exportovat do CSV
+    filter_tooltip: Filtr
+    reset_filter_tooltip: Zrušit filtr
+    boolean_filter_true_label: "áno"
+    boolean_filter_false_label: "ne"
+    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.
+    date_selector_tooltip_to: Dátum do
+    # The title of the checkox to turn on negation
+    negation_checkbox_title: Inverzní výběr
+    # link to switch to show all records
+    show_all_records_label: Zobrazit všechno
+    # tooltip for the link to switch to show all records
+    show_all_records_tooltip: Zobrazí všechny záznamy v databáze
+    # Warning message shown when the user wants to switch to all-records mode
+    all_queries_warning: Určitě chceš zobrazit všechny záznamy v databáze?
+    # link to paginated view
+    switch_back_to_paginated_mode_label: zpět na stránkové zobrazení
+    # tooltip for the link to paginated view
+    switch_back_to_paginated_mode_tooltip: Přepnout do stránkového zobrazení
+    # Title of the date string.
+    date_string_tooltip: Kliknutím zmažeš
+    saved_query_panel_title: Uložené filtry
+    save_query_button_label: Uložit aktuálni stav filtrů
+    saved_query_deletion_confirmation: Seš si jistej?
+    saved_query_deletion_link_title: Smazat uloženej filtr
+    saved_query_link_title: Použít uloženej filtr
+    validates_uniqueness_error: Filtr už existuje.
+    validates_presence_error: Prosím zadej název filtru.
+    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

data/config/locales/de.yml

@@ -0,0 +1,42 @@
+de:
+  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
+    expand: Ausklappen
+    collapse: Einklappen

data/config/locales/en.yml

@@ -0,0 +1,42 @@
+en:
+  wice_grid:
+    show_filter_tooltip: Show filter
+    hide_filter_tooltip: Hide filter
+    csv_export_tooltip: Export to CSV
+    filter_tooltip: Filter
+    reset_filter_tooltip: Reset
+    boolean_filter_true_label: "yes"
+    boolean_filter_false_label: "no"
+    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.
+    date_selector_tooltip_to: To
+    # The title of the checkox to turn on negation
+    negation_checkbox_title: Exclude
+    # link to switch to show all records
+    show_all_records_label: show all
+    # tooltip for the link to switch to show all records
+    show_all_records_tooltip: Show all records
+    # Warning message shown when the user wants to switch to all-records mode
+    all_queries_warning: Are you sure you want to display all records?
+    # link to paginated view
+    switch_back_to_paginated_mode_label: back to paginated view
+    # tooltip for the link to paginated view
+    switch_back_to_paginated_mode_tooltip: Switch back to the view with pages
+    # Title of the date string.
+    date_string_tooltip: Click to delete
+    saved_query_panel_title: Saved Queries
+    save_query_button_label: Save the state of filters
+    saved_query_deletion_confirmation: Are you sure?
+    saved_query_deletion_link_title: Delete query
+    saved_query_link_title: Load query
+    validates_uniqueness_error: A query with this name already exists
+    validates_presence_error: Please submit the name of the custom query
+    query_deleted_message: Saved query deleted.
+    query_saved_message: Query saved.
+    select_all: Select all
+    deselect_all: Remove selection
+    expand: Expand
+    collapse: Collapse

data/config/locales/es.yml

@@ -0,0 +1,42 @@
+es:
+  wice_grid:
+    show_filter_tooltip: Mostrar filtro
+    hide_filter_tooltip: Ocultar filtro
+    csv_export_tooltip: Exportar a CSV
+    filter_tooltip: Filtro
+    reset_filter_tooltip: Reset
+    boolean_filter_true_label: "Si"
+    boolean_filter_false_label: "No"
+    previous_label: «
+    next_label: »
+    # Title of the icon clicking on which will show the calendar to set the FROM date.
+    date_selector_tooltip_from: Desde
+    # Title of the icon clicking on which will show the calendar to set the TO date.
+    date_selector_tooltip_to: Hasta
+    # The title of the checkox to turn on negation
+    negation_checkbox_title: Excluir
+    # link to switch to show all records
+    show_all_records_label: mostrar todos
+    # tooltip for the link to switch to show all records
+    show_all_records_tooltip: Mostrar todos los registros
+    # Warning message shown when the user wants to switch to all-records mode
+    all_queries_warning: ¿Estás seguro que quieres mostrar todos los registros?
+    # link to paginated view
+    switch_back_to_paginated_mode_label: volver a la vista paginada
+    # tooltip for the link to paginated view
+    switch_back_to_paginated_mode_tooltip: Cambiar atrás a la vista con páginas
+    # Title of the date string.
+    date_string_tooltip: Click en borrar
+    saved_query_panel_title: Consultas salvadas
+    save_query_button_label: Salvar el estado de los filtros
+    saved_query_deletion_confirmation: ¿Estás seguro?
+    saved_query_deletion_link_title: Borrar consulta
+    saved_query_link_title: Cargar consulta
+    validates_uniqueness_error: Una consulta con este nombre ya existe
+    validates_presence_error: Por favor tramita el nombre la consulta modificada
+    query_deleted_message: Salvada la consulta borrado.
+    query_saved_message: Consulta salvada.
+    select_all: Selecciona todo
+    deselect_all: Borra la selección
+    expand: Expandir
+    collapse: Contraer

data/config/locales/fr.yml

@@ -0,0 +1,40 @@
+fr:
+  wice_grid:
+    show_filter_tooltip: Afficher le filtre
+    hide_filter_tooltip: Cacher le filtrer
+    csv_export_tooltip: Exporter en CSV
+    filter_tooltip: Filtrer
+    reset_filter_tooltip: Effacer
+    boolean_filter_true_label: oui
+    boolean_filter_false_label: non
+    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.
+    date_selector_tooltip_to: à
+    # The title of the checkox to turn on negation
+    negation_checkbox_title: Exclure
+    # link to switch to show all records
+    show_all_records_label: Voir tous
+    # tooltip for the link to switch to show all records
+    show_all_records_tooltip: Voir tous les enregistrements
+    # Warning message shown when the user wants to switch to all-records mode
+    all_queries_warning: Etes-vous certain de vouloir afficher tous les enregistrements?
+    # link to paginated view
+    switch_back_to_paginated_mode_label: Retour à la vue paginée
+    # tooltip for the link to paginated view
+    switch_back_to_paginated_mode_tooltip: Retour à la vue par pages
+    # Title of the date string.
+    date_string_tooltip: Cliquez pour effacer
+    saved_query_panel_title: Requêtes sauvées
+    save_query_button_label: Sauver l'état des filtres
+    saved_query_deletion_confirmation: Etes vous sûr?
+    saved_query_deletion_link_title: Effacer la requête
+    saved_query_link_title: Charger la requête
+    validates_uniqueness_error: Un requête existante porte déjà ce nom
+    validates_presence_error: Veuillez indiquer le nom de la requête que vous souhaitez sauver
+    query_deleted_message: La requête a été effacée.
+    query_saved_message: La requête a été sauvée.
+    select_all: Sélectionner tout
+    deselect_all: Désélectionner tout

data/config/locales/is.yml

@@ -0,0 +1,41 @@
+is:
+  wice_grid:
+    show_filter_tooltip: Sýna síumöguleika
+    hide_filter_tooltip: Fela síumoguleika
+    csv_export_tooltip: Flytja út CSV
+    filter_tooltip: Sía
+    reset_filter_tooltip: Hreinsa
+    boolean_filter_true_label: Já
+    boolean_filter_false_label: Nei
+    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.
+    date_selector_tooltip_to: Til
+    # The title of the checkox to turn on negation
+    negation_checkbox_title: Undanskilja
+    # link to switch to show all records
+    show_all_records_label: Sýna allt
+    # tooltip for the link to switch to show all records
+    show_all_records_tooltip: Sýna öll gögn
+    # Warning message shown when the user wants to switch to all-records mode
+    all_queries_warning: Ertu viss um að þú viljir láta sýna öll gögn?
+    # link to paginated view
+    switch_back_to_paginated_mode_label: Aftur til síðuhorfs
+    # tooltip for the link to paginated view
+    switch_back_to_paginated_mode_tooltip: Aftur til síðuhorfs
+    # Title of the date string.
+    date_string_tooltip: Smella á til að eyða
+    saved_query_panel_title: Vistaðar leitarskipanir
+    save_query_button_label: Vista síuval
+    saved_query_deletion_confirmation: Ertu viss?
+    saved_query_deletion_link_title:  Eyða leitarskipun
+    saved_query_link_title: Hlaða leitarskipun
+    validates_uniqueness_error: Leitarskipun með þessu nafni er þegar til
+    validates_presence_error: Vinsamlegast gefið heiti fyrir leitarskipun
+    query_deleted_message: Vistaðri leitarskipun hefur verið eytt
+    query_saved_message: leitaskipun hefur verið vistuð
+    # To do: translate
+    select_all: Select all
+    deselect_all: Remove selection