hobo 0.8.5 → 0.8.6

data/taglibs/rapid_core.dryml

@@ -98,12 +98,12 @@ This will use `<input/>` as the tag in each table cell instead of `<view/>`
       <thead if="&all_parameters[:thead] || fields" param>
         <tr param="field-heading-row">
           <with-field-names merge-attrs="&all_attributes & attrs_for(:with_fields)">
-            <th param="#{scope.field_name}-heading"><%= this.member_class.view_hints.field_name(scope.field_name) %></th>
+            <th param="#{scope.field_name}-heading"><%= this.member_class.try.view_hints.try.field_name(scope.field_name) if scope %></th>
           </with-field-names>
           <th if="&all_parameters[:controls]" class="controls"/>
         </tr>
       </thead>
-      <tbody>
+      <tbody param>
         <repeat>
           <tr param if="&can_view?"
               class="#{scope.even_odd} #{this_type.name.underscore} #{model_id_class}">
@@ -112,7 +112,7 @@ This will use `<input/>` as the tag in each table cell instead of `<view/>`
                 <td param="#{this_field.to_s.sub('?', '').gsub('.', '-')}-view"><call-tag tag="&field_tag"/></td>
               </with-fields>
               <td class="controls" param="controls" if="&all_parameters[:controls]">
-                <a param="edit-link" action="edit">Edit</a>
+                <a param="edit-link" action="edit" if="&can_edit?">Edit</a>
                 <delete-button param/>
               </td>
             </if>
@@ -213,8 +213,9 @@ Provides a short hand way of displaying images in public/images
 -->
 <def tag="type-name" attrs="plural, lowercase, dasherize"><%=
   type ||= (this if this.is_a?(Class)) || this.try.member_class || this.class
-
-  name = dasherize ? type.name.underscore.dasherize : type.name.titleize
+  
+  name = type.respond_to?(:view_hints) ? type.view_hints.model_name : type.name
+  name = dasherize ? name.underscore.dasherize : name.titleize
   name = name.pluralize if plural
   name = name.downcase if lowercase
   name
@@ -293,7 +294,7 @@ Or a new page if the context is a class:
 * If `action="new"` then `<a>` will check that the current user has permission to create the object
 * Several useful classes are added automatically to the output `<a>`.
 -->
-<def tag="a" attrs="action, to, params, query-params, href, format, subsite"><%=
+<def tag="a" attrs="action, to, params, query-params, href, format, subsite, force"><%=
   content = parameters.default
    
   params = self.query_params.merge(params || HashWithIndifferentAccess.new) if query_params
@@ -314,7 +315,7 @@ Or a new page if the context is a class:
       new_record.set_creator(current_user)
       href = object_url(target, "new", params._?.merge(:subsite => subsite))
       
-      if href && can_create?(new_record)
+      if href && (force || can_create?(new_record))
         new_class_name = if target.respond_to?(:proxy_reflection)
                            target.proxy_reflection.klass.name
                          else
@@ -527,7 +528,7 @@ The label can be customised using the `label` attribute, e.g.
 <def tag="theme-stylesheet" attrs="name">
   <% name ||= Hobo.current_theme -%>
   <link href="#{base_url}/hobothemes/#{Hobo.current_theme}/stylesheets/#{name}.css"
-        media="screen" rel="Stylesheet" type="text/css" />
+        media="all" rel="Stylesheet" type="text/css" merge/>
 </def>
 
 <!-- Convenience tag to help with the common situation where you need to address the current user as "you", and refer to other users by name
@@ -562,14 +563,7 @@ The context should be a user object. If `this == current_user` the "you" form is
   <else><do param="default"><%= n = name; n.ends_with?('s') ? "#{n}'" : "#{n}'s" %></do></else>
 </def>
 
-<!-- Renders "a book" or "an orange" according the the word passed in the attribute `word`
-
-### Usage
-
-To render either "Please select a recipe" or "Please select an event", according to the type of the `this`:
-
-    <a-or-an word="&type_name"/>
-
+<!-- Deprecated. It's harder than you think to do this (e.g. an umbrealla, an user)
 -->
 <def tag="a-or-an" attrs="word"><%=
   (word =~ /^[aeiou]/i ? "an " : "a ") + word
