wice_grid 3.0.0.pre1

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

@@ -0,0 +1,154 @@
+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
+
+  # Default order direction
+  Wice::Defaults::ORDER_DIRECTION = 'asc'
+
+  # Default name for a grid. A grid name is the basis for a lot of
+  # names including parameter names, DOM IDs, etc
+  # The shorter the name is the shorter the request URI will be.
+  Wice::Defaults::GRID_NAME = 'grid'
+
+  # If REUSE_LAST_COLUMN_FOR_FILTER_ICONS is true and the last column doesn't have any filter and column name, it will be used
+  # 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 = '--'
+
+
+  # Allow switching between a single and multiple selection modes in custom filters (dropdown boxes)
+  Wice::Defaults::ALLOW_MULTIPLE_SELECTION = true
+
+  # Show the upper pagination panel by default or not
+  Wice::Defaults::SHOW_UPPER_PAGINATION_PANEL = false
+
+  # Enabling CSV export by default
+  Wice::Defaults::ENABLE_EXPORT_TO_CSV = false
+
+
+  # The strategy when to show the filter.
+  # * <tt>:when_filtered</tt> - when the table is the result of filtering
+  # * <tt>:always</tt>        - show the filter always
+  # * <tt>:no</tt>            - never show the filter
+  Wice::Defaults::SHOW_FILTER = :always
+
+  # A boolean value specifying if a change in a filter triggers reloading of the grid.
+  Wice::Defaults::AUTO_RELOAD = false
+
+
+  # SQL operator used for matching strings in string filters.
+  Wice::Defaults::STRING_MATCHING_OPERATOR = 'LIKE'
+  # STRING_MATCHING_OPERATOR = 'ILIKE' # Use this for Postgresql case-insensitive matching.
+
+
+  # Defining one string matching operator globally for the whole application turns is not enough
+  # when you connect to two databases one of which is MySQL and the other is Postgresql.
+  # If the key for an adapter is missing it will fall back to Wice::Defaults::STRING_MATCHING_OPERATOR
+  Wice::Defaults::STRING_MATCHING_OPERATORS = {
+    'ActiveRecord::ConnectionAdapters::MysqlAdapter' => 'LIKE',
+    'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter' => 'ILIKE'
+  }
+
+
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #                              Advanced Filters                             #
+
+  # Switch of the negation checkbox in all text filters
+  Wice::Defaults::NEGATION_IN_STRING_FILTERS = false
+
+
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #                              Showing All Queries                          #
+
+  # Enable or disable showing all queries (non-paginated table)
+  Wice::Defaults::ALLOW_SHOWING_ALL_QUERIES = true
+
+  # If number of all queries is more than this value, the user will be given a warning message
+  Wice::Defaults::START_SHOWING_WARNING_FROM = 100
+
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #                               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'
+
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #            Here go settings related to the calendar helpers               #
+
+  # The default style of the date and datetime helper
+  # * <tt>:calendar</tt> - JS calendar
+  # * <tt>:standard</tt> - standard Rails date and datetime helpers
+  Wice::Defaults::HELPER_STYLE = :calendar
+
+  # Format of the datetime displayed.
+  # If you change the format, make sure to check if +DATETIME_PARSER+ can still parse this string.
+  Wice::Defaults::DATETIME_FORMAT = "%Y-%m-%d %H:%M"
+
+  # Format of the date displayed.
+  # If you change the format, make sure to check if +DATE_PARSER+ can still parse this string.
+  Wice::Defaults::DATE_FORMAT     =  "%Y-%m-%d"
+
+  # Format of the date displayed in jQuery's Datepicker
+  # If you change the format, make sure to check if +DATE_PARSER+ can still parse this string.
+  Wice::Defaults::DATE_FORMAT_JQUERY     =  "yy-mm-dd"
+
+
+  # With Calendar helpers enabled the parameter sent is the string displayed. This lambda will be given a date string in the
+  # format defined by +DATETIME_FORMAT+ and must generate a DateTime object.
+  # 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| Time.zone.parse(datetime_string) }
+
+  # With Calendar helpers enabled the parameter sent is the string displayed. This lambda will be given a date string in the
+  # 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) }
+
+  # Icon to popup the calendar.
+  Wice::Defaults::CALENDAR_ICON = "/images/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
+
+end

data/lib/generators/wice_grid/templates/wice_grid_jquery.js

