wice_grid 3.4.2 → 3.4.3

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

@@ -66,6 +66,28 @@ if defined?(Wice::Defaults)
   Wice::Defaults::NEGATION_IN_STRING_FILTERS = false
 
 
+  # Each WiceGrid filter column is defined in two classes, one used for rendering the filter, the other
+  # for generating query conditions. All these columns are in lib/wice/columns/*.rb .
+  # File lib/wice/columns/column_processor_index.rb lists all predefined processors.
+  # In most cases a processor is chosen automatically based on the DB column type,
+  # for example, integer columns
+  # can have two of processors, the default one with one input field, and a processor called "range",
+  # with 2 input fields. In this case it is possible to specify a processor in the column definition:
+  #
+  #     g.column filter_type: :range
+  #
+  # It is also possible to define you own processors:
+  #
+  #     Wice::Defaults::ADDITIONAL_COLUMN_PROCESSORS = {
+  #       some_key_identifying_new_column_type:  ['AViewColumnProcessorClass', 'ConditionsGeneratorClass'],
+  #       another_key_identifying_new_column_type:  ['AnotherViewColumnProcessorClass', 'AnotherConditionsGeneratorClass']
+  #     }
+  #
+  # Column processor keys/names should not coincide with the existing keys/names (see lib/wice/columns/column_processor_index.rb)
+  # the value is a 2-element array with 2 strings, the first should be a name of view processor class inherited from
+  # Wice::Columns::ViewColumn, the second should be a name of conditions generator class inherited from
+  # Wice::Columns::ConditionsGeneratorColumn .
+
 
   # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
   #                              Showing All Queries                          #

data/lib/wice/columns.rb

@@ -3,7 +3,10 @@ module Wice #:nodoc:
 
   module Columns #:nodoc:
 
+    mattr_reader :handled_type_view, :handled_type_conditions_generator
+
     class << self #:nodoc:
+
       def load_column_processors #:nodoc:
 
         require_columns
@@ -12,6 +15,51 @@ module Wice #:nodoc:
 
         @@handled_type_view                 = build_table_of_processors 'view'
         @@handled_type_conditions_generator = build_table_of_processors 'conditions_generator'
+
+        if Wice::Defaults.const_defined?(:ADDITIONAL_COLUMN_PROCESSORS)
+
+          common_error_prefix = "Error loading Wice::Defaults::ADDITIONAL_COLUMN_PROCESSORS. "
+
+          Wice::Defaults::ADDITIONAL_COLUMN_PROCESSORS.each do |key, value|
+            unless key.is_a?(Symbol)
+              raise common_error_prefix + "A key of Wice::Defaults::ADDITIONAL_COLUMN_PROCESSORS should be a Symbol!"
+            end
+
+            if @@handled_type_view.has_key?(key)
+              raise common_error_prefix +
+                "Column with key \"#{key}\" already exists in WiceGrid, overwriting existing columns is forbidden, please choose another key!"
+            end
+
+            if ! value.is_a?(Array) || value.size != 2
+              raise common_error_prefix +
+                "A value of Wice::Defaults::ADDITIONAL_COLUMN_PROCESSORS should be a a 2-element array!"
+            end
+
+            view_processor, conditions_generator  = value.map(&:to_s).map do |klass|
+              begin
+                eval(klass)
+              rescue NameError
+                raise common_error_prefix + "Class #{klass} is not defined!"
+              end
+            end
+
+            unless view_processor.ancestors.include?(::Wice::Columns::ViewColumn)
+              raise common_error_prefix +
+                "#{view_processor} should be inherited from Wice::Columns::ViewColumn!"
+            end
+
+
+            unless conditions_generator.ancestors.include?(::Wice::Columns::ConditionsGeneratorColumn)
+              raise common_error_prefix +
+                "#{conditions_generator} should be inherited from Wice::Columns::ConditionsGeneratorColumn!"
+            end
+
+            @@handled_type_view[key] = view_processor
+            @@handled_type_conditions_generator[key] = conditions_generator
+
+          end
+        end
+
       end
 
       def get_view_column_processor(column_type) #:nodoc:
@@ -88,6 +136,7 @@ module Wice #:nodoc:
 
 
       def add_css_class(klass_value)
+        self.html ||= {}
         if html[:class].nil?
           html[:class] = klass_value
         else
@@ -97,7 +146,11 @@ module Wice #:nodoc:
       end
 
       def css_class #:nodoc:
-        html[:class] || ''
+        if html && html[:class]
+          html[:class]
+        else
+          ''
+        end
       end
 
       def yield_declaration_of_column_filter #:nodoc:

data/lib/wice/columns/column_datetime.rb