@@ -584,3 +578,14 @@ To render either "Please select a recipe" or "Please select an event", according
 
 <!-- Renders a collection of string joined with ", ", or some other string passed in the `join` attribute -->
 <def tag="comma-list" attrs="join"><%= this.join(join || ", ") %></def>
+
+
+<!-- Development mode only - a menu to change the `current_user` -->
+<def tag="dev-user-changer">
+  <set user="&Hobo::User.default_user_model"/>
+  <select-menu if="&user && RAILS_ENV == 'development'"
+               first-option="Guest" options="&user.all(:limit => 30).*.login"
+               onchange="location.href = '/dev/set_current_user?login=' + this.options[this.selectedIndex].value"
+               selected="#{current_user.login}"
+               class="dev-user-changer"/>
+</def>

data/taglibs/rapid_document_tags.dryml

@@ -19,7 +19,7 @@
 -->
 <def tag="section" attrs="empty, with-flash-messages">
   <set body="&parameters.default" flash="&with_flash_messages && !scope.flash_rendered"/>
-  <div class="section #{'with-flash' if flash}" merge-attrs if="&!body.blank? || empty">
+  <div class="section #{'with-flash' if flash}" merge-attrs if="&!body.blank? || empty || flash">
     <flash-messages if="&flash"/>
     <%= body %>
   </div>

data/taglibs/rapid_editing.dryml

@@ -58,9 +58,6 @@ This area of Hobo has had less attention that the non-ajax forms of late, so it'
 <!-- Provides a simple Scriptaculous in-place-editor that uses an `<input type='text'>` -->
 <def tag="editor" for="float"><%= in_place_editor attributes %></def>
 
-<!-- Provides a simple Scriptaculous in-place-editor that uses an `<input type='text'>` -->
-<def tag="editor" for="big_integer"><%= in_place_editor attributes %></def>
-
 <!-- Raises an error - passwords cannot be edited in place -->
 <def tag="editor" for="password"><% raise HoboError, "passwords cannot be edited in place" %></def>
 
@@ -88,14 +85,14 @@ This area of Hobo has had less attention that the non-ajax forms of late, so it'
    NOTE: yes that's *DOM ID's* not part-names. A common source of confusion because by default the part name and DOM ID are the same.
 
   -->
-<def tag="select-one-editor" attrs="include-none, blank-message, sort, update"><%
+<def tag="select-one-editor" attrs="include-none, blank-message, sort, update, options"><%
   raise HoboError.new("Not allowed to edit") unless can_edit?
   blank_message ||= "(No #{this_type.name.to_s.titleize})"
-  select_options = this_field_reflection.klass.find(:all).select {|x| can_view?(x)}.map {|x|
+  options ||= this_field_reflection.klass.find(:all).select {|x| can_view?(x)}.map {|x|
             [ name(:with => x, :no_wrapper => true), x.id ]
           }
-   select_options = select_options.sort if sort
-   select_options.insert(0, [blank_message, ""]) if this.nil? || include_none
+   options = options.sort if sort
+   options.insert(0, [blank_message, ""]) if this.nil? || include_none
    f = ajax_updater(object_url(this_parent, :method => :put),
                     update,
                     :method => "put",
@@ -104,7 +101,7 @@ This area of Hobo has had less attention that the non-ajax forms of late, so it'
                       } })
     %>
   <select onchange="#{f}" merge-attrs>
-     <%= options_for_select(select_options, this ? this.id : "") %>
+     <%= options_for_select(options, this ? this.id : "") %>
   </select>
 </def>
 
@@ -212,10 +209,10 @@ This area of Hobo has had less attention that the non-ajax forms of late, so it'
   -->
 <def tag="integer-select-editor" attrs="options, min, max, update, nil-option, message">
  <% options ||= (min.to_i..max.to_i).to_a %>
- <select class="number-editor-bhv #{model_id_class} #{'update:' + comma_split(update).join(':') unless update.blank?}"
+ <select class="integer editor #{'update:' + comma_split(update).join(':') unless update.blank?} #{model_id_class(this_parent, this_field)}"
           merge-attrs="&message ? attributes.merge(:hobo_message => message) : attributes">
    <if test="&this.nil?"><option value=""><%= nil_option || "Choose a value" %></option></if>
