zen 0.1a → 0.2

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

@@ -0,0 +1,42 @@
+---
+titles:
+  index : 'Comments'
+  edit  : 'Edit Comment'
+
+labels:
+  id                 : '#'
+  website            : 'Website'
+  entry              : 'Section Entry'
+  email              : 'Email'
+  status             : 'Status'
+  comment            : 'Comment'
+  name               : 'Name'
+  created_at         : 'Created'
+  updated_at         : 'Updated'
+  defensio_signature : 'Defensio Signature'
+  open               : 'Open'
+  closed             : 'Closed'
+  spam               : 'Spam'
+
+messages:
+  no_comments: 'No comments have been added yet.'
+
+success:
+  new      : 'The new comment has been created.'
+  save     : 'The comment has been modified.'
+  delete   : 'All selected comments have been deleted.'
+  moderate : "The comment has been posted but mush be approved by an administrator before it's displayed."
+
+errors:
+  new                  : 'Failed to create the new comment.'
+  save                 : 'Failed to modify the comment.'
+  delete               : 'Failed to delete the comment with ID #%s.'
+  no_delete            : "You haven't specified any comments to delete."
+  invalid_entry        : 'The specified section entry is invalid.'
+  comments_not_allowed : "Comments aren't allowed for this section."
+  no_api_key           : 'You need to specify an API key for the Defensio system in your settings panel.'
+  defensio_status      : 'The comment could not be saved due to a problem with the Defensio server.'
+
+buttons:
+  delete : 'Delete selected comments'
+  save   : 'Save comment'

data/lib/zen/{packages → package}/comments/lib/comments/liquid/comment_form.rb

@@ -1,14 +1,38 @@
 require 'ramaze/gestalt'
 
+#:nodoc:
 module Comments
+  #:nodoc:
   module Liquid
     ##
-    # Describe...
+    # Liquid tag that can be used to generate the required form elements for submitting
+    # comments. It's important to remember that you still need to define your own
+    # form fields such as those for the name and Email, this tag merely generates
+    # the form open/closing tags and a few hidden fields. The following field (names)
+    # are required when creating a comment form:
+    #
+    # * name
+    # * website
+    # * email
+    # * comment
+    #
+    # Basic usage of this tag is as following:
+    #
+    #     {% comment_form section_entry="hello-world" %}
+    #
+    #       <p>
+    #           <label for="name">Name</label>
+    #           <input type="text" name="name" id="name" />
+    #       </p>
+    #
+    #       <input type="submit" value="Submit comment" />
+    #
+    #     {% endcomment_form %}
     #
     # The following arguments can be used:
     #
-    # * section_entry
-    # * section_entry_id
+    # * section_entry: the slug of the entry
+    # * section_entry_id: the ID of the entry
     #
     # @author Yorick Peterse
     # @since  0.1
@@ -29,7 +53,7 @@ module Comments
       # @param  [String] html The HTML inside the block.
       # @since  0.1
       #
-      def initialize(tag_name, arguments, html)
+      def initialize(tag_name = 'comments_form', arguments = '', html = '')
         super
         
         @arguments   = parse_key_values(arguments)
@@ -57,15 +81,17 @@ module Comments
         g            = Ramaze::Gestalt.new
         user_html    = ''
         
-        super(context).each do |h|
-          user_html += h
-        end
+        super(context).each { |h| user_html += h }
         
         # Get our section to which this form belongs
         if @arguments.key?('section_entry')
-          section_entry = ::Sections::Models::SectionEntry[:slug => @arguments['section_entry']]
+          section_entry = ::Sections::Models::SectionEntry[
+            :slug => @arguments['section_entry']
+          ]
         else
-          section_entry = ::Sections::Models::SectionEntry[@arguments['section_entry_id'].to_i]
+          section_entry = ::Sections::Models::SectionEntry[
+            @arguments['section_entry_id'].to_i
+          ]
         end
         
         # Get the section entry's ID
@@ -82,10 +108,14 @@ module Comments
           user_id = nil
         end
         