@@ -109,12 +109,12 @@ module Wice
         conditions = [[]]
         if opts[:fr]
           conditions[0] << " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} >= ? "
-          conditions << opts[:fr]
+          conditions << opts[:fr].to_date
         end
 
         if opts[:to]
-          conditions[0] << " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} <= ? "
-          conditions << opts[:to]
+          conditions[0] << " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} < ? "
+          conditions << (opts[:to].to_date + 1)
         end
 
         return false if conditions.size == 1

data/lib/wice/columns/column_integer.rb

@@ -35,6 +35,23 @@ module Wice
 
 
     class ConditionsGeneratorColumnInteger < ConditionsGeneratorColumn  #:nodoc:
+      def get_op_and_value(val)
+        num = nil
+        op  = nil
+
+        # remove spaces
+        val = val.gsub(' ','')
+
+        first_digit_or_dot_index = val =~ /[0-9.]/
+        if first_digit_or_dot_index
+          op = val[0...first_digit_or_dot_index]
+          op = '=' if op == ''
+          num = Float(val[first_digit_or_dot_index..-1]) rescue nil
+
+          op = nil unless ['<','>','<=','>=','='].include?(op)
+        end
+        [op, num]
+      end
 
       def  generate_conditions(table_alias, opts)   #:nodoc:
         unless opts.kind_of? Hash
@@ -43,9 +60,10 @@ module Wice
         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]
+          op, num = get_op_and_value(opts[:eq])
+          if op && num
+            conditions[0] << " #{@column_wrapper.alias_or_table_name(table_alias)}.#{@column_wrapper.name} " + op + " ? "
+            conditions << num
           else
             opts.delete(:eq)
           end
@@ -62,4 +80,4 @@ module Wice
     end
 
   end
-end
+end

data/lib/wice/grid_renderer.rb

@@ -11,6 +11,7 @@ module Wice
     attr_reader :page_parameter_name
     attr_reader :after_row_handler
     attr_reader :before_row_handler
+    attr_reader :replace_row_handler
     attr_reader :blank_slate_handler
     attr_reader :last_row_handler
     attr_reader :grid
@@ -311,6 +312,7 @@ module Wice
       end
 
       if options[:class]
+        options[:html] ||= {}
         Wice::WgHash.add_or_append_class_value!(options[:html], options[:class])
         options.delete(:class)
       end
@@ -409,6 +411,12 @@ module Wice
       @before_row_handler = block
     end
 
+    # Can be used to replace the HTML code (for example to make a multi-column spanning row) of a row.
+    # Nothing is replaced if the block return +false+ or +nil+.
+    def replace_row(&block)
+      @replace_row_handler = block
+    end
+
     # Can be used to add HTML code (calculation results, for example) after all rows.
     # Nothing is added if the block return +false+ or +nil+.
     def last_row(&block)
@@ -464,16 +472,14 @@ module Wice
       end
 
       new_params[:only_path] = false
-      base_link_with_pp_info = controller.url_for(new_params).gsub(/\?+$/,'')
+      base_link_with_pp_info = omit_empty_query controller.url_for(new_params)
 
       if new_params[@grid.name]
         new_params[@grid.name].delete(:pp)    # and reset back to pagination if show all mode is on
       end
-      [base_link_with_pp_info, controller.url_for(new_params).gsub(/\?+$/,'')]
+      [base_link_with_pp_info, omit_empty_query(controller.url_for(new_params))]
     end
 
-
-
     def link_for_export(controller, format, extra_parameters = {})   #:nodoc:
       new_params = Wice::WgHash.deep_clone controller.params
       new_params.merge!(extra_parameters)
@@ -519,5 +525,15 @@ module Wice
       method_name ? @columns.select(&method_name) : @columns
     end
 
+    def omit_empty_query(url) #:nodoc:
+      # /foo?                --> /foo
+      # /foo?grid=           --> /foo
+      # /foo?grid=&page=1    --> /foo?page=1
+      # /foo?grid=some_value --> /foo?grid=some_value
+
+      empty_hash_rx = Regexp.new "([&?])#{Regexp.escape @grid.name}=([&?]|$)" # c.f., issue #140
+      url.gsub(empty_hash_rx, '\1').gsub /\?+$/, ''
+    end
+
   end
 end

data/lib/wice/helpers/wice_grid_view_helpers.rb

@@ -166,6 +166,56 @@ module Wice
       extra_argument ? block.call(ar, extra_argument) : block.call(ar)
     end
 
