fancygrid 1.0.0

data/lib/generators/install_generator.rb

@@ -0,0 +1,61 @@
+module Fancygrid
+  module Generators#:nodoc:
+    
+    class InstallGenerator < Rails::Generators::Base#:nodoc:
+
+      def copy_initializer
+        plugin_path = File.join(File.dirname(__FILE__), "../../config/initializers/fancygrid.rb")
+        rails_path = Rails.root.join('config/initializers/fancygrid.rb')
+        copy_file(plugin_path, rails_path)
+      end
+    
+      def copy_default_cells_view
+        plugin_path = File.join(File.dirname(__FILE__), "../../app/views/fancygrid/_cells.html.haml")
+        rails_path = Rails.root.join("app/views/fancygrid/_cells.html.haml")
+        copy_file(plugin_path, rails_path)
+      end
+      
+      def copy_javascript_source
+        js_source = File.join(File.dirname(__FILE__), '../../public/javascripts/fancygrid.js')
+        js_target = Rails.root.join('public/javascripts/fancygrid.js')
+        copy_file(js_source, js_target)
+      end
+      
+      def copy_css
+        %w(css scss).each do |ext|
+          js_source = File.join(File.dirname(__FILE__), "../../public/stylesheets/fancygrid.#{ext}")
+          js_target = Rails.root.join("public/stylesheets/fancygrid.#{ext}")
+          copy_file(js_source, js_target)
+        end
+      end
+      
+      def copy_images
+        %w(add.png clear.png ddn.png dn.png dots.png loading.gif magnifier.png next.png order.png prev.png reload.png remove.png spacer.gif submit.png th_bg.png up.png uup.png).each do |filename|
+          plugin_path = File.join(File.dirname(__FILE__), "../../public/images/fancygrid", filename)
+          rails_path = Rails.root.join('public/images/fancygrid', filename)
+          copy_file(plugin_path, rails_path)
+        end
+      end
+
+      def copy_locale
+        %w(de en).each do |locale|
+          plugin_path = File.join(File.dirname(__FILE__), "../../config/locales/fancygrid.#{locale}.yml")
+          rails_path = Rails.root.join("config/locales/fancygrid.#{locale}.yml")
+          copy_file(plugin_path, rails_path)
+        end
+      end
+
+      def print_info
+        puts "====================================================================="
+        puts ""
+        puts "  Almost done. Next steps you have to do yourself"
+        puts "  -----------------------------------------------"
+        puts "  1 include the javascript file in your layout : \"= javascript_include_tag 'fancygrid'\""
+        puts "  2 include the stylesheet file in your layout : \"= stylesheet_link_tag 'fancygrid'\""
+        puts ""
+        puts "====================================================================="
+      end
+    end
+  end
+  
+end

data/lib/generators/views_generator.rb

@@ -0,0 +1,25 @@
+module Fancygrid
+  module Generators#:nodoc:
+    
+    class ViewsGenerator < Rails::Generators::Base#:nodoc:
+
+      def copy_views
+        %w(controls list_frame table_frame search sort).each do |name|
+          plugin_path = File.join(File.dirname(__FILE__), "../../app/views/fancygrid/base/#{name}.html.haml")
+          rails_path = Rails.root.join("app/views/fancygrid/base/#{name}.html.haml")
+          copy_file(plugin_path, rails_path)
+        end
+      end
+
+      def print_info
+        puts "====================================================================="
+        puts ""
+        puts "  Views have been copied to #{Rails.root.join('app/views/fancygrid/base')} "
+        puts "  You can modify them as you wish"
+        puts ""
+        puts "====================================================================="
+      end
+    end
+  end
+  
+end

data/public/javascripts/fancygrid.js

