wice_grid 3.6.2 → 4.1.0

data/lib/wice/columns.rb

@@ -99,7 +99,8 @@ module Wice #:nodoc:
 
       # fields defined from the options parameter
       FIELDS = [:attribute, :name, :html, :filter, :model, :allow_multiple_selection,
-                :in_html, :in_csv, :table_alias, :custom_order, :detach_with_id, :ordering, :auto_reload]
+                :in_html, :in_csv, :table_alias, :custom_order, :detach_with_id, :ordering, :auto_reload,
+                :filter_control_options, :sort_by]
 
       attr_accessor(*FIELDS)
 
@@ -124,6 +125,9 @@ module Wice #:nodoc:
       # A boolean flag: whether a column has a text input or not
       attr_reader :contains_a_text_input
 
+      # options for rendering filter controls. Supported options are specific to the type.
+      attr_accessor :filter_control_options
+
       def initialize(block, options, grid_obj, tname, mtable, cfilter, view)  #:nodoc:
         self.cell_rendering_block = block
         self.grid           = grid_obj
@@ -199,13 +203,16 @@ module Wice #:nodoc:
         [query, query_without_equals_sign, parameter_name, dom_id.tr('.', '_')]
       end
 
-      # bad name, because for the main table the name is not really 'fully_qualified'
-      def attribute_name_fully_qualified_for_all_but_main_table_columns #:nodoc:
-        self.main_table ? attribute : table_alias_or_table_name + '.' + attribute
+      # Returns a reference to the column in the form: "table_name.column_name", unless it is a column in the main
+      # table, in which case it will return just "column_name",
+      def attribute_name_fully_qualified_for_all_but_main_table_columns
+        return attribute if main_table
+        return fully_qualified_attribute_name
       end
 
-      def fully_qualified_attribute_name #:nodoc:
-        table_alias_or_table_name + '.' + attribute
+      # Returns a reference to the column in the form: "table_name.column_name".
+      def fully_qualified_attribute_name
+        table_alias_or_table_name ? (table_alias_or_table_name + '.' + attribute) : nil
       end
 
       def filter_shown? #:nodoc:

data/lib/wice/columns/column_integer.rb

@@ -30,6 +30,16 @@ module Wice
     end
 
     class ConditionsGeneratorColumnInteger < ConditionsGeneratorColumn  #:nodoc:
+      # Note: also used in ColumnRange, hence class method
+      def self.get_value(val) #:nodoc:
+        # Try to determine localized separator using I18n and replace it with default one
+        separator = I18n.t!('number.format.separator') rescue nil
+        val = val.sub(separator, '.') if val.respond_to?(:sub) && separator
+
+        # Parse as float
+        Float(val) rescue nil
+      end
+
       def get_op_and_value(val) #:nodoc:
         num = nil
         op  = nil
@@ -41,7 +51,7 @@ module Wice
         if start_of_num
           op = val[0...start_of_num]
           op = '=' if op == ''
-          num = Float(val[start_of_num..-1]) rescue nil
+          num = ConditionsGeneratorColumnInteger.get_value(val[start_of_num..-1])
 
           op = nil unless ['<', '>', '<=', '>=', '='].include?(op)
         end

data/lib/wice/columns/column_rails_datetime_helper.rb

@@ -11,9 +11,10 @@ module Wice
       end
 
       def do_render(params) #:nodoc:
+        datetime_options = filter_control_options ? filter_control_options.slice(:start_year, :end_year, :max_year_allowed) : {}
         '<div class="date-filter">' +
-          select_datetime(params[:fr], include_blank: true, prefix: @name1) + '<br/>' +
-          select_datetime(params[:to], include_blank: true, prefix: @name2) +
+          select_datetime(params[:fr], datetime_options.merge(include_blank: true, prefix: @name1)) + '<br/>' +
+          select_datetime(params[:to], datetime_options.merge(include_blank: true, prefix: @name2)) +
           '</div>'
       end
 

data/lib/wice/columns/column_range.rb

@@ -41,18 +41,20 @@ module Wice
         end
         conditions = [[]]
         if opts[:fr]