+    def get_row_content(rendering, ar, sorting_dependant_row_cycling)
+      cell_value_of_the_ordered_column = nil
+      row_content = ''
+      rendering.each_column(:in_html) do |column|
+        cell_block = column.cell_rendering_block
+
+        opts = column.html
+
+        opts = opts ? opts.clone : {}
+
+        column_block_output = if column.class == Columns.get_view_column_processor(:action)
+          cell_block.call(ar, params)
+        else
+          call_block(cell_block, ar)
+        end
+
+        if column_block_output.kind_of?(Array)
+
+          unless column_block_output.size == 2
+            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)
+            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
+
+          additional_css_class = nil
+          if additional_opts.has_key?(:class)
+            additional_css_class = additional_opts[:class]
+            additional_opts.delete(:class)
+          elsif additional_opts.has_key?('class')
+            additional_css_class = additional_opts['class']
+            additional_opts.delete('class')
+          end
+          opts.merge!(additional_opts)
+          Wice::WgHash.add_or_append_class_value!(opts, additional_css_class) unless additional_css_class.blank?
+        end
+
+        if sorting_dependant_row_cycling && column.attribute && grid.ordered_by?(column)
+          cell_value_of_the_ordered_column = column_block_output
+        end
+        row_content += content_tag(:td, column_block_output, opts)
+      end
+      [row_content, cell_value_of_the_ordered_column]
+    end
+
     # the longest method? :(
     def grid_html(grid, options, rendering, reuse_last_column_for_filter_buttons) #:nodoc:
 
@@ -192,7 +242,7 @@ module Wice
       # Ruby 1.9.x
       grid.output_buffer.force_encoding('UTF-8') if grid.output_buffer.respond_to?(:force_encoding)
 
-      grid.output_buffer << %!<div class="wice-grid-container" id="#{grid.name}"><div id="#{grid.name}_title">!
+      grid.output_buffer << %!<div class="wice-grid-container" data-grid-name="#{grid.name}" id="#{grid.name}"><div id="#{grid.name}_title">!
       grid.output_buffer << content_tag(:h3, grid.saved_query.name) if grid.saved_query
       grid.output_buffer << "</div><table #{tag_options(table_html_attrs, true)}>"
       grid.output_buffer << "<caption>#{rendering.kaption}</caption>" if rendering.kaption
@@ -241,6 +291,13 @@ module Wice
 
         column_name = column.name
 
+        opts = column.html
+
+        opts = opts ? opts.clone : {}
+
+        Wice::WgHash.add_or_append_class_value!(opts, column.css_class)
+
+
         if column.attribute && column.ordering
 
           column.add_css_class('active-filter') if grid.filtered_by?(column)
@@ -258,7 +315,7 @@ module Wice
             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, column.css_class))
+          grid.output_buffer << content_tag(:th, col_link, opts)
 
         else
           if reuse_last_column_for_filter_buttons && last
@@ -266,7 +323,7 @@ module Wice
               hide_show_icon(filter_row_id, grid, filter_shown, no_filter_row, options[:show_filters], rendering)
             )
           else
-            grid.output_buffer << content_tag(:th, column_name)
+            grid.output_buffer << content_tag(:th, column_name, opts)
           end
         end
       end
@@ -299,23 +356,27 @@ module Wice
           grid.output_buffer << '>'
 
           rendering.each_column_aware_of_one_last_one(:in_html) do |column, last|
+
+            opts = column.html ? column.html.clone : {}
+            Wice::WgHash.add_or_append_class_value!(opts, column.css_class)
+
             if column.filter_shown?
 
               filter_html_code = column.render_filter.html_safe
               if column.detach_with_id
-                grid.output_buffer << content_tag(:th, '', Wice::WgHash.make_hash(:class, column.css_class))
+                grid.output_buffer << content_tag(:th, '', opts)
                 grid.output_buffer.add_filter(column.detach_with_id, filter_html_code)
               else
-                grid.output_buffer << content_tag(:th, filter_html_code, Wice::WgHash.make_hash(:class, column.css_class))
+                grid.output_buffer << content_tag(:th, filter_html_code, opts)
               end
             else
               if reuse_last_column_for_filter_buttons && last
                 grid.output_buffer << content_tag(:th,
                   reset_submit_buttons(options, grid, rendering),
-                  Wice::WgHash.add_or_append_class_value!(Wice::WgHash.make_hash(:class, column.css_class), 'filter_icons')
+                  Wice::WgHash.add_or_append_class_value!(opts, 'filter_icons')
                 )
               else
-                grid.output_buffer << content_tag(:th, '', Wice::WgHash.make_hash(:class, column.css_class))
+                grid.output_buffer << content_tag(:th, '', opts)
               end
             end
           end
@@ -359,48 +420,19 @@ module Wice
           nil
         end
 
