zen 0.1a → 0.2

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

@@ -0,0 +1,259 @@
+#:nodoc:
+module CustomFields
+  #:nodoc:
+  module Controllers
+    ##
+    # Controller for managing custom fields. Custom fields are one of
+    # the most important elements in Zen. Custom fields can be used to
+    # create radio buttons, textareas, the whole shebang. Before
+    # being able to use a custom field you'll need to add it to a group
+    # and bind that group to a section.
+    #
+    # @author  Yorick Peterse
+    # @since   0.1
+    #
+    class CustomFields < Zen::Controllers::AdminController
+      include ::CustomFields::Models
+
+      map   '/admin/custom-fields'
+      trait :extension_identifier => 'com.zen.custom_fields'
+      
+      before_all do
+        csrf_protection(:save, :delete) do
+          respond(lang('zen_general.errors.csrf'), 403)
+        end
+      end
+      
+      ##
+      # Constructor method, called upon initialization. It's used to set the
+      # URL to which forms send their data and load the language pack.
+      #
+      # This method loads the following language files:
+      #
+      # * custom_fields
+      # * custom_field_groups
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def initialize
+        super
+        
+        @form_save_url     = CustomFields.r(:save)
+        @form_delete_url   = CustomFields.r(:delete)
+        
+        Zen::Language.load('custom_fields')
+        Zen::Language.load('custom_field_groups')
+        
+        # Set the page title
+        if !action.method.nil?
+          method      = action.method.to_sym
+          @page_title = lang("custom_fields.titles.#{method}") rescue nil
+        end
+
+        # Build our array containing all custom field formats
+        @field_type_hash = {
+          'textbox'         => lang('custom_fields.special.type_hash.textbox'),
+          'textarea'        => lang('custom_fields.special.type_hash.textarea'),
+          'radio'           => lang('custom_fields.special.type_hash.radio'),
+          'checkbox'        => lang('custom_fields.special.type_hash.checkbox'),
+          'date'            => lang('custom_fields.special.type_hash.date'),
+          'select'          => lang('custom_fields.special.type_hash.select'),
+          'select_multiple' => lang('custom_fields.special.type_hash.select_multiple')
+        }
+      end
+      
+      ##
+      # Show an overview of all existing custom fields. Using this overview a user
+      # can manage an existing field, delete it or create a new one.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      # 
+      # @author Yorick Peterse
+      # @param  [Integer] custom_field_group_id The ID of the custom field group to 
+      # which all fields belong.
+      # @since  0.1
+      #
+      def index custom_field_group_id
+        if !user_authorized?([:read])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        set_breadcrumbs(
+          anchor_to(lang('custom_field_groups.titles.index'), CustomFieldGroups.r(:index)),
+          lang('custom_fields.titles.index')
+        )
+        
+        @custom_field_group_id  = custom_field_group_id.to_i
+        @custom_fields          = CustomFieldGroup[@custom_field_group_id].custom_fields
+      end
+      
+      ##
+      # Show a form that lets the user edit an existing custom field group.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * update
+      #
+      # @author Yorick Peterse
+      # @param  [Integer] custom_field_group_id The ID of the custom field group to 
+      # which all fields belong.
+      # @param  [Integer] id The ID of the custom field to retrieve so that we can edit it.
+      # @since  0.1
+      #
+      def edit custom_field_group_id, id
+        if !user_authorized?([:read, :update])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        set_breadcrumbs(
+          anchor_to(lang('custom_field_groups.titles.index'), CustomFieldGroups.r(:index)),
+          anchor_to(lang('custom_fields.titles.index'), CustomFields.r(:index, custom_field_group_id)),
+          lang('custom_fields.titles.edit')
+        )
+          
+        @custom_field_group_id = custom_field_group_id
+
+        if flash[:form_data]
+          @custom_field = flash[:form_data]
+        else
+          @custom_field = CustomField[id.to_i]
+        end
+      end
+      
+      ##
+      # Show a form that lets the user create a new custom field group.
+      #
+      # This method requires the following permissions:
+      #
+      # * create
+      # * read
+      #
+      # @author Yorick Peterse
+      # @param  [Integer] custom_field_group_id The ID of the custom field group to 
+      # which all fields belong.
+      # @since  0.1
+      #
+      def new custom_field_group_id
+        if !user_authorized?([:read, :create])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        set_breadcrumbs(
+          anchor_to(lang('custom_field_groups.titles.index'), CustomFieldGroups.r(:index)),
+          anchor_to(lang('custom_fields.titles.index'), CustomFields.r(:index, custom_field_group_id)),
+          lang('custom_fields.titles.index')
+        )
+        
+        @custom_field_group_id = custom_field_group_id
+        @custom_field          = CustomField.new
+      end
+      
+      ##
+      # Method used for processing the form data and redirecting the user back to
+      # the proper URL. Based on the value of a hidden field named 'id' we'll determine
+      # if the data will be used to create a new custom field or to update an existing one.
+      #
+      # This method requires the following permissions:
+      #
+      # * create
+      # * update
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def save
+        if !user_authorized?([:create, :update])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        post                  = request.params.dup
+        custom_field_group_id = post['custom_field_group_id']
+        
+        post.delete('slug') if post['slug'].empty?
+
+        # Get or create a custom field group based on the ID from the hidden field.
+        if post['id'] and !post['id'].empty?
+          @custom_field = CustomField[post['id'].to_i]
+          save_action   = :save
+        else
+          @custom_field = CustomField.new
+          save_action   = :new
+        end
+        
+        flash_success = lang("custom_fields.success.#{save_action}")
+        flash_error   = lang("custom_fields.errors.#{save_action}")
+
+        begin
+          @custom_field.update(post)
+          notification(:success, lang('custom_fields.titles.index'), flash_success)
+        rescue
+          notification(:error, lang('custom_fields.titles.index'), flash_error)
+
+          flash[:form_data]   = @custom_field
+          flash[:form_errors] = @custom_field.errors
+        end
+        
+        if @custom_field.id
+          redirect(CustomFields.r(:edit, custom_field_group_id, @custom_field.id))
+        else
+          redirect(CustomFields.r(:new, custom_field_group_id))
+        end
+      end
+      
+      ##
+      # Delete an existing custom field.
+      #
+      # In order to delete a custom field group you'll need to send a POST request that 
+      # contains a field named 'custom_field_ids[]'. This field should contain the 
+      # primary values of each field that has to be deleted.
+      #
+      # This method requires the following permissions:
+      #
+      # * delete
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def delete
+        if !user_authorized?([:delete])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+
+        post = request.params.dup
+        
+        if !request.params['custom_field_ids'] or request.params['custom_field_ids'].empty?
+          notification(
+            :error, 
+            lang('custom_fields.titles.index'), 
+            lang('custom_fields.errors.no_delete')
+          )
+
+          redirect(CustomFields.r(:index, post['custom_field_group_id']))
+        end
+        
+        request.params['custom_field_ids'].each do |id|
+          begin
+            CustomField[id.to_i].destroy
+            notification(
+              :success, 
+              lang('custom_fields.titles.index'), 
+              lang('custom_fields.success.delete')
+            )
+          rescue
+            notification(
+              :error, 
+              lang('custom_fields.titles.index'), 
+              lang('custom_fields.errors.delete') % id
+            )
+          end
+        end
+        
+        redirect_referrer
+      end
+    end
+  end
+end

