zen 0.2.7 → 0.2.8

data/lib/zen/package/comments/lib/comments/plugin/comments.rb

@@ -3,8 +3,8 @@ module Comments
   #:nodoc
   module Plugin
     ##
-    # The Comments plugin can be used to display a list of comments for a given section
-    # entry.
+    # The Comments plugin can be used to display a list of comments for a given 
+    # section entry.
     #
     # ## Usage
     #
@@ -26,18 +26,21 @@ module Comments
       include ::Comments::Model
       
       ##
-      # Creates a new instance of the plugin and saves the specified configuration options.
+      # Creates a new instance of the plugin and saves the specified 
+      # configuration options.
       #
       # @author Yorick Peterse
       # @since  0.2.5
-      # @param  [Hash] options Hash with a set of options that determine how the comments
-      # should be retrieved.
-      # @option options [String/Integer] :entry The slug or ID of the entry for which to
-      # retrieve all comments.
-      # @option options [Integer] :limit The maximum amount of comments to retrieve.
-      # @option options [Integer] :offset The row offset, useful for pagination systems.
-      # @option options [Boolean] :markup When set to true (default) the markup used in
-      # each comment will be converted to the appropriate format.
+      # @param  [Hash] options Hash with a set of options that determine how 
+      # the comments should be retrieved.
+      # @option options [String/Integer] :entry The slug or ID of the entry for 
+      # which to retrieve all comments.
+      # @option options [Integer] :limit The maximum amount of comments to 
+      # retrieve.
+      # @option options [Integer] :offset The row offset, useful for pagination 
+      # systems.
+      # @option options [Boolean] :markup When set to true (default) the markup 
+      # used in each comment will be converted to the appropriate format.
       #
       def initialize(options = {})
         @options = {
@@ -55,8 +58,8 @@ module Comments
       end
 
       ##
-      # Retrieves all comments based on the options set in the construct. The comments are
-      # returned as an array.
+      # Retrieves all comments based on the options set in the construct. The 
+      # comments are returned as an array.
       #
       # @author Yorick Peterse
       # @since  0.2.5
@@ -69,27 +72,29 @@ module Comments
           entry = SectionEntry[@options[:entry]]
         end 
 
-        # Now that we have the entry and the section we can start retrieving all the 
-        # comments.
+        # Now that we have the entry and the section we can start retrieving 
+        # all the comments.
         comments = Comment.filter(:section_entry_id => entry.id) \
           .limit(@options[:limit], @options[:offset]) \
           .all
 
-        # Don't bother with all code below this if/end if we don't want to convert the
-        # markup of each comment.
+        # Don't bother with all code below this if/end if we don't want to 
+        # convert the markup of each comment.
         if @options[:markup] === false
           return comments
         end
 
-        # Get the section for the comments. This is required to determine what markup is 
-        # used for the comments.
+        # Get the section for the comments. This is required to determine what 
+        # markup is used for the comments.
         section = entry.section
 
         # Convert the markup of each comment and convert each comment to a hash
         comments.each_with_index do |comment, index|
           user              = comment.user
           comment           = comment.values
-          comment[:comment] = plugin(:markup, section.comment_format, comment[:comment])
+          comment[:comment] = plugin(
+            :markup, section.comment_format, comment[:comment]
+          )
 
           # Conver the userdata to a hash as well
           comment[:user] = {}

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

@@ -1,57 +1,64 @@
-#{
-  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)
+<article>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
     
-    if !@comment.user
-      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
-    )
+    #{
+      form_for(
+        @comment, 
+        :method => :post, 
+        :action => Comments::Controller::Comments.r(:save), 
+        :id     => :comment_form
+      ) do |f|
+        f.input_hidden(:csrf_token, get_csrf_token)
+        f.input_hidden(:id        , @comment.id)
+        
+        if !@comment.user
+          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::Model::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'))
+        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'), 
+          :comment_status_id, 
+          :values   => Comments::Model::Comment.status_hash,
+          :selected => @comment.comment_status_id,
+          :size     => 1
+        )
+        
+        f.textarea(
+          lang('comments.labels.comment'), 
+          :comment, 
+          :rows => 10
+        )
+        
+        f.g.div(:class => 'button') do
+          f.g.input(:type => 'submit', :value => lang('comments.buttons.save'))
+        end
       end
