zen 0.4 → 0.4.1

data/lib/zen/package/custom_fields/lib/custom_fields/controller/custom_field_groups.rb

@@ -48,12 +48,30 @@ module CustomFields
     # When creating a new group or editing an existing group you can fill in the
     # following two fields:
     #
-    # * **Name** (required): the name of the group, an example of such a name is
-    #   "General group" or "Meta fields".
-    # * **Description**: a description of the group.
-    #
-    # Note that the length of the group name can not be longer than 255
-    # characters.
+    # <table class="table full">
+    #     <thead>
+    #         <tr>
+    #             <th class="field_name">Field</th>
+    #             <th>Required</th>
+    #             <th>Maximum Length</th>
+    #             <th>Description</th>
+    #         </tr>
+    #     </thead>
+    #     <tbody>
+    #         <tr>
+    #             <td>Name</td>
+    #             <td>Yes</td>
+    #             <td>255</td>
+    #             <td>The name of the custom field group.</td>
+    #         </tr>
+    #         <tr>
+    #             <td>Description</td>
+    #             <td>No</td>
+    #             <td>Unlimited</td>
+    #             <td>A description of the custom field group.</td>
+    #         </tr>
+    #     </tbody>
+    # </table>
     #
     # ## Used Permissions
     #

data/lib/zen/package/custom_fields/lib/custom_fields/controller/custom_field_types.rb

@@ -28,26 +28,74 @@ module CustomFields
     #
     # In this form you can specify the following fields:
     #
-    # * **Name** (required): the name of the custom field type. This name can be
-    #   anything you like.
-    # * **Language string** (required): a valid language string that will result
-    #   in a language specific block of text. This text will be used for the
-    #   label.
-    # * **HTML Class**: a space separated list of HTML classes to apply to the
-    #   field type. The format of this value has to match the regular expression
-    #   ``/^[a-zA-Z\-_0-9\s]*$/``.
-    # * **Serialize**: whether or not the value of a field using this type
-    #   should be serialized. Set this to "Yes" if a field takes multiple values
-    #   such as a checkbox or a select element with the attribute
-    #   ``multiple="multiple"``.
-    # * **Allow markup**: whether or not users can use markup, such as Markdown
-    #   in a field using this type.
-    # * **Custom field method** (required): the name of a method in
-    #   {CustomFields::BlueFormParameters}. This method will be used to generate
-    #   all the parameters for the BlueForm helper.
-    #
-    # Note that the name, language string and HTML class can not be longer than
-    # 255 characters.
+    # <table class="table full">
+    #     <thead>
+    #         <tr>
+    #             <th class="field_name">Field</th>
+    #             <th>Required</th>
+    #             <th>Maximum Length</th>
+    #             <th>Description</th>
+    #         </tr>
+    #     </thead>
+    #     <tbody>
+    #         <tr>
+    #             <td>Name</td>
+    #             <td>Yes</td>
+    #             <td>255</td>
+    #             <td>The name of the custom field type.</td>
+    #         </tr>
+    #         <tr>
+    #             <td>Language string</td>
+    #             <td>Yes</td>
+    #             <td>255</td>
+    #             <td>
+    #                 The language string to use when displaying the custom
+    #                 field type.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>HTML class</td>
+    #             <td>No</td>
+    #             <td>255</td>
+    #             <td>
+    #                 A space separated list of HTML classes to apply to custom
+    #                 fields of this type. The value of this field should match
+    #                 the pattern <code>/^[a-zA-Z\-_0-9\s]*$/</code>
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>Serialize</td>
+    #             <td>No</td>
+    #             <td></td>
+    #             <td>
+    #                 When set the values of custom fields of this type will be
+    #                 serialized using Ruby's Marshal module. This setting is
+    #                 useful for fields that can have multiple values such as
+    #                 checkboxes.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>Allow markup</td>
+    #             <td>No</td>
+    #             <td></td>
+    #             <td>
+    #                 When set custom fields of this type can contain markup
+    #                 other than plain text.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>Custom field method</td>
+    #             <td>Yes</td>
+    #             <td></td>
+    #             <td>
+    #                 The name of the method in the module
+    #                 {CustomFields::BlueFormParameters}. This method will be
+    #                 used for generating the required markup for each field of
+    #                 this type.
+    #             </td>
+    #         </tr>
+    #     </tbody>
+    # </table>
     #
     # ## Used Permissions
     #

