wice_grid 3.2.0 → 3.2.1.pre1

data/CHANGELOG

@@ -1,7 +1,13 @@
-to do:
 
-1) get rid of this :href => "javascript: toggle_multi_select
-   at view_columns
+action_column can now also take a block. If the block returns a falsy value, no checkbox will be rendered
+
+A fix: the css class submitted to column is also added to <th> tags of the column
+
+Filter related code has been refactored: condition generators are unified together with view column processors into one module. Writing your own filters has been simplified.
+
+The default filter for numeric columns has been replaced by a simple one field filter which checks the values for equality, not the inclusion in a range.
+New column parameter :filter_type allows to load custom alternative filters. The old numeric range filter can still be used by specifying  filter_type: :range.
+See lib/columns/column_processor_index.rb</tt> for the list of available filters.
 
 +++++++
 +++++++
@@ -83,9 +89,6 @@ This version of WiceGrid is accompanied by an application called _WiceGrid Examp
 
 Here's a list of changes as compared with "version 0.4":https://blog.wice.eu/2009/7/6/moving-to-github-and-wicegrid-version-0-4 :
 
-h4. selected_records
-
-Method @selected_records@ of WiceGrid instances allows to  access the list of all records of the current selection throughout all pages in the context of a view:
 
 --- RHTML
 <%= grid(@tasks_grid) do |g|

data/README.rdoc

@@ -624,6 +624,17 @@ To only allow single selection use <tt>:allow_multiple_selection</tt>:
   end
 
 
+==== Numeric Filters
+
+Before version 3.2.1 the filter used for numeric columns was a range filter with two limits. Beginning with version  3.2.1
+the default is a direct comparison filter with one input field. The old range filter can still be loaded using parameter <tt>:filter_type</tt>
+with value <tt>:range</tt>:
+
+  g.column :filter_type => :range do |task|
+    ...
+  end
+
+
 === Defaults
 
 Default values like  can be  changed in <tt>config/initializers/wice_grid_config.rb</tt>.
@@ -801,6 +812,24 @@ taken care of by the application code.
 By default the name of the HTTP parameter follows pattern <tt>"#{grid_name}[#{param_name}][]"</tt>, thus
 <tt>params[grid_name][param_name]</tt> will contain an array of object IDs.
 
+
+You can hide a certain action checkbox if you add the usual block to +g.action_column+, just like with the
++g.column+ definition. If the block returns +nil+ or +false+ no checkbox will be rendered.
+
+  <%= grid(@tasks_grid, :show_filters => :always) do |g|
+
+    ...
+
+    g.action_column do |task|
+      task.finished?
+    end
+
+    ...
+
+  end -%>
+
+
+
 WiceGrid is form-friendly: submitting grid in a form retains the state of the form.
 
 

data/VERSION

@@ -1 +1 @@
-3.2.0
+3.2.1.pre1

data/lib/active_record_column_wrapper.rb

