zen 0.1a

data/lib/zen/packages/comments/lib/comments/liquid/comments.rb

@@ -0,0 +1,115 @@
+module Comments
+  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 %}
+    #
+    # The following arguments can be used for this tag:
+    #
+    # * section_entry: the slug of the section entry for which to retrieve all comments
+    # * limit: the amount of comments to retriee
+    # * offset: the offset from which to start retrieving comments
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    #
+    class Comments < ::Liquid::Block
+      include ::Ramaze::Helper::CGI
+      include ::Zen::Liquid::General
+      
+      ##
+      # Creates a new instance of the block and passes the tag name,
+      # all additional arguments and the HTML to the constructor method.
+      #
+      # @author Yorick Peterse
+      # @param  [String] tag_name The name of the tag that was called.
+      # @param  [String] arguments All additional arguments passed as a string.
+      # @param  [String] html The HTML inside the block.
+      # @since  0.1
+      #
+      def initialize tag_name, arguments, html
+        super
+        
+        @arguments = {
+          'limit'  => nil,
+          'offset' => nil
+        }.merge(parse_key_values(arguments))
+        
+        @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"
+        end
+      end
+      
+      ##
+      # Retrieves all comments and renders the tag block.
+      # 
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      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
+        end
+        
+        @args_parsed = true
+        result       = []
+        filter_hash  = {:status => 'open'}
+        comments     = []
+        format       = nil
+        
+        if @arguments.key?('section_entry')
+          entry = ::Sections::Models::SectionEntry[:slug => @arguments['section_entry']]
+          
+          return if entry.nil?
+          filter_hash[:section_entry_id] = entry.id
+        end
+    
+        comments = ::Comments::Models::Comment
+          .eager(:user, :section_entry)
+          .filter(filter_hash)
+          .limit(@arguments['limit'], @arguments['offset'])
+          
+        context['total_rows'] = comments.count
+        
+        comments.each_with_index do |comment, index|
+          context['index'] = index
+          
+          if format.nil?
+            section = comment.section_entry.section
+            format  = section.comment_format
+          end
+          
+          comment.values.each { |k, v| context[k.to_s] = v }
+          
+          # Convert the comment body into HTML
+          context['comment'] = markup_to_html(context['comment'], format)
+          
+          ['email', 'name', 'website'].each do |c|
+            if context[c].nil? or context[c].empty?
+              context[c] = comment.user.send(c)
+            end
+          end
+          
+          result << render_all(@nodelist, context)
+        end
+        
+        result << render_all(@nodelist, context) if result.empty?
+        return result
+      end
+    end
+  end
+end

data/lib/zen/packages/comments/lib/comments/model/comment.rb

@@ -0,0 +1,34 @@
+module Comments
+  module Models
+    ##
+    # Model that represents a single comment. This model has the following relations:
+    #
+    # * section entry (many to one)
+    # * user (many to one)
+    #
+    # The following plugins are used:
+    #
+    # * timestamps 
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    #
+    class Comment < Sequel::Model
+      many_to_one :section_entry, :class => "Sections::Models::SectionEntry"
+      many_to_one :user,          :class => "Users::Models::User"
+      
+      plugin :timestamps, :create => :created_at, :update => :updated_at
+      
+      ##
+      # Specify the validation rules for each comment.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def validate
+        validates_presence :comment
+        validates_presence :email
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+#{
+  form_for(@comment, :method => :post, :action => @form_save_url) 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 @comments_lang.labels[:name], :name, :value => name
+    f.input_text @comments_lang.labels[:website], :website, :value => website
+    f.input_text @comments_lang.labels[:email], :email, :value => email
+    
+    f.select @comments_lang.labels[:status], :status, :values => @comments_lang.special[:status_hash],
+      :selected => @comment.status, :size => 1
+    
+    f.textarea @comments_lang.labels[:comment], :comment, :rows => 10
+    
+    f.g.div :class => 'clearfix' do
+      f.g.div :class => 'button' do
+        f.g.input :type => 'submit', :value => @comments_lang.buttons[:save_comment]
+      end
+    end
+  end
+}

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

@@ -0,0 +1,74 @@
+<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>#{@comments_lang.labels[:id]}</th>
+        <th>#{@comments_lang.labels[:comment]}</th>
+        <th>#{@comments_lang.labels[:entry]}</th>
+        <th>#{@comments_lang.labels[:status]}</th>
+        <th>#{@comments_lang.labels[:name]}</th>
+        <th>#{@comments_lang.labels[:email]}</th>
+        <th>#{@comments_lang.labels[:website]}</th>
+        <th>#{@comments_lang.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]}...", "admin/comments/edit/#{comment.id}")}</td>
+          <?r else ?>
+          <td>#{comment.comment[0, 15]}...</td>
+          <?r end ?>
+          
+          <td>#{comment.section_entry.title}</td>
+          <td>#{@comments_lang.special[: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>#{@comments_lang.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="#{@comments_lang.buttons[:delete_comments]}" />
+      </div>
+    </div>
+    <?r end ?>
+    
+  </form>
+</article>