-    end
-  end
-}
+    }
+</article>

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

@@ -2,15 +2,16 @@
     <header>
         <h1>#{get_breadcrumbs}</h1>
     </header>
-    
-    <form method="post" action="#{@form_delete_url}">
+
+    <form method="post" action="#{Comments::Controller::Comments.r(:delete)}">
         <input type="hidden" name="csrf_token" value="#{get_csrf_token}" />
-        
+
         <?r if @comments and !@comments.empty? ?>
-        <table class="table">
+
+        <table>
             <thead>
                 <?r if user_authorized?([:delete]) ?>
-                <th>
+                <th class="no_sort">
                     <input type="checkbox" />
                 </th>
                 <?r end ?>
@@ -23,31 +24,37 @@
                 <th>#{lang('comments.labels.website')}</th>
                 <th>#{lang('comments.labels.created_at')}</th>
              </thead>
-            <tbody> 
+            <tbody>
                 <?r @comments.each do |comment| ?>
                 <tr>
                     <?r if user_authorized?([:delete]) ?>
                     <td>
-                        <input type="checkbox" name="comment_ids[]" value="#{comment.id}" />
+                        <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::Controller::Comments.r(:edit, comment.id)
+                        #{Comments::Controller::Comments.a(
+                          comment.comment[0, 15].to_s + '...',
+                          :edit,
+                          comment.id
                         )}
                     </td>
                     <?r else ?>
                     <td>#{comment.comment[0, 15]}...</td>
                     <?r end ?>
-                    
+
                     <td>#{comment.section_entry.title}</td>
-                    <td>#{Comments::Model::Comment.status_hash[comment.status]}</td>
-                    
+                    <td>
+                        #{lang(
+                          "comments.labels.#{comment.comment_status.name}"
+                        )}
+                    </td>
+
                     <?r if !comment.user ?>
                     <td>#{comment.name}</td>
                     <td>#{comment.email}</td>
@@ -58,22 +65,30 @@
                     <td>#{user.email}</td>
                     <td>#{user.website}</td>
                     <?r end ?>
-                    <td>#{comment.created_at.strftime(session[:user].date_format)}</td>
+                    <td>
+                        #{comment.created_at.strftime(
+                          session[:user].date_format
+                        )}
+                    </td>
                 </tr>
                 <?r end ?>
             </tbody>
         </table>
+
+        #{
+        if @comments.respond_to?(:navigation) and @comments.page_count > 1
+          @comments.navigation
+        end
+        }
+
         <?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>
+
+        <?r if user_authorized?([:delete]) and !@comments.empty? ?>
+        <div class="button">
+            <input type="submit" value="#{lang('comments.buttons.delete')}" />
         </div>
         <?r end ?>
-        
     </form>
 </article>

data/lib/zen/package/comments/migrations/1308774099_comment_status.rb

@@ -0,0 +1,60 @@
+Sequel.migration do
+  # Updates the database with the changes specified in the block.
+  up do
+    create_table(:comment_statuses) do
+      primary_key :id
+
+      String :name, :null => false, :unique => true
+    end
+
+    # Get all the current comments so we can update the statuses
+    comments = Zen.database[:comments].all
+
+    # Replace the old status column
+    drop_column(:comments, :status)
+
+    alter_table(:comments) do
+      add_foreign_key(
+        :comment_status_id,
+        :comment_statuses,
+        :on_delete => :cascade,
+        :on_update => :cascade,
+        :key       => :id
+      )
+    end
+
+    # Insert the possible statuses and migrate existing statuses over to the IDs
+    ['open', 'closed', 'spam'].each do |status|
+      status_id = Zen.database[:comment_statuses].insert({:name => status})
+
+      comments.each do |comment|
+        if comment[:status] === status
+          Zen.database[:comments].filter(:id => comment[:id]) \
+            .update(:comment_status_id => status_id)
+        end
+      end
+    end
+  end
+
+  # Reverts the changes made in the up() block.
+  down do
+    statuses = {}
+    comments = Zen.database[:comments].all
+
+    Zen.database[:comment_statuses].all.each do |status|
+      statuses[status[:id]] = status[:name]
+    end
+
+    # Put the old columns back in place
+    drop_column(:comments, :comment_status_id)
+    add_column(:comments, :status, String, :default => 'closed')
+
+    # Put the old statuses back in place
+    comments.each do |comment|
+      Zen.database.filter(:id => comment[:id]) \
+        .update(:status => statuses[comment[:comment_status_id]])
+    end
+
+    drop_table(:comment_statuses)
+  end
+end

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

