wice_grid 3.6.0 → 3.6.2

data/lib/wice/helpers/bs_calendar_helpers.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Wice #:nodoc:
   module BsCalendarHelpers #:nodoc:
 
@@ -57,8 +56,8 @@ module Wice #:nodoc:
         calendar_data.date_string               = options[:initial_date].nil? ? '' : options[:initial_date].strftime(date_format)
         calendar_data.dom_id                    = options[:name].gsub(/([\[\(])|(\]\[)/, '_').gsub(/[\]\)]/, '').gsub(/\./, '_').gsub(/_+/, '_')
         calendar_data.datepicker_placeholder_id = calendar_data.dom_id + '_date_placeholder'
-        calendar_data.date_div_id              = calendar_data.dom_id + '_date_view'
-        calendar_data.close_calendar_event_name =  "wg:calendarChanged_#{options[:grid_name]}"
+        calendar_data.date_div_id               = calendar_data.dom_id + '_date_view'
+        calendar_data.close_calendar_event_name = "wg:calendarChanged_#{options[:grid_name]}"
         calendar_data.fire_event                = options[:fire_event]
       end
     end

data/lib/wice/helpers/js_calendar_helpers.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Wice #:nodoc:
   module JsCalendarHelpers #:nodoc:
 
@@ -74,7 +73,7 @@ module Wice #:nodoc:
         calendar_data.dom_id                    = options[:name].gsub(/([\[\(])|(\]\[)/, '_').gsub(/[\]\)]/, '').gsub(/\./, '_').gsub(/_+/, '_')
         calendar_data.datepicker_placeholder_id = calendar_data.dom_id + '_date_placeholder'
         calendar_data.date_span_id              = calendar_data.dom_id + '_date_view'
-        calendar_data.close_calendar_event_name =  "wg:calendarChanged_#{options[:grid_name]}"
+        calendar_data.close_calendar_event_name = "wg:calendarChanged_#{options[:grid_name]}"
         calendar_data.title                     = options[:title]
         calendar_data.fire_event                = options[:fire_event]
       end

data/lib/wice/helpers/wice_grid_misc_view_helpers.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Wice
 
   # Various grid related helpers
@@ -9,7 +8,7 @@ module Wice
     # The only parameter is a grid object returned by +initialize_grid+ in the controller.
     def dump_filter_parameters_as_hidden_fields(grid)
       unless grid.is_a? WiceGrid
-        fail WiceGridArgumentError.new('dump_filter_parameters_as_hidden_fields: the parameter must be a WiceGrid instance.')
+        raise WiceGridArgumentError.new('dump_filter_parameters_as_hidden_fields: the parameter must be a WiceGrid instance.')
       end
 
       grid.get_state_as_parameter_value_pairs(true).collect do|param_name, value|
@@ -51,7 +50,7 @@ module Wice
     # so I do not document this method to avoid contributing to this misunderstanding.
     def scaffolded_grid(grid_obj, opts = {}) #:nodoc:
       unless grid_obj.is_a? WiceGrid
-        fail WiceGridArgumentError.new('scaffolded_grid: the parameter must be a WiceGrid instance.')
+        raise WiceGridArgumentError.new('scaffolded_grid: the parameter must be a WiceGrid instance.')
       end
 
       # debug grid.klass.column_names

data/lib/wice/helpers/wice_grid_serialized_queries_view_helpers.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Wice
   module GridViewHelper
     # View helper to render the list of saved queries and the form to create a new query.
@@ -8,7 +7,7 @@ module Wice
     # Read section "Adding Application Specific Logic to Saving/Restoring Queries" in README for more details.
     def saved_queries_panel(grid, opts = {})
       unless grid.is_a? WiceGrid
-        fail WiceGridArgumentError.new('saved_queries_panel: the parameter must be a WiceGrid instance.')
+        raise WiceGridArgumentError.new('saved_queries_panel: the parameter must be a WiceGrid instance.')
       end
 
       options = { extra_parameters: {}, confirm: 1 }
@@ -40,10 +39,10 @@ module Wice
         button_tag(
           NlMessage['save_query_button_label'],
           class: 'wice-grid-save-query-button btn btn-primary',
-          'data-grid-name'   => grid_name,
+          'data-grid-name'                     => grid_name,
           'data-base-path-to-query-controller' => base_path_to_query_controller,
-          'data-parameters'  => parameters.to_json,
-          'data-ids'         => ids.to_json
+          'data-parameters'                    => parameters.to_json,
+          'data-ids'                           => ids.to_json
         ) +
         '</div></div></div>'
         ).html_safe