-        g_html = form_for(nil, :method => :post, :action => "/comments_form/save") do |f|
-          f.input_hidden :csrf_token, get_csrf_token
-          f.input_hidden :section_entry, section_entry_id
-          f.input_hidden :user_id, user_id
+        g_html = form_for(
+          nil, 
+          :method => :post, 
+          :action => Comments::Controllers::CommentsForm.r(:save)
+        ) do |f|
+          f.input_hidden(:csrf_token   , get_csrf_token)
+          f.input_hidden(:section_entry, section_entry_id)
+          f.input_hidden(:user_id      , user_id)
           
           user_html
         end

data/lib/zen/{packages → package}/comments/lib/comments/liquid/comments.rb

@@ -1,11 +1,12 @@
+#:nodoc:
 module Comments
+  #:nodoc:
   module Liquid
     ##
     # Tag that can be used to display a number of comments based on the section entry ID
     # or the slug of a section entry.
     #
     # @example
-    #
     #  {% comments section_entry="hello-world" limit="10" %}
     #    {{comment}}
     #  {% endcomments %}
@@ -33,7 +34,7 @@ module Comments
       # @param  [String] html The HTML inside the block.
       # @since  0.1
       #
-      def initialize tag_name, arguments, html
+      def initialize(tag_name = 'comments', arguments = '', html = '')
         super
         
         @arguments = {
@@ -44,7 +45,10 @@ module Comments
         @args_parsed = false
         
         if !@arguments.key?('section_entry') or @arguments['section_entry'].empty?
-          raise ArgumentError, "You need to specify a section entry's slug in order to retrieve a set of comments"
+          raise(
+            ArgumentError, 
+            "You need to specify a section entry's slug in order to retrieve a set of comments"
+          )
         end
       end
       
@@ -56,13 +60,7 @@ module Comments
       #
       def render context
         if @args_parsed == false
-          @arguments.each do |k, v|
-            v = v.to_s
-            
-            if context.has_key?(v)
-              @arguments[k] = h(context[v])
-            end
-          end
+          @arguments = merge_context(@arguments, context)
         end
         
         @args_parsed = true
@@ -104,10 +102,10 @@ module Comments
             end
           end
           
-          result << render_all(@nodelist, context)
+          result.push(render_all(@nodelist, context))
         end
         
-        result << render_all(@nodelist, context) if result.empty?
+        result.push(render_all(@nodelist, context)) if result.empty?
         return result
       end
     end

data/lib/zen/{packages → package}/comments/lib/comments/model/comment.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Comments
+  #:nodoc:
   module Models
     ##
     # Model that represents a single comment. This model has the following relations:
@@ -14,6 +16,8 @@ module Comments
     # @since  0.1
     #
     class Comment < Sequel::Model
+      include ::Zen::Language
+
       many_to_one :section_entry, :class => "Sections::Models::SectionEntry"
       many_to_one :user,          :class => "Users::Models::User"
       
@@ -29,6 +33,26 @@ module Comments
         validates_presence :comment
         validates_presence :email
       end
+
+      ##
+      # Returns a hash containing all available statuses for each comment.
+      #
+      # @example
+      #  Comments::Models::Comment.status_hash
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      # @return [Hash]
+      #
+      def self.status_hash
+        ::Zen::Language.load('comments')
+
+        return {
+          'open'   => lang('comments.labels.open'),
+          'closed' => lang('comments.labels.closed'),
+          'spam'   => lang('comments.labels.spam') 
+        }
+      end
     end
   end
 end

data/lib/zen/package/comments/lib/comments/view/admin/comments/edit.xhtml

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

data/lib/zen/package/comments/lib/comments/view/admin/comments/form.xhtml

@@ -0,0 +1,57 @@
+#{
+  form_for(
+    @comment, :method => :post, :action => @form_save_url, :id => :comment_form
+  ) do |f|
+    f.input_hidden(:csrf_token, get_csrf_token)
+    f.input_hidden(:id        , @comment.id)
+    
+    if !@comment.user_id
+      name    = @comment.name
+      website = @comment.website
+      email   = @comment.email
+    else
+      name    = @comment.user.name
+      website = @comment.user.website
+      email   = @comment.user.email
+    end
+    
+    f.input_text(
+      lang('comments.labels.name'), 
+      :name, 
+      :value    => name, 
+      :disabled => :disabled
+    )
+
+    f.input_text(
+      lang('comments.labels.website'), 
+      :website, 
+      :value => website
+    )
+    
+    f.input_text(
+      lang('comments.labels.email'), 
+      :email, 
+      :value => email
+    )
+    
+    f.select(
+      lang('comments.labels.status'), 
+      :status, 
+      :values   => Comments::Models::Comment.status_hash,
+      :selected => @comment.status, 
+      :size     => 1
+    )
+    
+    f.textarea(
+      lang('comments.labels.comment'), 
+      :comment, 
+      :rows => 10
+    )
+    
+    f.g.div(:class => 'clearfix') do
+      f.g.div(:class => 'button') do
+        f.g.input(:type => 'submit', :value => lang('comments.buttons.save'))
+      end
+    end
+  end
+}

