wice_grid 3.0.4 → 3.2.0.pre1

data/lib/wice_grid_controller.rb

@@ -40,6 +40,7 @@ module Wice
     #   HTTP parametes, DOM IDs, etc. The shorter the name, the shorter the GET request is. The name can only contain alphanumeruc characters.
     # * <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
@@ -60,14 +61,12 @@ module Wice
     #   all pages with the current filters. Can be a lambda object or a controller method name (symbol). The argument to
     #   the callback is a lambda object which returns the list of records when called. See the README for the explanation.
     #
-    # Defaults for parameters <tt>:per_page</tt>, <tt>:order_direction</tt>, <tt>:name</tt>, and <tt>:erb_mode</tt>
+    # Defaults for parameters <tt>:per_page</tt>, <tt>:order_direction</tt>, and <tt>:name</tt>
     # can be changed in <tt>lib/wice_grid_config.rb</tt>, this is convenient if you want to set a project wide setting
     # without having to repeat it for every grid instance.
 
 
     def initialize_grid(klass, opts = {})
-      Wice::JsAdaptor.init
-      @__wice_grid_on_page = true
       wg = WiceGrid.new(klass, self, opts)
       self.wice_grid_instances = [] if self.wice_grid_instances.nil?
       self.wice_grid_instances << wg
@@ -134,28 +133,28 @@ module Wice
     # * <tt>:grid_name</tt> - The name of the grid. Just like parameter <tt>:name</tt> of
     #   <tt>initialize_grid</tt>, the parameter is optional, and when absent, the name
     #   <tt>'grid'</tt> is assumed
-    # * <tt>:attribute_name</tt> and <tt>:model_class</tt> - should be the same as <tt>:attribute_name</tt> and
-    #   <tt>:model_class</tt> of the column declaration with the target custom filter.
+    # * <tt>:attribute</tt> and <tt>:model</tt> - should be the same as <tt>:attribute</tt> and
+    #   <tt>:model</tt> of the column declaration with the target custom filter.
     # * <tt>:value</tt> - the value of the column filter.
     def wice_grid_custom_filter_params(opts = {})
       options = {:grid_name => 'grid',
-                 :attribute_name => nil,
-                 :model_class => nil,
+                 :attribute => nil,
+                 :model => nil,
                  :value => nil}
       options.merge!(opts)
 
-      [:attribute_name, :value].each do |key|
+      [:attribute, :value].each do |key|
         raise ::Wice::WiceGridArgumentError.new("wice_grid_custom_filter_params: :#{key} is a mandatory argument") unless options[key]
       end
 
-      attr_name = if options[:model_class]
-        unless options[:model_class].nil?
-          options[:model_class] = options[:model_class].constantize if options[:model_class].is_a? String
-          raise Wice::WiceGridArgumentError.new("Option :model_class can be either a class or a string instance") unless options[:model_class].is_a? Class
+      attr_name = if options[:model]
+        unless options[:model].nil?
+          options[:model] = options[:model].constantize if options[:model].is_a? String
+          raise Wice::WiceGridArgumentError.new("Option :model can be either a class or a string instance") unless options[:model].is_a? Class
         end
-        options[:model_class].table_name + '.' + options[:attribute_name]
+        options[:model].table_name + '.' + options[:attribute]
       else
-        options[:attribute_name]
+        options[:attribute]
       end
 
       {"#{options[:grid_name]}[f][#{attr_name}][]" => options[:value]}
@@ -165,7 +164,7 @@ module Wice
 
 
     def send_file_rails2(path, options = {}) #:doc:
-      raise MissingFile, "Cannot read file #{path}" unless File.file?(path) and File.readable?(path)
+      raise "Cannot read file #{path}" unless File.file?(path) and File.readable?(path)
 
       options[:length]   ||= File.size(path)
       options[:filename] ||= File.basename(path) unless options[:url_based_filename]

data/lib/wice_grid_misc.rb

@@ -71,11 +71,11 @@ module Wice
   end
 
 
-  module WiceGridNlMessageProvider #:nodoc:
+  module NlMessage #:nodoc:
     class << self
 
-      def get_message(key) #:nodoc:
-        translated = I18n.t(key.to_s.downcase, :scope => 'wice_grid')
+      def [](key) #:nodoc:
+        translated = I18n.t(key, :scope => 'wice_grid')
       end
 
     end

data/lib/wice_grid_serialized_queries_controller.rb

@@ -28,17 +28,13 @@ module Wice
           if params[:current]
             @current = @query_store_model.find_by_id_and_grid_name(params[:current], @grid_name)
           end