data/lib/wice/helpers/wice_grid_view_helpers.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Wice
   module GridViewHelper
     # View helper for rendering the grid.
@@ -69,7 +68,7 @@ module Wice
     # Pease read documentation about the +column+ method to achieve the enlightenment.
 
     def grid(grid, opts = {}, &block)
-      fail WiceGridArgumentError.new('Missing block for the grid helper.' \
+      raise WiceGridArgumentError.new('Missing block for the grid helper.' \
         ' For detached filters use first define_grid with the same API as grid, ' \
         'then grid_filter to add filters, and then render_grid to actually show the grid') if block.nil?
       define_grid(grid, opts, &block)
@@ -83,7 +82,7 @@ module Wice
     def define_grid(grid, opts = {}, &block)
       # strip the method from HTML stuff
       unless grid.class == WiceGrid
-        fail WiceGridArgumentError.new('The first argument for the grid helper must be an instance of the WiceGrid class')
+        raise WiceGridArgumentError.new('The first argument for the grid helper must be an instance of the WiceGrid class')
       end
 
       options = {
@@ -140,7 +139,7 @@ module Wice
       elsif grid.csv_tempfile
         grid.csv_tempfile.path
       else
-        fail WiceGridException.new("Attempt to use 'render_grid' without 'define_grid' before.")
+        raise WiceGridException.new("Attempt to use 'render_grid' without 'define_grid' before.")
       end
     end
 
@@ -155,9 +154,11 @@ module Wice
         rendering.blank_slate_handler
       end
 
+      # rubocop:disable Style/SymbolProc
       if rendering.find_one_for(:in_html) { |column| column.detach_with_id }
         grid.output_buffer.return_empty_strings_for_nonexistent_filters = true
       end
+      # rubocop:enable Style/SymbolProc
     end
 
     def call_block(block, ar, extra_argument = nil)  #:nodoc:
@@ -183,14 +184,14 @@ module Wice
         if column_block_output.is_a?(Array)
 
           unless column_block_output.size == 2
-            fail WiceGridArgumentError.new('When WiceGrid column block returns an array it is expected to contain 2 elements only - ' \
+            raise WiceGridArgumentError.new('When WiceGrid column block returns an array it is expected to contain 2 elements only - ' \
               'the first is the contents of the table cell and the second is a hash containing HTML attributes for the <td> tag.')
           end
 
           column_block_output, additional_opts = column_block_output
 
           unless additional_opts.is_a?(Hash)
-            fail WiceGridArgumentError.new('When WiceGrid column block returns an array its second element is expected to be a ' \
+            raise WiceGridArgumentError.new('When WiceGrid column block returns an array its second element is expected to be a ' \
                                             "hash containing HTML attributes for the <td> tag. The returned value is #{additional_opts.inspect}. Read documentation.")
           end
 
@@ -469,7 +470,7 @@ module Wice
 
       base_link_for_filter, base_link_for_show_all_records = rendering.base_link_for_filter(controller, options[:extra_request_parameters])
 
-      link_for_export      = rendering.link_for_export(controller, 'csv', options[:extra_request_parameters])
+      link_for_export = rendering.link_for_export(controller, 'csv', options[:extra_request_parameters])
 
       parameter_name_for_query_loading = { grid.name => { q: '' } }.to_query
       parameter_name_for_focus = { grid.name => { foc: '' } }.to_query
@@ -569,13 +570,13 @@ module Wice
     # * +filter_key+ an identifier of the filter specified in the column declaration by parameter +:detach_with_id+
     def grid_filter(grid, filter_key)
       unless grid.is_a? WiceGrid
-        fail WiceGridArgumentError.new('grid_filter: the parameter must be a WiceGrid instance.')
+        raise WiceGridArgumentError.new('grid_filter: the parameter must be a WiceGrid instance.')
       end
       if grid.output_buffer.nil?
-        fail WiceGridArgumentError.new("grid_filter: You have attempted to run 'grid_filter' before 'grid'. Read about detached filters in the documentation.")
+        raise WiceGridArgumentError.new("grid_filter: You have attempted to run 'grid_filter' before 'grid'. Read about detached filters in the documentation.")
       end
       if grid.output_buffer == true
-        fail WiceGridArgumentError.new('grid_filter: You have defined no detached filters, or you try use detached filters with' \
+        raise WiceGridArgumentError.new('grid_filter: You have defined no detached filters, or you try use detached filters with' \
           ':show_filters => :no (set :show_filters to :always in this case). Read about detached filters in the documentation.')
       end
 
@@ -684,7 +685,7 @@ module Wice
         first = collection.offset_value + 1
         last  = collection.last_page? ? collection.total_count : collection.offset_value + collection.limit_value
 
-        num_pages = collection.num_pages
+        num_pages = collection.total_pages
       end
 
       parameters = grid.get_state_as_parameter_value_pairs

data/lib/wice/kaminari_monkey_patching.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # Ugly monkey-patching Kaminari (https://github.com/amatsuda/kaminari/pull/267)
 module Kaminari #:nodoc:
   module Helpers #:nodoc:

data/lib/wice/table_column_matrix.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Wice
 
   # a matrix for all declared columns
@@ -48,7 +47,7 @@ module Wice
 
     def get_column_in_default_model_class_by_column_name(column_name)  #:nodoc:
       if @default_model_class.nil?
-        fail WiceGridException.new("Cannot search for this column(#{column_name}) in a default model(#{@default_model_class}) as the default model is not set")
+        raise WiceGridException.new("Cannot search for this column(#{column_name}) in a default model(#{@default_model_class}) as the default model is not set")
       end
 
       self[@default_model_class][column_name]

data/lib/wice/wice_grid_controller.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Wice
   module Controller #:nodoc:
     def self.included(base) #:nodoc:
@@ -144,13 +143,13 @@ module Wice
       options.merge!(opts)
 
       [:attribute, :value].each do |key|
-        fail ::Wice::WiceGridArgumentError.new("wice_grid_custom_filter_params: :#{key} is a mandatory argument") unless options[key]
+        raise ::Wice::WiceGridArgumentError.new("wice_grid_custom_filter_params: :#{key} is a mandatory argument") unless options[key]
       end
 
       attr_name = if options[:model]
         unless options[:model].nil?
           options[:model] = options[:model].constantize if options[:model].is_a? String
-          fail Wice::WiceGridArgumentError.new('Option :model can be either a class or a string instance') unless options[:model].is_a? Class
+          raise Wice::WiceGridArgumentError.new('Option :model can be either a class or a string instance') unless options[:model].is_a? Class
         end
         options[:model].table_name + '.' + options[:attribute]
       else
@@ -171,7 +170,7 @@ module Wice
     end
 
     def send_file_rails2(path, options = {}) #:nodoc:
-      fail "Cannot read file #{path}" unless File.file?(path) && File.readable?(path)
+      raise "Cannot read file #{path}" unless File.file?(path) && File.readable?(path)
 
       options[:length] ||= File.size(path)
       options[:filename] ||= File.basename(path) unless options[:url_based_filename]
@@ -194,7 +193,7 @@ module Wice
     def send_file_headers_rails2!(options) #:nodoc:
       options.update(DEFAULT_SEND_FILE_OPTIONS_RAILS2.merge(options))
       [:length, :type, :disposition].each do |arg|
-        fail ArgumentError, ":#{arg} option required" if options[arg].nil?
+        raise ArgumentError, ":#{arg} option required" if options[arg].nil?
       end
 
       disposition = options[:disposition].dup || 'attachment'

data/lib/wice/wice_grid_core_ext.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Wice
   module WgHash #:nodoc:
     class << self #:nodoc:

data/lib/wice/wice_grid_misc.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Wice
   class << self
 
@@ -124,11 +123,11 @@ module Wice
     # checks whether the class is a valid storage for saved queries
     def validate_query_model(query_store_model)  #:nodoc:
       unless query_store_model.respond_to?(:list)
-        fail ::Wice::WiceGridArgumentError.new("Model for saving queries #{query_store_model.class.name} is invalid - there is no class method #list defined")
+        raise ::Wice::WiceGridArgumentError.new("Model for saving queries #{query_store_model.class.name} is invalid - there is no class method #list defined")
       end
       arit = query_store_model.method(:list).arity
       unless arit == 2
-        fail ::Wice::WiceGridArgumentError.new("Method list in the model for saving queries #{query_store_model.class.name} has wrong arity - it should be 2 instead of #{arit}")
+        raise ::Wice::WiceGridArgumentError.new("Method list in the model for saving queries #{query_store_model.class.name} has wrong arity - it should be 2 instead of #{arit}")
       end
       @@model_validated = true
     end
@@ -137,7 +136,7 @@ module Wice
     def get_query_store_model #:nodoc:
       query_store_model = Wice::ConfigurationProvider.value_for(:QUERY_STORE_MODEL)
       query_store_model = query_store_model.constantize if query_store_model.is_a? String
-      fail ::Wice::WiceGridArgumentError.new('Defaults::QUERY_STORE_MODEL must be an ActiveRecord class or a string which can be constantized to an ActiveRecord class') unless query_store_model.is_a? Class
+      raise ::Wice::WiceGridArgumentError.new('Defaults::QUERY_STORE_MODEL must be an ActiveRecord class or a string which can be constantized to an ActiveRecord class') unless query_store_model.is_a? Class
       validate_query_model(query_store_model) unless @@model_validated
       query_store_model
     end
@@ -179,7 +178,7 @@ module Wice
           Wice::Defaults.const_get(key)
         else
           if strict
-            fail WiceGridMissingConfigurationConstantException.new("Could not find constant #{key} in the configuration file!" \
+            raise WiceGridMissingConfigurationConstantException.new("Could not find constant #{key} in the configuration file!" \
                 ' It is possible that the version of WiceGrid you are using is newer than the installed configuration file in config/initializers. ' \
                 "Constant Wice::Defaults::#{key} is missing  and you need to add it manually to wice_grid_config.rb or run the generator task=:\n" \
                 '   rails g wice_grid:install')

data/lib/wice/wice_grid_serialized_queries_controller.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Wice
   class <<self
     # Used in routes.rb to define routes to the query processing controller.

data/lib/wice/wice_grid_serialized_query.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 class WiceGridSerializedQuery < ActiveRecord::Base  #:nodoc:
   serialize :query
 

data/lib/wice/wice_grid_spreadsheet.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 require 'csv'
 
 module Wice

data/lib/wice_grid.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 require 'wice/wice_grid_misc.rb'
 require 'wice/wice_grid_core_ext.rb'
 require 'wice/grid_renderer.rb'
@@ -86,13 +85,13 @@ module Wice
       end
 
       unless @klass.is_a?(Class) && @klass.ancestors.index(ActiveRecord::Base)
-        fail WiceGridArgumentError.new('ActiveRecord model class (second argument) must be a Class derived from ActiveRecord::Base')
+        raise WiceGridArgumentError.new('ActiveRecord model class (second argument) must be a Class derived from ActiveRecord::Base')
       end
 
       # validate :with_resultset & :with_paginated_resultset
       [:with_resultset, :with_paginated_resultset].each do |callback_symbol|
         unless [NilClass, Symbol, Proc].index(opts[callback_symbol].class)
-          fail WiceGridArgumentError.new(":#{callback_symbol} must be either a Proc or Symbol object")
+          raise WiceGridArgumentError.new(":#{callback_symbol} must be either a Proc or Symbol object")
         end
       end
 
@@ -101,7 +100,7 @@ module Wice
       # validate :order_direction
       if opts[:order_direction] && ! (opts[:order_direction] == 'asc' || opts[:order_direction] == :asc || opts[:order_direction] == 'desc' ||
                                       opts[:order_direction] == :desc)
-        fail WiceGridArgumentError.new(":order_direction must be either 'asc' or 'desc'.")
+        raise WiceGridArgumentError.new(":order_direction must be either 'asc' or 'desc'.")
       end
 
       begin
@@ -146,9 +145,9 @@ module Wice
       when Symbol
         @name = @name.to_s
       else
-        fail WiceGridArgumentError.new('name of the grid should be a string or a symbol')
+        raise WiceGridArgumentError.new('name of the grid should be a string or a symbol')
       end
-      fail WiceGridArgumentError.new('name of the grid can only contain alphanumeruc characters') unless @name =~ /^[a-zA-Z\d_]*$/
+      raise WiceGridArgumentError.new('name of the grid can only contain alphanumeruc characters') unless @name =~ /^[a-zA-Z\d_]*$/
 
       @table_column_matrix = TableColumnMatrix.new
       @table_column_matrix.default_model_class = @klass
@@ -225,24 +224,24 @@ module Wice
     # declare_column(String, ActiveRecord, CustomFilterSpec, nil | string, nil | Boolean)
     def declare_column(
                  column_name: nil,
-                       model: nil,
-        custom_filter_active: nil,
+                 model: nil,
+                 custom_filter_active: nil,
                  table_alias: nil,
                  filter_type: nil,
-                      assocs: [])  #:nodoc:
+                 assocs: [])  #:nodoc:
 
 
       @options[:include] = Wice.build_includes(@options[:include], assocs)
 
       if model # this is an included table
         column = @table_column_matrix.get_column_by_model_class_and_column_name(model, column_name)
-        fail WiceGridArgumentError.new("Column '#{column_name}' is not found in table '#{model.table_name}'!") if column.nil?
+        raise WiceGridArgumentError.new("Column '#{column_name}' is not found in table '#{model.table_name}'!") if column.nil?
         main_table = false
         table_name = model.table_name
       else
         column = @table_column_matrix.get_column_in_default_model_class_by_column_name(column_name)
         if column.nil?
-          fail WiceGridArgumentError.new("Column '#{column_name}' is not found in table '#{@klass.table_name}'! " \
+          raise WiceGridArgumentError.new("Column '#{column_name}' is not found in table '#{@klass.table_name}'! " \
             "If '#{column_name}' belongs to another table you should declare it in :include or :join when initialising " \
             'the grid, and specify :model in column declaration.')
         end
@@ -322,7 +321,7 @@ module Wice
     def add_references(relation) #:nodoc:
       if @ar_options[:include] && relation.respond_to?(:references)
         # refs = [@ar_options[:include]] unless @ar_options[:include].is_a?(Array)
-        relation =  relation.references(* @ar_options[:include])
+        relation = relation.references(* @ar_options[:include])
       end
       relation
     end
@@ -508,13 +507,13 @@ module Wice
     # Returns the list of objects browsable through all pages with the current filters.
     # Should only be called after the +grid+ helper.
     def all_pages_records
-      fail WiceGridException.new('all_pages_records can only be called only after the grid view helper') unless self.view_helper_finished
+      raise WiceGridException.new('all_pages_records can only be called only after the grid view helper') unless self.view_helper_finished
       resultset_without_paging_with_user_filters
     end
 
     # Returns the list of objects displayed on current page. Should only be called after the +grid+ helper.
     def current_page_records
-      fail WiceGridException.new('current_page_records can only be called only after the grid view helper') unless self.view_helper_finished
+      raise WiceGridException.new('current_page_records can only be called only after the grid view helper') unless self.view_helper_finished
       @resultset
     end
 
@@ -557,7 +556,7 @@ module Wice
         elsif custom_order.is_a? Proc
           custom_order.call(fully_qualified_column_name)
         else
-          fail WiceGridArgumentError.new("invalid custom order #{custom_order.inspect}")
+          raise WiceGridArgumentError.new("invalid custom order #{custom_order.inspect}")
         end
       end
     end
@@ -653,7 +652,7 @@ module Wice
       # create a Time instance out of parameters
       def params_2_datetime(par)   #:nodoc:
         return nil if par.blank?
-        params =  [par[:year], par[:month], par[:day], par[:hour], par[:minute]].collect { |v| v.blank? ? nil : v.to_i }
+        params = [par[:year], par[:month], par[:day], par[:hour], par[:minute]].collect { |v| v.blank? ? nil : v.to_i }
         begin
           Time.local(*params)
         rescue ArgumentError, TypeError
@@ -664,7 +663,7 @@ module Wice
       # create a Date instance out of parameters
       def params_2_date(par)   #:nodoc:
         return nil if par.blank?
-        params =  [par[:year], par[:month], par[:day]].collect { |v| v.blank? ? nil : v.to_i }
+        params = [par[:year], par[:month], par[:day]].collect { |v| v.blank? ? nil : v.to_i }
         begin
           Date.civil(*params)
         rescue ArgumentError, TypeError

data/spec/schema.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 ActiveRecord::Schema.define(version: 20150713103513) do
   create_table 'dummies', force: :cascade do |t|
     t.string 'name'

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause

data/spec/support/active_record.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 require 'active_record'
 
 ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'

data/spec/support/wice_grid_test_config.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # Default number of rows to show per page.
 Wice::Defaults::PER_PAGE = 20
 

data/spec/wice/grid_output_buffer_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 describe Wice::GridOutputBuffer do
   FILTER_COMMON_CODE = 'here filter code'
 

data/spec/wice/table_column_matrix_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 describe Wice::TableColumnMatrix do
   let(:general_conditions){ 'conditions' }