@@ -1,30 +1,56 @@
+# Update the helpers path for the controllers
+Ramaze::HelpersHelper.options.paths.push(__DIR__('custom_fields'))
+
+# Update the language path
+Zen::Language.options.paths.push(__DIR__('custom_fields'))
+
+# Load all models
+require __DIR__('custom_fields/model/custom_field_method')
+require __DIR__('custom_fields/model/custom_field_type')
 require __DIR__('custom_fields/model/custom_field')
 require __DIR__('custom_fields/model/custom_field_group')
 require __DIR__('custom_fields/model/custom_field_value')
+
+# Load all controllers
 require __DIR__('custom_fields/controller/custom_field_groups')
 require __DIR__('custom_fields/controller/custom_fields')
+require __DIR__('custom_fields/controller/custom_field_types')
 
-Zen::Language.options.paths.push(__DIR__('custom_fields'))
+require __DIR__('custom_fields/blue_form_parameters')
+
+# Load all the language files
 Zen::Language.load('custom_fields')
 Zen::Language.load('custom_field_groups')
+Zen::Language.load('custom_field_types')
 
+# Define the package
 Zen::Package.add do |p|
   p.name          = 'custom_fields'
   p.author        = 'Yorick Peterse'
   p.url           = 'http://yorickpeterse.com/'
-  p.about         = "The Custom Fields module is used to manage custom fields and custom 
-field groups."
+  p.about         = "The Custom Fields module is used to manage custom fields 
+and custom field groups."
 
   p.directory     = __DIR__('custom_fields')
   p.migration_dir = __DIR__('../migrations')
   
   p.menu = [{
-    :title => lang('custom_fields.titles.index'),
-    :url   => "admin/custom-field-groups"
+    :title    => lang('custom_fields.titles.index'),
+    :url      => "admin/custom-field-groups",
+    :children => [
+      {
+        :title => lang('custom_field_types.titles.index'),
+        :url   => 'admin/custom-field-types'
+      }
+    ]
   }]
 
   p.controllers = {
-    lang('custom_fields.titles.index')       => CustomFields::Controller::CustomFields, 
-    lang('custom_field_groups.titles.index') => CustomFields::Controller::CustomFieldGroups
+    lang('custom_fields.titles.index') \
+      => CustomFields::Controller::CustomFields, 
+    lang('custom_field_groups.titles.index') \
+      => CustomFields::Controller::CustomFieldGroups,
+    lang('custom_field_types.titles.index') \
+      => CustomFields::Controller::CustomFieldTypes
   }
 end

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