data/lib/zen/package/custom_fields/lib/custom_fields/controller/custom_fields.rb

@@ -24,32 +24,112 @@ module CustomFields
     #
     # In this form you can specify the following fields:
     #
-    # * **Name** (required): the name of the custom field, can be anything you
-    #   like. Examples are "Body" and "Date picker".
-    # * **Slug**: a URL friendly version of the name. If none is specified one
-    #   will be generated automatically.
-    # * **Field type** (required): the type of custom field.
-    # * **Format** (required): the markup engine to use for the custom field. If
-    #   a custom field type doesn't allow the use of markup this setting will
-    #   be ignored.
-    # * **Description**: a description of the custom field.
-    # * **Possible values**: in case a custom field type allows you to specify
-    #   multiple values (such as a checkbox) you can specify a value on each
-    #   line. These values can be specified as following:
-    #
-    #       key|value
-    #
-    #   Example:
-    #
-    #       Yes!|yes
-    #
-    # * **Requires a value**: whether or not this field requires a value.
-    # * **Enable a text editor**: when set to "Yes" the user can use the markup
-    #   editor when adding/editing a value of a field.
-    # * **Textarea rows**: the amount of rows when the field type is a textarea.
-    # * **Character limit**: the maximum amount of characters a user can enter
-    #   in the field.
-    # * **Sort order**: a number that indicates the sort order of the field.
+    # <table class="table full">
+    #     <thead>
+    #         <tr>
+    #             <th class="field_name">Field</th>
+    #             <th>Required</th>
+    #             <th>Maximum Length</th>
+    #             <th>Description</th>
+    #         </tr>
+    #     </thead>
+    #     <tbody>
+    #         <tr>
+    #             <td>Name</td>
+    #             <td>Yes</td>
+    #             <td>255</td>
+    #             <td>The name of the custom field.</td>
+    #         </tr>
+    #         <tr>
+    #             <td>Slug</td>
+    #             <td>No</td>
+    #             <td>255</td>
+    #             <td>
+    #                 A URL friendly version of the name. If no value is
+    #                 specified the slug will be generated based on the custom
+    #                 field's name.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>Field type</td>
+    #             <td>Yes</td>
+    #             <td></td>
+    #             <td>The custom field type to use.</td>
+    #         </tr>
+    #         <tr>
+    #             <td>Format</td>
+    #             <td>Yes</td>
+    #             <td></td>
+    #             <td>The markup format for values of this custom field.</td>
+    #         </tr>
+    #         <tr>
+    #             <td>Description</td>
+    #             <td>No</td>
+    #             <td>Unlimited</td>
+    #             <td>
+    #                 A description of the custom field, displayed when the user
+    #                 hovers over a custom field's form element.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>Possible values</td>
+    #             <td>No</td>
+    #             <td>Unlimited</td>
+    #             <td>
+    #                 A newline separated list of values that can be specified
+    #                 for custom fields that allow multiple values to be
+    #                 selected (e.g.  checkboxes). These values can be specified
+    #                 by writing "key|value" (where "key" and "value" are the
+    #                 name and value of an item) on each line.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>Requires a value</td>
+    #             <td>No</td>
+    #             <td></td>
+    #             <td>
+    #                 When set to "Yes" users are required to enter a value for
+    #                 the custom field.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>Enable a text editor</td>
+    #             <td>No</td>
+    #             <td></td>
+    #             <td>
+    #                 When set to "Yes" the values of the custom field can be
+    #                 set using a markup editor.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>Textarea rows</td>
+    #             <td>No</td>
+    #             <td></td>
+    #             <td>
+    #                 The amount of rows for a textarea field. This value only
+    #                 affects custom fields using the "Textarea" type.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>Character limit</td>
+    #             <td>No</td>
+    #             <td></td>
+    #             <td>
+    #                 The maximum amount of characters that a user can enter in
+    #                 a field.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>Sort order</td>
+    #             <td>No</td>
+    #             <td></td>
+    #             <td>
+    #                 The order in which to display the field when managing a
+    #                 section entry.
+    #             </td>
+    #         </tr>
+    #     </tbody>
+    # </table>
     #
     # ## Used Permissions
     #