@@ -0,0 +1,477 @@
+(function( $ ) {
+
+  $.fn.fancygrid = function(method) {
+    if ( methods[method] ) {
+      return methods[method].apply( this, Array.prototype.slice.call( arguments, 1 ));
+    } else if (typeof(method) === 'object' || !method) {
+      return methods.init.apply(this, arguments);
+    } else {
+      $.error( 'Method ' + method + ' does not exist on jQuery.fancygrid' );
+    }
+  };
+
+  var methods = {
+    init : function(options){
+      var settings = { 
+        url               : "/", 
+				ajaxType          : "GET",
+        name              : "", 
+        query             : { 
+          pagination      : { 
+            page : (options.paginationPage || 0), 
+            per_page : options.paginationPerPage
+          },
+          columns         : {}, 
+          conditions      : {},
+          operator        : "any",
+          order           : {}
+        },
+        searchFadeTime    : 25,
+        searchFadeOpac    : 0.5,
+        searchType        : "simple",
+        queries           : 0,
+        isStatic          : false,
+        gridType          : "table",
+        hideTopControl    : false,
+        hideBottomControl : false
+      };
+      options = (options || {});
+      $.extend(settings, options);
+      
+      return this.each(function(){
+        var $this = $(this);
+        var data = $this.data('fancygrid');
+        
+        if (!data){
+          // initialize fancygrid
+          
+          // set data
+          $this.data('fancygrid', settings);
+          
+          // Hide the helper stuff
+          $(".fg-sort-window, .fg-sort-content, .fg-search-template").hide();
+          
+          // hide search tab and controls if wanted
+          if (!settings.searchVisible){
+            $this.find(".fg-search").hide();
+          } else {
+            settings.searchVisible = true;
+          }
+          
+          // bind control buttons with functions
+          
+          // search attribute changed/focused
+          $this.find(".fg-search").find("input[type='text'], select").bind("change.fancygrid", function(){
+            $(this).parents(".fg-fancygrid").fancygrid('newSearch'); 
+            return false;
+          }).bind("focus.fancygrid", function(){
+            $(this).select();
+            return false;
+          });
+          
+          // search attribute changed/focused
+          $this.find(".fg-page").bind("change.fancygrid", function(){
+            $(this).parents(".fg-fancygrid").fancygrid('page', $(this).val()); 
+            return false;
+          }).bind("focus.fancygrid", function(){
+            $(this).select();
+            return false;
+          });
+          
+          // previous page click
+          $this.find(".fg-previous").bind("click.fancygrid", function(){
+            $(this).parents(".fg-fancygrid").fancygrid('previousPage'); 
+            return false;
+          });
+          
+          // next page click
+          $this.find(".fg-next").bind("click.fancygrid", function(){
+            $(this).parents(".fg-fancygrid").fancygrid('nextPage'); 
+            return false;
+          });
+          
+          // reload click
+          $this.find(".fg-reload").bind("click.fancygrid", function(){
+            $(this).parents(".fg-fancygrid").fancygrid('reloadPage'); 
+            return false;
+          });
+          
+          // clear click
+          $this.find(".fg-clear").bind("click.fancygrid", function(){
+            $(this).parents(".fg-fancygrid").fancygrid('clearSearch'); 
+            return false;
+          });
+          
+          // per page change
+          $this.find(".fg-per-page").bind("change.fancygrid", function(){
+            $(this).parents(".fg-fancygrid").fancygrid('perPage', $(this).val()); 
+            return false;
+          });
+          
+          // magnifier click
+          $this.find(".fg-magnify").bind("click.fancygrid", function(){
+            $(this).parents(".fg-fancygrid").fancygrid('toggleSearch'); 
+            return false;
+          });
+          
+          // sort click
+          $this.find(".fg-sort").bind("click.fancygrid", function(){
+            $(this).parents(".fg-fancygrid").fancygrid('showSortWindow'); 
+            return false;
+          });
+          
+          //extended search submit
+          $this.find(".fg-search-submit").bind("click.fancygrid", function(){
+            $(this).parents(".fg-fancygrid").fancygrid('newSearch'); 
+            return false;
+          });
+          
+          //button remove
+          $this.find(".fg-search-remove").click(function(){
+            $(this).parents(".fg-search-criterion").remove();
+          });
+          
+          //button add new criterion
+          $this.find(".fg-search-add").click(function(){
+            $this.fancygrid("addCriterionRow");
+          });
+          
+          // close the sort window if user clicked outside the sortable lists
+          $this.find(".fg-sort-content").click(function(){
+            $this.fancygrid("closeSortWindow");
+          });
+          $this.find(".fg-sortable").click(function(e){
+            e.stopPropagation();
+          });
+          
+        } else {
+          // nothing to do when fancygrid is already initialized
+          $.extend(data, options);
+        }
+      });
+    },
+    //
+    // removes the plugin and clears the attached data
+    //
+    destroy : function(){
+      return this.each(function(){
+        var $this = $(this);
+        data = $this.data('fancygrid');
+        $this.unbind('.fancygrid');
+        $this.removeData('fancygrid');
+      });
+    },
+    //
+    // Fills the fancygrid query data with search conditions
+    //
+    setupConditions : function(){
+      var $this = $(this);
+      var data = $this.data('fancygrid');
+      
+      data = $this.data('fancygrid');
+      data.query.conditions = {};
+      
+      if (data.searchType === "simple"){
+        
+        // process simple search
+        data.query.operator = "all";
+        
+        $(this).find(".fg-attribute").each(function(){
+          data.query.conditions[$(this).attr("name")] = $(this).val();
+        });
+      } else {
+        
+        // process complex search
+        
+        data.query.operator = $this.find("#fg-search-conditions:checked").val() || "any";
+
+        $this.find("ul.fg-search-criteria li.fg-search-criterion").each(function(){
+          var column_name = $(this).find("select[name='column_name']").val();
+          var operator  = $(this).find("select[name='operator']").val();
+          var value = $(this).find("input[name='column_value']").val();
+          
+          if (typeof(data.query.conditions[column_name]) === "undefined"){
+            data.query.conditions[column_name] = [];
+          }
+          
+          data.query.conditions[column_name].push({
+            operator : operator,
+            value : value
+          });
+        }); 
+      }
+    },
+    //
+    // Fills the fancygrid query data with emputy search conditions
+    //
+    setupEmptyConditions : function(){
+      var $this = $(this);
+      var data = $this.data('fancygrid');
+      
+      data.query.conditions = {};
+    },
+    //
+    // Fills the fancygrid query data with pagination conditions
+    //
+    setupPagination : function(page, perPage){
+      var $this = $(this);
+      var data = $this.data('fancygrid');
+      
+      data.query.pagination = { page : 0, per_page : 20 };
+      if(!isNaN(Number(page)) && Number(page) >= 0){
+        data.query.pagination.page = page;
+      }
+      if (!isNaN(Number(perPage)) && Number(perPage) > 0){
+        data.query.pagination.per_page = perPage;
+      }
+    },
+    setupOrder : function(){
+      var $this = $(this);
+      var data = $this.data('fancygrid');
+      var order = {};
+      var column = $this.find("th.fg-orderable[order='ASC'], th.fg-orderable[order='DESC']");
+      
+      if (column.length > 0){
+        order.table = column.attr("table");
+        order.column = column.attr("column");
+        order.direction = column.attr("order");        
+      }
+
+      data.query.order = order;
+    },
+    //
+    // Fills the fancygrid query data with column order and column visibility conditions
+    //
+    setupColumns : function(){
+      var $this = $(this);
+      var data = $this.data('fancygrid');
+      var columns = {};
+      
+      var visibleArray = $this.find('.fg-sortable-visible li:not(.fg-not-sortable)');
+      var hiddenArray = $this.find('.fg-sortable-hidden li:not(.fg-not-sortable)');
+      
+      var index = 0;
+      $(visibleArray).each(function(){
+        columns[$(this).attr("id")] = {
+          visible : true,
+          position : index
+        };
+        index += 1;
+      });
+      $(hiddenArray).each(function(){
+        columns[$(this).attr("id")] = {
+          visible : false,
+          position : index
+        };
+        index += 1;
+      });
+      
+      data.query.columns = columns;
+    },
+    order : function(){
+      return "";
+    },
+    search : function(){
+      var $this = $(this);
+      var $content = $this.find(".fg-tablewrapper");
+      var $control = $this.find(".fg-control-bar");
+      var data = $this.data('fancygrid');
+      data.queries += 1;
+      data.query.search_visible = $this.find(".fg-search").is(":visible");
+      
+      $control.find(".fg-reload").addClass("loading");
+      $this.fadeTo(data.searchFadeTime, data.searchFadeOpac);
+      
+      queryData = { "fancygrid" : {} };
+      queryData.fancygrid[data.name] = data.query;
+      
+      $.ajax({
+        type      : data.ajaxType,
+        url       : data.url,
+        data      : queryData,
+        dataType  : "html",
+        success   : function(result){  
+          data.queries -= 1;
+          if(data.queries === 0){
+            $this.fancygrid("replaceContent", $(result).find(".fg-tablewrapper"));
+            
+            $control.find(".fg-per-page").val(data.query.pagination.per_page);
+            $control.find(".fg-page").val(Number(data.query.pagination.page) + 1);
+            
+            total = (Number($(result).find(".fg-result-total").html()));
+            totalPages = total / data.query.pagination.per_page;
+            totalPages = (totalPages | 0) + 1;
+
+            $control.find(".fg-page-total").text(totalPages);
+            $control.find(".fg-result-total").html(total);
+            
+            $this.fadeTo(data.searchFadeTime, 1.0, function(){
+              $control.find(".fg-reload").removeClass("loading");
+            }); 
+          }
+          $this.trigger("loadSuccess");
+        },
+        error     : function(){
+          data.queries -= 1;
+          if(data.queries === 0){
+            $content.find(".fg-row").detach();
+            $this.fadeTo(data.searchFadeTime, 1.0, function(){
+              $control.find(".fg-reload").removeClass("loading");
+            });
+          }
+          $this.trigger("loadError");
+        }
+      });
+    },
+    replaceContent : function(newContent){
+      var $this = $(this);
+      var data = $this.data('fancygrid');
+      
+			var focused_id = $this.find("input:focus").attr("id");
+			
+      // replace the content
+      $this.find(".fg-tablewrapper").replaceWith(newContent);
+      
+      // rebind events to search input fields
+      $this.find(".fg-tablewrapper").find(".fg-search").find("input[type='text'], select").bind("change.fancygrid", function(){
+        $(this).parents(".fg-fancygrid").fancygrid('newSearch'); 
+        return false;
+      }).bind("focus.fancygrid", function(){
+        $(this).select();
+        return false;
+      });
+      
+      $this.find("th.fg-orderable").click(function(){
+        $this.fancygrid("orderBy", $(this));
+      });
+      
+      if (data.searchVisible){
+        $this.find(".fg-search").show();
+      } else {
+        $this.find(".fg-search").hide();
+      }
+
+			if (focused_id){
+				$this.find("#" + focused_id).focus();
+			}
+    },                           
+    nextPage : function(){
+      var $this = $(this);
+      data = $this.data('fancygrid');
+      $this.fancygrid("setupPagination", data.query.pagination.page + 1, data.query.pagination.per_page);
+      $this.fancygrid("search");
+    },
+    previousPage : function(){
+      var $this = $(this);
+      data = $this.data('fancygrid');
+      $this.fancygrid("setupPagination", data.query.pagination.page - 1, data.query.pagination.per_page);
+      $this.fancygrid("search");
+    },
+    perPage : function(perPage){
+      var $this = $(this);
+      data = $this.data('fancygrid');
+      $this.fancygrid("setupPagination", 0, perPage);
+      $this.fancygrid("search");
+    },
+    page : function(page){
+      var $this = $(this);
+      data = $this.data('fancygrid');
+      $this.fancygrid("setupPagination", Number(page) - 1, data.query.pagination.per_page);
+      $this.fancygrid("search");
+    },
+    reloadPage : function(){
+      var $this = $(this);
+      data = $this.data('fancygrid');
+      $this.fancygrid("setupPagination", data.query.pagination.page, data.query.pagination.per_page);
+      $this.fancygrid("setupConditions");
+      $this.fancygrid("setupColumns");
+      $this.fancygrid("setupOrder");
+      $this.fancygrid("search");
+    },
+    newSearch : function(){
+      var $this = $(this);
+      data = $this.data('fancygrid');
+      $this.fancygrid("setupPagination", 0, data.query.pagination.per_page);
+      $this.fancygrid("setupConditions");
+      $this.fancygrid("setupColumns");
+      $this.fancygrid("setupOrder");
+      $this.fancygrid("search");
+    },
+    clearSearch : function(){
+      var $this = $(this);
+      data = $this.data('fancygrid');
+      
+      // clear simple search
+      $this.find(".fg-attribute").each(function(){
+        $(this).val("");
+      });
+      
+      // clear complex search
+      $this.find("ul.fg-search-criteria li.fg-search-criterion").detach();
+      
+      //$this.fancygrid("setupPagination", 0, data.query.pagination.per_page);
+      $this.fancygrid("setupEmptyConditions");
+      $this.fancygrid("search");
+    },
+    toggleSearch : function(){
+      var $this = $(this);
+      data = $this.data('fancygrid');
+      
+      // toggle only the simple search
+      $this.find(".fg-search").toggle();
+      data.searchVisible = $this.find(".fg-search").is(":visible");
+    },
+    addCriterionRow : function(){
+      var $this = $(this);
+      var row = $($this.find(".fg-search-template").html());
+      
+      // add criterion row
+      $this.find("ul.fg-search-criteria").append(row);
+      
+      // button remove
+      row.find(".fg-search-remove").click(function(){
+        $(this).parents(".fg-search-criterion").remove();
+      });
+      
+      row.find("input[type='text']").bind("change.fancygrid", function(){
+        $(this).parents(".fg-fancygrid").fancygrid('newSearch'); 
+        return false;
+      }).bind("focus.fancygrid", function(){
+        $(this).select();
+        return false;
+      });
+    },
+    showSortWindow : function(){
+      var $this = $(this);
+      
+      $this.find(".fg-sort-window").show();
+      $this.find(".fg-sort-content").show();
+      
+      $this.find(".fg-sortable").sortable({
+        connectWith: ".fg-sortable",
+        items: "li:not(.fg-not-sortable)"
+      });
+    },
+    closeSortWindow : function(){
+      var $this = $(this);
+      $this.find(".fg-sort-window").hide();
+      $this.find(".fg-sort-content").hide();
+      $this.fancygrid("reloadPage");
+    },
+    orderBy : function(column){
+      $this = $(this);
+      
+      var old_order = column.attr("order");
+      
+      $this.find("th.fg-orderable").removeAttr("order");
+      
+      if (old_order === "DESC"){
+        column.attr("order", "ASC");
+      } else {
+        column.attr("order", "DESC");
+      }
+
+      $this.fancygrid("reloadPage");
+    }
+  };
+})(jQuery);