data/lib/zen/package/custom_fields/lib/custom_fields/language/en/custom_field_groups.yml

@@ -0,0 +1,32 @@
+---
+titles:
+  index: 'Custom Field Groups'
+  edit: 'Edit Custom Field Group'
+  new: 'Add Custom Field Group'
+
+labels:
+  id            : '#'
+  name          : 'Name'
+  description   : 'Description'
+  sections      : 'Sections'
+  manage_fields : 'Manage custom fields'
+  none          : 'None'
+
+messages:
+  no_groups : 'No custom field groups have been created yet.'
+
+errors:
+  new       : 'Failed to create a new custom field group.'
+  save      : 'Failed to modify the custom field group.'
+  delete    : 'Failed to delete the custom field group with ID #%s'
+  no_delete : "You haven't specified any custom field groups to delete"
+
+success:
+  new    : 'The custom field group has been created.'
+  save   : 'The custom field group has been modified.'
+  delete : 'The selected custom field groups have been deleted.'
+
+buttons:
+  new    : 'Add group'
+  delete : 'Delete selected groups'
+  save   : 'Save group'

data/lib/zen/package/custom_fields/lib/custom_fields/language/en/custom_fields.yml

@@ -0,0 +1,52 @@
+---
+titles:
+  index  : 'Custom Fields'
+  edit   : 'Edit Custom Field'
+  new    : 'Add Custom Field'
+
+labels:
+  id               : '#'
+  name             : 'Name'
+  slug             : 'Slug'
+  type             : 'Type'
+  format           : 'Format'
+  description      : 'Description'
+  possible_values  : 'Possible values (one value per line)'
+  required         : 'Requires a value'
+  visual_editor    : 'Enable the visual editor'
+  textarea_rows    : 'Textarea rows'
+  text_limit       : 'Character limit'
+  sort_order       : 'Sort order'
+
+tabs:
+  general   : 'General'
+  settings  : 'Settings'
+
+messages:
+  no_fields : 'No custom fields have been added yet.'
+
+errors:
+  new       : 'Failed to create a new custom field.'
+  save      : 'Failed to modify the custom field.'
+  delete    : 'Failed to delete the custom field with ID #%s.'
+  no_delete : "You haven't specified any custom fields to delete."
+
+success:
+  new     : 'The new custom field has been created.'
+  save    : 'The custom field has been modified.'
+  delete  : 'The selected custom fields have been deleted.'
+
+special:
+  type_hash:
+    textbox          : 'Textbox'
+    textarea         : 'Textarea'
+    radio            : 'Radio button'
+    checkbox         : 'Checkboxe'
+    date             : 'Date'
+    select           : 'Select dropdown'
+    select_multiple  : 'Multi select'
+
+buttons:
+  new     : 'Add custom field'
+  delete  : 'Delete selected fields'
+  save    : 'Save custom field'