-          @notification_messages = WiceGridNlMessageProvider.get_message(:QUERY_DELETED_MESSAGE)
+          @notification_messages = NlMessage['query_deleted_message']
         else
           @error_messages = sq.errors.full_raw_messages.join(' ')
         end
       end
-      template_name = if Wice::ConfigurationProvider.value_for(:JS_FRAMEWORK) == :prototype
-        'delete'
-      else
-        'delete_jq'
-      end
-      render :file => "#{Pathname.new(__FILE__).dirname}/views/#{template_name}.rjs"
+
+      render_asyns_result
     end
 
     def create  #:nodoc:
@@ -56,16 +52,12 @@ module Wice
 
       if @saved_query.save
         @grid_title_id = "#{@grid_name}_title"
-        @notification_messages = WiceGridNlMessageProvider.get_message(:QUERY_SAVED_MESSAGE)
+        @notification_messages = NlMessage['query_saved_message']
       else
         @error_messages = @saved_query.errors.map{ |_, msg| msg }.join(' ')
       end
-      template_name = if Wice::ConfigurationProvider.value_for(:JS_FRAMEWORK) == :prototype
-        'create'
-      else
-        'create_jq'
-      end
-      render :file => "#{Pathname.new(__FILE__).dirname}/views/#{template_name}.rjs"
+
+      render_asyns_result
     end
 
     def extra
@@ -74,13 +66,18 @@ module Wice
 
     protected
 
+    def render_asyns_result
+      render :json => {
+        'error_messages' => @error_messages,
+        'notification_messages' => @notification_messages,
+        'query_list' => render_to_string(:inline => '<%=saved_queries_list(@grid_name, @saved_query, controller.extra, @confirm).html_safe%>')
+      }
+    end
+
     def init  #:nodoc:
       @query_store_model = ::Wice::get_query_store_model
-
+      @confirm = params[:confirm] == '1' || params[:confirm] == 'true'
       @grid_name = params[:grid_name]
-      @notification_messages_dom_id = "#{@grid_name}_notification_messages"
-      @query_list_dom_id = "#{@grid_name}_query_list"
-
     end
   end
 end

data/lib/wice_grid_spreadsheet.rb

@@ -6,7 +6,7 @@ module Wice
 
     attr_reader :tempfile
     # CSV in 1.9.1 is a version of FasterCSV
-    if RUBY_VERSION == '1.9.1' || RUBY_VERSION == '1.9.2'
+    if RUBY_VERSION =~ /1\.9\./
 
       def initialize(name, field_separator)  #:nodoc:
         @tempfile = Tempfile.new(name)
@@ -16,7 +16,7 @@ module Wice
       def << (row)  #:nodoc:
         @csv << row
       end
-      
+
     else
       def initialize(name, field_separator)  #:nodoc:
         @tempfile = Tempfile.new(name)

data/lib/will_paginate_paginator.rb

@@ -0,0 +1,31 @@
+module Wice
+  class WillPaginatePaginator < ::WillPaginate::ActionView::LinkRenderer
+    def html_container(html)
+      tag(:div,
+        tag(:ul, html),
+        container_attributes
+      )
+    end
+
+    def page_number(page)
+      if page == current_page
+        tag(:li, link(page, page, :rel => rel_value(page)), :class => 'active')
+      else
+        tag(:li, link(page, page, :rel => rel_value(page)))
+      end
+    end
+
+    def previous_or_next_page(page, text, classname)
+      if page
+        tag(:li, link(text, page))
+      else
+        tag(:li, link(text, page), :class => 'disabled')
+      end
+    end
+
+    def gap
+      '<li class="disabled"><a href="#">...</a></li>'
+    end
+
+  end
+end

data/test/readme.txt

@@ -0,0 +1 @@
+all tests are (temporarily) in a separate application: https://github.com/leikind/wice_grid_testbed

data/vendor/assets/javascripts/wice_grid.js

@@ -0,0 +1,3 @@
+//= require wice_grid_processor
+//= require wice_grid_init
+//= require wice_grid_saved_queries_init

data/vendor/assets/javascripts/wice_grid_init.js.coffee