-   <%= options_for_select(options.*.to_s, this) %>
+   <%= options_for_select(options.*.to_s, this.to_s) %>
  </select>
 </def>
 

data/taglibs/rapid_forms.dryml

@@ -1,5 +1,7 @@
 <!-- Rapid Forms provides various tags that make it quick and easy to produce working new or edit forms. 
 
+### Overview
+
 The main tags are:
 
  - `<form>`, which acts like the dumb HTML tag if you provide the `action` attribute, and picks up various Rapid smarts 
@@ -169,7 +171,7 @@ AJAX based submission can be enabled by simply adding an `update` attribute. e.g
       b
     end
      
-    auth_token = if method.nil? || method == 'get' || request_forgery_protection_token.nil?
+    auth_token = if method.nil? || method == 'get' || !protect_against_forgery?
                    ''
                  else
                    element(:input, {:type => "hidden", 
@@ -278,7 +280,7 @@ If the context is a `has_many :through` association, the polymorphic `<collectio
                       if refl.options[:through]
                         collection_input(attrs)
                       else
-                        raise NotImplementedError, "An input for has-many associations has not been implemented yet"
+                        input_many(attrs)
                       end
                     end
                   else
@@ -363,7 +365,7 @@ The menus default to the current time if the current value is nil.
 ### Attributes
 
  - order: The order of the year, month and date menus. A comma separated string or an array. Default: "year, month,
-   day, hour, minute, second"
+   day, hour, minute"
  
 Any other attributes are passed through to the `select_datetime` helper.
  
@@ -371,8 +373,13 @@ The menus default to the current time if the current value is nil.
 
   -->
 <def tag="input" for="datetime" attrs="order">
-  <% order = order.nil? ? [:year, :month, :day, :hour, :minute, :second] : comma_split(order).*.to_sym -%>
-  <%= select_datetime(this || Time.now, attributes.merge(:prefix => param_name_for_this, :order => order)) %>
+  <% if ! order.nil?
+       order = comma_split(order).*.to_sym 
+       attributes.merge!(:order => order)
+       require 'ruby-debug'
+       debugger
+     end -%>
+  <%= select_datetime(this || Time.now, attributes.merge(:prefix => param_name_for_this)) %>
 </def>
 
 <!-- An `<input type='text'>` input. -->
@@ -390,11 +397,6 @@ The menus default to the current time if the current value is nil.
   <%= text_field_tag(name, this, attributes) %>
 </def>
 
-<!-- An `<input type='text'>` input. -->
-<def tag="input" for="big_integer" attrs="name">
-  <%= text_field_tag(name, this, attributes) %>
-</def>
-
 <!-- A `<select>` menu containing the values of an 'enum string'.
   
 ### Attributes
@@ -405,12 +407,13 @@ The menus default to the current time if the current value is nil.
  - titleize: Set to false to have the value itself (rather than `value.titleize`) be the default label. Default: true
   
    -->
-<def tag="input" for="HoboFields::EnumString" attrs="labels, titleize"><%
+<def tag="input" for="HoboFields::EnumString" attrs="labels, titleize, first-option, first-value"><%
   labels ||= {}
   titleize = true if titleize.nil?
   options = this_type.values.map {|v| [labels.fetch(v.to_sym, titleize ? v.titleize : v), v] }
   %>
   <select name="#{param_name_for_this}" merge-attrs>
+    <option value="#{first_value}" unless="&first_option.nil?"><first-option/></option>
     <%= options_for_select(options, this) %>
   </select>
 </def>
@@ -547,7 +550,7 @@ All the standard ajax attributes *except the callbacks* are supported (see the m
 %></def>
 
 
-<!-- Provides either an ajax or non-ajax create button that will send a RESTful "POST" to the server to create a new resource.
+<!-- Provides an ajax create button that will send a RESTful "POST" to the server to create a new resource.
   
 All of the standard ajax attributes are supported (see the main taglib documention for Rapid Forms).
 
@@ -582,6 +585,21 @@ All of the standard ajax attributes are supported (see the main taglib documenti
 %></def>
 
 
+<!-- A `<select>` menu from which the user can choose the target record for a `belongs_to` association.
+
+This is the default input that Rapid uses for `belongs_to` associations. The menu is constructed using the `to_s` representation of the records.
+
+### Attributes
+
+ - `include-none` - whether to include a 'none' option (i.e. set the foreign key to null). Defaults to false
+ - `blank-message` - the message for the 'none' option. Defaults to "(No `<model-name>`)", e.g. "(No Product)"
+ - `options` - an array of records to include in the menu. Defaults to the all the records in the target table that match any `:conditions` declared on the `belongs_to` (limited to 100).
+ 
+### See Also
+
+For situations where there are too many target records to practically include in a menu, `<name-one>` provides an autocompleter which would be more suitable.
+
+  -->
 <def tag="select-one" attrs="include-none, blank-message, options, sort"><%
   raise HoboError.new("Not allowed to edit #{this_field}") if !attributes[:disabled] && !can_edit? 
 
@@ -589,7 +607,7 @@ All of the standard ajax attributes are supported (see the main taglib documenti
    
   options ||= begin
     conditions = ActiveRecord::Associations::BelongsToAssociation.new(this_parent, this_field_reflection).conditions
-    this_field_reflection.klass.all(:conditions => conditions).select {|x| can_view?(x)}
+    this_field_reflection.klass.all(:conditions => conditions, :limit => 100).select {|x| can_view?(x)}
   end
 
   select_options = options.map { |x| [x.to_s, x.id ] }
@@ -603,6 +621,23 @@ All of the standard ajax attributes are supported (see the main taglib documenti
 </def>
 
 
+<!-- An `<input type="text">` with auto-completion. Allows the user to chose the target of a `belongs_to` association
+  by name.
+  
+### Attributes
+
+ - `complete-target`
+ - `completer`
+ 
+In the simple case no attributes are needed, e.g.: `<name-one:category/>`.
+
+The completions are provided by the server with a GET request. The `complete-target` and `completer` attributes can be used to customise the URL for the request. For example:
+
+ - If `completer` is a class, say `Product`: `/products/complete_name` (where `name` is the declared name attribute of `Product`)
+ - If `completer` is a record, say a `Product` with id `12`: `/products/complete_name?id=12`
+ - If `completer-name` is given, e.g. with `completer-name="new_product_names"`: `/products/complete_new_product_names`
+
+  -->
 <def tag="name-one" attrs="complete-target, completer"><%
   complete_target ||= this_field_reflection.klass
   completer ||= (complete_target.is_a?(Class) ? complete_target : complete_target.class).name_attribute
@@ -615,18 +650,31 @@ All of the standard ajax attributes are supported (see the main taglib documenti
 </def>
 
 
+<!-- nodoc. -->
 <def tag="sti-type-input">
   <select name="#{param_name_for(form_field_path + ['type'])}">
     <%= options_for_select(this.class.send(:subclasses).map{|x| [x.name.titleize, x.name]}, this.class.name) %>
   </select>
 </def>
 
-      
+
+<!-- A `<select>` menu input. This tag differes from `<select-menu>` only in that it adds the correct `name` attribute for the current field, and `selected` default to `this`.
+  
+### Attributes
+ 
+ - `options` - an array of options suitable to be passed to the Rails `options_for_select` helper.
+ - `selected` - the value (from the `options` array) that should be initially selected. Defaults to `this`
+ - first-option - A string to be used for an extra option in the first position. E.g. "Please choose..."
+ - first-value - the value to be used with the `first-option`. Typcially not used, meaning the option has a blank value.
+
+  -->
 <def tag="select-input">
   <select-menu name="#{param_name_for_this}" selected="&this" merge/>
 </def>
 
-      
+
+<!-- Renders a readable list of error messages following a form submission. Expects the errors to be in `this.errors`. Renders nothing if there are no errors.
+  -->
 <def tag="error-messages">
   <section class="error-messages" merge-attrs if="&this.errors.length > 0">
     <h2 param="heading">To proceed please correct the following:</h2>
@@ -676,6 +724,7 @@ To use this tag, the model of the items the user is chosing *must* have unique n
   </div>
 </def>
 
+
 <!--
 Used inside a form to specify where to redirect after successful submission. This works by inserting a hidden field called `after_submit` which is used by Hobo if present to perform a redirect after the form submission.
 
@@ -710,31 +759,68 @@ Use the `uri` option to specify a redirect location:
 </def>
 
 
+<!-- A simple wrapper around the `<select>` tag and `options_for_select` helper
+  
+  ### Attributes
+
+   - `options` - an array of options suitable to be passed to the Rails `options_for_select` helper.
+   - `selected` - the value (from the `options` array) that should be initially selected. Defaults to `this`
+   - first-option - A string to be used for an extra option in the first position. E.g. "Please choose..."
+   - first-value - the value to be used with the `first-option`. Typcially not used, meaning the option has a blank value.
+
+ -->
 <def tag="select-menu" attrs="options, selected, first-option, first-value">
   <select merge-attrs param="default">
+    <% selected=this if selected.nil? %>
     <option value="#{first_value}" unless="&first_option.nil?"><first-option/></option>
-    <do param="options"><% options_for_select(options, selected.to_s) %></do>
+    <do param="options"><% options_for_select(options, selected) %></do>
   </select>
 </def>
 
 
-<def tag="check-many">
-  <% collection = this; param_name = param_name_for_this; options ||= this.member_class.find(:all) -%>
-  <ul class="check-many">
-    <li repeat="&options">
-      <input type="checkbox" name="#{param_name}[]" value="&h this.to_s" checked="&this.in?(collection)"/>
-      <name/>
+<!-- Renders a `<ul>` list of checkboxes, one for each of the potential targt in a `has_many` association. The use can check the items they wish to have associated. A typical use might be selecting categories for a blog post.
+  -->
+<def tag="check-many" attrs="disabled"><% 
+  collection = this
+  param_name = param_name_for_this
+  options ||= begin
+    conditions = ActiveRecord::Associations::BelongsToAssociation.new(this_parent, this_field_reflection).conditions
+    this_field_reflection.klass.all(:conditions => conditions, :limit => 100).select {|x| can_view?(x)}
+  end
+  -%>
+  <ul class="check-many" param="default" merge-attrs>
+    <input type="hidden" name="#{param_name}[]" value=""/><% # ensure all items are removed when nothing checked %>
+    <li repeat="&options" param>
+      <input type="checkbox" name="#{param_name}[]" value="@#{this.id}" checked="&this.in?(collection)" disabled="&disabled"/>
+      <name param/>
     </li>
   </ul>
 </def>
 
 
+<!-- Renders an `<input type='hidden'>` for the `id` field of the current context -->
 <def tag="hidden-id-field">
   <if:id><input type="hidden" name="#{param_name_for_this}" value="#{this}" /></if>
 </def>
 
 
-<def tag="input-many">
+<!-- Creates a sub-section of the form which the user can repeat using (+) and (-) buttons, in order to allow an entire `has_many` collection to be created/edited in a single form.
+  
+This tag is very different from tags like `<select-many>` and `<check-many>` in that:
+
+ - Those tags are used to *chose existing records* to include in the assocaition, while `<input-many>` is used to actually create or edit the records in the association.
+ - Those tags work by themselves, while `<input-many>` is just a wrapper for other input fields.
+ 
+### Example
+
+Say you are creating a new `Category` in your online shop, and you want to create some initial products *in the same form*, you can add the following to your form:
+
+    <input-many:products><field-list fields="name, price"/></input-many>
+    
+The body of the tag will be repeated for each of the current records in the collection, or will just appear once (with blank fields) if the colleciton is empty.
+  
+  -->
+<def tag="input-many" polymorphic>
   <set empty="&this.empty?"/>
   <ul class="input-many #{this_field.dasherize} #{css_data :input_many_prefix, param_name_for_this}">
     <li repeat class="#{'record-with-errors' unless this.errors.empty?}">
@@ -742,12 +828,12 @@ Use the `uri` option to specify a redirect location:
       <hidden-id-field/>
       <div class="input-many-item" param="default"/>
       <div class="buttons">
-        <button class="remove-item" unless="&this_parent.length == 1" merge-attrs="disabled">-</button>
+        <button class="remove-item" merge-attrs="disabled">-</button>
         <button class="add-item" if="&last_item?" merge-attrs="disabled">+</button>
       </div>
     </li>
     <li if="&empty">
-      <fake-field-context fake-field="0" context="&this.new">
+      <fake-field-context fake-field="0" context="&this.try.new_candidate || this.member_class.new">
         <div class="input-many-item" param="default"/>
       </fake-field-context>
       <div class="buttons">
@@ -758,6 +844,8 @@ Use the `uri` option to specify a redirect location:
 </def>
 
 
+<!-- Renders a sub-section of a form with fields for every record in a `has_many` association. This is similar to `<input-many>` except there is no ability to add and remove items (i.e. no (+) and (-) buttons).
+  -->
 <def tag="input-all">
   <% association_fkey = this_field_reflection.primary_key_name -%>
   <ul class="input-all #{this_field.dasherize}">
@@ -771,7 +859,8 @@ Use the `uri` option to specify a redirect location:
   </ul>
 </def>
 
-
+<!-- Renders the common "or (Cancel)" for a form. Attributes are merged into the link (`<a>Cancel</a>`), making it easy to customise the destination of the cancel link. By default it will link to `this` or `this.class`.
+  -->
 <def tag="or-cancel">
   <if test="&linkable?">or <a merge-attrs>Cancel</a></if>
   <else>

data/taglibs/rapid_generics.dryml

@@ -1,3 +1,6 @@
+<!-- Rapid Generics provides tags that provide generic renderings that can adapt to the model being renderd. At the moment this library provides cards and collections of cards. -->
+
+<!-- A 'card' is a representation of an sub-object *within* a page, such as a comment on a blog-post, or a single product in a list of produtcs. This definition is just the very basic framework which gives the basis for the automatic cards that get generated. See `app/views/taglibs/auto/rapid/cards.dryml` for the cards that have been generated for your specific application. -->
 <def tag="card" polymorphic>
   <div class="card" param="default" merge-attrs>
     <header param/>
@@ -6,11 +9,14 @@
 </def>
 
 
+<!-- A special card which is used by live-search to render the results. By default this just calls card, but you can define your own search cards with `<def tag='search-card' for="MyModel">` to customise search results for that model. -->
 <def tag="search-card" polymorphic>
-  <card/>
+  <card merge/>
 </def>
 
 
+<!-- Renders a message such as "No products to display". If the collection (`this`) is empty, `style="display:none"` is added. This means the message is still present and can be revealed with JavaScript if all items in the collection are removed with ajax remove buttons.
+  -->
 <def tag="empty-collection-message">
   <div class="empty-collection-message" style="#{'display:none' if !this.empty?}" param="default">
     No <collection-name lowercase/> to display
@@ -18,6 +24,10 @@
 </def>
 
 
+<!-- Repeats the body of the tag inside a `<ul>` list with one item for each object in the collection (`this`). If no body is given, renders a `<card>` inside the `<li>`.
+  
+The `<li>` tags are automatically given a 'model ID' CSS class, which means the ajax `<remove-button>` will automatically be able to remove items from the collection. Also adds 'even' and 'odd' CSS classes.
+ -->
 <def tag="collection">
   <ul class="collection #{collection_name :dasherize => true}" merge-attrs unless="empty?">
     <li param="item" class="#{scope.even_odd} #{model_id_class}" repeat="&select_viewable">
@@ -27,7 +37,7 @@
   <empty-collection-message param="empty-message"/>
 </def>
 
-
-<def tag="field-names-where-true" attrs="fields"><%=
+<!-- Renders a comma separated list of any fields passed in the `fields` attribute that are true (in the Ruby sense). For example, if a forum post had a boolean field `sticky`, this tag can be used to automatically label sticky posts "Sticky". Similarly, you could automatically add an "Administrator" label to the user's home page (this is seen in the default Hobo app).  -->
+<def tag="record-flags" attrs="fields"><%=
   comma_split(fields).select { |f| this.send(f) }.map { |f| f.titleize }.join(', ')
 %></def>