@@ -0,0 +1,161 @@
+function WiceGridProcessor(name, base_request_for_filter, base_link_for_show_all_records,
+                      link_for_export, parameter_name_for_query_loading, parameter_name_for_focus, environment){
+
+   this.checkIfJsFrameworkIsLoaded = function(){
+     if (! jQuery){
+       alert("jQuery not loaded, WiceGrid cannot proceed!")
+     }
+   }
+
+  this.checkIfJsFrameworkIsLoaded();
+  this.name = name;
+  this.parameter_name_for_query_loading = parameter_name_for_query_loading;
+  this.parameter_name_for_focus = parameter_name_for_focus;
+  this.base_request_for_filter = base_request_for_filter;
+  this.base_link_for_show_all_records = base_link_for_show_all_records;
+  this.link_for_export = link_for_export;
+  this.filter_declarations = new Array();
+  this.environment = environment;
+
+  this.toString = function(){
+    return "<WiceGridProcessor instance for grid '" + this.name + "'>";
+  }
+
+
+  this.process = function(dom_id_to_focus){
+    window.location = this.build_url_with_params(dom_id_to_focus);
+  }
+
+  this.reload_page_for_given_grid_state = function(grid_state){
+    var request_path = this.grid_state_to_request(grid_state);
+    window.location = this.append_to_url(this.base_link_for_show_all_records, request_path);
+  }
+
+  this.load_query = function(query_id){
+    var request = this.append_to_url(this.build_url_with_params(),
+      (this.parameter_name_for_query_loading +  encodeURIComponent(query_id)));
+    window.location = request;
+  }
+
+  this.save_query = function(query_name, base_path_to_query_controller, grid_state, input_ids){
+    if (input_ids instanceof Array) {
+      input_ids.each(function(dom_id){
+        grid_state.push(['extra[' + dom_id + ']', $('#'+ dom_id)[0].value])
+      });
+    }
+
+    var request_path = this.grid_state_to_request(grid_state);
+
+    jQuery.ajax({
+      url: base_path_to_query_controller,
+      async: true,
+      data: request_path + '&query_name=' + encodeURIComponent(query_name),
+      dataType: 'script',
+      type: 'POST'
+    });
+  }
+
+  this.grid_state_to_request = function(grid_state){
+    return jQuery.map(grid_state, function(pair){
+      return encodeURIComponent(pair[0]) + '=' + encodeURIComponent(pair[1]);
+    }).join('&');
+  }
+
+
+  this.append_to_url = function(url, str){
+    var sep;
+    if (url.indexOf('?') != -1){
+      if (/[&\?]$/.exec(url)){
+        sep = '';
+      }else{
+        sep = '&';
+      }
+    }else{
+      sep = '?';
+    }
+    return url + sep + str;
+  }
+
+
+  this.build_url_with_params = function(dom_id_to_focus){
+    var results = new Array();
+    var _this =  this;
+    jQuery.each(this.filter_declarations, function(i, filter_declaration){
+      param = _this.read_values_and_form_query_string(
+        filter_declaration.filter_name, filter_declaration.detached,
+        filter_declaration.templates, filter_declaration.ids);
+      if (param && param != ''){
+        results.push(param);
+      }
+    });
+
+    var res = this.base_request_for_filter;
+    if ( results.length != 0){
+      all_filter_params = results.join('&');
+      res = this.append_to_url(res, all_filter_params);
+    }
+    if (dom_id_to_focus){
+      res = this.append_to_url(res, this.parameter_name_for_focus + dom_id_to_focus);
+    }
+    return res;
+  }
+
+  this.reset = function(){
+    window.location = this.base_request_for_filter;
+  }
+
+  this.export_to_csv = function(){
+    window.location = this.link_for_export;
+  }
+
+  this.register = function(func){
+    this.filter_declarations.push(func);
+  }
+
+  this.read_values_and_form_query_string = function(filter_name, detached, templates, ids){
+    var res = new Array();
+    for(i = 0; i < templates.length; i++){
+      if($(ids[i]) == null){
+        if (this.environment == "development"){
+          message = 'WiceGrid: Error reading state of filter "' + filter_name + '". No DOM element with id "' + ids[i] + '" found.'
+          if (detached){
+            message += 'You have declared "' + filter_name +
+              '" as a detached filter but have not output it anywhere in the template. Read documentation about detached filters.'
+          }
+          alert(message);
+        }
+        return '';
+      }
+      var el = $('#' + ids[i]);
+      var val;
+      if (el[0] && el[0].type == 'checkbox'){
+        if (el[0].checked) val = 1;
+      } else {
+        val = el.val();
+      }
+      if (val instanceof Array) {
+        for(j = 0; j < val.length; j++){
+          if (val[j] && val[j] != "")
+            res.push(templates[i] + encodeURIComponent(val[j]));
+        }
+      } else if (val &&  val != ''){
+        res.push(templates[i]  + encodeURIComponent(val));
+      }
+    }
+    return res.join('&');
+  }
+
+};
+
+function toggle_multi_select(select_id, link_obj, expand_label, collapse_label) {
+  var select = $('#' + select_id)[0];
+  if (select.multiple == true) {
+    select.multiple = false;
+    link_obj.title = expand_label;
+  } else {
+    select.multiple = true;
+    link_obj.title = collapse_label;
+  }
+}
+
+WiceGridProcessor._version = '0.4.3';

data/lib/generators/wice_grid/templates/wice_grid_prototype.js