data/lib/zen/package/custom_fields/lib/custom_fields/helper/custom_field.rb

@@ -1,5 +1,4 @@
 module Ramaze
-  #:nodocL
   module Helper
     ##
     # Helper for the custom fields package.
@@ -16,11 +15,12 @@ module Ramaze
       # @return [CustomFields::Model::CustomFieldGroup]
       #
       def validate_custom_field_group(custom_field_group_id)
+        redirect_invalid_field_group unless custom_field_group_id =~ /\d+/
+
         group = ::CustomFields::Model::CustomFieldGroup[custom_field_group_id]
 
         if group.nil?
-          message(:error, lang('custom_field_groups.errors.invalid_group'))
-          redirect(::CustomFields::Controller::CustomFieldGroups.r(:index))
+          redirect_invalid_field_group
         else
           return group
         end
@@ -37,15 +37,14 @@ module Ramaze
       # @return [CustomFields::Model::CustomField]
       #
       def validate_custom_field(custom_field_id, custom_field_group_id)
+        unless custom_field_id =~ /\d+/
+          redirect_invalid_field(custom_field_group_id)
+        end
+
         field = ::CustomFields::Model::CustomField[custom_field_id]
 
         if field.nil?
-          message(:error, lang('custom_fields.errors.invalid_field'))
-          redirect(
-            ::CustomFields::Controller::CustomFields.r(
-              :index, custom_field_group_id
-            )
-          )
+          redirect_invalid_field(custom_field_group_id)
         else
           return field
         end
@@ -60,15 +59,55 @@ module Ramaze
       # @return [CustomFields::Model::CustomFieldType]
       #
       def validate_custom_field_type(custom_field_type_id)
+        redirect_invalid_field_type unless custom_field_type_id =~ /\d+/
+
         type = ::CustomFields::Model::CustomFieldType[custom_field_type_id]
 
         if type.nil?
-          message(:error, lang('custom_field_types.errors.invalid_type'))
-          redirect(::CustomFields::Controller::CustomFieldTypes.r(:index))
+          redirect_invalid_field_type
         else
           return type
         end
       end
+
+      ##
+      # Redirects the user back to the field groups overview and shows a message
+      # informing the user that the group he/she tried to access was invalid.
+      #
+      # @since 05-04-2012
+      #
+      def redirect_invalid_field_group
+        message(:error, lang('custom_field_groups.errors.invalid_group'))
+        redirect(::CustomFields::Controller::CustomFieldGroups.r(:index))
+      end
+
+      ##
+      # Redirects the user to the custom field types overview and informs
+      # him/her that the type he/she tried to access was invalid.
+      #
+      # @since 05-04-2012
+      #
+      def redirect_invalid_field_type
+        message(:error, lang('custom_field_types.errors.invalid_type'))
+        redirect(::CustomFields::Controller::CustomFieldTypes.r(:index))
+      end
+
+      ##
+      # Redirects the user to the overview of all custom fields of a given group
+      # and informs the user that the field he/she tried to access is invalid.
+      #
+      # @since 05-04-2012
+      # @param [Fixnum] custom_field_group_id The ID of the group to use for
+      #  redirecting the user.
+      #
+      def redirect_invalid_field(custom_field_group_id)
+        message(:error, lang('custom_fields.errors.invalid_field'))
+        redirect(
+          ::CustomFields::Controller::CustomFields.r(
+            :index, custom_field_group_id
+          )
+        )
+      end
     end # CustomField
   end # Helper
 end # Ramaze

data/lib/zen/package/custom_fields/lib/custom_fields/view/admin/custom-fields/form.xhtml

