zen 0.1a

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

@@ -0,0 +1,194 @@
+module CustomFields
+  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
+      map '/admin/custom_fields'
+      
+      trait :extension_identifier => 'com.zen.custom_fields'
+      
+      include ::CustomFields::Models
+      
+      before_all do
+        csrf_protection :save, :delete do
+          respond(@zen_general_lang.errors[:csrf], 401)
+        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.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def initialize
+        super
+        
+        @form_save_url     = '/admin/custom_fields/save'
+        @form_delete_url   = '/admin/custom_fields/delete'
+        @fields_lang       = Zen::Language.load 'custom_fields'
+        @field_groups_lang = Zen::Language.load 'custom_field_groups'
+        
+        # Set the page title
+        if !action.method.nil?
+          method = action.method.to_sym
+        
+          if @fields_lang.titles.key? method
+            @page_title = @fields_lang.titles[method]
+          end
+        end
+      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.
+      # 
+      # @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(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs anchor_to(@field_groups_lang.titles[:index], "admin/custom_field_groups"),
+          @fields_lang.titles[:index]
+        
+        @custom_field_group_id  = custom_field_group_id
+        @custom_fields          = CustomFieldGroup[@custom_field_group_id].custom_fields
+      end
+      
+      ##
+      # Show a form that lets the user edit an existing custom field group.
+      #
+      # @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(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs anchor_to(@field_groups_lang.titles[:index], "admin/custom_field_groups"),
+          anchor_to(@fields_lang.titles[:index], "admin/custom_fields/#{custom_field_group_id}"),
+          @fields_lang.titles[:edit]
+          
+        @custom_field_group_id = custom_field_group_id
+        @custom_field          = CustomField[id]
+      end
+      
+      ##
+      # Show a form that lets the user create a new custom field group.
+      #
+      # @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(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs anchor_to(@field_groups_lang.titles[:index], "admin/custom_field_groups"),
+          anchor_to(@fields_lang.titles[:index], "admin/custom_fields/#{custom_field_group_id}"),
+          @fields_lang.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.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def save
+        if !user_authorized?([:create, :update])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        post                  = request.params.dup
+        custom_field_group_id = post["custom_field_group_id"]
+        
+        post.each do |key, value|
+          post.delete(key) if value.empty?
+        end
+        
+        # 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"]]
+          save_action   = :save
+        else
+          @custom_field = CustomField.new
+          save_action   = :new
+        end
+        
+        flash_success = @fields_lang.success[save_action]
+        flash_error   = @fields_lang.errors[save_action]
+
+        begin
+          @custom_field.update(post)
+          notification(:success, @fields_lang.titles[:index], flash_success)
+        rescue
+          notification(:error, @fields_lang.titles[:index], flash_error)
+          flash[:form_errors] = @custom_field.errors
+        end
+        
+        if @custom_field.id
+          redirect "/admin/custom_fields/edit/#{custom_field_group_id}/#{@custom_field.id}"
+        else
+          redirect "/admin/custom_fields/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.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def delete
+        if !user_authorized?([:delete])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        if !request.params["custom_field_ids"] or request.params["custom_field_ids"].empty?
+          notification(:error, @fields_lang.titles[:index], @fields_lang.errors[:no_delete])
+          redirect "/admin/custom_fields/index/#{post['custom_field_group_id']}"
+        end
+        
+        request.params["custom_field_ids"].each do |id|
+          @custom_field = CustomField[id]
+          
+          begin
+            @custom_field.delete
+            notification(:success, @fields_lang.titles[:index], @fields_lang.success[:delete] % id)
+          rescue
+            notification(:error, @fields_lang.titles[:index], @fields_lang.errors[:delete] % id)
+          end
+        end
+        
+        redirect "/admin/custom_fields/index/#{request.params['custom_field_group_id']}"
+      end
+    end
+  end
+end

data/lib/zen/packages/custom_fields/lib/custom_fields/language/en/custom_field_groups.rb