@@ -0,0 +1,153 @@
+function WiceGridProcessor(name, base_request_for_filter, base_link_for_show_all_records,
+                      link_for_export, parameter_name_for_query_loading, parameter_name_for_focus, environment){
+
+  this.checkIfJsFrameworkIsLoaded = function(){
+    if (typeof(Prototype) == "undefined"){
+      alert("Prototype javascript library not loaded, WiceGrid cannot proceed!")
+    }
+  }
+
+
+  this.checkIfJsFrameworkIsLoaded();
+  this.name = name;
+  this.parameter_name_for_query_loading = parameter_name_for_query_loading;
+  this.parameter_name_for_focus = parameter_name_for_focus;
+  this.base_request_for_filter = base_request_for_filter;
+  this.base_link_for_show_all_records = base_link_for_show_all_records;
+  this.link_for_export = link_for_export;
+  this.filter_declarations = new Array();
+  this.environment = environment;
+  
+  this.toString = function(){
+    return "<WiceGridProcessor instance for grid '" + this.name + "'>";
+  }
+
+
+  this.process = function(dom_id_to_focus){
+    window.location = this.build_url_with_params(dom_id_to_focus);
+  }
+
+  this.reload_page_for_given_grid_state = function(grid_state){
+    var request_path = this.grid_state_to_request(grid_state);
+    window.location = this.append_to_url(this.base_link_for_show_all_records, request_path);
+  }
+
+  this.load_query = function(query_id){
+    var request = this.append_to_url(this.build_url_with_params(),
+      (this.parameter_name_for_query_loading +  encodeURIComponent(query_id)));
+    window.location = request;
+  }
+
+  this.save_query = function(query_name, base_path_to_query_controller, grid_state, input_ids){
+    if (input_ids instanceof Array) {
+      input_ids.each(function(dom_id){
+        grid_state.push(['extra[' + dom_id + ']', $F(dom_id)])
+      });
+    }
+    
+    var request_path = this.grid_state_to_request(grid_state);
+    
+    new Ajax.Request(base_path_to_query_controller, {
+      asynchronous:true,
+      evalScripts:true,
+      parameters: request_path + '&query_name=' + encodeURIComponent(query_name)
+    })
+  }
+
+  this.grid_state_to_request = function(grid_state){
+    return res = grid_state.collect(function(pair){
+      return encodeURIComponent(pair[0]) + '=' + encodeURIComponent(pair[1]);
+    }).join('&');
+  }
+
+
+  this.append_to_url = function(url, str){
+    var sep;
+    if (url.include('?')){
+      if (/[&\?]$/.exec(url)){
+        sep = '';
+      }else{
+        sep = '&';
+      }
+    }else{
+      sep = '?';
+    }
+    return url + sep + str;
+  }
+
+
+  this.build_url_with_params = function(dom_id_to_focus){
+    var results = new Array();
+    this.filter_declarations.each(function(filter_declaration){
+      param = this.read_values_and_form_query_string(
+        filter_declaration.filter_name, filter_declaration.detached, 
+        filter_declaration.templates, filter_declaration.ids);
+      if (param && param != ''){
+        results.push(param);
+      }
+    }.bind(this));
+    var res = this.base_request_for_filter;
+    if ( results.length != 0){
+      all_filter_params = results.join('&');
+      res = this.append_to_url(res, all_filter_params);
+    }
+    if (dom_id_to_focus){
+      res = this.append_to_url(res, this.parameter_name_for_focus + dom_id_to_focus);
+    }
+    return res;
+  }
+
+  this.reset = function(){
+    window.location = this.base_request_for_filter;
+  }
+
+  this.export_to_csv = function(){
+    window.location = this.link_for_export;
+  }
+
+
+  this.register = function(func){
+    this.filter_declarations.push(func);
+  }
+
+  this.read_values_and_form_query_string = function(filter_name, detached, templates, ids){
+    var res = new Array();
+    for(i = 0; i < templates.length; i++){
+      if($(ids[i]) == null){
+        if (this.environment == "development"){
+          message = 'WiceGrid: Error reading state of filter "' + filter_name + '". No DOM element with id "' + ids[i] + '" found.'
+          if (detached){
+            message += 'You have declared "' + filter_name + 
+              '" as a detached filter but have not output it anywhere in the template. Read documentation about detached filters.'
+          }
+          alert(message);
+        }
+        return '';
+      }
+      var val = $F(ids[i]);
+      if (val instanceof Array) {
+        for(j = 0; j < val.length; j++){
+          if (val[j] && val[j] != "")
+            res.push(templates[i] + encodeURIComponent(val[j]));
+        }
+      } else if (val && ! val.empty()){
+        res.push(templates[i]  + encodeURIComponent(val));
+      }
+    }
+    return res.join('&');
+  }
+
+};
+
+function toggle_multi_select(select_id, link_obj, expand_label, collapse_label) {
+  var select = $(select_id);
+  if (select.multiple == true) {
+    select.multiple = false;
+    link_obj.title = expand_label;
+  } else {
+    select.multiple = true;
+    link_obj.title = collapse_label;
+  }
+}
+
+WiceGridProcessor._version = '0.4.3';