RubyGems - admin_assistant - Versions diffs - 1.0.0 → 1.0.1 - Mend

admin_assistant 1.0.0 → 1.0.1

Files changed (377) hide show

data/website/js/scriptaculous.js ADDED Viewed

@@ -0,0 +1,58 @@
+// script.aculo.us scriptaculous.js v1.8.1, Thu Jan 03 22:07:12 -0500 2008
+// Copyright (c) 2005-2007 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us)
+//
+// 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.
+//
+// For details, see the script.aculo.us web site: http://script.aculo.us/
+var Scriptaculous = {
+  Version: '1.8.1',
+  require: function(libraryName) {
+    // inserting via DOM fails in Safari 2.0, so brute force approach
+    document.write('<script type="text/javascript" src="'+libraryName+'"><\/script>');
+  },
+  REQUIRED_PROTOTYPE: '1.6.0',
+  load: function() {
+    function convertVersionString(versionString){
+      var r = versionString.split('.');
+      return parseInt(r[0])*100000 + parseInt(r[1])*1000 + parseInt(r[2]);
+    }
+    if((typeof Prototype=='undefined') ||
+       (typeof Element == 'undefined') ||
+       (typeof Element.Methods=='undefined') ||
+       (convertVersionString(Prototype.Version) <
+        convertVersionString(Scriptaculous.REQUIRED_PROTOTYPE)))
+       throw("script.aculo.us requires the Prototype JavaScript framework >= " +
+        Scriptaculous.REQUIRED_PROTOTYPE);
+    $A(document.getElementsByTagName("script")).findAll( function(s) {
+      return (s.src && s.src.match(/scriptaculous\.js(\?.*)?$/))
+    }).each( function(s) {
+      var path = s.src.replace(/scriptaculous\.js(\?.*)?$/,'');
+      var includes = s.src.match(/\?.*load=([a-z,]*)/);
+      (includes ? includes[1] : 'builder,effects,dragdrop,controls,slider,sound').split(',').each(
+       function(include) { Scriptaculous.require(path+include+'.js') });
+    });
+  }
+}
+Scriptaculous.load();

data/website/quick_start.markdown ADDED Viewed

@@ -0,0 +1,44 @@
+---
+layout: default
+title:  Quick start
+---
+*This document assumes you are highly familiar with Ruby and Rails; if you are a beginning Rails user you might want to start with our [tutorial](./tutorial.html).*
+1) First, install the plugin from Github.
+    ./script/plugin install git://github.com/fhwang/admin_assistant.git
+2) If you don't have the popular will\_paginate gem, you'll need that too. See [http://wiki.github.com/mislav/will_paginate/installation](http://wiki.github.com/mislav/will_paginate/installation) for more info.
+3) admin\_assistant comes packaged with standard CSS and Javascript that you should include in whatever layout your admin controllers will be using. You'll also need to make sure to include prototype.js, effects.js, and controls.js, if you're not including them already.
+    <html>
+      <head>
+        <%= javascript_include_tag("prototype", "effects", "controls") %>
+        <%= admin_assistant_includes %>
+      </head>
+      ...
+    </html>
+4) Setup an admin controller by attaching it to a model and using the admin layout:
+    class Admin::BlogPostsController < ApplicationController
+      layout 'admin'
+      admin_assistant_for BlogPost
+    end
+That's it for the basic version. You should now be able to go to /admin/blog\_posts in your app and search, paginate, create, and edit blog posts.
+![index](./img/blog_posts-index.png)
+Depending on the model you're using, you might notice a few things:
+* Boolean values can be toggled on and off in the index view.
+* Any belongs-to associations are handled in the form by either a drop-down, or an Ajax autocompleter, depending on how many choices there are for the association.
+* There is no `destroy` action out of the box. This is intended as a safe default, but you can add it if you like.
+* If you have more than 10 pages of a given model, the pagination at the bottom includes a jump form to let you automatically jump to a page you enter.
+For more, check out the [API reference](./api/).

data/website/screenshots.markdown ADDED Viewed