@@ -0,0 +1,45 @@
+Zen::Language.translation 'custom_field_groups' do |item|
+  # Page titles
+  item.titles = {
+    :index  => 'Custom Field Groups',
+    :edit   => 'Edit Custom Field Group',
+    :new    => 'Add Custom Field Group'
+  }
+  
+  # Labels
+  item.labels = {
+    :id                => '#',
+    :name              => 'Name',
+    :description       => 'Description',
+    :sections          => 'Sections',
+    :manage_fields     => 'Manage Custom Fields',
+    :none              => 'None'
+  }
+
+  # General messages
+  item.messages = {
+    :no_groups    => 'It seems you haven\'t created any custom field groups yet.'
+  }
+  
+  # Error specific messages
+  item.errors = {
+    :new        => "Failed to create a new custom field group.",
+    :save       => "Failed to save 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 messages
+  item.success = {
+    :new    => "The new custom field group has been created.",
+    :save   => "The custom field group has been modified.",
+    :delete => "The custom field group with ID #%s has been deleted."
+  }
+  
+  # Buttons
+  item.buttons = {
+    :new_group     => 'New group',
+    :delete_groups => 'Delete selected groups',
+    :save_group    => 'Save group'
+  }
+end

data/lib/zen/packages/custom_fields/lib/custom_fields/language/en/custom_fields.rb

@@ -0,0 +1,64 @@
+Zen::Language.translation 'custom_fields' do |item|
+  # Page titles
+  item.titles = {
+    :index  => 'Custom Fields',
+    :edit   => 'Edit Custom Field',
+    :new    => 'Add Custom Field'
+  }
+  
+  # Labels
+  item.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'
+  }
+  
+  item.tabs = {
+    :general  => 'General',
+    :settings => 'Settings'
+  }
+
+  # General messages
+  item.messages = {
+    :no_fields    => 'It seems you haven\'t created any custom fields yet.'
+  }
+  
+  # Error specific messages
+  item.errors = {
+    :new        => "Failed to create a new custom field.",
+    :save       => "Failed to save 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 messages
+  item.success = {
+    :new    => "The new custom field has been created.",
+    :save   => "The custom field has been modified.",
+    :delete => "The custom field with ID #%s has been deleted."
+  }
+  
+  # Special items such as hashes for field types
+  item.special = {
+    :format_hash  => {"html" => "HTML", "textile" => "Textile", "markdown" => "Markdown", "plain" => "Plain"},
+    :type_hash    => {"textbox" => "Textbox", "textarea" => "Textarea", "radio" => "Radio button",
+      "checkbox"  => "Checkbox", "date" => "Date", "select" => "Select", "select_multiple" => "Multi select"},
+    :boolean_hash => {"Yes" => true, "No" => false}
+  }
+  
+  # Buttons
+  item.buttons = {
+    :new_field     => 'New field',
+    :delete_fields => 'Delete selected fields',
+    :save_field    => 'Save field'
+  }
+end

data/lib/zen/packages/custom_fields/lib/custom_fields/model/custom_field.rb

@@ -0,0 +1,41 @@
+module CustomFields
+  module Models
+    ##
+    # Model that represents a single custom field. This model has the following
+    # relations:
+    #
+    # * custom field values (one to many)
+    #
+    # The following plugins are loaded:
+    #
+    # * sluggable (source: "name")
+    #
+    # When creating or saving a new custom field several validation rules are used.
+    # For more information on these rules see the validate() method of this model.
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    #
+    class CustomField < Sequel::Model
+      one_to_many :custom_field_values, :class => "CustomFields::Models::CustomFieldValue"
+      
+      plugin :sluggable, :source => :name, :freeze => false
+      
+      ##
+      # Validates rules used whenever the model is created or saved.
+      #
+      # @author Yorick Peterse
+      # @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_unique :slug
+      end
+    end
+  end
+end

data/lib/zen/packages/custom_fields/lib/custom_fields/model/custom_field_group.rb

@@ -0,0 +1,32 @@
+module CustomFields
+  module Models
+    ##
+    # Model that represents a single custom field group. This model has
+    # the following relations:
+    #
+    # * custom fields (one to many, ordered by "sort_order")
+    # * sections (many to many)
+    #
+    # When creating or saving a group you are required to specify a "name" field.
+    # This field may also be no longer than 255 characters.
+    #
+    # @author Yorick Peterse
+    # @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"
+      
+      ##
+      # Validates rules used whenever the model is created or saved.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def validate
+        validates_presence        [:name]
+        validates_max_length 255, [:name]
+      end
+    end
+  end
+end

data/lib/zen/packages/custom_fields/lib/custom_fields/model/custom_field_value.rb

@@ -0,0 +1,20 @@
+module CustomFields
+  module Models
+    ##
+    # Model that represents a single custom field value. This model
+    # has the following relations:
+    #
+    # * custom field (many to one)
+    # * section entry (many to one)
+    #
+    # This model is basically just a join table with some extra columns.
+    #
+    # @author Yorick Peterse
+    # @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"
+    end
+  end
+end

data/lib/zen/packages/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/packages/custom_fields/lib/custom_fields/view/admin/custom_field_groups/form.xhtml

@@ -0,0 +1,18 @@
+#{
+form_for(@field_group, :method => :post, :action => @form_save_url) 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 @field_groups_lang.labels[:name], :name
+    
+    f.textarea @field_groups_lang.labels[:description], :description, :rows => 8
+  end
+  
+  f.g.div :class => "clearfix" do
+    f.g.div :class => "button" do
+      f.g.input :type => 'submit', :value => @field_groups_lang.buttons[:save_group]
+    end
+  end
+end
+}

