wice_grid 3.0.4 → 3.2.0.pre1

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

@@ -1,13 +1,5 @@
 if defined?(Wice::Defaults)
 
-  Wice::Defaults::JS_FRAMEWORK = :<%= active_js_framework %>
-  # Wice::Defaults::JS_FRAMEWORK = :<%= inactive_js_framework %>
-
-  # Style of the view helper.
-  # +false+ is a usual view helper.
-  # +true+ will allow to embed erb content in column (cell) definitions.
-  Wice::Defaults::ERB_MODE = false
-
   # Default number of rows to show per page.
   Wice::Defaults::PER_PAGE = 20
 
@@ -23,30 +15,11 @@ if defined?(Wice::Defaults)
   # for filter related icons (filter icon, reset icon, show/hide icon), otherwise an additional table column is added.
   Wice::Defaults::REUSE_LAST_COLUMN_FOR_FILTER_ICONS = true
 
-  Wice::Defaults::SHOW_HIDE_FILTER_ICON = 'icons/grid/page_white_find.png'
-
-
-  # Icon to trigger filtering.
-  Wice::Defaults::FILTER_ICON = 'icons/grid/table_refresh.png'
-
-  # Icon to reset the filter.
-  Wice::Defaults::RESET_ICON = "icons/grid/table.png"
-
-  # Icon to reset the filter.
-  Wice::Defaults::TOGGLE_MULTI_SELECT_ICON = "/images/icons/grid/expand.png"
-
-  # CSV Export icon.
-  Wice::Defaults::CSV_EXPORT_ICON = "/images/icons/grid/page_white_excel.png"
-
-  # Tick-All icon for the action column.
-  Wice::Defaults::TICK_ALL_ICON = "/images/icons/grid/tick_all.png"
-
-  # Untick-All icon for the action column.
-  Wice::Defaults::UNTICK_ALL_ICON = "/images/icons/grid/untick_all.png"
-
   # The label of the first option of a custom dropdown list meaning 'All items'
   Wice::Defaults::CUSTOM_FILTER_ALL_LABEL = '--'
 
+  # A list of classes for the table tag of the grid
+  Wice::Defaults::DEFAULT_TABLE_CLASSES = ['table', 'table-bordered', 'table-striped']
 
   # Allow switching between a single and multiple selection modes in custom filters (dropdown boxes)
   Wice::Defaults::ALLOW_MULTIPLE_SELECTION = true
@@ -54,9 +27,12 @@ if defined?(Wice::Defaults)
   # Show the upper pagination panel by default or not
   Wice::Defaults::SHOW_UPPER_PAGINATION_PANEL = false
 
-  # Enabling CSV export by default
+  # Disabling CSV export by default
   Wice::Defaults::ENABLE_EXPORT_TO_CSV = false
 
+  # 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
@@ -67,11 +43,6 @@ if defined?(Wice::Defaults)
   # A boolean value specifying if a change in a filter triggers reloading of the grid.
   Wice::Defaults::AUTO_RELOAD = false
 
-  # If set to an integer (including 0), in integer and float filters the second field will be
-  # dynamically updated when the first field is updated
-  Wice::Defaults::SECOND_RANGE_VALUE_FOLLOWING_THE_FIRST = false
-  # Wice::Defaults::SECOND_RANGE_VALUE_FOLLOWING_THE_FIRST = 1
-
 
   # SQL operator used for matching strings in string filters.
   Wice::Defaults::STRING_MATCHING_OPERATOR = 'LIKE'
@@ -109,9 +80,6 @@ if defined?(Wice::Defaults)
   # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
   #                               Saving Queries                              #
 
-  # Icon to delete a saved query
-  Wice::Defaults::DELETE_QUERY_ICON = 'icons/grid/delete.png'
-
   # ActiveRecord model to store queries. Read the documentation for details
   # QUERY_STORE_MODEL = 'WiceGridSerializedQuery'
   Wice::Defaults::QUERY_STORE_MODEL = 'WiceGridSerializedQuery'
@@ -143,7 +111,9 @@ if defined?(Wice::Defaults)
   # 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|
-    if Time.zone
+    if datetime_string.blank?
+      nil
+    elsif Time.zone
       Time.zone.parse(datetime_string)
     else
       Time.parse(datetime_string)
@@ -155,10 +125,16 @@ if defined?(Wice::Defaults)
   # 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| Date.parse(date_string) }
+  Wice::Defaults::DATE_PARSER = lambda{|date_string|
+    if date_string.blank?
+      nil
+    else
+      Date.parse(date_string)
+    end
+  }
 
   # Icon to popup the calendar.
-  Wice::Defaults::CALENDAR_ICON = "/images/icons/grid/calendar_view_month.png"
+  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

data/lib/grid_output_buffer.rb

@@ -7,7 +7,6 @@ module Wice
     attr_accessor :return_empty_strings_for_nonexistent_filters
 
     def stubborn_output_mode=(m)
-      RAILS_DEFAULT_LOGGER.debug("=== WiceGrid: detached filters are requested, postponing output till the second call of the view helper") if m
       @stubborn_output_mode = m
     end
 
@@ -40,7 +39,9 @@ module Wice
           raise  WiceGridException.new("No filter with Detached ID '#{detach_with_id}'!")
         end
       end
-      raise  WiceGridException.new("Filter with Detached ID '#{detach_with_id}' has already been requested once! There cannot be two instances of the same filter on one page") if @filters[detach_with_id] == false
+      if @filters[detach_with_id] == false
+        raise  WiceGridException.new("Filter with Detached ID '#{detach_with_id}' has already been requested once! There cannot be two instances of the same filter on one page")
+      end
       res = @filters[detach_with_id]
       @filters[detach_with_id] = false
       return res

data/lib/grid_renderer.rb

@@ -14,9 +14,6 @@ module Wice
     attr_reader :blank_slate_handler
     attr_reader :last_row_handler
     attr_reader :grid
-    attr_accessor :erb_mode
-
-    attr_accessor :reset_button_present, :submit_button_present, :show_hide_button_present, :csv_export_icon_present
 
     @@order_parameter_name = "order"
     @@order_direction_parameter_name = "order_direction"
@@ -41,7 +38,7 @@ module Wice
 
 
     def add_column(vc)  #:nodoc:
-      @columns_table[vc.fully_qualified_attribute_name] = vc if vc.attribute_name
+      @columns_table[vc.fully_qualified_attribute_name] = vc if vc.attribute
       @columns << vc
     end
 
@@ -54,21 +51,17 @@ module Wice
     end
 
     def each_column_label(filter = nil)  #:nodoc:
-      filter_columns(filter).each{|col| yield col.column_name}
+      filter_columns(filter).each{|col| yield col.name}
     end
 
     def column_labels(filter = nil)  #:nodoc:
-      filter_columns(filter).collect(&:column_name)
+      filter_columns(filter).collect(&:name)
     end
 
     def each_column(filter = nil)  #:nodoc:
       filter_columns(filter).each{|col| yield col}
     end
 
-    def contains_a_text_input?  #:nodoc:
-      filter_columns(:in_html).detect(&:contains_a_text_input)
-    end
-
     def each_column_aware_of_one_last_one(filter = nil)  #:nodoc:
       cols = filter_columns(filter)
       cols[0..-2].each{|col| yield col, false}
@@ -89,30 +82,24 @@ module Wice
 
 
     def each_column_with_attribute  #:nodoc:
-      @columns.select(&:attribute_name).each{|col| yield col}
+      @columns.select(&:attribute).each{|col| yield col}
     end
 
     alias_method :each, :each_column
     include Enumerable
 
     def csv_export_icon #:nodoc:
-      tooltip = WiceGridNlMessageProvider.get_message(:CSV_EXPORT_TOOLTIP)
-      @csv_export_icon_present = true
-      image_tag(Defaults::CSV_EXPORT_ICON,
-        :title => tooltip,
-        :class => 'clickable export_to_csv_button',
-        :alt   => tooltip
+      content_tag(:div, '',
+        :title => NlMessage['csv_export_tooltip'],
+        :class => 'clickable export-to-csv-button'
       )
     end
 
-    def pagination_panel(no_rightmost_column, hide_csv_button)  #:nodoc:
+    def pagination_panel(number_of_columns, hide_csv_button)  #:nodoc:
       panel = yield
 
       render_csv_button = @grid.export_to_csv_enabled && ! hide_csv_button
 
-      number_of_columns = self.number_of_columns(:in_html)
-      number_of_columns -= 1 if no_rightmost_column
-
       if panel.nil?
         if render_csv_button
           "<tr><td colspan=\"#{number_of_columns}\"></td><td>#{csv_export_icon}</td></tr>"
@@ -128,11 +115,6 @@ module Wice
       end
     end
 
-    def element_to_focus  #:nodoc:
-      grid.status['foc']
-    end
-
-
     # Adds a column with checkboxes for each record. Useful for actions with multiple records, for example, deleting
     # selected records. Please note that +action_column+ only creates the checkboxes and the 'Select All' and
     # 'Deselect All' buttons, and the form itelf as well as processing the parameters should be taken care of
@@ -141,7 +123,7 @@ module Wice
     # * <tt>:param_name</tt> - The name of the HTTP parameter.
     #   The complete HTTP parameter is <tt>"#{grid_name}[#{param_name}][]"</tt>.
     #   The default param_name is 'selected'.
-    # * <tt>:td_html_attrs</tt> - a hash of HTML attributes to be included into the <tt>td</tt> tag.
+    # * <tt>:html</tt> - a hash of HTML attributes to be included into the <tt>td</tt> tag.
     # * <tt>:select_all_buttons</tt> - show/hide buttons 'Select All' and 'Deselect All' in the column header.
     #   The default is +true+.
     # * <tt>:object_property</tt> - a method used to obtain the value for the HTTP parameter. The default is +id+.
@@ -153,7 +135,7 @@ module Wice
 
       options = {
         :param_name     => :selected,
-        :td_html_attrs  => {},
+        :html           => {},
         :select_all_buttons => true,
         :object_property => :id
       }
@@ -161,7 +143,9 @@ module Wice
       opts.assert_valid_keys(options.keys)
       options.merge!(opts)
       @action_column_present = true
-      @columns << ActionViewColumn.new(@grid, options[:td_html_attrs], options[:param_name],
+      column_processor_klass = ViewColumn.get_column_processor(:action)
+
+      @columns << column_processor_klass.new(@grid, options[:html], options[:param_name],
             options[:select_all_buttons], options[:object_property], @view)
     end
 
@@ -172,15 +156,15 @@ module Wice
     # The only parameter is a hash of options. None of them is optional. If no options are supplied, the result will be a
     # column with no name, no filtering and no sorting.
     #
-    # * <tt>:column_name</tt> - Name of the column.
-    # * <tt>:td_html_attrs</tt> - a hash of HTML attributes to be included into the <tt>td</tt> tag.
-    # * <tt>:class</tt> - a shortcut for <tt>:td_html_attrs => {:class => 'css_class'}</tt>
-    # * <tt>:attribute_name</tt> - name of a database column (which normally correspond to a model attribute with the
+    # * <tt>:name</tt> - Name of the column.
+    # * <tt>:html</tt> - a hash of HTML attributes to be included into the <tt>td</tt> tag.
+    # * <tt>:class</tt> - a shortcut for <tt>:html => {:class => 'css_class'}</tt>
+    # * <tt>:attribute</tt> - name of a database column (which normally correspond to a model attribute with the
     #   same name). By default the field is assumed to belong to the default table (see documentation for the
-    #   +initialize_grid+ method). Parameter <tt>:model_class</tt> allows to specify another table. Presence of
+    #   +initialize_grid+ method). Parameter <tt>:model</tt> allows to specify another table. Presence of
     #   this parameter
     #   * adds sorting capabilities by this field
-    #   * automatically creates a filter based on the type of the field unless parameter <tt>:no_filter</tt> is set to true.
+    #   * automatically creates a filter based on the type of the field unless parameter <tt>:filter</tt> is set to false.
     #     The following filters exist for the following types:
     #     * <tt>string</tt> - a text field
     #     * <tt>integer</tt> and <tt>float</tt>  - two text fields to specify the range. Both limits or only one
@@ -190,11 +174,11 @@ module Wice
     #     * <tt>date</tt> - two sets of standard date dropdown lists so specify the time range.
     #     * <tt>datetime</tt> - two sets of standard datetime dropdown lists so specify the time range. This filter
     #       is far from being user-friendly due to the number of dropdown lists.
-    # * <tt>:no_filter</tt> - Turns off filters even if <tt>:attribute_name</tt> is specified.
+    # * <tt>:filter</tt> - Disables filters when set to false.
     #   This is needed if sorting is required while  filters are not.
-    # * <tt>:allow_ordering</tt> - Enable/disable ordering links in the column titles. The default is +true+
-    #   (i.e. if <tt>:attribute_name</tt> is defined, ordering is enabled)
-    # * <tt>:model_class</tt> - Name of the model class to which <tt>:attribute_name</tt> belongs to if this is not the main table.
+    # * <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>:model</tt> - Name of the model class to which <tt>:attribute</tt> belongs to if this is not the main table.
     # * <tt>:table_alias</tt> - In case there are two joined assocations both referring to the same table, ActiveRecord
     #   constructs a query where the second join provides an alias for the joined table. Setting <tt>:table_alias</tt>
     #   to this alias will enable WiceGrid to order and filter by columns belonging to different associatiations  but
@@ -208,8 +192,8 @@ module Wice
     #   * Hash - The keys of the hash become the labels of the generated dropdown list,
     #     while the values will be values of options of the dropdown list:
     #   * <tt>:auto</tt> - a powerful option which populates the dropdown list with all unique values of the field specified by
-    #     <tt>:attribute_name</tt> and <tt>:model_class</tt>.
-    #     <tt>:attribute_name</tt> throughout all pages. In other words, this runs an SQL query without +offset+ and +limit+
+    #     <tt>:attribute</tt> and <tt>:model</tt>.
+    #     <tt>:attribute</tt> throughout all pages. In other words, this runs an SQL query without +offset+ and +limit+
     #     clauses and  with <tt>distinct(table.field)</tt> instead of <tt>distinct(*)</tt>
     #   * any other symbol name (method name) - The dropdown list is populated by all unique value returned by the
     #     method with this name sent to <em>all</em> ActiveRecord objects throughout all pages. The main difference
@@ -253,9 +237,9 @@ module Wice
     # * <tt>:helper_style</tt> - Changes the flavor of Date and DateTime filters. The values are:
     #   * <tt>:standard</tt> - the default Rails Date/DateTime helper
     #   * <tt>:calendar</tt> - a Javascript popup calendar control
-    # * <tt>:negation_in_filter</tt> - turn on/off the negation checkbox in string filters
+    # * <tt>:negation</tt> - turn on/off the negation checkbox in string filters
     # * <tt>:auto_reload</tt> - a boolean value specifying if a change in a filter triggers reloading of the grid. Works with all
-    #   filter types including the JS calendar, the only exception is the standard Rails date/datetime filters. 
+    #   filter types including the JS calendar, the only exception is the standard Rails date/datetime filters.
     #   The default is false. (see +AUTO_RELOAD+ in the configuration file).
     #
     # The block parameter is an ActiveRecord instance. This block is called for every ActiveRecord shown, and the return
@@ -264,71 +248,70 @@ module Wice
     # tag of the current cell.
     #
     # In case of an array output, please note that if you need to define HTML attributes for all <tt><td></tt>'s in a
-    # column, use +td_html_attrs+. Also note that if the method returns a hash with a <tt>:class</tt> or <tt>'class'</tt>
-    # element, it will not overwrite the class defined in +td_html_attrs+, or classes added by the grid itself
-    # (+active_filter+ and +sorted+), instead they will be all concatenated:
+    # column, use +html+. Also note that if the method returns a hash with a <tt>:class</tt> or <tt>'class'</tt>
+    # element, it will not overwrite the class defined in +html+, or classes added by the grid itself
+    # (+active-filter+ and +sorted+), instead they will be all concatenated:
     # <tt><td class="sorted user_class_for_columns user_class_for_this_specific_cell"></tt>
     #
     # It is up to the developer to make sure that what in rendered in column cells
-    # corresponds to sorting and filtering specified by parameters <tt>:attribute_name</tt> and <tt>:model_class</tt>.
+    # corresponds to sorting and filtering specified by parameters <tt>:attribute</tt> and <tt>:model</tt>.
 
     def column(opts = {}, &block)
       options = {
         :allow_multiple_selection   => Defaults::ALLOW_MULTIPLE_SELECTION,
-        :allow_ordering             => true,
-        :attribute_name             => nil,
+        :ordering                   => true,
+        :attribute                  => nil,
         :auto_reload                => Defaults::AUTO_RELOAD,
-        :boolean_filter_false_label => WiceGridNlMessageProvider.get_message(:BOOLEAN_FILTER_FALSE_LABEL),
-        :boolean_filter_true_label  => WiceGridNlMessageProvider.get_message(:BOOLEAN_FILTER_TRUE_LABEL),
+        :boolean_filter_false_label => NlMessage['boolean_filter_false_label'],
+        :boolean_filter_true_label  => NlMessage['boolean_filter_true_label'],
         :class                      => nil,
-        :column_name                => '',
+        :name                       => '',
         :custom_filter              => nil,
-        :custom_order               => nil,
         :detach_with_id             => nil,
         :filter_all_label           => Defaults::CUSTOM_FILTER_ALL_LABEL,
         :helper_style               => Defaults::HELPER_STYLE,
         :in_csv                     => true,
         :in_html                    => true,
-        :model_class                => nil,
-        :negation_in_filter         => Defaults::NEGATION_IN_STRING_FILTERS,
-        :no_filter                  => false,
+        :model                      => nil,
+        :negation                   => Defaults::NEGATION_IN_STRING_FILTERS,
+        :filter                     => true,
         :table_alias                => nil,
-        :td_html_attrs              => {}
+        :html                       => {}
       }
 
       opts.assert_valid_keys(options.keys)
       options.merge!(opts)
 
-      unless options[:model_class].nil?
-        options[:model_class] = options[:model_class].constantize if options[:model_class].is_a? String
-        raise WiceGridArgumentError.new("Option :model_class can be either a class or a string instance") unless options[:model_class].is_a? Class
+      unless options[:model].nil?
+        options[:model] = options[:model].constantize if options[:model].is_a? String
+        raise WiceGridArgumentError.new("Option :model can be either a class or a string instance") unless options[:model].is_a? Class
       end
 
-      if options[:attribute_name].nil? && options[:model_class]
-        raise WiceGridArgumentError.new("Option :model_class is only used together with :attribute_name")
+      if options[:attribute].nil? && options[:model]
+        raise WiceGridArgumentError.new("Option :model is only used together with :attribute")
       end
 
-      if options[:attribute_name] && options[:attribute_name].index('.')
-        raise WiceGridArgumentError.new("Invalid attribute name #{options[:attribute_name]}. An attribute name must not contain a table name!")
+      if options[:attribute] && options[:attribute].index('.')
+        raise WiceGridArgumentError.new("Invalid attribute name #{options[:attribute]}. An attribute name must not contain a table name!")
       end
 
       if options[:class]
-        options[:td_html_attrs].add_or_append_class_value!(options[:class])
+        options[:html].add_or_append_class_value!(options[:class])
         options.delete(:class)
       end
 
       if block.nil?
-        if ! options[:attribute_name].blank?
-          block = lambda{|obj| obj.send(options[:attribute_name])}
+        if ! options[:attribute].blank?
+          block = lambda{|obj| obj.send(options[:attribute])}
         else
           raise WiceGridArgumentError.new(
-            "Missing column block without attribute_name defined. You can only omit the block if attribute_name is present.")
+            "Missing column block without attribute defined. You can only omit the block if attribute is present.")
         end
       end
 
       klass = ViewColumn
-      if options[:attribute_name] &&
-          col_type_and_table_name = @grid.declare_column(options[:attribute_name], options[:model_class],
+      if options[:attribute] &&
+          col_type_and_table_name = @grid.declare_column(options[:attribute], options[:model],
             options[:custom_filter],  options[:table_alias])
 
         db_column, table_name, main_table = col_type_and_table_name
@@ -369,18 +352,19 @@ module Wice
             end
           end
 
-          klass = ViewColumnCustomDropdown
+          klass = ViewColumn.get_column_processor(:custom)
         else
-          klass = ViewColumn.handled_type[col_type] || ViewColumn
+          klass = ViewColumn.get_column_processor(col_type)
         end # custom_filter
-      end # attribute_name
+
+      end # attribute
 
       vc = klass.new(block, options, @grid, table_name, main_table, custom_filter, @view)
 
-      vc.negation    = options[:negation_in_filter] if vc.respond_to? :negation=
+      vc.negation = options[:negation] if vc.respond_to? :negation=
 
-      vc.filter_all_label = options[:filter_all_label] if vc.kind_of?(ViewColumnCustomDropdown)
-      if vc.kind_of?(ViewColumnBoolean)
+      vc.filter_all_label = options[:filter_all_label] if vc.kind_of?(ViewColumn.get_column_processor(:custom))
+      if vc.kind_of?(ViewColumn.get_column_processor(:boolean))
         vc.boolean_filter_true_label = options[:boolean_filter_true_label]
         vc.boolean_filter_false_label = options[:boolean_filter_false_label]
       end
@@ -487,10 +471,10 @@ module Wice
 
     def column_link(column, direction, params, extra_parameters = {})   #:nodoc:
 
-      column_attribute_name = if column.attribute_name.index('.') or column.main_table
-        column.attribute_name
+      column_attribute_name = if column.attribute.index('.') or column.main_table
+        column.attribute
       else
-        column.table_alias_or_table_name + '.' + column.attribute_name
+        column.table_alias_or_table_name + '.' + column.attribute
       end
 
       query_params = {@grid.name => {
@@ -510,32 +494,9 @@ module Wice
       '?' + query_params.to_query
     end
 
-    def contains_auto_reloading_inputs #:nodoc:
-      contains_auto_reloading_elements(:has_auto_reloading_input?)
-    end
-
-    def contains_auto_reloading_inputs_with_negation_checkboxes #:nodoc:
-      contains_auto_reloading_elements(:auto_reloading_input_with_negation_checkbox?)
-    end
-
-    def contains_auto_reloading_selects #:nodoc:
-      contains_auto_reloading_elements(:has_auto_reloading_select?)
-    end
-
-    def contains_auto_reloading_calendars #:nodoc:
-      contains_auto_reloading_elements(:has_auto_reloading_calendar?)
-    end
-
-    def contains_range_filters
-      filter_columns(:in_html).detect{|column| column.filter_shown? && column.is_a?(ViewColumnInteger)}
-    end
 
     protected
 
-    def contains_auto_reloading_elements(what) #:nodoc:
-      filter_columns(:in_html).detect{|column| column.filter_shown? && column.send(what)}
-    end
-
 
     def filter_columns(method_name = nil) #:nodoc:
       method_name ? @columns.select(&method_name) : @columns