-          if opts[:fr] =~ /\d/
+          fr_num = ConditionsGeneratorColumnInteger.get_value(opts[:fr])
+          if fr_num
             conditions[0] << " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} >= ? "
-            conditions << opts[:fr]
+            conditions << fr_num
           else
             opts.delete(:fr)
           end
         end
 
         if opts[:to]
-          if opts[:to] =~ /\d/
+          to_num = ConditionsGeneratorColumnInteger.get_value(opts[:to])
+          if to_num
             conditions[0] << " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} <= ? "
-            conditions << opts[:to]
+            conditions << to_num
           else
             opts.delete(:to)
           end

data/lib/wice/grid_renderer.rb

@@ -215,6 +215,9 @@ module Wice
     # * <tt>:filter_type</tt> - Using a column filter different from the default filter chosen automatically based on the
     #   data type or the <tt>:custom_filter</tt> argument. See <tt>lib/columns/column_processor_index.rb</tt> for the
     #   list of available filters.
+    # * <tt>:filter_control_options</tt> - Additional options to pass to the filter class to change the filter control
+    #   behaviour. Supported options are dependent on the filter used.
+    #   This is needed if sorting is required while  filters are not.
     # * <tt>:ordering</tt> - Enable/disable ordering links in the column titles. The default is +true+
     #   (i.e. if <tt>:attribute</tt> is defined, ordering is enabled)
     # * <tt>:assoc</tt> - Name of the model association. <tt>:attribute</tt> belongs to the table joined via this association.
@@ -259,6 +262,12 @@ module Wice
     #     However, if the retuned value is a two element array, the first element is used for the option label and the
     #     second - for the value.
     #     Read more in README, section 'Custom dropdown filters'
+    # * <tt>:sort_by</tt> - allows arbitrary sorting of the results. This option takes a Proc which returns a value to
+    #   sort by. When this option is used and sorting on this column is activated, the entire resultset is loaded and
+    #   the Proc is passed to Enumerable#sort_by. This can also be used with calculated columns, but an arbitrary
+    #   <tt>:attribute</tt> option must be included to provide a request parameter key. Because this option will load
+    #   the entire resultset, it should only be used with small resultsets. The <tt>:custom_order</tt> option on grid
+    #   initialization should be preferred if possible, as it will perform the sorting in SQL.
     # * <tt>:boolean_filter_true_label</tt> - overrides the label for <tt>true</tt> in the boolean filter (<tt>wice_grid.boolean_filter_true_label</tt> in <tt>wice_grid.yml</tt>).
     # * <tt>:boolean_filter_false_label</tt> - overrides the label for <tt>false</tt> in the boolean filter (<tt>wice_grid.boolean_filter_false_label</tt> in <tt>wice_grid.yml</tt>).
     # * <tt>:allow_multiple_selection</tt> - enables or disables switching between single and multiple selection modes for
@@ -305,6 +314,7 @@ module Wice
         detach_with_id:              nil,
         filter:                      true,
         filter_all_label:            ConfigurationProvider.value_for(:CUSTOM_FILTER_ALL_LABEL),
+        filter_control_options:      {},
         filter_type:                 nil,
         html:                        {},
         in_csv:                      true,
@@ -313,7 +323,8 @@ module Wice
         name:                        '',
         negation:                    ConfigurationProvider.value_for(:NEGATION_IN_STRING_FILTERS),
         ordering:                    true,
-        table_alias:                 nil
+        table_alias:                 nil,
+        sort_by:                     nil,
       }
 
       opts.assert_valid_keys(options.keys)
@@ -375,7 +386,8 @@ module Wice
           custom_filter_active: options[:custom_filter],
           table_alias:          options[:table_alias],
           filter_type:          options[:filter_type],
-          assocs:               assocs
+          assocs:               assocs,
+          sort_by:              options[:sort_by],
         )
 
         # [ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter::Column, String, Boolean]
@@ -536,7 +548,7 @@ module Wice
     end
 
     def base_link_for_filter(controller, extra_parameters = {})   #:nodoc:
-      new_params = Wice::WgHash.deep_clone controller.params
+      new_params = Wice::WgHash.deep_clone controller.params.to_unsafe_h
       new_params.merge!(extra_parameters)
 
       if new_params[@grid.name]
@@ -556,7 +568,7 @@ module Wice
     end
 
     def link_for_export(controller, format, extra_parameters = {})   #:nodoc:
-      new_params = Wice::WgHash.deep_clone controller.params
+      new_params = Wice::WgHash.deep_clone controller.params.to_unsafe_h
       new_params.merge!(extra_parameters)
 
       new_params[@grid.name] = {} unless new_params[@grid.name]
@@ -567,7 +579,7 @@ module Wice
     end
 
     def column_link(column, direction, params, extra_parameters = {})   #:nodoc:
-      column_attribute_name = if column.attribute.index('.') || column.main_table
+      column_attribute_name = if column.attribute.index('.') || column.main_table || column.table_alias_or_table_name.nil?
         column.attribute
       else
         column.table_alias_or_table_name + '.' + column.attribute
@@ -578,7 +590,7 @@ module Wice
         ORDER_DIRECTION_PARAMETER_NAME => direction
       } }
 
-      cleaned_params = Wice::WgHash.deep_clone params
+      cleaned_params = Wice::WgHash.deep_clone params.to_unsafe_h
       cleaned_params.merge!(extra_parameters)
 
       cleaned_params.delete(:controller)
@@ -586,7 +598,11 @@ module Wice
 
       query_params = Wice::WgHash.rec_merge(cleaned_params, query_params)
 
-      '?' + query_params.to_query
+      if Rails.version.to_i >= 5
+        '?' + query_params.to_h.to_query
+      else
+        '?' + query_params.to_query
+      end
     end
 
     protected

data/lib/wice/helpers/bs_calendar_helpers.rb

@@ -17,12 +17,20 @@ module Wice #:nodoc:
     end
 
     def date_calendar_bs(calendar_data)  #:nodoc:
+      placeholder =
+        if calendar_data.the_other_datepicker_id_to
+          I18n.t("wice_grid.date_selector_tooltip_from")
+        else
+          I18n.t("wice_grid.date_selector_tooltip_to")
+        end
+
       text_field_tag_options = {
           :id                   => calendar_data.dom_id,
           'data-provide'        => 'datepicker',
           'data-date-language'  => I18n.locale,
           'data-date-autoclose' => true,
-          'data-date-format'    => Wice::ConfigurationProvider.value_for(:DATE_FORMAT_BOOTSTRAP)
+          'data-date-format'    => Wice::ConfigurationProvider.value_for(:DATE_FORMAT_BOOTSTRAP),
+          'placeholder'         => placeholder
       }
 
       text_field_tag_options['class'] = 'form-control input-sm'

data/lib/wice/helpers/wice_grid_view_helpers.rb

@@ -294,7 +294,7 @@ module Wice
 
         Wice::WgHash.add_or_append_class_value!(opts, column.css_class)
 
-        if column.attribute && column.ordering
+        if column.attribute && (column.ordering || column.sort_by)
 
           column.add_css_class('active-filter') if grid.filtered_by?(column)
 
@@ -505,14 +505,14 @@ module Wice
       grid.output_buffer << '</div>'
 
       if Rails.env.development?
-        grid.output_buffer << javascript_tag(%/ $(document).ready(function(){ \n/ +
+        grid.output_buffer << javascript_tag(%/ document.ready = function(){ \n/ +
           %$ if (typeof(WiceGridProcessor) == "undefined"){\n$ +
           %$   alert("wice_grid.js not loaded, WiceGrid cannot proceed!\\n" +\n$ +
           %(     "Make sure that you have loaded wice_grid.js.\\n" + ) +
           %(     "Add line //= require wice_grid.js " + ) +
           %$     "to app/assets/javascripts/application.js")\n$ +
           %( } ) +
-          %$ }) $)
+          %$ } $)
       end
 
       grid.output_buffer
@@ -667,7 +667,7 @@ module Wice
         first = 1
         last = collection.size
 
-        num_pages = 1
+        total_pages = 1
 
         class << collection
           def current_page