data/lib/zen/package/comments/lib/comments/view/admin/comments/index.xhtml

@@ -0,0 +1,79 @@
+<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 @comments and !@comments.empty? ?>
+        <table class="table">
+            <thead>
+                <?r if user_authorized?([:delete]) ?>
+                <th>
+                    <input type="checkbox" />
+                </th>
+                <?r end ?>
+                <th>#{lang('comments.labels.id')}</th>
+                <th>#{lang('comments.labels.comment')}</th>
+                <th>#{lang('comments.labels.entry')}</th>
+                <th>#{lang('comments.labels.status')}</th>
+                <th>#{lang('comments.labels.name')}</th>
+                <th>#{lang('comments.labels.email')}</th>
+                <th>#{lang('comments.labels.website')}</th>
+                <th>#{lang('comments.labels.defensio_signature')}</th>
+             </thead>
+            <tbody> 
+                <?r @comments.each do |comment| ?>
+                <tr>
+                    <?r if user_authorized?([:delete]) ?>
+                    <td>
+                        <input type="checkbox" name="comment_ids[]" value="#{comment.id}" />
+                    </td>
+                    <?r end ?>
+                    
+                    <td>#{comment.id}</td>
+                    
+                    <?r if user_authorized?([:update]) ?>
+                    <td>
+                        #{anchor_to(
+                          "#{comment.comment[0, 15]}...", 
+                          Comments::Controllers::Comments.r(:edit, comment.id)
+                        )}
+                    </td>
+                    <?r else ?>
+                    <td>#{comment.comment[0, 15]}...</td>
+                    <?r end ?>
+                    
+                    <td>#{comment.section_entry.title}</td>
+                    <td>#{Comments::Models::Comment.status_hash[comment.status]}</td>
+                    
+                    <?r if !comment.user_id ?>
+                    <td>#{comment.name}</td>
+                    <td>#{comment.email}</td>
+                    <td>#{comment.website}</td>
+                    <?r else ?>
+                    <?r user = comment.user ?>
+                    <td>#{user.name}</td>
+                    <td>#{user.email}</td>
+                    <td>#{user.website}</td>
+                    <?r end ?>
+                    <td>#{comment.defensio_signature}</td>
+                </tr>
+                <?r end ?>
+            </tbody>
+        </table>
+        <?r else ?>
+        <p>#{lang('comments.messages.no_comments')}</p>
+        <?r end ?>
+        
+        <?r if user_authorized?([:delete]) and @comments and !@comments.empty? ?>
+        <div class="clearfix">
+            <div class="button">
+                <input type="submit" value="#{lang('comments.buttons.delete')}" />
+            </div>
+        </div>
+        <?r end ?>
+        
+    </form>
+</article>

data/lib/zen/{packages → package}/comments/migrations/1295282202_create_schema.rb

@@ -8,12 +8,14 @@ Sequel.migration do
       String  :name
       String  :website
       String  :email
-      String  :comment,    :text => true
-      Enum    :status,     :elements => ['open', 'closed', 'spam'], :default => 'closed'
+      String  :comment,            :text => true
+      String  :defensio_signature
+      String  :status,             :default => 'closed'
       Time    :created_at
       Time    :updated_at
       
-      foreign_key :section_entry_id, :section_entries, :on_delete => :cascade, :on_update => :cascade, :key => :id
+      foreign_key :section_entry_id, :section_entries, :on_delete => :cascade, 
+        :on_update => :cascade, :key => :id
     end
   end
   
@@ -21,4 +23,4 @@ Sequel.migration do
     drop_table :comments
   end
 