data/lib/zen/packages/custom_fields/lib/custom_fields/view/admin/custom_field_groups/index.xhtml

@@ -0,0 +1,88 @@
+<article>
+  <header>
+    <h1>#{get_breadcrumbs}</h1>
+  </header>
+  
+  <form method="post" action="#{@form_delete_url}">
+    <input type="hidden" name="csrf_token" value="#{get_csrf_token}" />
+    
+    <?r if @field_groups and !@field_groups.empty? ?>
+    
+    <table class="table">
+      <thead>
+        <tr>
+          <?r if user_authorized?([:delete]) ?>
+          <th>
+            <input type="checkbox" />
+          </th>
+          <?r end ?>
+          
+          <th>#{@field_groups_lang.labels[:id]}</th>
+          <th>#{@field_groups_lang.labels[:name]}</th>
+          <th>#{@field_groups_lang.labels[:sections]}</th>
+          
+          <?r if user_authorized?([:create]) ?>
+          <th></th>
+          <?r end ?>
+          
+        </tr>
+      </thead>
+      <tbody>
+        <?r @field_groups.each do |group| ?>
+        <tr>
+          <?r if user_authorized?([:delete]) ?>
+          <td>
+            <input type="checkbox" name="custom_field_group_ids[]" value="#{group.id}" />
+          </td>
+          <?r end ?>
+          
+          <td>#{group.id}</td>
+          
+          <?r if user_authorized?([:update]) ?>
+          <td>#{anchor_to(group.name, "admin/custom_field_groups/edit/#{group.id}", :title => group.name)}</td>
+          <?r else ?>
+          <td>#{group.name}</td>
+          <?r end ?>
+          
+          <td>
+            <?r sections = group.sections.map { |s| s.name } ?>
+                    
+            <?r if !sections.empty? ?>
+              #{sections.join(', ')}
+            <?r else ?>
+              #{@field_groups_lang.labels[:none]}
+            <?r end ?> 
+          </td>
+          
+          <?r if user_authorized?([:create]) ?>
+          <td>#{anchor_to(@field_groups_lang.labels[:manage_fields], "admin/custom_fields/index/#{group.id}", :title => @field_groups_lang.labels[:manage_fields])}</td>
+          <?r end ?>
+          
+        </tr>
+        <?r end ?>
+      </tbody>
+    </table>
+    
+    <?r else ?>
+    
+    <p>#{@field_groups_lang.messages[:no_groups]}</p>
+    
+    <?r end ?>
+    
+    <div class="clearfix">
+      
+      <?r if user_authorized?([:create]) ?>
+      <div class="button">
+        #{anchor_to(@field_groups_lang.buttons[:new_group], "admin/custom_field_groups/new")}
+      </div>
+      <?r end ?>
+      
+      <?r if user_authorized?([:delete]) and @field_groups and !@field_groups.empty? ?>
+      <div class="button">
+        <input type="submit" value="#{@field_groups_lang.buttons[:delete_groups]}" />
+      </div>
+      <?r end ?>
+    </div>
+
+  </form>
+</article>