data/lib/zen/{packages → package}/custom_fields/lib/custom_fields/model/custom_field.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module CustomFields
+  #:nodoc:
   module Models
     ##
     # Model that represents a single custom field. This model has the following
@@ -17,7 +19,10 @@ module CustomFields
     # @since  0.1
     #
     class CustomField < Sequel::Model
-      one_to_many :custom_field_values, :class => "CustomFields::Models::CustomFieldValue"
+      one_to_many(
+        :custom_field_values, 
+        :class => "CustomFields::Models::CustomFieldValue"
+      )
       
       plugin :sluggable, :source => :name, :freeze => false
       
@@ -28,13 +33,13 @@ module CustomFields
       # @since  0.1
       # 
       def validate
-        validates_presence         [:name, :type, :format, :required, :visual_editor]
-        validates_presence         :slug unless new?
-        validates_max_length 255 , [:name]
-        validates_type TrueClass , [:required, :visual_editor]
-        validates_integer [:sort_order, :textarea_rows, :text_limit]
+        validates_presence              [:name, :type, :format, :required, :visual_editor]
+        validates_max_length 255      , [:name]
+        validates_type       TrueClass, [:required, :visual_editor]
+        validates_integer               [:sort_order, :textarea_rows, :text_limit]
         
-        validates_unique :slug
+        validates_presence :slug unless new?
+        validates_unique   :slug
       end
     end
   end

data/lib/zen/{packages → package}/custom_fields/lib/custom_fields/model/custom_field_group.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module CustomFields
+  #:nodoc:
   module Models
     ##
     # Model that represents a single custom field group. This model has
@@ -14,8 +16,16 @@ module CustomFields
     # @since  0.1
     #
     class CustomFieldGroup < Sequel::Model
-      one_to_many  :custom_fields, :class => "CustomFields::Models::CustomField", :order => :sort_order
-      many_to_many :sections     , :class => "Sections::Models::Section"
+      one_to_many(
+        :custom_fields, 
+        :class => "CustomFields::Models::CustomField", 
+        :order => :sort_order
+      )
+
+      many_to_many(
+        :sections, 
+        :class => "Sections::Models::Section"
+      )
       
       ##
       # Validates rules used whenever the model is created or saved.
@@ -24,8 +34,8 @@ module CustomFields
       # @since  0.1
       #
       def validate
-        validates_presence        [:name]
-        validates_max_length 255, [:name]
+        validates_presence        :name
+        validates_max_length 255, :name
       end
     end
   end

data/lib/zen/{packages → package}/custom_fields/lib/custom_fields/model/custom_field_value.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module CustomFields
+  #:nodoc:
   module Models
     ##
     # Model that represents a single custom field value. This model
@@ -13,8 +15,8 @@ module CustomFields
     # @since  0.1
     #
     class CustomFieldValue < Sequel::Model
-      many_to_one :custom_field , :class => "CustomFields::Models::CustomField"
-      many_to_one :section_entry, :class => "Sections::Models::SectionEntry"
+      many_to_one(:custom_field , :class => "CustomFields::Models::CustomField")
+      many_to_one(:section_entry, :class => "Sections::Models::SectionEntry")
     end
   end
 end

data/lib/zen/package/custom_fields/lib/custom_fields/view/admin/custom-field-groups/edit.xhtml

@@ -0,0 +1,7 @@
+<article>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
+    
+    #{render_partial :form}
+</article>

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

@@ -0,0 +1,30 @@
+#{
+form_for(
+  @field_group, :method => :post, :action => @form_save_url, 
+  :id => :custom_field_group_form
+) do |f|
+
+  f.input_hidden(:id, @field_group.id)
+  f.input_hidden(:csrf_token, get_csrf_token)
+  
+  f.g.div(:id => 'general') do
+    f.input_text(
+      lang('custom_field_groups.labels.name'), 
+      :name
+    )
+    
+    f.textarea(
+      lang('custom_field_groups.labels.description'), 
+      :description, 
+      :rows => 8
+    )
+  end
+  
+  f.g.div(:class => 'clearfix') do
+    f.g.div(:class => 'button') do
+      f.g.input(:type => 'submit', :value => lang('custom_field_groups.buttons.save'))
+    end
+  end
+
+end
+}