-end
+end

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

@@ -19,6 +19,6 @@ Zen::Package.add do |p|
   
   p.menu = [{
     :title => "Custom Fields",
-    :url   => "admin/custom_field_groups"
+    :url   => "admin/custom-field-groups"
   }]
-end
+end

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

@@ -0,0 +1,224 @@
+#:nodoc:
+module CustomFields
+  #:nodoc:
+  module Controllers
+    ##
+    # Controller for managing custom field groups. These groups are used
+    # to organize individual fields into a larger group which in turn will
+    # be assigned to a section.
+    #
+    # @author  Yorick Peterse
+    # @since   0.1
+    #
+    class CustomFieldGroups < Zen::Controllers::AdminController
+      include ::CustomFields::Models
+
+      map   '/admin/custom-field-groups'
+      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_field_groups
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def initialize
+        super
+        
+        @form_save_url     = CustomFieldGroups.r(:save)
+        @form_delete_url   = CustomFieldGroups.r(:delete)
+
+        Zen::Language.load('custom_field_groups')
+        
+        # Set the page title
+        if !action.method.nil?
+          method      = action.method.to_sym
+          @page_title = lang("custom_field_groups.titles.#{method}") rescue nil
+        end
+      end
+      
+      ##
+      # Show an overview of all existing custom field groups. Using this overview a user
+      # can manage an existing field group, delete it or create a new one.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      # 
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def index
+        if !user_authorized?([:read])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        set_breadcrumbs(lang('custom_field_groups.titles.index'))
+        
+        @field_groups = CustomFieldGroup.all
+      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] id The ID of the custom field group to retrieve so that we 
+      # can edit it.
+      # @since  0.1
+      #
+      def edit 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)), 
+          @page_title
+        )
+        
+        if flash[:form_data]
+          @field_group = flash[:form_data]
+        else
+          @field_group = CustomFieldGroup[id.to_i]
+        end
+      end
+      
+      ##
+      # Show a form that lets the user create a new custom field group.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * create
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def new
+        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)), 
+          @page_title
+        )
+        
+        @field_group = CustomFieldGroup.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 group 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
+        
+        # Get or create a custom field group based on the ID from the hidden field.
+        if post['id'] and !post['id'].empty?
+          @field_group  = CustomFieldGroup[post['id'].to_i]
+          save_action   = :save
+        else
+          @field_group  = CustomFieldGroup.new
+          save_action   = :new
+        end
+        
+        flash_success = lang("custom_field_groups.success.#{save_action}")
+        flash_error   = lang("custom_field_groups.errors.#{save_action}")
+        
+        begin
+          @field_group.update(post)
+          notification(:success, lang("custom_field_groups.titles.index"), flash_success)
+        rescue
+          notification(:error, lang("custom_field_groups.titles.index"), flash_error)
+
+          flash[:form_errors] = @field_group.errors
+          flash[:form_data]   = @field_group
+        end
+        
+        if !@field_group.nil? and @field_group.id
+          redirect(CustomFieldGroups.r(:edit, @field_group.id))
+        else
+          redirect(CustomFieldGroups.r(:new))
+        end
+      end
+      
+      ##
+      # Delete an existing custom field group.
+      #
+      # In order to delete a custom field group you'll need to send a POST request 
+      # that contains a field named 'custom_field_group_ids[]'. This field should 
+      # contain the primary values of each field group 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
+        
+        if !request.params['custom_field_group_ids'] or request.params['custom_field_group_ids'].empty?
+          notification(
+            :error, 
+            lang('custom_field_groups.titles.index'), 
+            lang('custom_field_groups.errors.no_delete')
+          )
+          redirect(CustomFieldGroups.r(:index))
+        end
+        
+        request.params['custom_field_group_ids'].each do |id|
+          begin
+            CustomFieldGroup[id.to_i].destroy
+            notification(
+              :success, 
+              lang('custom_field_groups.titles.index'), 
+              lang('custom_field_groups.success.delete')
+            )
+          rescue
+            notification(
+              :error, 
+              lang('custom_field_groups.titles.index'), 
+              lang('custom_field_groups.errors.delete') % id
+            )
+          end
+        end
+        
+        redirect_referrer
+      end
+    end
+  end
+end