zen 0.2.4.1 → 0.2.5

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module Comments
   #:nodoc:
-  module Controllers
+  module Controller
     ##
     # Controller used for managing comments. Administrations can't actually
     # add new comments using the backend controller but can edit or delete them.
@@ -13,11 +13,10 @@ module Comments
     # @author  Yorick Peterse
     # @since   0.1
     #
-    class Comments < Zen::Controllers::AdminController
-      include ::Comments::Models
+    class Comments < Zen::Controller::AdminController
+      include ::Comments::Model
 
-      map '/admin/comments'
-      trait :extension_identifier => 'com.zen.comments'
+      map('/admin/comments')
       
       before_all do
         csrf_protection(:save, :delete) do

data/lib/zen/package/comments/lib/comments/controller/comments_form.rb

@@ -1,7 +1,7 @@
 #:nodoc:
 module Comments
   #:nodoc:
-  module Controllers
+  module Controller
     ##
     # Frontend controller for the comments system used for saving user-submitted comments.
     # When the anti-spam system is enabled Zen will use Defensio to check if the comment is
@@ -10,11 +10,10 @@ module Comments
     # @author Yorick Peterse
     # @since  0.1
     # 
-    class CommentsForm < Zen::Controllers::FrontendController
-      include ::Comments::Models
+    class CommentsForm < Zen::Controller::FrontendController
+      include ::Comments::Model
       
-      map '/comments_form'
-      trait :extension_identifier => 'com.zen.comments'
+      map('/comments-form')
       
       before_all do
         csrf_protection(:save) do
@@ -34,7 +33,7 @@ module Comments
 
         comment = Comment.new
         post    = request.params.dup
-        entry   = ::Sections::Models::SectionEntry[h(post['section_entry']).to_i]
+        entry   = ::Sections::Model::SectionEntry[h(post['section_entry']).to_i]
         
         # Remove empty values
         post.each { |k, v| post.delete(k) if v.empty? }
@@ -82,9 +81,9 @@ module Comments
         end
         
         # Require anti-spam validation?
-        if session[:settings][:enable_antispam] == '1'
+        if ::Zen::Settings[:enable_antispam] == '1'
           # Validate the comment
-          api_key = session[:settings][:defensio_key]
+          api_key = ::Zen::Settings[:defensio_key]
           
           if api_key.nil?
             flash[:error] = lang('comments.errors.no_api_key')

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module Comments
   #:nodoc:
-  module Models
+  module Model
     ##
     # Model that represents a single comment. This model has the following relations:
     #
@@ -18,8 +18,8 @@ module Comments
     class Comment < Sequel::Model
       include ::Zen::Language
 
-      many_to_one :section_entry, :class => "Sections::Models::SectionEntry"
-      many_to_one :user,          :class => "Users::Models::User"
+      many_to_one :section_entry, :class => "Sections::Model::SectionEntry"
+      many_to_one :user,          :class => "Users::Model::User"
       
       plugin :timestamps, :create => :created_at, :update => :updated_at
       
@@ -38,7 +38,7 @@ module Comments
       # Returns a hash containing all available statuses for each comment.
       #
       # @example
-      #  Comments::Models::Comment.status_hash
+      #  Comments::Model::Comment.status_hash
       #
       # @author Yorick Peterse
       # @since  0.2

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