@@ -685,12 +685,12 @@ module Wice
         first = collection.offset_value + 1
         last  = collection.last_page? ? collection.total_count : collection.offset_value + collection.limit_value
 
-        num_pages = collection.total_pages
+        total_pages = collection.total_pages
       end
 
       parameters = grid.get_state_as_parameter_value_pairs
 
-      if num_pages < 2 && collection.length == 0
+      if total_pages < 2 && collection.length == 0
         '0'
       else
         parameters << ["#{grid.name}[pp]", collection_total_entries]

data/lib/wice/wice_grid_controller.rb

@@ -40,10 +40,12 @@ module Wice
     # * <tt>:enable_export_to_csv</tt> - <Enable export of the table to CSV. Read the How-To to learn what else is needed to enable CSV export.
     # * <tt>:csv_file_name</tt> - Name of the exported CSV file. If the parameter is missing, the name of the grid will be used instead.
     # * <tt>:csv_field_separator</tt> - field separator for CSV files. The default is defined in +CSV_FIELD_SEPARATOR+ in the config file.
-    # * <tt>:custom_order</tt> - used for overriding the ORDER BY clause with custom sql code (for example, including a function).
-    #   The value of the parameter is a hash where keys are fully qualified names
-    #   of database columns, and values the required chunks of SQL to use in the ORDER BY clause, either as strings or Proc object
-    #   evaluating to string. See section 'Custom Ordering' in the README.
+    # * <tt>:custom_order</tt> - used for overriding the ORDER BY clause with custom sql code (for example, using an SQL
+    #   function). A Hash with keys of the fully qualified names of database columns and with values that specify the
+    #   ordering to be used, without specifying the direction (no ASC or DESC). The values of this Hash can any String
+    #   of SQL that can be passed to the ActiveRecord order clause, an instance of Arel::Attributes::Attribute, or a
+    #   Proc that receives the fully qualified column name and returns a String or Arel::Attributes::Attribute. See
+    #   section 'Custom Ordering' in the README.
     # * <tt>:saved_query</tt> - id of the saved query or the query object itself to load initially.
     #   Read section "Saving Queries How-To" in README for more details.
     # * <tt>:after</tt> - defined a name of a controller method which would be called by the grid after all user input has been processed,
@@ -179,7 +181,7 @@ module Wice
       @performed_render = false
 
       logger.info "Sending file #{path}" unless logger.nil?
-      File.open(path, 'rb') { |file| render status: options[:status], text: file.read }
+      File.open(path, 'rb') { |file| render status: options[:status], plain: file.read }
     end
 
     DEFAULT_SEND_FILE_OPTIONS_RAILS2 = { #:nodoc:

data/lib/wice/wice_grid_core_ext.rb

@@ -113,7 +113,11 @@ module ActionView #:nodoc:
   module Helpers #:nodoc:
     module TagHelper #:nodoc:
       def public_tag_options(options, escape = true) #:nodoc:
-        tag_options(options, escape)
+        if respond_to?(:tag_options, true)
+          tag_options(options, escape)
+        else
+          tag_builder.tag_options(options, escape)
+        end
       end
     end
   end

data/lib/wice/wice_grid_misc.rb

@@ -159,7 +159,7 @@ module Wice
     end
 
     def log(message) #:nodoc:
-      ActiveRecord::Base.logger.info('WiceGrid: ' + message)
+      ActiveRecord::Base.logger.info('WiceGrid: ' + message) if ActiveRecord::Base.logger
     end
   end
 

data/lib/wice_grid.rb

@@ -95,7 +95,7 @@ module Wice
         end
       end
 
-      opts[:order_direction].downcase! if opts[:order_direction].is_a?(String)
+      opts[:order_direction] = opts[:order_direction].downcase if opts[:order_direction].is_a?(String)
 
       # validate :order_direction
       if opts[:order_direction] && ! (opts[:order_direction] == 'asc' || opts[:order_direction] == :asc || opts[:order_direction] == 'desc' ||
@@ -228,7 +228,8 @@ module Wice
                  custom_filter_active: nil,
                  table_alias: nil,
                  filter_type: nil,
-                 assocs: [])  #:nodoc:
+                 assocs: [],
+                 sort_by: nil)  #:nodoc:
 
 
       @options[:include] = Wice.build_includes(@options[:include], assocs)