@@ -33,7 +33,7 @@
           f.input_hidden(:custom_field_group_id, @custom_field_group_id)
           f.input_hidden(:csrf_token           , get_csrf_token)
 
-          f.g.div(:id => 'general') do
+          f.g.div(:id => 'general', :class => :tab_field) do
             f.input_text(
               lang('custom_fields.labels.name'),
               :name,
@@ -77,7 +77,7 @@
             )
           end
 
-          f.g.div(:id => 'settings') do
+          f.g.div(:id => 'settings', :class => :tab_field) do
             f.input_radio(
               lang('custom_fields.labels.required'),
               :required,

data/lib/zen/package/dashboard/lib/dashboard/controller/dashboard.rb

@@ -20,7 +20,7 @@ module Dashboard
   module Controller
     ##
     # Shows the dashboard for the currently logged in user. The dashboard shows
-    # a list of user specific widgets. These widgets can be re-arranged,
+    # a list of user specific widgets. These widgets can be rearranged,
     # disabled/enabled and the columns for these widgets can also be customized.
     #
     # When you open up the dashboard for the first time only one widget will be

data/lib/zen/package/menu.rb

@@ -19,6 +19,9 @@ module Zen
       # All the child elements of the current navigation element.
       attr_reader :children
 
+      # Hash containing extra configuration options for the menu.
+      attr_reader :options
+
       ##
       # Creates a new instance of the class and optionally processes all sub
       # navigation items.
@@ -77,7 +80,9 @@ module Zen
       def html(permissions = [])
         # Skip the navigation menu and all it's child elements if the user isn't
         # allowed to view it.
-        return if !user_authorized?(@options[:permission])
+        if @options[:permission] and !user_authorized?(@options[:permissions])
+          return
+        end
 
         g        = Ramaze::Gestalt.new
         children = []

data/lib/zen/package/menus/lib/menus/controller/menu_items.rb

@@ -30,14 +30,49 @@ module Menus
     #
     # In this form you can specify the following fields:
     #
-    # * **Name**: the name of the menu item.
-    # * **URL**: the URL of the menu item.
-    # * **HTML class**: a space separated list of classes to apply to the HTML
-    #   element.
-    # * **HTML ID**: a single ID to apply to the HTML element.
-    #
-    # Note that the name, URL, HTML class and HTML ID fields have a maximum
-    # length of 255 characters.
+    # <table class="table full">
+    #     <thead>
+    #         <tr>
+    #             <th class="field_name">Field</th>
+    #             <th>Required</th>
+    #             <th>Maximum Length</th>
+    #             <th>Description</th>
+    #         </tr>
+    #     </thead>
+    #     <tbody>
+    #         <tr>
+    #             <td>Name</td>
+    #             <td>Yes</td>
+    #             <td>255</td>
+    #             <td>The name of the menu item.</td>
+    #         </tr>
+    #         <tr>
+    #             <td>URL</td>
+    #             <td>Yes</td>
+    #             <td>255</td>
+    #             <td>The URL the menu item should point to.</td>
+    #         </tr>
+    #         <tr>
+    #             <td>HTML class</td>
+    #             <td>No</td>
+    #             <td>255</td>
+    #             <td>
+    #                 A space separated string containing the class(es) to apply
+    #                 to the menu. This value should match the pattern
+    #                 <code>^[a-zA-Z\-_0-9\s]*$</code>.
+    #             </td>
+    #         </tr>
+    #         <tr>
+    #             <td>HTML ID</td>
+    #             <td>No</td>
+    #             <td>255</td>
+    #             <td>
+    #                 A single ID to apply to the menu. This value should match
+    #                 the pattern <code>^[a-zA-Z\-_0-9]*$</code>.
+    #             </td>
+    #         </tr>
+    #     </tbody>
+    # </table>
     #
     # ## Used Permissions
     #
@@ -142,7 +177,7 @@ module Menus
       end
 
       ##
-      # Saves an existing menu iten or creates a new one using the supplied
+      # Saves an existing menu item or creates a new one using the supplied
       # POST data.
       #
       # @since      0.2a