@@ -0,0 +1,111 @@
+#:nodoc
+module Comments
+  #:nodoc
+  module Plugin
+    ##
+    # The Comments plugin can be used to display a list of comments for a given section
+    # entry.
+    #
+    # ## Usage
+    #
+    # If we want to retrieve all comments for the entry "hello-world":
+    #
+    #     plugin(:comments, :entry => 'hello-world').each do |comment|
+    #       comment[:website]
+    #     end
+    #
+    # For more information about all available options see 
+    # Comments::Plugin::Comments#initialize
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    class Comments
+      include ::Zen::Plugin::Helper
+      include ::Sections::Model
+      include ::Comments::Model
+      
+      ##
+      # 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.
+      #
+      def initialize(options = {})
+        @options = {
+          :limit  => 20,
+          :offset => 0,
+          :markup => true,
+          :entry  => nil
+        }.merge(options)
+
+        # Validate the :entry option
+        validate_type(@options[:limit] , :limit , [Integer, Fixnum])
+        validate_type(@options[:offset], :offset, [Integer, Fixnum])
+        validate_type(@options[:entry] , :entry , [Integer, String, Fixnum])
+        validate_type(@options[:markup], :markup, [FalseClass, TrueClass])
+      end
+
+      ##
+      # 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
+      #
+      def call
+        # Get the section entry
+        if @options[:entry].class == String
+          entry = SectionEntry[:slug => @options[:entry]]
+        else
+          entry = SectionEntry[@options[:entry]]
+        end 
+
+        # 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.
+        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.
+        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])
+
+          # Conver the userdata to a hash as well
+          comment[:user] = {}
+          
+          if !user.nil?
+            user.values.each do |k, v|
+              comment[:user][k] = v
+            end
+          end
+
+          comments[index] = comment
+        end
+
+        return comments
+      end
+
+    end
+  end
+end

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

@@ -5,7 +5,7 @@
     f.input_hidden(:csrf_token, get_csrf_token)
     f.input_hidden(:id        , @comment.id)
     
-    if !@comment.user_id
+    if !@comment.user
       name    = @comment.name
       website = @comment.website
       email   = @comment.email
@@ -37,7 +37,7 @@
     f.select(
       lang('comments.labels.status'), 
       :status, 
-      :values   => Comments::Models::Comment.status_hash,
+      :values   => Comments::Model::Comment.status_hash,
       :selected => @comment.status, 
       :size     => 1
     )

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

@@ -38,7 +38,7 @@
                     <td>
                         #{anchor_to(
                           "#{comment.comment[0, 15]}...", 
-                          Comments::Controllers::Comments.r(:edit, comment.id)
+                          Comments::Controller::Comments.r(:edit, comment.id)
                         )}
                     </td>
                     <?r else ?>
@@ -46,9 +46,9 @@
                     <?r end ?>
                     
                     <td>#{comment.section_entry.title}</td>
-                    <td>#{Comments::Models::Comment.status_hash[comment.status]}</td>
+                    <td>#{Comments::Model::Comment.status_hash[comment.status]}</td>
                     
-                    <?r if !comment.user_id ?>
+                    <?r if !comment.user ?>
                     <td>#{comment.name}</td>
                     <td>#{comment.email}</td>
                     <td>#{comment.website}</td>

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

@@ -1,23 +1,30 @@
+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')
 
-# 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::Language.options.paths.push(__DIR__('custom_fields'))
+Zen::Language.load('custom_fields')
+Zen::Language.load('custom_field_groups')
 
 Zen::Package.add do |p|
-  p.name          = 'Custom Fields'
+  p.name          = 'custom_fields'
   p.author        = 'Yorick Peterse'
   p.url           = 'http://yorickpeterse.com/'
-  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.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 => "Custom Fields",
+    :title => lang('custom_fields.titles.index'),
     :url   => "admin/custom-field-groups"
   }]
+
+  p.controllers = {
+    lang('custom_fields.titles.index')       => CustomFields::Controller::CustomFields, 
+    lang('custom_field_groups.titles.index') => CustomFields::Controller::CustomFieldGroups
+  }
 end

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module CustomFields
   #:nodoc:
-  module Controllers
+  module Controller
     ##
     # Controller for managing custom field groups. These groups are used
     # to organize individual fields into a larger group which in turn will
@@ -10,11 +10,10 @@ module CustomFields
     # @author  Yorick Peterse
     # @since   0.1
     #
-    class CustomFieldGroups < Zen::Controllers::AdminController
-      include ::CustomFields::Models
+    class CustomFieldGroups < Zen::Controller::AdminController
+      include ::CustomFields::Model
 
-      map   '/admin/custom-field-groups'
-      trait :extension_identifier => 'com.zen.custom_fields' 
+      map('/admin/custom-field-groups')
       
       before_all do
         csrf_protection(:save, :delete) do

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module CustomFields
   #:nodoc:
-  module Controllers
+  module Controller
     ##
     # Controller for managing custom fields. Custom fields are one of
     # the most important elements in Zen. Custom fields can be used to
@@ -12,11 +12,10 @@ module CustomFields
     # @author  Yorick Peterse
     # @since   0.1
     #
-    class CustomFields < Zen::Controllers::AdminController
-      include ::CustomFields::Models
+    class CustomFields < Zen::Controller::AdminController
+      include ::CustomFields::Model
 
-      map   '/admin/custom-fields'
-      trait :extension_identifier => 'com.zen.custom_fields'
+      map('/admin/custom-fields')
       
       before_all do
         csrf_protection(:save, :delete) do

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module CustomFields
   #:nodoc:
-  module Models
+  module Model
     ##
     # Model that represents a single custom field. This model has the following
     # relations:
@@ -21,7 +21,7 @@ module CustomFields
     class CustomField < Sequel::Model
       one_to_many(
         :custom_field_values, 
-        :class => "CustomFields::Models::CustomFieldValue"
+        :class => "CustomFields::Model::CustomFieldValue"
       )
       
       plugin :sluggable, :source => :name, :freeze => false

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module CustomFields
   #:nodoc:
-  module Models
+  module Model
     ##
     # Model that represents a single custom field group. This model has
     # the following relations:
@@ -18,13 +18,13 @@ module CustomFields
     class CustomFieldGroup < Sequel::Model
       one_to_many(
         :custom_fields, 
-        :class => "CustomFields::Models::CustomField", 
+        :class => "CustomFields::Model::CustomField", 
         :order => :sort_order
       )
 
       many_to_many(
         :sections, 
-        :class => "Sections::Models::Section"
+        :class => "Sections::Model::Section"
       )
       
       ##

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module CustomFields
   #:nodoc:
-  module Models
+  module Model
     ##
     # Model that represents a single custom field value. This model
     # has the following relations:
@@ -15,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::Model::CustomField")
+      many_to_one(:section_entry, :class => "Sections::Model::SectionEntry")
 
       ##
       # Hook that is executed before saving a field's value. This hook is used to clean

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

@@ -21,7 +21,9 @@
                     <th>#{lang('custom_field_groups.labels.name')}</th>
                     <th>#{lang('custom_field_groups.labels.sections')}</th>
                     
-                    <?r if user_authorized?([:create]) ?>
+                    <?r if user_authorized?(
+                      [:read], true, 'CustomFields::Controller::CustomFields'
+                    ) ?>
                     <th></th>
                     <?r end ?>
                 </tr>
@@ -41,7 +43,7 @@
                     <td>
                         #{anchor_to(
                           group.name, 
-                          CustomFields::Controllers::CustomFieldGroups.r(:edit, group.id), 
+                          CustomFields::Controller::CustomFieldGroups.r(:edit, group.id), 
                           :title => group.name
                         )}
                     </td>
@@ -58,11 +60,13 @@
                         <?r end ?> 
                     </td>
                     
-                    <?r if user_authorized?([:create]) ?>
+                    <?r if user_authorized?(
+                      [:read], true, 'CustomFields::Controller::CustomFields'
+                    ) ?>
                     <td>
                       #{anchor_to(
                           lang('custom_field_groups.labels.manage_fields'), 
-                          CustomFields::Controllers::CustomFields.r(:index, group.id) 
+                          CustomFields::Controller::CustomFields.r(:index, group.id) 
                         )}
                     </td>
                     <?r end ?>
@@ -84,7 +88,7 @@
             <div class="button">
                 #{anchor_to(
                   lang('custom_field_groups.buttons.new'), 
-                  CustomFields::Controllers::CustomFieldGroups.r(:new)
+                  CustomFields::Controller::CustomFieldGroups.r(:new)
                 )}
             </div>
             <?r end ?>

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

@@ -45,7 +45,7 @@ form_for(
     f.select(
       lang('custom_fields.labels.format'),
       :format, 
-      :values   => @format_hash, 
+      :values   => Zen::Plugin::Markup::Engines, 
       :size     => 1,
       :selected => @custom_field.format
     )