scaffolding_extensions 1.0.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2004-2008 Jeremy Evans
+
+Permission is hereby granted, free of charge, to any person obtaining a copy 
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights 
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+copies of the Software, and to permit persons to whom the Software is 
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in 
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
+SOFTWARE.

data/README

@@ -0,0 +1,144 @@
+= ScaffoldingExtensions
+
+Scaffolding Extensions provides a powerful and simple to use administrative
+interface to perform common actions on models.  It has the following features:
+
+* Creates pages for browsing, creating, deleting, displaying, updating, 
+  searching, and merging records
+* Choose which fields are displayed in the scaffolds and in which order
+* Handles associated records for common one-to-many, many-to-one, and
+  many-to-many associations
+* Extensive support for modifying the display and working of the plugin
+* Advanced features such as access control, autocompleting, and eager loading
+
+Scaffolding Extensions is not a code generator, and isn't really scaffolding at
+all, as you are not expected to modify the output.  Instead, you use
+configuration options inside the model to control the display of the pages.
+The scaffolding analogy is misleading, Scaffolding Extensions is not really
+scaffolding--it is a completely functional structure that you can easily modify
+to better suit your needs.
+
+Scaffolding Extensions currently supports:
+
+* Web Frameworks
+  * Rails 2.0
+  * Ramaze 0.3.5
+  * Camping 1.5
+  * Sinatra 0.1.7
+* Object/Relational Mappers
+  * ActiveRecord 2.0
+  * DataMapper 0.2.5
+* Javascript Libaries (used for Ajax/Autocompleting)
+  * Prototype 1.6.0.1
+  * JQuery 1.2.3
+  
+Support for other web frameworks and ORMs can be added, see the
+controller_spec.txt and model_spec.txt files for the methods that need to be
+defined.
+
+The current version of Scaffolding Extensions is quite different from older
+versions (svn revision 89 and previous).  Older versions of Rails should be
+able to use an older version of the plugin, which won't be discussed further as
+it is substantially different from the current version (see the conversion.txt
+file for details).
+
+You can get Scaffolding Extensions via subversion or as a gem:
+
+* svn: svn://code.jeremyevans.net/rails-plugins/scaffolding_extensions
+* gem: sudo gem install scaffolding_extensions
+* RDoc: http://code.jeremyevans.net/doc/scaffolding_extensions
+* Bug Tracker: http://rubyforge.org/tracker/?atid=22169&group_id=5726&func=browse
+* Forum: http://rubyforge.org/forum/forum.php?forum_id=22403
+
+== Quick Start
+
+The recommended use of the plugin is to execute:
+
+  scaffold_all_models
+  
+inside of a controller.  We'll assume the path to the controller is /admin.
+
+Then go to the index page for the controller (e.g. http://website/admin).  
+You'll see a link to a management page for each of your models.  Each
+management page has links to browse, create, delete, edit, show, search, and
+merge pages for the model. The pages are usable right away, but you'll want to
+add some configuration code to your models to specify the default names to
+display in select boxes, attributes to show on the forms, associations to show,
+whether to use select boxes or autocompleting text boxes, etc..
+
+== Customization
+
+The main reason to use this plugin are the features and extent of customization
+it provides.  Customization is done by adding methods and instance variables
+to the model class itself. Here are some common customizations:
+
+  class Album < ActiveRecord::Base
+    has_and_belongs_to_many :artists
+    belongs_to :genre
+    @scaffold_fields = [:name, :rating, :genre, :numtracks]
+    @scaffold_select_order = 'name'
+    @scaffold_column_names = {:numtracks=>'Number of Tracks'}
+    @scaffold_use_auto_complete = true
+    def scaffold_name
+      name[0...50]
+    end
+  end
+
+@scaffold_fields determines which fields are shown in the new, edit, and search
+forms (which use the order specified).  It should be a list of symbols.  If you
+want some pages to show more fields than others, you can define variables such
+as @scaffold_edit_fields or @scaffold_search_fields to override the defaults
+for certain pages.
+
+@scaffold_select_order determines which order is used in the SQL ORDER BY
+clause when displaying a list of objects (for example, when choosing an object
+to edit).
+
+@scaffold_column_names specifies the visible names for each attribute.
+
+@scaffold_use_auto_complete turns on autocompleting for the model, instead
+of using select boxes (necessary for a decent response time if you have a large
+number of records). See the advanced.txt for more autocompleting options.
+
+scaffold_name is an instance method that determines the name to use for each
+album inside those select boxes.
+
+Notice in this case that genre was specified.  In this case, our schema has 
+genre_id as a foreign key to the genres table.  If you specified genre_id,
+you'd get a usual text input box for the foreign key integer.  If you specify
+genre (the name of the belongs_to association), instead of a text input box,
+you will get a select box with all genres, allowing you to pick one.  It will
+use the @scaffold_select_order variable and scaffold_name method in the Genre 
+model to format the select box (though this can be overridden with the
+@scaffold_genre_select_order_association variable in the Album model).
+
+If you have @scaffold_auto_complete_options set in the Genre model (or
+@scaffold_genre_association_use_auto_complete set in the Album model), there
+will be an autocompleting text box instead of a select box (though since there
+aren't that many genres, you would probably be better off with a select box in
+this case).
+
+There are a ton of other customization options:
+
+* Override the input widget type and widget options per attribute
+* Choose which associations to display on the edit screen of a model
+* Choose which associations to eagerly load when displaying select boxes for
+  the model
+* Set the number of records returned in searching or browsing
+* Specify different fields used in each type of scaffold (e.g. certain fields
+  can only be viewed, not edited)
+* Control access to the model via a session variable (e.g. so a user can only
+  see objects with a matching user_id)
+
+Consult advanced.txt and/or the RDoc if you would like more information on
+these (and many other options).
+
+== Testing
+
+See the testing.txt file for details on the plugin's automated test suite and
+Rails functional testing support.
+
+== Questions?
+
+Please post on the RubyForge forum if you have any questions about Scaffolding
+Extensions.

data/contrib/scaffold_associations_tree/README

@@ -0,0 +1,9 @@
+This allows you to change the scaffolded display of associated items in the
+edit view from a simple list to a explorer-style clickable tree.
+
+To use this, include the .gifs in the /images subdirectory (or modify the .css
+file), and add the .css and .js files to the layout.
+
+Then set this in your application's environment:
+
+  ActiveRecord::Base::SCAFFOLD_OPTIONS[:association_list_class] = 'scaffold_associations_tree'

data/contrib/scaffold_associations_tree/scaffold_associations_tree.css

@@ -0,0 +1,20 @@
+/* Turn off list bullets */
+ul.scaffold_associations_tree li { list-style: none; }
+
+ul.scaffold_associations_tree, ul.scaffold_associations_tree ul, ul.scaffold_associations_tree li {
+  margin: 0;
+  padding: 0; 
+}
+
+/* This controls the indent for each sublist */
+ul.scaffold_associations_tree ul, ul.scaffold_associations_tree li a.treestatus { padding-left: 20px; }
+
+/* Show "bullets" in the links, depending on the class of the
+   LI that the link's in */
+ul.scaffold_associations_tree li.sat_open   a.treestatus { background: url("/images/minus.gif") center left no-repeat; }
+ul.scaffold_associations_tree li.sat_closed a.treestatus { background: url("/images/plus.gif") center left no-repeat; }
+ul.scaffold_associations_tree li.sat_bullet a.treestatus { background: url("/images/bullet.gif") center left no-repeat; }
+
+/* Actually show and hide sublists */
+ul.scaffold_associations_tree li.sat_open ul { display: block; }
+ul.scaffold_associations_tree li.sat_closed ul { display: none; }

data/contrib/scaffold_associations_tree/scaffold_associations_tree.js

@@ -0,0 +1,57 @@
+/* Based on aqtree3clickable from http://www.kryogenix.org/code/browser/aqlists/
+Modifications by Jeremy Evans (code@jeremyevans.net) */
+
+addEvent(window, "load", makeTreesC);
+
+function makeTreesC() {
+    if (!document.createElement) 
+        return;
+    uls = document.getElementsByTagName("ul");
+    for (uli=0;uli<uls.length;uli++) {
+        ul = uls[uli];
+        if (ul.nodeName == "UL" && ul.className == "scaffold_associations_tree") {
+            processULELC(ul);
+        }
+    }
+}
+
+function processULELC(ul) {
+    if (!ul.childNodes || ul.childNodes.length == 0) 
+        return;
+    for (var itemi=0;itemi<ul.childNodes.length;itemi++) {
+        var item = ul.childNodes[itemi];
+        if (item.nodeName == "LI") {
+            var subul;
+            subul = "";
+            for (var sitemi=0;sitemi<item.childNodes.length;sitemi++) {
+                if (item.childNodes[sitemi].nodeName == "UL") {
+                    subul = item.childNodes[sitemi];
+                    processULELC(subul);
+                }
+            }
+            if (subul) {
+                item.className = 'sat_closed'
+                item.innerHTML = '<a href="#" class="treestatus" onclick=\'this.parentNode.className = (this.parentNode.className=="sat_open") ? "sat_closed" : "sat_open"; return false;\'></a>' + item.innerHTML
+            } else {
+                item.className = "sat_bullet";
+                item.innerHTML = '<a href="#" class="treestatus" onclick=\'return false;\'></a>' + item.innerHTML
+            }
+        }
+    }
+}
+
+/*              Utility functions                    */
+
+function addEvent(obj, evType, fn){
+    /* adds an eventListener for browsers which support it
+       Written by Scott Andrew: nice one, Scott */
+    if (obj.addEventListener){
+        obj.addEventListener(evType, fn, false);
+        return true;
+    } else if (obj.attachEvent){
+        var r = obj.attachEvent("on"+evType, fn);
+        return r;
+    } else {
+        return false;
+    }
+}

data/contrib/scaffold_auto_complete_style/README

@@ -0,0 +1,8 @@
+This allows you to skip the output of the style when using scaffold auto
+completing.  This is necessary if you want to be XHTML compliant, as style tags
+aren't allowed inside form elements.
+
+To use this, add the .css file to your layout. Then set this in your
+application's environment:
+
+  ScaffoldingExtensions.auto_complete_skip_style = true

data/contrib/scaffold_auto_complete_style/auto_complete.css

@@ -0,0 +1,23 @@
+div.auto_complete {
+  width: 350px;
+  background: #fff;
+}
+div.auto_complete ul {
+  border:1px solid #888;
+  margin:0;
+  padding:0;
+  width:100%;
+  list-style-type:none;
+}
+div.auto_complete ul li {
+  margin:0;
+  padding:3px;
+}
+div.auto_complete ul li.selected { 
+  background-color: #ffb; 
+}
+div.auto_complete ul strong.highlight { 
+  color: #800; 
+  margin:0;
+  padding:0;
+}

data/contrib/scaffold_form_focus/README

@@ -0,0 +1,12 @@
+This allows you to auto focus the page to the first form field.
+
+To use this, conditionally include the .js file in your layout via something
+like:
+
+  <%= javascript_include_tag('scaffold_form_focus') if @scaffold_options %>
+
+The if statement makes it take effect for the scaffolded pages (which always
+define @scaffold_options).  Note that the code is fairly simplistic, it just
+focuses on the first text input, password input, textarea, or
+select box on the page, so if your layout has a form before the scaffolded
+form, you'll probably want to modify the code.

data/contrib/scaffold_form_focus/scaffold_form_focus.js

@@ -0,0 +1,21 @@
+function scaffold_form_focus() {
+    num_forms = document.forms.length
+    for(i=0;i<num_forms;i++) { 
+        elements = document.forms[i].elements
+        num_elements = elements.length
+        for(j=0;j<num_elements;j++) {
+            element = elements[j]
+            tagName = element.tagName
+            if(tagName == 'SELECT' || tagName == 'TEXTAREA' || (tagName == 'INPUT' && (element.type == 'text' || element.type == 'password'))) {
+                if(tagName != 'SELECT') {
+                    element.selectionStart = 0
+                    element.selectionEnd = 0
+                }
+                element.focus()
+                return
+            }
+        }
+    }
+}
+
+scaffold_form_focus()

data/contrib/scaffold_jquery_autocomplete/README

@@ -0,0 +1,8 @@
+If you are using JQuery javascript library with the plugin, you need to use this
+plugin for autocomplete functionality.  It's a modification of jq-autocomplete
+[1].  It also requires the Dimensions JQuery plugin [2].  To use this plugin,
+add the include the css file as a stylesheet and the js file as a script (in
+addition to JQuery and the Dimensions plugin).
+
+[1] http://plugins.jquery.com/project/jq-autocomplete
+[2] http://plugins.jquery.com/project/dimensions

data/contrib/scaffold_jquery_autocomplete/jquery.ui.se_autocomplete.css

@@ -0,0 +1,22 @@
+ul.se_autocomplete {
+    position: absolute;
+    overflow: hidden;
+    background-color: #fff;
+    border: 1px solid #aaa;
+    margin: 0px;
+    padding: 0;
+    list-style: none;
+    font: normal .75em/.75em Verdana, Arial, sans-serif;
+    color: #333;
+}
+ul.se_autocomplete li {
+    display: block;
+    padding: .3em .5em .3em .3em;
+    overflow: hidden;
+    width: 100%;
+}
+
+ul.se_autocomplete li.active {
+    background-color: #3875d7;
+    color: #fff;
+}

data/contrib/scaffold_jquery_autocomplete/jquery.ui.se_autocomplete.js

@@ -0,0 +1,121 @@
+/* Copyright 2007 Yehuda Katz, Rein Henrichs
+ * Copyright 2008 Jeremy Evans
+ */
+ 
+(function($) {
+  
+  $.ui = $.ui || {}; $.ui.autocomplete = $.ui.autocomplete || {}; var active;
+    
+  $.fn.autocompleteMode = function(container, input, size, opt) {
+    var original = input.val(); var selected = -1; var self = this;
+    
+    $.data(document.body, "autocompleteMode", true);
+
+    $("body").one("cancel.autocomplete", function() { 
+      input.trigger("cancel.autocomplete"); $("body").trigger("off.autocomplete"); input.val(original); 
+    });
+    
+    $("body").one("activate.autocomplete", function() {
+      input.trigger("activate.autocomplete", [$(active[0]).html()]); $("body").trigger("off.autocomplete");
+    });
+    
+    $("body").one("off.autocomplete", function(e, reset) {
+      container.remove();
+      $.data(document.body, "autocompleteMode", false);
+      input.unbind("keydown.autocomplete");
+      $("body").add(window).unbind("click.autocomplete").unbind("cancel.autocomplete").unbind("activate.autocomplete");
+    });
+    
+    // If a click bubbles all the way up to the window, close the autocomplete
+    $(window).bind("click.autocomplete", function() { $("body").trigger("cancel.autocomplete"); });
+
+    var select = function() {
+      active = $("> *", container).removeClass("active").slice(selected, selected + 1).addClass("active");
+      input.trigger("itemSelected.autocomplete", [$(active[0]).html()]);     
+      input.val($(active[0]).html());
+    };
+    
+    container.mouseover(function(e) {
+      // If you hover over the container, but not its children, return
+      if(e.target == container[0]) return;
+      // Set the selected item to the item hovered over and make it active
+      selected = $("> *", container).index($(e.target).is('li') ? $(e.target)[0] : $(e.target).parents('li')[0]); select();
+    }).bind("click.autocomplete", function(e) {
+      $("body").trigger("activate.autocomplete"); $.data(document.body, "suppressKey", false); 
+    });
+    
+    input
+      .bind("keydown.autocomplete", function(e) {
+        if(e.which == 27) { $("body").trigger("cancel.autocomplete"); }
+        else if(e.which == 13) { $("body").trigger("activate.autocomplete"); }
+        else if(e.which == 40 || e.which == 9 || e.which == 38) {
+          switch(e.which) {
+            case 40: 
+            case 9:
+              selected = selected >= size - 1 ? 0 : selected + 1; break;
+            case 38:
+              selected = selected <= 0 ? size - 1 : selected - 1; break;
+            default: break;
+          }
+          select();
+        } else { return true; }
+        $.data(document.body, "suppressKey", true);
+      });
+  };
+  
+  $.fn.autocomplete = function(opt) {
+    var ajax = opt.ajax;
+    var association = opt.association
+    opt = $.extend({}, {
+      timeout: 1000,
+      getList: function(input) { 
+        params = "id=" + input.val()
+        if(association) {
+          params += '&association=' + association
+        }
+        $.get(ajax, params, function(html) { input.trigger("updateList", [html]); }); 
+      }
+    }, opt);
+
+    return this.each(function() {
+  
+      $(this)
+        .keypress(function(e) {
+          var typingTimeout = $.data(this, "typingTimeout");
+          if(typingTimeout) window.clearInterval(typingTimeout);
+                    
+          if($.data(document.body, "suppressKey"))
+            return $.data(document.body, "suppressKey", false);
+          else if($.data(document.body, "autocompleteMode") && e.charCode < 32 && e.keyCode != 8 && e.keyCode != 46) return false;          
+          else {
+            $.data(this, "typingTimeout", window.setTimeout(function() { 
+              $(e.target).trigger("autocomplete"); 
+            }, opt.timeout));
+          }
+        })
+        .bind("autocomplete", function() {
+          var self = $(this);
+
+          self.one("updateList", function(e, list) {
+            $("body").trigger("off.autocomplete");
+            
+            list = $(list);
+            var length = list.children().length;
+            if(!length) return false;
+            
+            list.addClass('se_autocomplete');
+            
+            var offset = self.offset();
+          
+            list.css({top: offset.top + self.outerHeight(), left: offset.left, width: self.width()}).appendTo("body");
+          
+            $("body").autocompleteMode(list, self, length, opt);
+          });
+
+          opt.getList(self);
+        });
+
+    });
+  };
+  
+})(jQuery);