@@ -240,7 +241,8 @@ module Wice
         table_name = model.table_name
       else
         column = @table_column_matrix.get_column_in_default_model_class_by_column_name(column_name)
-        if column.nil?
+        # Allow the column to not exist if we're doing a custom sort (calculated field)
+        if column.nil? && !sort_by
           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.')
@@ -296,9 +298,21 @@ module Wice
       # conditions processed
 
       if (!opts[:skip_ordering]) && ! @status[:order].blank?
-        @ar_options[:order] = add_custom_order_sql(complete_column_name(@status[:order]))
-
-        @ar_options[:order] += ' ' + @status[:order_direction]
+        custom_order = get_custom_order_reference
+        if custom_order
+          @ar_options[:order] = custom_order
+        else
+          @ar_options[:order] = arel_column_reference(@status[:order])
+        end
+        if @ar_options[:order].is_a?(Arel::Attributes::Attribute)
+          if @status[:order_direction] == 'desc'
+            @ar_options[:order] = @ar_options[:order].desc
+          else
+            @ar_options[:order] = @ar_options[:order].asc
+          end
+        else
+          @ar_options[:order] += " #{@status[:order_direction]}"
+        end
       end
 
       @ar_options[:joins]   = @options[:joins]
@@ -326,36 +340,49 @@ module Wice
       relation
     end
 
+    # Apply the sort_by option to the results.
+    def apply_sort_by(relation)
+      active_sort_by = nil
+      @renderer.find_one_for(->(c) {c.attribute == @status[:order]}) {|r| active_sort_by = r.sort_by}
+      return relation if !active_sort_by
+      relation = relation.sort_by(&active_sort_by)
+      relation = relation.reverse if @status[:order_direction] == 'desc'
+      return relation
+    end
+
     # TO DO: what to do with other @ar_options values?
     def read  #:nodoc:
       form_ar_options
       use_default_or_unscoped do
-        @resultset = if self.output_csv? || all_record_mode?
-          relation = @relation
-                     .includes(@ar_options[:include])
-                     .joins(@ar_options[:joins])
-                     .order(@ar_options[:order])
-                     .group(@ar_options[:group])
-                     .merge(@ar_options[:conditions])
-          relation = add_references relation
-
-          relation
-        else
-          # p @ar_options
-          relation = @relation
-                     .send(@options[:page_method_name], @ar_options[:page])
-                     .per(@ar_options[:per_page])
-                     .includes(@ar_options[:include])
-                     .joins(@ar_options[:joins])
-                     .order(@ar_options[:order])
-                     .group(@ar_options[:group])
-                     .merge(@ar_options[:conditions])
-
-          relation = add_references relation
-
-          relation
+        relation = @relation
+                       .includes(@ar_options[:include])
+                       .joins(@ar_options[:joins])
+                       .group(@ar_options[:group])
+                       .merge(@ar_options[:conditions])
+        relation = add_references relation
+        relation = apply_sort_by relation
+
+        # If relation is an Array, it got the sort from apply_sort_by.
+        relation = relation.order(@ar_options[:order]) if !relation.is_a?(Array)
+
+        if !output_csv? && !all_record_mode?
+          if relation.is_a?(Array)
+            relation = Kaminari.paginate_array(relation, limit: @ar_options[:per_page], offset: @ar_options[:per_page].to_i * (@ar_options[:page].to_i - 1))
+          else
+            relation = relation
+                           .send(@options[:page_method_name], @ar_options[:page])
+                           .per(@ar_options[:per_page])
+          end
+        end
+
+        if all_record_mode? && relation.is_a?(Array)
+          # This still needs to be a Kaminari object as the paginator will read limit_value.
+          relation = Kaminari.paginate_array(relation, limit: relation.count)
         end
+
+        @resultset = relation
       end
+
       invoke_resultset_callbacks
     end
 