@@ -0,0 +1,105 @@
+# encoding: UTF-8
+module Wice
+
+  # to be mixed in into ActiveRecord::ConnectionAdapters::Column
+  module WiceGridExtentionToActiveRecordColumn #:nodoc:
+    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
+
+
+    def wg_initialize_request_parameters  #:nodoc:
+      @request_params = nil
+      return if @all_filter_params.nil?
+
+      # if the parameter does not specify the table name we only allow columns in the default table to use these parameters
+      if @main_table && @request_params  = @all_filter_params[@column.name]
+        current_parameter_name = @column.name
+      elsif @request_params = @all_filter_params[alias_or_table_name(@table_alias) + '.' + @column.name]
+        current_parameter_name = alias_or_table_name(@table_alias) + '.' + @column.name
+      end
+
+      # Preprocess incoming parameters for datetime, if what's coming in is
+      # 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]
+              if @request_params[sym].is_a?(String)
+                @request_params[sym] = Wice::ConfigurationProvider.value_for(:DATETIME_PARSER).call(@request_params[sym])
+              elsif @request_params[sym].is_a?(Hash)
+                @request_params[sym] = Wice::GridTools.params_2_datetime(@request_params[sym])
+              end
+            end
+          end
+
+        end
+
+        # Preprocess incoming parameters for date, if what's coming in is
+        # 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)
+                @request_params[sym] = Wice::ConfigurationProvider.value_for(:DATE_PARSER).call(@request_params[sym])
+              elsif @request_params[sym].is_a?(Hash)
+                @request_params[sym] = ::Wice::GridTools.params_2_date(@request_params[sym])
+              end
+            end
+          end
+        end
+      end
+
+      return wg_generate_conditions, current_parameter_name
+    end
+
+    def wg_generate_conditions  #:nodoc:
+      return nil if @request_params.nil?
+
+      if @custom_filter_active
+        custom_processor_klass = ::Wice::Columns.get_conditions_generator_column_processor(:custom)
+        custom_processor = custom_processor_klass.new(self)
+        return custom_processor.generate_conditions(@table_alias, @request_params)
+      end
+
+      column_type = @filter_type || @column.type.to_s
+
+      processor_class = ::Wice::Columns.get_conditions_generator_column_processor(column_type)
+
+      if processor_class
+        return processor_class.new(self).generate_conditions(@table_alias, @request_params)
+      else
+        Wice.log("No processor for database type #{column_type}!!!")
+        nil
+      end
+    end
+
+    def name #:nodoc:
+      @column.name
+    end
+
+    def model #:nodoc:
+      @column.model
+    end
+
+
+    def alias_or_table_name(table_alias) #:nodoc:
+      table_alias || @column.model.table_name
+    end
+
+
+  end
+
+
+end

data/lib/columns/column_action.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+module Wice
+
+  module Columns #:nodoc:
+
+
+    class ViewColumnAction < ViewColumn #:nodoc:
+      def initialize(grid_obj, html, param_name, select_all_buttons, object_property, view, block = nil)  #:nodoc:
+        @view = view
+        @select_all_buttons   = select_all_buttons
+        self.grid             = grid_obj
+        self.html             = html
+        Wice::WgHash.add_or_append_class_value!(self.html, 'sel')
+        grid_name             = self.grid.name
+        @param_name           = param_name
+        @cell_rendering_block = lambda do |object, params|
+          if block && ! block.call(object)
+            ''
+          else
+            selected = params[grid_name] && params[grid_name][param_name] && params[grid_name][param_name].index(object.send(object_property).to_s)
+            check_box_tag("#{grid_name}[#{param_name}][]", object.send(object_property), selected, :id => nil)
+          end
+        end
+      end
+
+      def in_html  #:nodoc:
+        true
+      end
+
+      def capable_of_hosting_filter_related_icons?  #:nodoc:
+        false
+      end
+
+      def name  #:nodoc:
+        return '' unless @select_all_buttons
+
+        content_tag(:div, '',
+          :class => 'clickable select-all',
+          :title => NlMessage['select_all']) + ' ' +
+        content_tag(:div, '',
+          :class => 'clickable deselect-all',
+          :title => NlMessage['deselect_all'])
+
+      end
+
+    end
+
+    ConditionsGeneratorColumnAction = ConditionsGeneratorColumn #:nodoc:
+  end
+end

data/lib/columns/column_boolean.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+module Wice
+
+  module Columns #:nodoc:
+
+    class ViewColumnBoolean < ViewColumnCustomDropdown #:nodoc:
+      include ActionView::Helpers::FormOptionsHelper
+
+      attr_accessor :boolean_filter_true_label, :boolean_filter_false_label
+
+      def render_filter_internal(params) #:nodoc:
+        @custom_filter = {
+          @filter_all_label => nil,
+          @boolean_filter_true_label  => 't',
+          @boolean_filter_false_label => 'f'
+        }
+
+        @turn_off_select_toggling = true
+        super(params)
+      end
+    end
+
+
+    class ConditionsGeneratorColumnBoolean < ConditionsGeneratorColumn  #:nodoc:
+      def  generate_conditions(table_alias, opts)   #:nodoc:
+        unless (opts.kind_of?(Array) && opts.size == 1)
+          Wice.log "invalid parameters for the grid boolean filter - must be an one item array: #{opts.inspect}"
+          return false
+        end
+        opts = opts[0]
+        if opts == 'f'
+          [" (#{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} = ? or #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} is null) ", false]
+        elsif opts == 't'
+          [" #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} = ?", true]
+        else
+          nil
+        end
+      end
+    end
+
+  end
+
+end