@@ -0,0 +1,209 @@
+#:nodoc:
+module CustomFields
+  ##
+  # The BlueFormParameters module is used to build an array of parameters for
+  # various BlueForm methods based on the type and method of a custom field.
+  #
+  # @author Yorick Peterse
+  # @since  0.2.8
+  #
+  module BlueFormParameters
+    class << self
+      ##
+      # Generates the required parameters for
+      # Ramaze::Helper::BlueForm::Form#input_text.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @param  [CustomFields::Model::CustomField] field The custom field to use
+      # for filling in classes, values, etc.
+      # @param  [CustomFields::Model::CustomFieldValue] field_value The
+      # value of the custom field for a given entry.
+      # @return [Array]
+      #
+      def input_text(field, field_value)
+        type   = field.custom_field_type
+        value  = field_value.value rescue nil
+        params = [
+          :input_text,
+          field.name,
+          "custom_field_value_#{field.id}",
+          {:value => value}
+        ]
+
+        if !field.text_limit.nil?
+          params.last[:maxlength] = field.text_limit
+        end
+
+        if !field.description.nil?
+          params.last[:placeholder] = field.description
+        end
+
+        if !field.format.nil? and !field.format.empty? \
+        and type.allow_markup === true
+          params.last[:'data-format'] = field.format
+        end
+
+        if !type.html_class.nil? and !type.html_class.empty?
+          params.last[:class] = type.html_class
+        end
+
+        return params
+      end
+
+      ##
+      # Generates the required parameters for
+      # Ramaze::Helper::BlueForm::Form#input_password.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @see    CustomFields::BlueFormParameters.input_text
+      #
+      def input_password(field, field_value)
+        params    = input_text(field, field_value)
+        params[0] = :input_password
+
+        params.last.delete(:'data-format')
+
+        return params
+      end
+
+      ##
+      # Generates the required parameters for
+      # Ramaze::Helper::BlueForm::Form#textarea.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @see    CustomFields::BlueFormParameters.input_text
+      #
+      def textarea(field, field_value)
+        params    = input_text(field, field_value)
+        params[0] = :textarea
+
+        if !field.textarea_rows.nil?
+          params.last[:rows] = field.textarea_rows
+        end
+
+        # Remove the class "text]editor" if the field does not allow the text
+        # editor to be used.
+        if field.text_editor === false
+          params.last[:class].gsub!('text_editor', '')
+        end
+
+        return params
+      end
+
+      ##
+      # Generates the required parameters for
+      # Ramaze::Helper::BlueForm::Form#input_radio.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @see    CustomFields::BlueFormParameters.input_text
+      #
+      def input_radio(field, field_value)
+        type   = field.custom_field_type
+        value  = field_value.value rescue nil
+        params = [
+          :input_radio,
+          field.name,
+          "custom_field_value_#{field.id}",
+          value,
+          {}
+        ]
+
+        # Convert the string containing the possible values to a hash.
+        if !field.possible_values.nil? and !field.possible_values.empty?
+          params.last[:values] = {}
+
+          field.possible_values.split(/\n|\r\n/).each do |row|
+            if row.include?('|')
+              row        = row.split('|', 2)
+              key, value = row[0], row[1]
+            else
+              key = value = row
+            end
+
+            params.last[:values][key] = value
+          end
+        end
+
+        return params
+      end
+
+      ##
+      # Generates the required parameters for
+      # Ramaze::Helper::BlueForm::Form#input_checkbox.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @see    CustomFields::BlueFormParameters.input_radio
+      #
+      def input_checkbox(field, field_value)
+        params    = input_radio(field, field_value)
+        params[0] = :input_checkbox
+
+        return params
+      end
+
+      ##
+      # Generates the required parameters for
+      # Ramaze::Helper::BlueForm::Form#select.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @see    CustomFields::BlueFormParameters.input_text
+      #
+      def select(field, field_value)
+        type   = field.custom_field_type
+        value  = field_value.value rescue nil
+        params = [
+          :select,
+          field.name,
+          "custom_field_value_#{field.id}",
+          {:selected => value, :size => 1}
+        ]
+
+        # Convert the string containing the possible values to a hash.
+        if !field.possible_values.nil? and !field.possible_values.empty?
+          params.last[:values] = {}
+
+          field.possible_values.split(/\n|\r\n/).each do |row|
+            if row.include?('|')
+              row        = row.split('|', 2)
+              key, value = row[0], row[1]
+            else
+              key = value = row
+            end
+
+            params.last[:values][key] = value
+          end
+        end
+
+        return params
+      end
+
+      ##
+      # Generates the required parameters for
+      # Ramaze::Helper::BlueForm::Form#select but allows multiple values to be
+      # selected.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @see    CustomFields::BlueFormParameters.select
+      #
+      def select_multiple(field, field_value)
+        params = select(field, field_value)
+
+        params.last[:multiple] = :multiple
+        params.last[:values]   = params.last[:values].invert
+
+        params.last.delete(:size)
+
+        return params
+      end
+
+      private
+    end # class << self
+  end # BlueFormParameters
+end # CustomFields