data/lib/zen/packages/comments/migrations/1295282202_create_schema.rb

@@ -0,0 +1,24 @@
+Sequel.migration do
+
+  up do
+    create_table :comments do
+      primary_key :id
+     
+      Integer :user_id
+      String  :name
+      String  :website
+      String  :email
+      String  :comment,    :text => true
+      Enum    :status,     :elements => ['open', 'closed', 'spam'], :default => 'closed'
+      Time    :created_at
+      Time    :updated_at
+      
+      foreign_key :section_entry_id, :section_entries, :on_delete => :cascade, :on_update => :cascade, :key => :id
+    end
+  end
+  
+  down do
+    drop_table :comments
+  end
+
+end

data/lib/zen/packages/comments/migrations/1296949631_add_defensio_signature.rb

@@ -0,0 +1,11 @@
+Sequel.migration do
+
+  up do
+    add_column :comments, :defensio_signature, String, :null => true
+  end
+  
+  down do
+    drop_column :comments, :defensio_signature
+  end
+
+end

data/lib/zen/packages/custom_fields/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011, Yorick Peterse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

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

@@ -0,0 +1,24 @@
+
+# Load all the classes such as controllers, models and so on.
+require __DIR__ 'custom_fields/model/custom_field'
+require __DIR__ 'custom_fields/model/custom_field_group'
+require __DIR__ 'custom_fields/model/custom_field_value'
+
+require __DIR__ 'custom_fields/controller/custom_field_groups'
+require __DIR__ 'custom_fields/controller/custom_fields'
+
+Zen::Package.add do |p|
+  p.type        = 'extension'
+  p.name        = 'Custom Fields'
+  p.author      = 'Yorick Peterse'
+  p.url         = 'http://yorickpeterse.com/'
+  p.version     = 1.0
+  p.about       = "The Custom Fields module is used to manage, how original, custom fields and custom field groups."
+  p.identifier  = 'com.zen.custom_fields'
+  p.directory   = __DIR__('custom_fields')
+  
+  p.menu = [{
+    :title => "Custom Fields",
+    :url   => "admin/custom_field_groups"
+  }]
+end

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

@@ -0,0 +1,179 @@
+module CustomFields
+  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
+      map '/admin/custom_field_groups'
+      
+      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_field_groups/save'
+        @form_delete_url   = '/admin/custom_field_groups/delete'
+        @field_groups_lang = Zen::Language.load 'custom_field_groups'
+        
+        # Set the page title
+        if !action.method.nil?
+          method = action.method.to_sym
+        
+          if @field_groups_lang.titles.key? method
+            @page_title = @field_groups_lang.titles[method]
+          end
+        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.
+      # 
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def index
+        if !user_authorized?([:read])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs @field_groups_lang.titles[:index]
+        
+        @field_groups = CustomFieldGroup.all
+      end
+      
+      ##
+      # Show a form that lets the user edit an existing custom field group.
+      #
+      # @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(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs anchor_to(@field_groups_lang.titles[:index], "admin/custom_field_groups"), @page_title
+        
+        @field_group = CustomFieldGroup[id]
+      end
+      
+      ##
+      # Show a form that lets the user create a new custom field group.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def new
+        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"), @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.
+      #
+      # @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
+        
+        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?
+          @field_group  = CustomFieldGroup[post["id"]]
+          save_action   = :save
+        else
+          @field_group  = CustomFieldGroup.new
+          save_action   = :new
+        end
+        
+        flash_success = @field_groups_lang.success[save_action]
+        flash_error   = @field_groups_lang.errors[save_action]
+        
+        begin
+          @field_group.update(post)
+          notification(:success, @field_groups_lang.titles[:index], flash_success)
+        rescue
+          notification(:error, @field_groups_lang.titles[:index], flash_error)
+          flash[:form_errors] = @field_group.errors
+        end
+        
+        if @field_group.id
+          redirect "/admin/custom_field_groups/edit/#{@field_group.id}"
+        else
+          redirect "/admin/custom_field_groups/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.
+      #
+      # @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_group_ids"] or request.params["custom_field_group_ids"].empty?
+          notification(:error, @field_groups_lang.titles[:index], @field_groups_lang.errors[:no_delete])
+          redirect "/admin/custom_field_groups"
+        end
+        
+        request.params["custom_field_group_ids"].each do |id|
+          @field_group = CustomFieldGroup[id]
+          
+          begin
+            @field_group.delete
+            notification(:success, @field_groups_lang.titles[:index], @field_groups_lang.success[:delete] % id)
+          rescue
+            notification(:error, @field_groups_lang.titles[:index], @field_groups_lang.errors[:delete] % id)
+          end
+        end
+        
+        redirect "/admin/custom_field_groups"
+      end
+    end
+  end
+end