wice_grid 3.5.0 → 3.6.0.pre1

data/Rakefile

@@ -1,15 +1,59 @@
-require "bundler/gem_tasks"
-require 'rdoc/task'
+# encoding: utf-8
+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)
+
+require 'rubocop/rake_task'
+
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end
+
+desc 'Run RSpec with code coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
 
-task default: :rdoc
+# Experimenting with documentation system we will keep both Yardoc and Rdoc for some time, plus Inch
 
-desc 'Generate documentation for the wice_grid plugin.'
+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.rdoc')
-  rdoc.rdoc_files.include('SAVED_QUERIES_HOWTO.rdoc')
-  rdoc.rdoc_files.include('CHANGELOG')
+  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: [:rubocop, :spec, :yardoc]

data/{SAVED_QUERIES_HOWTO.rdoc → SAVED_QUERIES_HOWTO.md}

@@ -1,63 +1,63 @@
-== Saving Queries How-To
+## 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
+### 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
-
+```
+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.
+```
+### 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 <tt>routes.rb</tt>:
+### 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.
+```
+### 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 <tt>:name</tt> in +initialize_grid+)
+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 <tt>saved_query</tt>:
-
+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
+## 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 <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.
+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
 
@@ -71,11 +71,12 @@ After renaming the model to SavedQuery it looks like this:
       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
 
@@ -94,17 +95,19 @@ store queries for each user, we could add +user_id+ to the table and modify the
       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
-<tt>saved_queries_panel(@grid_object)</tt> to the following:
-
+`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
-<tt>attributes=</tt> method of the query object.
+`attributes=` method of the query object.
 
 Finally, let WiceGrid know which model to use for saving queries by changing constant  +QUERY_STORE_MODEL+
-in <tt>lib/wice_grid_config.rb</tt> to the name of the custom model (as a string), in the above example this would look like the following:
-
+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/TODO.md