@@ -0,0 +1,27 @@
+---
+layout: default
+title:  Screenshots
+---
+<a href="./img/screen1.png" rel="lightbox[screens]" class="thumb" title="With a few lines of code, admin_assistant gives you a lot of default functionality for one model, including an index view with pagination and sorting, search, creating, and editing."><img src="./img/screen1-thumb.png"></a>
+<a href="./img/screen2.png" rel="lightbox[screens]" class="thumb" title="Sorting is built-in, and done in the URL for easy bookmarking, etc."><img src="./img/screen2-thumb.png"></a>
+<a href="./img/screen3.png" rel="lightbox[screens]" class="thumb" title="If there are many results, the pagination section will include a form for jumping to a specific page quickly."><img src="./img/screen3-thumb.png"></a>
+<a href="./img/screen4.png" rel="lightbox[screens]" class="thumb" title="By default, any boolean field on the model can be toggled in the index view with an Ajax link."><img src="./img/screen4-thumb.png"></a>
+<a href="./img/screen5.png" rel="lightbox[screens]" class="thumb" title="New and edit pages render default widgets for each column on the model. Datetime fields, for example, each get a &quot;Clear&quot; javascript link by default."><img src="./img/screen5-thumb.png"></a>
+<a href="./img/screen6.png" rel="lightbox[screens]" class="thumb" title="If the model has a belongs-to association, and there are too many records on that associated table to be usable in a dropdown, admin_assistant renders an autocompleter instead."><img src="./img/screen6-thumb.png"></a>
+<a href="./img/screen7.png" rel="lightbox[screens]" class="thumb" title="On the form, individual column inputs on the form can be overridden with custom logic. On this admin controller for the Product model, the column &quot;price&quot; is being rendered with the ERB template _price_input.html.erb. The submitted parameters are then pre-processed with a protected controller method called price_from_form."><img src="./img/screen7-thumb.png"></a>
+<a href="./img/screen8.png" rel="lightbox[screens]" class="thumb" title="A customized search form can give you searching by specific columns. The user can choose to match all or any of the conditions. Also, numerical fields include comparators by default, so, for example, you can search for all products costing greater than $100."><img src="./img/screen8-thumb.png"></a>
+<a href="./img/screen9.png" rel="lightbox[screens]" class="thumb" title="The same autocompleting for belongs-to associations is also available in the search form. In this example, the user is searching for blog posts by author."><img src="./img/screen9-thumb.png"></a>
+<a href="./img/screen10.png" rel="lightbox[screens]" class="thumb" title="There is an optional theme that mimics ActiveScaffold, which may come in handy if you're in the process of transitioning away from ActiveScaffold. admin_assistant does not conflict with ActiveScaffold; you can use the two in different controllers of the same Rails app."><img src="./img/screen10-thumb.png"></a>
+<a href="./img/screen11.png" rel="lightbox[screens]" class="thumb" title="admin_assistant handles images out of the box through either Paperclip or FileColumn."><img src="./img/screen11-thumb.png"></a>

data/website/tutorial.markdown ADDED Viewed

@@ -0,0 +1,56 @@
+---
+layout: default
+title:  Quick start
+---
+*This document assumes you are a beginning Rails user; if you are very familiar with Rails you might want to check out our [quick start](./quick_start.html).*
+1) First, install the plugin from Github.
+    ./script/plugin install git://github.com/fhwang/admin_assistant.git
+2) If you don't have the popular will\_paginate gem, you'll need that too. See [http://wiki.github.com/mislav/will_paginate/installation](http://wiki.github.com/mislav/will_paginate/installation) for more info.
+3) If you don't have any admin controllers in your Rails project yet, you probably need to create a separate admin layout. Create a file called `app/views/layouts/admin.html.erb` like this:
+    <html>
+      <head>
+        <%= javascript_include_tag("prototype", "effects", "controls") %>
+        <%= admin_assistant_includes %>
+      </head>
+      <body>
+        <%=yield %>
+      </body>
+    </html>
+If you've already created an admin layout, you should add the javascript references, and the call to `admin_assistant_includes`. This includes the standard CSS and Javascript that are packed with admin\_assistant.
+4) Create your new admin controller for a pre-existing model. We'll be using a BlogPost as an example but you should be able to use any model in your Rails app.
+    ./script/generate controller admin/blog_posts
+5) Open `app/controllers/admin/blog_posts_controller.rb` and set it up to use the admin layout and to use admin\_assistant for the BlogPost model:
+    class Admin::BlogPostsController < ApplicationController
+      layout 'admin'
+      admin_assistant_for BlogPost
+    end
+6) If you were already running your Rails app with `./script/server` etc, you should restart it.
+7) Visit `/admin/blog_posts` in your browser and you'll see something like this:
+![index](./img/blog_posts-index.png)
+You can now search, paginate, create, and edit blog posts.
+Depending on the model you're using, you might notice a few things:
+* Boolean values can be toggled on and off in the index view.
+* Any belongs-to associations are handled in the form by either a drop-down, or an Ajax autocompleter, depending on how many choices there are for the association.
+* There is no `destroy` action out of the box. This is intended as a safe default, but you can add it if you like.
+* If you have more than 10 pages of a given model, the pagination at the bottom includes a jump form to let you automatically jump to a page you enter.
+For more, check out the [API reference](./api/).