@@ -0,0 +1,247 @@
+jQuery ->
+  initWiceGrid()
+
+initWiceGrid = ->
+
+  $(".wice-grid-container").each (index, wiceGridContainer) ->
+
+    gridName = wiceGridContainer.id
+    dataDiv = $(".wg-data", wiceGridContainer)
+
+    processorInitializerArguments = dataDiv.data("processor-initializer-arguments")
+
+    filterDeclarations = dataDiv.data("filter-declarations")
+
+    focusElementIfNeeded dataDiv.data("foc")
+
+    gridProcessor = new WiceGridProcessor(gridName,
+      processorInitializerArguments[0], processorInitializerArguments[1],
+      processorInitializerArguments[2], processorInitializerArguments[3],
+      processorInitializerArguments[4], processorInitializerArguments[5])
+
+    for filterDeclaration in filterDeclarations
+      do (filterDeclaration) ->
+        gridProcessor.register
+          filterName : filterDeclaration.filterName
+          detached    : filterDeclaration.detached
+          templates   : filterDeclaration.declaration.templates
+          ids         : filterDeclaration.declaration.ids
+
+    window[gridName] = gridProcessor
+
+    setupDatepicker()
+    setupSubmitReset wiceGridContainer, gridProcessor
+    setupCsvExport wiceGridContainer, gridProcessor
+    setupHidingShowingOfFilterRow wiceGridContainer
+    setupShowingAllRecords wiceGridContainer, gridProcessor
+    setupMultiSelectToggle wiceGridContainer
+    setupAutoreloadsForInternalFilters wiceGridContainer, gridProcessor
+    setupBulkToggleForActionColumn wiceGridContainer
+
+  setupAutoreloadsForExternalFilters()
+  setupExternalSubmitReset()
+  setupExternalCsvExport()
+
+# datepicker logic
+setupDatepicker = ->
+  # check if datepicker is loaded
+  if $('.wice-grid-container input.check-for-datepicker[type=hidden], .wg-detached-filter input.check-for-datepicker[type=hidden]').length != 0
+    unless $.datepicker
+      alert """Seems like you do not have jQuery datepicker (http://jqueryui.com/demos/datepicker/)
+        installed. Either install it or set Wice::Defaults::HELPER_STYLE to :standard in
+        wice_grid_config.rb in order to use standard Rails date helpers
+      """
+
+  # setting up the locale for datepicker
+  if locale = $('.wice-grid-container input[type=hidden], .wg-detached-filter input[type=hidden]').data('locale')
+    $.datepicker.setDefaults($.datepicker.regional[locale]);
+
+
+  $('.wice-grid-container .date-label, .wg-detached-filter .date-label').each  (index, removeLink) ->
+    datepickerHiddenField  = $('#' + $(removeLink).data('dom-id'))
+
+    eventToTriggerOnChange = datepickerHiddenField.data('close-calendar-event-name')
+
+    # setting up the remove link for datepicker
+    $(removeLink).click (event) ->
+      $(this).html('')
+      datepickerHiddenField.val('')
+      if eventToTriggerOnChange
+        datepickerHiddenField.trigger(eventToTriggerOnChange)
+      event.preventDefault()
+      false
+    that = this
+
+    # datepicker constructor
+    datepickerHiddenField.datepicker
+      firstDay:        1
+      showOn:          "button"
+      dateFormat:      datepickerHiddenField.data('date-format')
+      buttonImage:     datepickerHiddenField.data('button-image')
+      buttonImageOnly: true
+      buttonText:      datepickerHiddenField.data('button-text')
+      changeMonth:     true
+      changeYear:      true
+      onSelect: (dateText, inst) ->
+        $(that).html(dateText)
+        if eventToTriggerOnChange
+          datepickerHiddenField.trigger(eventToTriggerOnChange)
+
+
+
+# hiding and showing the row with filters
+setupHidingShowingOfFilterRow = (wiceGridContainer) ->
+  hideFilter = '.wg-hide-filter'
+  showFilter = '.wg-show-filter'
+  filterRow = '.wg-filter-row'
+
+  $(hideFilter, wiceGridContainer).click ->
+    $(this).hide()
+    $(showFilter, wiceGridContainer).show()
+    $(filterRow, wiceGridContainer).hide()
+
+  $(showFilter, wiceGridContainer).click ->
+    $(this).hide()
+    $(hideFilter, wiceGridContainer).show()
+    $(filterRow, wiceGridContainer).show()
+
+
+setupCsvExport = (wiceGridContainer, gridProcessor) ->
+  $('.export-to-csv-button', wiceGridContainer).click ->
+    gridProcessor.exportToCsv()
+
+
+# trigger submit/reset from within the grid
+setupSubmitReset = (wiceGridContainer, gridProcessor) ->
+  $('.submit', wiceGridContainer).click ->
+    gridProcessor.process()
+
+  $('.reset', wiceGridContainer).click ->
+    gridProcessor.reset()
+
+  $('.wg-filter-row input[type=text]', wiceGridContainer).keydown (event) ->
+    if event.keyCode == 13
+      event.preventDefault()
+      gridProcessor.process()
+
+
+focusElementIfNeeded = (focusId) ->
+  elements = $('#' + focusId)
+  if elToFocus = elements[0]
+    elToFocus.value = elToFocus.value
+    elToFocus.focus()
+
+
+# autoreload for internal filters
+setupAutoreloadsForInternalFilters = (wiceGridContainer, gridProcessor) ->
+  $('select.auto-reload', wiceGridContainer).change ->
+    gridProcessor.process()
+
+  $('input.auto-reload', wiceGridContainer).keyup ->
+    gridProcessor.setProcessTimer(this.id)
+
+  $('input.negation-checkbox.auto-reload', wiceGridContainer).click ->
+    gridProcessor.process()
+
+  $(document).bind 'wg:calendarChanged_' + gridProcessor.name, ->
+    gridProcessor.process()
+
+# autoreload for internal filters
+setupAutoreloadsForExternalFilters =  ->
+
+  $('.wg-detached-filter').each (index, detachedFilterContainer) ->
+    gridProcessor = getGridProcessorForElement(detachedFilterContainer)
+    if gridProcessor
+      $('select.auto-reload', detachedFilterContainer).change ->
+        gridProcessor.process()
+
+      $('input.auto-reload', detachedFilterContainer).keyup ->
+        gridProcessor.setProcessTimer(this.id)
+
+      $('input.negation-checkbox.auto-reload', detachedFilterContainer).click ->
+        gridProcessor.process()
+
+
+# trigger the all records mode
+setupShowingAllRecords = (wiceGridContainer, gridProcessor) ->
+  $('.wg-show-all-link, .wg-back-to-pagination-link', wiceGridContainer).click (event) ->
+    event.preventDefault()
+    gridState = $(this).data("grid-state")
+    confirmationMessage = $(this).data("confim-message")
+    reloadGrid = ->
+      gridProcessor.reloadPageForGivenGridState gridState
+    if confirmationMessage
+      if confirm(confirmationMessage)
+        reloadGrid()
+    else
+      reloadGrid()
+
+# dropdown filter multiselect
+setupMultiSelectToggle = (wiceGridContainer)->
+  $('.expand-multi-select-icon', wiceGridContainer).click ->
+    $(this).prev().each (index, select) ->
+      select.multiple = true
+    $(this).next().show()
+    $(this).hide()
+
+  $('.collapse-multi-select-icon', wiceGridContainer).click ->
+    $(this).prev().prev().each (index, select) ->
+      select.multiple = false
+    $(this).prev().show()
+    $(this).hide()
+
+
+setupBulkToggleForActionColumn = (wiceGridContainer) ->
+  $('.select-all', wiceGridContainer).click ->
+    $('.sel input', wiceGridContainer).prop('checked', true)
+
+  $('.deselect-all', wiceGridContainer).click ->
+    $('.sel input', wiceGridContainer).prop('checked', false)
+
+
+getGridProcessorForElement = (element) ->
+  gridName = $(element).data('grid-name')
+  if gridName
+    window[gridName]
+  else
+    null
+
+
+setupExternalCsvExport =  ->
+
+  $(".wg-external-csv-export-button").each (index, externalCsvExportButton) ->
+    gridProcessor = getGridProcessorForElement(externalCsvExportButton)
+    if gridProcessor
+      $(externalCsvExportButton).click (event) ->
+        gridProcessor.exportToCsv()
+
+
+setupExternalSubmitReset =  ->
+
+  $(".wg-external-submit-button").each (index, externalSubmitButton) ->
+    gridProcessor = getGridProcessorForElement(externalSubmitButton)
+    if gridProcessor
+      $(externalSubmitButton).click (event) ->
+        gridProcessor.process()
+        event.preventDefault()
+        false
+
+  $(".wg-external-reset-button").each (index, externalResetButton) ->
+    gridProcessor = getGridProcessorForElement(externalResetButton)
+    if gridProcessor
+      $(externalResetButton).click (event) ->
+        gridProcessor.reset()
+        event.preventDefault()
+        false
+
+
+  $('.wg-detached-filter').each (index, detachedFilterContainer) ->
+    gridProcessor = getGridProcessorForElement(detachedFilterContainer)
+    if gridProcessor
+      $('input[type=text]', this).keydown (event) ->
+        if event.keyCode == 13
+          gridProcessor.process()
+          event.preventDefault()
+          false
+
+window['getGridProcessorForElement'] = getGridProcessorForElement