@@ -0,0 +1,16 @@
+* [done] Replace all icons by Font Awesome, remove the icons
+* [done] Joined tables: Instead of
+    model: 'ModelClassName'
+  use
+    assoc: :comments
+* [done] Use ActiveRelation merge instead of manually merging hashes and arrays
+* [done] Switching between datepickers should be done via :filter_type, not via :helper_style.
+  Get rid of :helper_style and Wice::Defaults::HELPER_STYLE
+* [done] Fix datepickers when used with Datetime columns
+
+* Implement paging in the app, get rid of Kaminari
+* better tests (https://github.com/leikind/wice_grid_testbed)
+* review css class names in the generated markup
+* More unified and flexible approach to datepickers
+* try to guess :table_alias
+* throw away saved queries?

data/lib/generators/wice_grid/add_migration_for_serialized_queries_generator.rb

@@ -1,22 +1,20 @@
+# encoding: utf-8
 module WiceGrid #:nodoc:
   module Generators #:nodoc:
-
     class AddMigrationForSerializedQueriesGenerator < Rails::Generators::Base  #:nodoc:
-
       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")
+      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"
+        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

@@ -1,8 +1,8 @@
+# encoding: utf-8
 module WiceGrid #:nodoc:
   module Generators #:nodoc:
     class InstallGenerator < Rails::Generators::Base #:nodoc:
-
-      desc 'Copy WiceGrid wice_grid_config.rb to config/initializers, ' +
+      desc 'Copy WiceGrid wice_grid_config.rb to config/initializers, ' \
         'wice_grid.yml to config/locales/, and wice_grid.scss to assets/stylesheets'
 
       source_root File.expand_path('../templates', __FILE__)
@@ -11,9 +11,6 @@ module WiceGrid #: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.scss',  'app/assets/stylesheets/wice_grid.scss'
-
       end
     end
   end

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

@@ -1,3 +1,4 @@
+# encoding: utf-8
 class CreateWiceGridSerializedQueries < ::ActiveRecord::Migration #:nodoc:
   def change #:nodoc:
     create_table :wice_grid_serialized_queries do |t|

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

@@ -1,3 +1,4 @@
+# encoding: utf-8
 if defined?(Wice::Defaults)
 
   # Default number of rows to show per page.
@@ -33,7 +34,6 @@ if defined?(Wice::Defaults)
   # Default CSV field separator
   Wice::Defaults::CSV_FIELD_SEPARATOR = ','
 
-
   # The strategy when to show the filter.
   # * <tt>:when_filtered</tt> - when the table is the result of filtering
   # * <tt>:always</tt>        - show the filter always
@@ -43,29 +43,28 @@ if defined?(Wice::Defaults)
   # A boolean value specifying if a change in a filter triggers reloading of the grid.
   Wice::Defaults::AUTO_RELOAD = false
 
-
   # SQL operator used for matching strings in string filters.
   Wice::Defaults::STRING_MATCHING_OPERATOR = 'LIKE'
   # STRING_MATCHING_OPERATOR = 'ILIKE' # Use this for Postgresql case-insensitive matching.
 
-
   # Defining one string matching operator globally for the whole application turns is not enough
   # when you connect to two databases one of which is MySQL and the other is Postgresql.
-  # If the key for an adapter is missing it will fall back to Wice::Defaults::STRING_MATCHING_OPERATOR
+  # If the key for an adapter is missing it will fall back to Wice::Defaults::STRING_MATCHING_OPERATOR.
+  #
+  # 'CI_LIKE' is a special value. Setting a value in STRING_MATCHING_OPERATORS to CI_LIKE will result in the following SQL:
+  #
+  #    UPPER(table.field) LIKE  UPPER(?)"
   Wice::Defaults::STRING_MATCHING_OPERATORS = {
     'ActiveRecord::ConnectionAdapters::MysqlAdapter'      => 'LIKE',
     'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter' => 'ILIKE'
   }
 
-
-
   # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
   #                              Advanced Filters                             #
 
   # Switch of the negation checkbox in all text filters
   Wice::Defaults::NEGATION_IN_STRING_FILTERS = false
 
-
   # Each WiceGrid filter column is defined in two classes, one used for rendering the filter, the other
   # for generating query conditions. All these columns are in lib/wice/columns/*.rb .
   # File lib/wice/columns/column_processor_index.rb lists all predefined processors.
@@ -88,7 +87,6 @@ if defined?(Wice::Defaults)
   # Wice::Columns::ViewColumn, the second should be a name of conditions generator class inherited from
   # Wice::Columns::ConditionsGeneratorColumn .
 
-
   # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
   #                              Showing All Records                          #
 
@@ -107,7 +105,6 @@ if defined?(Wice::Defaults)
   # set to nil to skip the check
   Wice::Defaults::SWITCH_BACK_TO_PAGINATION_FROM = nil
 
-
   # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
   #                               Saving Queries                              #
 
@@ -115,40 +112,40 @@ if defined?(Wice::Defaults)
   # QUERY_STORE_MODEL = 'WiceGridSerializedQuery'
   Wice::Defaults::QUERY_STORE_MODEL = 'WiceGridSerializedQuery'
 
-
   # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
-  #            Here go settings related to the calendar helpers               #
+  #            Here go settings related to the date/datetime filters          #
 
-  # The default style of the date and datetime helper
-  # * <tt>:calendar</tt> - JS calendar
-  # * <tt>:html5</tt> - HTML5 date input field
-  # * <tt>:standard</tt> - standard Rails date and datetime helpers
-  # * <tt>:bootstrap</tt> - Bootstrap datepicker helper
-  Wice::Defaults::HELPER_STYLE = :calendar
+  # Default column filters
+  # Possible values:
+  # * <tt>:jquery_datepicker</tt> - Jquery datepicker (works for datetime, too)
+  # * <tt>:bootstrap_datepicker</tt> - Bootstrap datepicker (works for datetime, too)
+  # * <tt>:rails_date_helper</tt> - standard Rails date helper
+  # * <tt>:rails_datetime_helper</tt> - standard Rails datetime helper
+
+  Wice::Defaults::DEFAULT_FILTER_FOR_DATE     = :jquery_datepicker
+  Wice::Defaults::DEFAULT_FILTER_FOR_DATETIME = :jquery_datepicker
 
   # Format of the datetime displayed.
   # If you change the format, make sure to check if +DATETIME_PARSER+ can still parse this string.
-  Wice::Defaults::DATETIME_FORMAT = "%Y-%m-%d %H:%M"
+  Wice::Defaults::DATETIME_FORMAT = '%Y-%m-%d %H:%M'
 
   # Format of the date displayed.
   # If you change the format, make sure to check if +DATE_PARSER+ can still parse this string.
-  Wice::Defaults::DATE_FORMAT     =  "%Y-%m-%d"
+  Wice::Defaults::DATE_FORMAT     =  '%Y-%m-%d'
 
   # Format of the date displayed in jQuery's Datepicker
   # If you change the format, make sure to check if +DATE_PARSER+ can still parse this string.
-  Wice::Defaults::DATE_FORMAT_JQUERY     =  "yy-mm-dd"
-
+  Wice::Defaults::DATE_FORMAT_JQUERY     =  'yy-mm-dd'
 
   # Format of the date displayed in Bootstrap's Datepicker
   # If you change the format, make sure to check if +DATE_PARSER+ can still parse this string.
-  Wice::Defaults::DATE_FORMAT_BOOTSTRAP     =  "yyyy-mm-dd"
-
+  Wice::Defaults::DATE_FORMAT_BOOTSTRAP     =  'yyyy-mm-dd'
 
   # With Calendar helpers enabled the parameter sent is the string displayed. This lambda will be given a date string in the
   # format defined by +DATETIME_FORMAT+ and must generate a DateTime object.
   # In many cases <tt>Time.zone.parse</tt> is enough, for instance,  <tt>%Y-%m-%d</tt>. If you change the format, make sure to check this code
   # and modify it if needed.
-  Wice::Defaults::DATETIME_PARSER = lambda{|datetime_string|
+  Wice::Defaults::DATETIME_PARSER = lambda do|datetime_string|
     if datetime_string.blank?
       nil
     elsif Time.zone
@@ -156,19 +153,18 @@ if defined?(Wice::Defaults)
     else
       Time.parse(datetime_string)
     end
-  }
+  end
 
   # The range of years to display in jQuery Datepicker.
   # It can always be changed dynamically with the following javascript:
   #  $( ".hasDatepicker" ).datepicker( "option", "yearRange", "2000:2042" );
   Wice::Defaults::DATEPICKER_YEAR_RANGE = (from = Date.current.year - 10).to_s + ':' + (from + 15).to_s
 
-
   # With Calendar helpers enabled the parameter sent is the string displayed. This lambda will be given a date string in the
   # format defined by +DATETIME+ and must generate a Date object.
   # In many cases <tt>Date.parse</tt> is enough, for instance,  <tt>%Y-%m-%d</tt>. If you change the format, make sure to check this code
   # and modify it if needed.
-  Wice::Defaults::DATE_PARSER = lambda{|date_string|
+  Wice::Defaults::DATE_PARSER = lambda do|date_string|
     if date_string.blank?
       nil
     else
@@ -178,14 +174,13 @@ if defined?(Wice::Defaults)
         nil
       end
     end
-  }
-
-  # Icon to popup the calendar.
-  Wice::Defaults::CALENDAR_ICON = "/assets/icons/grid/calendar_view_month.png"
-
-  # popup calendar will be shown relative to the popup trigger element or to the mouse pointer
-  Wice::Defaults::POPUP_PLACEMENT_STRATEGY = :trigger # :pointer
+  end
 
   # The name of the page method (should correspond to Kaminari.config.page_method_name)
   Wice::Defaults::PAGE_METHOD_NAME = :page
+
+  # By default ActiveRecord calls are always executed inside Model.unscoped{}.
+  # Setting <tt>USE_DEFAULT_SCOPE</tt> to true will use the default scope for all queries.
+  Wice::Defaults::USE_DEFAULT_SCOPE = false
+
 end

data/lib/wice/active_record_column_wrapper.rb

@@ -1,20 +1,30 @@
+# encoding: utf-8
 module Wice
-
   # to be mixed in into ActiveRecord::ConnectionAdapters::Column
   module WiceGridExtentionToActiveRecordColumn #:nodoc:
+    # reference to the ActiveRecord model class
     attr_accessor :model
   end
 
-
-
   class ActiveRecordColumnWrapper #:nodoc:
     def initialize(column, all_filter_params, main_table, table_alias, custom_filter_active, filter_type) #:nodoc:
       @column = column
-      @filter_type = filter_type
-      @all_filter_params, @main_table, @table_alias, @custom_filter_active =
-        all_filter_params, main_table, table_alias, custom_filter_active
-    end
 
+      # nil | Symbol
+      @filter_type          = filter_type
+
+      # Hash { String => String | Array[String]}
+      @all_filter_params    = all_filter_params
+
+      # nil | Boolean
+      @main_table           = main_table
+
+      # nil | String
+      @table_alias          = table_alias
+
+      # nil | Array[String] | Array[Array[...]] | Array[Symbol]
+      @custom_filter_active = custom_filter_active
+    end
 
     def wg_initialize_request_parameters  #:nodoc:
       @request_params = nil
@@ -31,6 +41,7 @@ module Wice
       # a datetime (with custom_filter it can be anything else, and not
       # the datetime hash {fr: ..., to: ...})
       if @request_params
+
         if (@column.type == :datetime || @column.type == :timestamp) && @request_params.is_a?(Hash)
           [:fr, :to].each do |sym|
             if @request_params[sym]
@@ -48,6 +59,7 @@ module Wice
         # a date (with custom_filter it can be anything else, and not
         # the date hash {fr: ..., to: ...})
         if @column.type == :date && @request_params.is_a?(Hash)
+
           [:fr, :to].each do |sym|
             if @request_params[sym]
               if @request_params[sym].is_a?(String)
@@ -57,10 +69,11 @@ module Wice
               end
             end
           end
+
         end
       end
 
-      return wg_generate_conditions, current_parameter_name
+      [wg_generate_conditions, current_parameter_name]
     end
 
     def wg_generate_conditions  #:nodoc:
@@ -72,12 +85,23 @@ module Wice
         return custom_processor.generate_conditions(@table_alias, @request_params)
       end
 
-      column_type = @filter_type || @column.type.to_s
+      column_type = @filter_type || @column.type.to_s.intern
+
+      filter_type = case column_type
+      when :date
+        ConfigurationProvider.value_for(:DEFAULT_FILTER_FOR_DATE)
+      when :datetime
+        ConfigurationProvider.value_for(:DEFAULT_FILTER_FOR_DATETIME)
+      when :timestamp
+        ConfigurationProvider.value_for(:DEFAULT_FILTER_FOR_DATETIME)
+      else
+        column_type
+      end
 
-      processor_class = ::Wice::Columns.get_conditions_generator_column_processor(column_type)
+      processor_class = ::Wice::Columns.get_conditions_generator_column_processor(filter_type)
 
       if processor_class
-        return processor_class.new(self).generate_conditions(@table_alias, @request_params)
+        return processor_class.new(self, column_type).generate_conditions(@table_alias, @request_params)
       else
         Wice.log("No processor for database type #{column_type}!!!")
         nil
@@ -92,13 +116,8 @@ module Wice
       @column.model
     end
 
-
     def alias_or_table_name(table_alias) #:nodoc:
       table_alias || @column.model.table_name
     end
-
-
   end
-
-
-end
+end