-        row_content = ''
-        rendering.each_column(:in_html) do |column|
-          cell_block = column.cell_rendering_block
-
-          opts = column.html.clone
-
-          column_block_output = if column.class == Columns.get_view_column_processor(:action)
-            cell_block.call(ar, params)
-          else
-            call_block(cell_block, ar)
-          end
-
-          if column_block_output.kind_of?(Array)
-
-            unless column_block_output.size == 2
-              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)
-              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
-
-            additional_css_class = nil
-            if additional_opts.has_key?(:class)
-              additional_css_class = additional_opts[:class]
-              additional_opts.delete(:class)
-            elsif additional_opts.has_key?('class')
-              additional_css_class = additional_opts['class']
-              additional_opts.delete('class')
-            end
-            opts.merge!(additional_opts)
-            Wice::WgHash.add_or_append_class_value!(opts, additional_css_class) unless additional_css_class.blank?
-          end
+        replace_row_output = if rendering.replace_row_handler
+          call_block(rendering.replace_row_handler, ar, number_of_columns_for_extra_rows)
+        else
+          nil
+        end
 
-          if sorting_dependant_row_cycling && column.attribute && grid.ordered_by?(column)
-            cell_value_of_the_ordered_column = column_block_output
-          end
-          row_content += content_tag(:td, column_block_output, opts)
+        row_content = if replace_row_output
+          no_rightmost_column = true
+          replace_row_output
+        else
+          row_content, tmp_cell_value_of_the_ordered_column = get_row_content(rendering,ar,sorting_dependant_row_cycling)
+          cell_value_of_the_ordered_column = tmp_cell_value_of_the_ordered_column if tmp_cell_value_of_the_ordered_column
+          row_content
         end
 
         row_attributes = rendering.get_row_attributes(ar)

data/lib/wice/memory_adapter.rb

@@ -0,0 +1,172 @@
+# encoding: UTF-8
+module Wice
+  module MemoryAdapter
+    class MemoryAdapter
+      def initialize(rows, columns, kaminarafy = true)
+        @rows = rows
+        @klass = MemoryAdapterKlass.new(columns, self)
+        @columns = Set.new
+        columns.each do |col|
+          @columns << col.name.to_sym
+        end
+        @page_num = 1
+        @per_page = 20
+      end
+
+      def klass
+        @klass
+      end
+
+      def total_count
+        length
+      end
+
+      def length
+        @rows.length
+      end
+
+      # 1-based page number
+      def current_page
+        @page_num
+      end
+
+      def limit_value
+        @per_page
+      end
+
+      def total_pages
+        total_pages=(length.to_f / @per_page).ceil
+        total_pages
+      end
+
+      # 0-based index into array
+      def offset_value
+        @page_num = total_pages if current_page > total_pages
+
+        offset_value = (current_page-1) * @per_page
+        offset_value
+      end
+
+      def num_pages
+        total_pages
+      end
+
+      def last_page?
+        last_page = current_page==total_pages
+        last_page
+      end
+
+      def includes(*opts)
+        self
+      end
+
+      def joins(*opts)
+        self
+      end
+
+      def order(*opts)
+        self
+      end
+
+      def where(*opts)
+        self
+      end
+
+      def page(num)
+        @page_num=num.to_i
+        @page_num =1 if @page_num < 1
+        self
+      end
+
+      def per(num)
+        @per_page=num.to_i
+        @per_page = 1 if @per_page < 1
+        self
+      end
+
+      def each
+        start_index = offset_value
+        end_index = offset_value + @per_page
+        slice = @rows[start_index...end_index]
+        if slice
+          slice.each do |row|
+            yield Row.new(row, self)
+          end
+        end
+      end
+
+      def has_column?(col)
+        @columns.include?(col)
+      end
+    end
+
+    class MemoryAdapterKlass
+      def initialize(columns, memory_adapter)
+        @columns = columns
+        @memory_adapter = memory_adapter
+      end
+
+      def columns
+        @columns
+      end
+
+      def table_name
+        SecureRandom.hex
+      end
+
+      def merge_conditions(*conditions)
+        ""
+      end
+
+      def unscoped(&code)
+        #@memory_adapter.unscope
+        code.call
+        self
+      end
+
+      def connection
+      end
+    end
+
+    class Row
+      def initialize(row, memory_adapter)
+        @row=row
+        @memory_adapter = memory_adapter
+      end
+
+      def method_missing(m, *args, &block)
+        if @memory_adapter.has_column?(m)
+          @row[m]
+        else
+          super
+        end
+      end
+    end
+
+    class Column
+      def initialize(name)
+        @name = name.to_s
+        @model = Model.new
+      end
+
+      def name
+        @name
+      end
+
+      def model
+        @model
+      end
+
+      def model=(model)
+        @model=model
+      end
+
+      def type
+        :string
+      end
+    end
+
+    class Model
+    end
+  end
+end