wice_grid 3.2.0 → 3.2.1.pre1

data/lib/columns/column_range.rb

@@ -0,0 +1,74 @@
+# encoding: UTF-8
+module Wice
+
+  module Columns #:nodoc:
+
+    class ViewColumnRange < ViewColumn #:nodoc:
+
+      def render_filter_internal(params) #:nodoc:
+        @contains_a_text_input = true
+
+        @query, _, parameter_name, @dom_id = form_parameter_name_id_and_query(:fr => '')
+        @query2, _, parameter_name2, @dom_id2 = form_parameter_name_id_and_query(:to => '')
+
+        opts1 = {:size => 3, :id => @dom_id,  :class => 'range-start'}
+        opts2 = {:size => 3, :id => @dom_id2, :class => 'range-end'}
+
+        if auto_reload
+          opts1[:class] += ' auto-reload'
+          opts2[:class] += ' auto-reload'
+        end
+
+        text_field_tag(parameter_name,  params[:fr], opts1) + text_field_tag(parameter_name2, params[:to], opts2)
+      end
+
+      def yield_declaration_of_column_filter #:nodoc:
+        {
+          :templates => [@query, @query2],
+          :ids       => [@dom_id, @dom_id2]
+        }
+      end
+
+      def has_auto_reloading_input? #:nodoc:
+        auto_reload
+      end
+    end
+
+
+    class ConditionsGeneratorColumnRange < 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[:fr]
+          if opts[:fr] =~ /\d/
+            conditions[0] << " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} >= ? "
+            conditions << opts[:fr]
+          else
+            opts.delete(:fr)
+          end
+        end
+
+        if opts[:to]
+          if opts[:to] =~ /\d/
+            conditions[0] << " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} <= ? "
+            conditions << opts[:to]
+          else
+            opts.delete(:to)
+          end
+        end
+
+        if conditions.size == 1
+          return false
+        end
+
+        conditions[0] = conditions[0].join(' and ')
+
+        conditions
+      end
+    end
+  end
+end

data/lib/columns/column_string.rb

@@ -0,0 +1,89 @@
+# encoding: UTF-8
+module Wice
+
+  module Columns #:nodoc:
+
+    class ViewColumnString < ViewColumn #:nodoc:
+
+      attr_accessor :negation, :auto_reloading_input_with_negation_checkbox
+
+      def render_filter_internal(params) #:nodoc:
+        @contains_a_text_input = true
+        css_class = auto_reload ? 'auto-reload' : nil
+
+        if negation
+          self.auto_reloading_input_with_negation_checkbox = true if auto_reload
+
+          @query, _, parameter_name, @dom_id = form_parameter_name_id_and_query(:v => '')
+          @query2, _, parameter_name2, @dom_id2 = form_parameter_name_id_and_query(:n => '')
+
+          '<div class="text-filter-container">' +
+            text_field_tag(parameter_name, params[:v], :size => 8, :id => @dom_id, :class => css_class) +
+            if defined?(Wice::Defaults::NEGATION_CHECKBOX_LABEL) && ! Wice::ConfigurationProvider.value_for(:NEGATION_CHECKBOX_LABEL).blank?
+              Wice::ConfigurationProvider.value_for(:NEGATION_CHECKBOX_LABEL)
+            else
+              ''
+            end +
+            check_box_tag(parameter_name2, '1', (params[:n] == '1'),
+              :id => @dom_id2,
+              :title => NlMessage['negation_checkbox_title'],
+              :class => "negation-checkbox #{css_class}") +
+            '</div>'
+        else
+          @query, _, parameter_name, @dom_id = form_parameter_name_id_and_query('')
+          text_field_tag(parameter_name, (params.blank? ? '' : params), :size => 8, :id => @dom_id, :class => css_class)
+        end
+      end
+
+
+      def yield_declaration_of_column_filter #:nodoc:
+        if negation
+          {
+            :templates => [@query, @query2],
+            :ids       => [@dom_id, @dom_id2]
+          }
+        else
+          {
+            :templates => [@query],
+            :ids       => [@dom_id]
+          }
+        end
+      end
+
+
+      def has_auto_reloading_input? #:nodoc:
+        auto_reload
+      end
+
+      def auto_reloading_input_with_negation_checkbox? #:nodoc:
+        self.auto_reloading_input_with_negation_checkbox
+      end
+
+    end
+
+
+    class ConditionsGeneratorColumnString < ConditionsGeneratorColumn  #:nodoc:
+
+      def generate_conditions(table_alias, opts)   #:nodoc:
+        if opts.kind_of? String
+          string_fragment = opts
+          negation = ''
+        elsif (opts.kind_of? Hash) && opts.has_key?(:v)
+          string_fragment = opts[:v]
+          negation = opts[:n] == '1' ? 'NOT' : ''
+        else
+          Wice.log "invalid parameters for the grid string filter - must be a string: #{opts.inspect} or a Hash with keys :v and :n"
+          return false
+        end
+        if string_fragment.empty?
+          return false
+        end
+        [
+          " #{negation}  #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} #{::Wice.get_string_matching_operators(@column_wrapper.model)} ?",
+          '%' + string_fragment + '%'
+        ]
+      end
+
+    end
+  end
+end

data/lib/columns.rb

@@ -0,0 +1,223 @@
+# encoding: UTF-8
+module Wice #:nodoc:
+
+  module Columns #:nodoc:
+
+    class << self #:nodoc:
+      def load_column_processors #:nodoc:
+
+        require_columns
+
+        loaded_view_column_processors = Hash.new
+
+        @@handled_type_view                 = build_table_of_processors 'view'
+        @@handled_type_conditions_generator = build_table_of_processors 'conditions_generator'
+      end
+
+      def get_view_column_processor(column_type) #:nodoc:
+        @@handled_type_view[column_type] || ViewColumn
+      end
+
+      def get_conditions_generator_column_processor(column_type) #:nodoc:
+        column_type = column_type.intern if column_type.is_a? String
+        @@handled_type_conditions_generator[column_type] || raise("Could not find conditions generator processor for column_type #{column_type}")
+      end
+
+
+      private
+
+      def build_table_of_processors(prefix)
+        Hash.new.tap do |processor_table|
+          loaded_processors = Hash.new
+
+          Wice::Columns::COLUMN_PROCESSOR_INDEX.each do |column_type, column_source_file|
+            unless loaded_processors[column_source_file]
+              processor_class_name = "#{prefix}_#{column_source_file}".classify
+
+              unless Wice::Columns.const_defined?(processor_class_name.intern)
+                raise "#{column_source_file}.rb is expected to define #{processor_class_name}!"
+              end
+              processor_class = eval("Wice::Columns::#{processor_class_name}")
+
+              loaded_processors[column_source_file] = processor_class
+            end
+
+            processor_table[column_type] = loaded_processors[column_source_file]
+          end
+        end
+      end
+
+      def require_columns
+        Wice::Columns::COLUMN_PROCESSOR_INDEX.values.uniq do |column_source_file|
+          require "columns/#{column_source_file}.rb"
+        end
+      end
+
+    end
+
+    class ViewColumn  #:nodoc:
+
+
+      include ActionView::Helpers::FormTagHelper
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::JavaScriptHelper
+      include ActionView::Helpers::AssetTagHelper
+
+      # fields defined from the options parameter
+      FIELDS = [:attribute, :name, :html, :filter, :model, :allow_multiple_selection,
+                :in_html, :in_csv, :helper_style, :table_alias, :custom_order, :detach_with_id, :ordering, :auto_reload]
+
+      attr_accessor *FIELDS
+
+      attr_accessor :cell_rendering_block, :grid,  :table_name, :main_table, :model, :custom_filter
+
+      attr_reader :contains_a_text_input
+
+      def initialize(block, options, grid_obj, tname, mtable, cfilter, view)  #:nodoc:
+        self.cell_rendering_block = block
+        self.grid           = grid_obj
+        self.table_name     = tname
+        self.main_table     = mtable
+        self.custom_filter  = cfilter
+        @view = view
+
+        FIELDS.each do |field|
+          self.send(field.to_s + '=', options[field])
+        end
+      end
+
+
+      def add_css_class(klass_value)
+        if html[:class].nil?
+          html[:class] = klass_value
+        else
+          html[:class] << ' ' unless html[:class].empty?
+          html[:class] << klass_value
+        end
+      end
+
+      def css_class #:nodoc:
+        html[:class] || ''
+      end
+
+      def yield_declaration_of_column_filter #:nodoc:
+        nil
+      end
+
+      def detachness #:nodoc:
+        (! detach_with_id.blank?).to_s
+      end
+
+      def yield_declaration #:nodoc:
+        declaration = yield_declaration_of_column_filter
+        if declaration
+          {
+            :filterName => self.name,
+            :detached    => detachness,
+            :declaration => declaration
+          }
+        end
+      end
+
+
+      def config  #:nodoc:
+        @view.config
+      end
+
+      def controller  #:nodoc:
+        @view.controller
+      end
+
+
+      def render_filter #:nodoc:
+        params = @grid.filter_params(self)
+        render_filter_internal(params)
+      end
+
+      def render_filter_internal(params) #:nodoc:
+        '<!-- implement me! -->'
+      end
+
+      def form_parameter_name_id_and_query(v) #:nodoc:
+        query = form_parameter_template(v)
+        query_without_equals_sign = query.sub(/=$/,'')
+        parameter_name = CGI.unescape(query_without_equals_sign)
+        dom_id = id_out_of_name(parameter_name)
+        return 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
+      end
+
+      def fully_qualified_attribute_name #:nodoc:
+        table_alias_or_table_name + '.' + attribute
+      end
+
+
+      def filter_shown? #:nodoc:
+        self.attribute && self.filter
+      end
+
+      def filter_shown_in_main_table? #:nodoc:
+        filter_shown? && ! self.detach_with_id
+      end
+
+
+      def table_alias_or_table_name  #:nodoc:
+        table_alias || table_name
+      end
+
+      def capable_of_hosting_filter_related_icons?  #:nodoc:
+        self.attribute.blank? && self.name.blank? && ! self.filter_shown?
+      end
+
+      def has_auto_reloading_input?  #:nodoc:
+        false
+      end
+
+      def auto_reloading_input_with_negation_checkbox?  #:nodoc:
+        false
+      end
+
+      def has_auto_reloading_select?  #:nodoc:
+        false
+      end
+
+      def has_auto_reloading_calendar?  #:nodoc:
+        false
+      end
+
+      protected
+
+      def form_parameter_template(v) #:nodoc:
+        {@grid.name => {:f => {self.attribute_name_fully_qualified_for_all_but_main_table_columns => v}}}.to_query
+      end
+
+      def form_parameter_name(v) #:nodoc:
+        form_parameter_template_hash(v).to_query
+      end
+
+      def name_out_of_template(s) #:nodoc:
+        CGI.unescape(s).sub(/=$/,'')
+      end
+
+      def id_out_of_name(s) #:nodoc:
+        s.gsub(/[\[\]]+/,'_').sub(/_+$/, '')
+      end
+
+    end
+
+
+    class ConditionsGeneratorColumn   #:nodoc:
+
+      def initialize(column_wrapper)   #:nodoc:
+        @column_wrapper = column_wrapper
+      end
+    end
+
+  end
+
+
+end

data/lib/generators/wice_grid/add_migration_for_serialized_queries_generator.rb

@@ -1,7 +1,7 @@
 module WiceGrid #:nodoc:
   module Generators #:nodoc:
 
-    class AddMigrationForSerializedQueriesGenerator < Rails::Generators::Base
+    class AddMigrationForSerializedQueriesGenerator < Rails::Generators::Base  #:nodoc:
 
       include Rails::Generators::Migration
 

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

@@ -1,5 +1,5 @@
-class CreateWiceGridSerializedQueries < ::ActiveRecord::Migration
-  def change
+class CreateWiceGridSerializedQueries < ::ActiveRecord::Migration #:nodoc:
+  def change #:nodoc:
     create_table :wice_grid_serialized_queries do |t|
       t.column :name,      :string
       t.column :grid_name, :string

data/lib/grid_renderer.rb

@@ -127,7 +127,11 @@ module Wice
     # * <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+.
-    def action_column(opts = {})
+    #
+    # 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.
+
+    def action_column(opts = {}, &block)
 
       if @action_column_present
         raise Wice::WiceGridException.new('There can be only one action column in a WiceGrid')
@@ -143,10 +147,10 @@ module Wice
       opts.assert_valid_keys(options.keys)
       options.merge!(opts)
       @action_column_present = true
-      column_processor_klass = ViewColumn.get_column_processor(:action)
+      column_processor_klass = Columns.get_view_column_processor(:action)
 
       @columns << column_processor_klass.new(@grid, options[:html], options[:param_name],
-            options[:select_all_buttons], options[:object_property], @view)
+            options[:select_all_buttons], options[:object_property], @view, block)
     end
 
     # Defines everything related to a column in a grid - column name, filtering, rendering cells, etc.
@@ -176,6 +180,9 @@ module Wice
     #       is far from being user-friendly due to the number of dropdown lists.
     # * <tt>:filter</tt> - Disables filters when set to false.
     #   This is needed if sorting is required while  filters are not.
+    # * <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>: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.
@@ -275,6 +282,7 @@ module Wice
         :model                      => nil,
         :negation                   => Defaults::NEGATION_IN_STRING_FILTERS,
         :filter                     => true,
+        :filter_type                => nil,
         :table_alias                => nil,
         :html                       => {}
       }
@@ -309,10 +317,10 @@ module Wice
         end
       end
 
-      klass = ViewColumn
+      klass = Columns::ViewColumn
       if options[:attribute] &&
           col_type_and_table_name = @grid.declare_column(options[:attribute], options[:model],
-            options[:custom_filter],  options[:table_alias])
+            options[:custom_filter],  options[:table_alias], options[:filter_type])
 
         db_column, table_name, main_table = col_type_and_table_name
         col_type = db_column.type
@@ -352,9 +360,11 @@ module Wice
             end
           end
 
-          klass = ViewColumn.get_column_processor(:custom)
+          klass = Columns.get_view_column_processor(:custom)
+        elsif options[:filter_type]
+          klass = Columns.get_view_column_processor(options[:filter_type])
         else
-          klass = ViewColumn.get_column_processor(col_type)
+          klass = Columns.get_view_column_processor(col_type)
         end # custom_filter
 
       end # attribute
@@ -363,8 +373,8 @@ module Wice
 
       vc.negation = options[:negation] if vc.respond_to? :negation=
 
-      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.filter_all_label = options[:filter_all_label] if vc.kind_of?(Columns.get_view_column_processor(:custom))
+      if vc.kind_of?(Columns.get_view_column_processor(:boolean))
         vc.boolean_filter_true_label = options[:boolean_filter_true_label]
         vc.boolean_filter_false_label = options[:boolean_filter_false_label]
       end

data/lib/helpers/wice_grid_view_helpers.rb

@@ -242,12 +242,12 @@ module Wice
 
         if column.attribute && column.ordering
 
-          css_class = grid.filtered_by?(column) ? 'active-filter' : nil
+          column.add_css_class('active-filter') if grid.filtered_by?(column)
 
           direction = 'asc'
           link_style = nil
           if grid.ordered_by?(column)
-            css_class = css_class.nil? ? 'sorted' : css_class + ' sorted'
+            column.add_css_class('sorted')
             link_style = grid.order_direction
             direction = 'desc' if grid.order_direction == 'asc'
           end
@@ -256,8 +256,9 @@ module Wice
             column_name,
             rendering.column_link(column, direction, params, options[:extra_request_parameters]),
             :class => link_style)
-          grid.output_buffer << content_tag(:th, col_link, Wice::WgHash.make_hash(:class, css_class))
-          column.css_class = css_class
+
+          grid.output_buffer << content_tag(:th, col_link, Wice::WgHash.make_hash(:class, column.css_class))
+
         else
           if reuse_last_column_for_filter_buttons && last
             grid.output_buffer << content_tag(:th,
@@ -324,11 +325,6 @@ module Wice
         end
       end
 
-      rendering.each_column(:in_html) do |column|
-        unless column.css_class.blank?
-          Wice::WgHash.add_or_append_class_value!(column.html, column.css_class)
-        end
-      end
 
       grid.output_buffer << '</thead><tfoot>'
       grid.output_buffer << rendering.pagination_panel(number_of_columns, options[:hide_csv_button]) do
@@ -368,7 +364,7 @@ module Wice
 
           opts = column.html.clone
 
-          column_block_output = if column.class == ViewColumn.get_column_processor(:action)
+          column_block_output = if column.class == Columns.get_view_column_processor(:action)
             cell_block.call(ar, params)
           else
             call_block(cell_block, ar)

data/lib/kaminari_monkey_patching.rb

@@ -1,9 +1,9 @@
 # encoding: UTF-8
 # It is here only until this pull request is pulled: https://github.com/amatsuda/kaminari/pull/267
-module Kaminari
-  module Helpers
-    class Tag
-      def page_url_for(page)
+module Kaminari #:nodoc:
+  module Helpers #:nodoc:
+    class Tag #:nodoc:
+      def page_url_for(page) #:nodoc:
         current_page_params_as_query_string = @param_name.to_s + '=' + (page <= 1 ? nil : page).to_s
         current_page_params_as_hash = Rack::Utils.parse_nested_query(current_page_params_as_query_string)
         @template.url_for Wice::WgHash.rec_merge(@params, current_page_params_as_hash).symbolize_keys