data/lib/columns/column_custom_dropdown.rb

@@ -0,0 +1,119 @@
+# encoding: UTF-8
+module Wice
+
+  module Columns #:nodoc:
+
+    class ViewColumnCustomDropdown < ViewColumn #:nodoc:
+      include ActionView::Helpers::FormOptionsHelper
+
+      attr_accessor :filter_all_label
+      attr_accessor :custom_filter
+
+      def render_filter_internal(params) #:nodoc:
+        @query, @query_without_equals_sign, @parameter_name, @dom_id = form_parameter_name_id_and_query('')
+        @query_without_equals_sign += '%5B%5D='
+
+        @custom_filter = @custom_filter.call if @custom_filter.kind_of? Proc
+
+        if @custom_filter.kind_of? Array
+
+          @custom_filter = [[@filter_all_label, nil]] + @custom_filter.map{|label, value|
+            [label.to_s, value.to_s]
+          }
+
+        end
+
+        select_options = {:name => @parameter_name + '[]', :id => @dom_id, :class => 'custom-dropdown'}
+
+        if @turn_off_select_toggling
+          select_toggle = ''
+        else
+          if self.allow_multiple_selection
+            select_options[:multiple] = params.is_a?(Array) && params.size > 1
+
+            expand_icon_style, collapse_icon_style = nil, 'display: none'
+            expand_icon_style, collapse_icon_style = collapse_icon_style, expand_icon_style if select_options[:multiple]
+
+            select_toggle = content_tag(:span, '',
+              :title => NlMessage['expand'],
+              :class => 'expand-multi-select-icon clickable',
+              :style => expand_icon_style
+            ) +
+            content_tag(:span, '',
+              :title => NlMessage['collapse'],
+              :class => 'collapse-multi-select-icon clickable',
+              :style => collapse_icon_style
+            )
+          else
+            select_options[:multiple] = false
+            select_toggle = ''
+          end
+        end
+
+        if auto_reload
+          select_options[:class] += ' auto-reload'
+        end
+
+        params_for_select = (params.is_a?(Hash) && params.empty?) ? [nil] : params
+
+        '<div class="custom-dropdown-container">'.html_safe +
+          content_tag(:select,
+            options_for_select(@custom_filter, params_for_select),
+            select_options) +  select_toggle.html_safe + '</div>'.html_safe
+      end
+
+
+      def yield_declaration_of_column_filter #:nodoc:
+        {
+          :templates => [@query_without_equals_sign],
+          :ids       => [@dom_id]
+        }
+      end
+
+
+      def has_auto_reloading_select? #:nodoc:
+        auto_reload
+      end
+    end
+
+
+    class ConditionsGeneratorColumnCustomDropdown < ConditionsGeneratorColumn #:nodoc:
+
+      def generate_conditions(table_alias, opts)   #:nodoc:
+        if opts.empty? || (opts.is_a?(Array) && opts.size == 1 && opts[0].blank?)
+          return false
+        end
+        opts = (opts.kind_of?(Array) && opts.size == 1) ? opts[0] : opts
+
+        if opts.kind_of?(Array)
+          opts_with_special_values, normal_opts = opts.partition{|v| ::Wice::GridTools.special_value(v)}
+
+          conditions_ar = if normal_opts.size > 0
+            [" #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} IN ( " + (['?'] * normal_opts.size).join(', ') + ' )'] + normal_opts
+          else
+            []
+          end
+
+          if opts_with_special_values.size > 0
+            special_conditions = opts_with_special_values.collect{|v| " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} is " + v}.join(' or ')
+            if conditions_ar.size > 0
+              conditions_ar[0] = " (#{conditions_ar[0]} or #{special_conditions} ) "
+            else
+              conditions_ar = " ( #{special_conditions} ) "
+            end
+          end
+          conditions_ar
+        else
+          if ::Wice::GridTools.special_value(opts)
+            " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} is " + opts
+          else
+            [" #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} = ?", opts]
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/columns/column_date.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+module Wice
+
+  module Columns #:nodoc:
+
+    class ViewColumnDate < ViewColumnDatetime #:nodoc:
+
+      @@datetime_chunk_names = %w(year month day)
+
+      def render_standard_filter_internal(params) #:nodoc:
+        '<div class="date-filter">' +
+        select_date(params[:fr], {:include_blank => true, :prefix => @name1, :id => @dom_id}) + '<br/>' +
+        select_date(params[:to], {:include_blank => true, :prefix => @name2, :id => @dom_id2}) +
+        '</div>'
+      end
+
+    end
+
+    ConditionsGeneratorColumnDate = ConditionsGeneratorColumnDatetime #:nodoc:
+
+  end
+
+end

data/lib/columns/column_datetime.rb

@@ -0,0 +1,113 @@
+# encoding: UTF-8
+module Wice
+
+  module Columns #:nodoc:
+
+    class ViewColumnDatetime < ViewColumn #:nodoc:
+      include ActionView::Helpers::DateHelper
+      include Wice::JsCalendarHelpers
+
+
+      # name_and_id_from_options in Rails Date helper does not substitute '.' with '_'
+      # like all other simpler form helpers do. Thus, overriding it here.
+      def name_and_id_from_options(options, type)  #:nodoc:
+        options[:name] = (options[:prefix] || DEFAULT_PREFIX) + (options[:discard_type] ? '' : "[#{type}]")
+        options[:id] = options[:name].gsub(/([\[\(])|(\]\[)/, '_').gsub(/[\]\)]/, '').gsub(/\./, '_').gsub(/_+/, '_')
+      end
+
+      @@datetime_chunk_names = %w(year month day hour minute)
+
+      def prepare_for_standard_filter #:nodoc:
+        x = lambda{|sym|
+          @@datetime_chunk_names.collect{|datetime_chunk_name|
+            triple = form_parameter_name_id_and_query(sym => {datetime_chunk_name => ''})
+            [triple[0], triple[3]]
+          }
+        }
+
+        @queris_ids = x.call(:fr) + x.call(:to)
+
+        _, _, @name1, _ = form_parameter_name_id_and_query({:fr => ''})
+        _, _, @name2, _ = form_parameter_name_id_and_query({:to => ''})
+      end
+
+
+      def prepare_for_calendar_filter #:nodoc:
+        query, _, @name1, @dom_id = form_parameter_name_id_and_query(:fr => '')
+        query2, _, @name2, @dom_id2 = form_parameter_name_id_and_query(:to => '')
+
+        @queris_ids = [[query, @dom_id], [query2, @dom_id2] ]
+      end
+
+
+      def render_standard_filter_internal(params) #:nodoc:
+        '<div class="date-filter">' +
+        select_datetime(params[:fr], {:include_blank => true, :prefix => @name1}) + '<br/>' +
+        select_datetime(params[:to], {:include_blank => true, :prefix => @name2}) +
+        '</div>'
+      end
+
+      def render_calendar_filter_internal(params) #:nodoc:
+
+        html1 = date_calendar_jquery(
+          params[:fr], NlMessage['date_selector_tooltip_from'], :prefix => @name1, :fire_event => auto_reload, :grid_name => self.grid.name)
+
+        html2 = date_calendar_jquery(
+          params[:to], NlMessage['date_selector_tooltip_to'],   :prefix => @name2, :fire_event => auto_reload, :grid_name => self.grid.name)
+
+        %!<div class="date-filter">#{html1}<br/>#{html2}</div>!
+      end
+
+
+      def render_filter_internal(params) #:nodoc:
+        if helper_style == :standard
+          prepare_for_standard_filter
+          render_standard_filter_internal(params)
+        else
+          prepare_for_calendar_filter
+          render_calendar_filter_internal(params)
+        end
+      end
+
+
+      def yield_declaration_of_column_filter #:nodoc:
+        {
+          :templates => @queris_ids.collect{|tuple|  tuple[0] },
+          :ids       => @queris_ids.collect{|tuple|  tuple[1] }
+        }
+      end
+
+
+      def has_auto_reloading_calendar? #:nodoc:
+        auto_reload && helper_style == :calendar
+      end
+
+    end
+
+
+
+    class ConditionsGeneratorColumnDatetime < ConditionsGeneratorColumn  #:nodoc:
+
+      def generate_conditions(table_alias, opts)   #:nodoc:
+        conditions = [[]]
+        if opts[:fr]
+          conditions[0] << " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} >= ? "
+          conditions << opts[:fr]
+        end
+
+        if opts[:to]
+          conditions[0] << " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} <= ? "
+          conditions << opts[:to]
+        end
+
+        return false if conditions.size == 1
+
+        conditions[0] = conditions[0].join(' and ')
+        conditions
+      end
+    end
+
+  end
+
+
+end

data/lib/columns/column_float.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+module Wice #:nodoc:
+
+
+  module Columns #:nodoc:
+
+    class ViewColumnFloat < ViewColumnInteger #:nodoc:
+    end
+
+    ConditionsGeneratorColumnFloat = ConditionsGeneratorColumnInteger #:nodoc:
+
+  end
+
+end

data/lib/columns/column_integer.rb

@@ -0,0 +1,63 @@
+# encoding: UTF-8
+module Wice
+
+  module Columns #:nodoc:
+
+    class ViewColumnInteger < ViewColumn #:nodoc:
+
+      def render_filter_internal(params) #:nodoc:
+        @contains_a_text_input = true
+
+        @query, _, parameter_name, @dom_id = form_parameter_name_id_and_query(:eq => '')
+
+        opts = {:size => 3, :id => @dom_id,  :class => 'range-start'}
+
+        if auto_reload
+          opts[:class] += ' auto-reload'
+        end
+
+        text_field_tag(parameter_name,  params[:eq], opts)
+      end
+
+      def yield_declaration_of_column_filter #:nodoc:
+        {
+          :templates => [@query],
+          :ids       => [@dom_id]
+        }
+      end
+
+      def has_auto_reloading_input? #:nodoc:
+        auto_reload
+      end
+    end
+
+
+    class ConditionsGeneratorColumnInteger < ConditionsGeneratorColumn  #:nodoc:
+
+      def  generate_conditions(table_alias, opts)   #:nodoc:
+        unless opts.kind_of? Hash
+          Wice.log "invalid parameters for the grid integer filter - must be a hash"
+          return false
+        end
+        conditions = [[]]
+        if opts[:eq]
+          if opts[:eq] =~ /\d/
+            conditions[0] << " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} = ? "
+            conditions << opts[:eq]
+          else
+            opts.delete(:eq)
+          end
+        end
+
+        if conditions.size == 1
+          return false
+        end
+
+        conditions[0] = conditions[0].join(' and ')
+
+        conditions
+      end
+    end
+
+  end
+end

data/lib/columns/column_processor_index.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+module Wice #:nodoc:
+  module Columns #:nodoc:
+    COLUMN_PROCESSOR_INDEX = ActiveSupport::OrderedHash[ #:nodoc:
+      :action   , 'column_action', # Special processor for action column, columns with checkboxes
+      :text     , 'column_string',
+      :string   , 'column_string',
+      :timestamp, 'column_datetime',
+      :datetime , 'column_datetime',
+      :date     , 'column_date',
+      :integer  , 'column_integer',
+      :range    , 'column_range',
+      :float    , 'column_float',
+      :decimal  , 'column_float',
+      :custom   , 'column_custom_dropdown',  # Special processor for custom filter columns
+      :boolean  , 'column_boolean'
+    ]
+  end
+end