@@ -384,9 +411,10 @@ module Wice
       end
     end
 
-    def ordered_by?(column)  #:nodoc:
+    # Returns true if the current results are ordered by the passed column.
+    def ordered_by?(column)
       return nil if @status[:order].blank?
-      if column.main_table && ! @status[:order].index('.')
+      if column.main_table && ! @status[:order].index('.') || column.table_alias_or_table_name.nil?
         @status[:order] == column.attribute
       else
         @status[:order] == column.table_alias_or_table_name + '.' + column.attribute
@@ -449,11 +477,11 @@ module Wice
     def do_count #:nodoc:
       @relation
         .all
-        .merge(@ar_options[:conditions]).count(
-          joins:      @ar_options[:joins],
-          include:    @ar_options[:include],
-          group:      @ar_options[:group]
-        )
+        .joins(@ar_options[:joins])
+        .includes(@ar_options[:include])
+        .group(@ar_options[:group])
+        .where(@options[:conditions])
+        .count
     end
 
     alias_method :size, :count
@@ -533,7 +561,11 @@ module Wice
       invoke_resultset_callback(@options[:with_resultset], self.active_relation_for_resultset_without_paging_with_user_filters)
     end
 
-    def add_custom_order_sql(fully_qualified_column_name) #:nodoc:
+    # If a custom order has been configured, gets the column/function to be ordered by. If no custom order, returns nil.
+    def get_custom_order_reference
+      # TODO Do we need to distinguish between no custom order and a custom order that defines no ordering? Both return nil.
+
+      fully_qualified_column_name = complete_column_name(@status[:order])
       custom_order = if @options[:custom_order].key?(fully_qualified_column_name)
         @options[:custom_order][fully_qualified_column_name]
       else
@@ -542,39 +574,34 @@ module Wice
         end
       end
 
-      if custom_order.blank?
-        sqlite = ActiveRecord::ConnectionAdapters.const_defined?(:SQLite3Adapter) && ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::SQLite3Adapter)
-        postgres = ActiveRecord::ConnectionAdapters.const_defined?(:PostgreSQLAdapter) && ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
-        if sqlite || postgres
-          fully_qualified_column_name.strip.split('.').map { |chunk| ActiveRecord::Base.connection.quote_table_name(chunk) }.join('.')
-        else
-          ActiveRecord::Base.connection.quote_table_name(fully_qualified_column_name.strip)
-        end
-      else
-        if custom_order.is_a? String
-          custom_order.gsub(/\?/, fully_qualified_column_name)
-        elsif custom_order.is_a? Proc
-          custom_order.call(fully_qualified_column_name)
-        else
-          raise WiceGridArgumentError.new("invalid custom order #{custom_order.inspect}")
-        end
-      end
+      return custom_order if custom_order.nil? || custom_order.is_a?(Arel::Attributes::Attribute)
+      return custom_order.gsub(/\?/, fully_qualified_column_name) if custom_order.is_a?(String)
+      return custom_order.call(fully_qualified_column_name) if custom_order.is_a?(Proc)
+      raise WiceGridArgumentError.new("invalid custom order #{custom_order.inspect}")
     end
 
-    def complete_column_name(col_name)  #:nodoc:
+    # Returns an Arel::Attributes::Attribute for the passed column reference.
+    def arel_column_reference(col_name)  #:nodoc:
       if col_name.index('.') # already has a table name
-        col_name
+        table_name, col_name = col_name.split('.', 2)
+        Arel::Table.new(table_name)[col_name]
       else # add the default table
-        "#{@klass.table_name}.#{col_name}"
+        @klass.arel_table[col_name]
       end
     end
 
+    # Returns tablename.columnname for the passed column reference.
+    def complete_column_name(col_name)
+      return col_name if col_name.index('.') # already has a table name
+      return "#{@klass.table_name}.#{col_name}"
+    end
+
     def params  #:nodoc:
       @controller.params
     end
 
     def this_grid_params  #:nodoc:
-      params[name]
+      params[name].try(:to_unsafe_h) || params[name]
     end
 
     def resultset_without_paging_without_user_filters  #:nodoc: