zen 0.2.7 → 0.2.8

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

@@ -3,9 +3,9 @@ module Comments
   #:nodoc:
   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
-    # spam or ham.
+    # 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 spam or ham.
     #
     # @author Yorick Peterse
     # @since  0.1
@@ -13,7 +13,8 @@ module Comments
     class CommentsForm < Zen::Controller::FrontendController
       include ::Comments::Model
 
-      map('/comments-form')
+      map '/comments-form'
+      helper :message
 
       before_all do
         csrf_protection(:save) do
@@ -22,8 +23,8 @@ module Comments
       end
 
       ##
-      # Creates a new comment for the section entry. Once the comment has been saved
-      # the user will be redirected back to the previous page.
+      # Creates a new comment for the section entry. Once the comment has been
+      # saved the user will be redirected back to the previous page.
       #
       # @author Yorick Peterse
       # @since  0.1
@@ -33,21 +34,34 @@ module Comments
 
         comment = Comment.new
         post    = request.subset(
-          :section_entry, :user_id, :comment, :name, :website, :email
+          :section_entry,
+          :user_id,
+          :comment,
+          :name,
+          :website,
+          :email
         )
 
+        # Get all the comment statuses.
+        comment_statuses = {}
+        draft_status     = Sections::Model::SectionEntryStatus[
+          :name => 'draft'
+        ].id
+
+        ::Comments::Model::CommentStatus.all.each do |status|
+          comment_statuses[status.name] = status.id
+        end
+
         entry = ::Sections::Model::SectionEntry[post['section_entry']]
 
         # Remove empty values
         post.each { |k, v| post.delete(k) if v.empty? }
 
-        if post.key?('user_id')
-          comment.user_id = post['user_id']
-        end
-
-        # Set the comment data
+        comment.user_id = post['user_id'] if post.key?('user_id')
         comment.comment = post['comment']
 
+        # If no user ID is specified we'll use the name, website and Email of
+        # the POST data.
         if !post.key?('user_id')
           ['name', 'website', 'email'].each do |k|
             if post.key?(k)
@@ -56,31 +70,36 @@ module Comments
           end
         end
 
-        comment.section_entry_id = entry.id
-
         # Validate the section entry
-        if entry.nil?
+        if entry.nil? or entry.section_entry_status_id === draft_status
           message(:error, lang('comments.errors.invalid_entry'))
           redirect_referrer
         end
 
-        section = entry.section
+        comment.section_entry_id = entry.id
+        section                  = entry.section
+
+        # Section valid?
+        if section.nil?
+          message(:error, lang('comments.errors.invalid_entry'))
+          redirect_referrer
+        end
 
         # Comments allowed?
-        if section.comment_allow == false
+        if section.comment_allow === false
           message(:error, lang('comments.errors.comments_not_allowed'))
           redirect_referrer
         end
 
         # Comments require an account?
-        if section.comment_require_account == true and session[:user].nil?
+        if section.comment_require_account === true and session[:user].nil?
           message(:error, lang('comments.errors.comments_require_account'))
           redirect_referrer
         end
 
         # Require moderation?
-        if section.comment_moderate == true
-          comment.status = 'closed'
+        if section.comment_moderate === true
+          comment.comment_status_id = comment_statuses['closed']
         end
 
         # Require anti-spam validation?
@@ -91,12 +110,12 @@ module Comments
           # Time to validate the Defensio response
           if spam === false
             if section.comment_moderate == true
-              comment.status = 'closed'
+              comment.comment_status_id = comment_statuses['closed']
             else
-              comment.status = 'open'
+              comment.comment_status_id = comment_statuses['open']
             end
           else
-            comment.status = 'spam'
+            comment.comment_status_id = comment_statuses['spam']
           end
         end
 
@@ -116,6 +135,6 @@ module Comments
 
         redirect_referrer
       end
-    end
-  end
-end
+    end # CommentsForm
+  end # Controller
+end # Comments

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

@@ -0,0 +1,35 @@
+#:nodoc:
+module Ramaze
+  #:nodoc:
+  module Helper
+    ##
+    # Helper used by the comments package.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.8
+    #
+    module Comment
+      ##
+      # Given a comment ID this method checks if that ID results in a valid
+      # instance of Comments::Model::Comment. If this is the case the object is
+      # returned, otherwise the user is redirected back to the comment overview
+      # and is shown a message.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @param  [Fixnum] comment_id The ID of the comment to validate.
+      # @return [Comments::Model::Comment]
+      #
+      def validate_comment(comment_id)
+        comment = ::Comments::Model::Comment[comment_id]
+
+        if comment.nil?
+          message(:error, lang('comments.errors.invalid_comment'))
+          redirect(::Comments::Controller::Comments.r(:index))
+        else
+          return comment
+        end
+      end
+    end # Comment
+  end # Helper
+end # Ramaze

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

@@ -31,15 +31,17 @@ 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."
+  moderate : "The comment has been posted but must 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."
+  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."
+  comments_require_account: 'You need to be logged in to post a comment.'
+  invalid_comment         : 'The specified comment is invalid.'
 
 buttons:
   delete : 'Delete selected comments'

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

@@ -24,7 +24,7 @@ messages:
   no_comments: 'Er zijn nog geen reacties toegevoegd.'
 
 placeholders:
-  anti_spam_system: 'Het anti-spam systeem dat gebruikt moet worden voor het verifiëren 
+  anti_spam_system: 'Het anti-spam systeem dat gebruikt moet worden voor het verifiëren
 van reacties.'
   defensio_key: 'De API sleutel voor het Defensio anti-spam systeem.'
 
@@ -32,16 +32,18 @@ success:
   new     : 'De reactie is aangemaakt.'
   save    : 'De reactie is aangepast.'
   delete  : 'Alle geselecteerde reacties zijn verwijderd.'
-  moderate: 'De reactie moet eerst worden goedgekeurd door een beheerder voordat het kan 
+  moderate: 'De reactie moet eerst worden goedgekeurd door een beheerder voordat het kan
 worden weergegeven'
 
 errors:
-  new                 : 'De reactie kon niet worden aangemaakt.'
-  save                : 'De reactie kon niet worden aangepast.'
-  delete              : 'De reactie met ID #%s kon niet worden verwijderd.'
-  no_delete           : 'U moet ten minste 1 reactie specificeren om te verwijderen.'
-  invalid_entry       : 'Het gespecificeerde artikel is ongeldig.'
-  comments_not_allowed: 'Reacties zijn niet toegestaan voor deze sectie.'
+  new                     : 'De reactie kon niet worden aangemaakt.'
+  save                    : 'De reactie kon niet worden aangepast.'
+  delete                  : 'De reactie met ID #%s kon niet worden verwijderd.'
+  no_delete               : 'U moet ten minste 1 reactie specificeren om te verwijderen.'
+  invalid_entry           : 'Het gespecificeerde artikel is ongeldig.'
+  comments_not_allowed    : 'Reacties zijn niet toegestaan voor deze sectie.'
+  comments_require_account: 'Je moet ingelogd zijn om reacties te kunnen plaatsen.'
+  invalid_comment         : 'De opgegeven reactie is ongeldig.'
 
 buttons:
   delete: 'Geselecteerde reacties verwijderen'

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

@@ -3,14 +3,15 @@ module Comments
   #:nodoc:
   module Model
     ##
-    # Model that represents a single comment. This model has the following relations:
+    # 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 
+    # * timestamps
     #
     # @author Yorick Peterse
     # @since  0.1
@@ -18,11 +19,12 @@ module Comments
     class Comment < Sequel::Model
       include ::Zen::Language
 
-      many_to_one :section_entry, :class => "Sections::Model::SectionEntry"
-      many_to_one :user,          :class => "Users::Model::User"
-      
+      many_to_one :section_entry,   :class => "Sections::Model::SectionEntry"
+      many_to_one :user,            :class => "Users::Model::User"
+      many_to_one  :comment_status, :class => 'Comments::Model::CommentStatus'
+
       plugin :timestamps, :create => :created_at, :update => :updated_at
-      
+
       ##
       # Specify the validation rules for each comment.
       #
@@ -30,7 +32,8 @@ module Comments
       # @since  0.1
       #
       def validate
-        validates_presence :comment
+        validates_presence [:comment, :section_entry_id]
+        validates_integer  [:comment_status_id, :section_entry_id]
 
         if user_id.nil?
           validates_presence :email
@@ -50,11 +53,13 @@ module Comments
       def self.status_hash
         ::Zen::Language.load('comments')
 
-        return {
-          'open'   => lang('comments.labels.open'),
-          'closed' => lang('comments.labels.closed'),
-          'spam'   => lang('comments.labels.spam') 
-        }
+        statuses = {}
+
+        ::Comments::Model::CommentStatus.all.each do |status|
+          statuses[status.id] = lang("comments.labels.#{status.name}")
+        end
+
+        return statuses
       end
 
       ##
@@ -64,8 +69,8 @@ module Comments
       # @since  0.2.6
       #
       def before_create
+        prepare_comment
         super
-        sanitize
       end
 
       ##
@@ -75,24 +80,33 @@ module Comments
       # @since  0.2.6
       #
       def before_save
+        prepare_comment
         super
-        sanitize
       end
 
       ##
-      # Cleans all the input data of nasty stuff.
+      # Cleans all the input data of nasty stuff and ensures certain fields have
+      # the correct values.
       #
       # @author Yorick Peterse
       # @since  0.2.6
       #
-      def sanitize
+      def prepare_comment
         [:name, :website, :email, :comment].each do |field|
           got = send(field)
 
           if !got.nil?
-            send("#{field}=", Loofah.fragment(got).scrub!(:whitewash).scrub!(:nofollow).to_s)
+            send("#{field}=", Loofah.fragment(got).scrub!(:whitewash) \
+              .scrub!(:nofollow).to_s)
           end
         end
+
+        # Get the default status of a comment
+        if self.comment_status_id.nil?
+          self.comment_status_id = ::Comments::Model::CommentStatus[
+            :name => 'closed'
+          ].id
+        end
       end
     end # Comment
   end # Model

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

@@ -0,0 +1,15 @@
+#:nodoc:
+module Comments
+  #:nodoc:
+  module Model
+    ##
+    # Model used for managing the statuses of a comment.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.8
+    #
+    class CommentStatus < Sequel::Model
+      many_to_one :comment, :class => 'Comments::Model::CommentStatus'
+    end # CommentStatus
+  end # Model
+end # Comments

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

@@ -3,34 +3,38 @@ module Comments
   #:nodoc:
   module Plugin
     ##
-    # A plugin that can be used to verify a comment against an external (or internal)
-    # service to see if it's spam or ham.
+    # A plugin that can be used to verify a comment against an external (or 
+    # internal) service to see if it's spam or ham.
     #
     # ## Usage
     #
     #     plugin(:anti_spam, engine, author, email, url, comment)
     #
-    # Note that all variables are required. This is because certain anti-spam systems may
-    # verify the name of the author or the entered Email address besides just the comment.
-    # When using Defensio you're only required to set the comment:
+    # Note that all variables are required. This is because certain anti-spam 
+    # systems may verify the name of the author or the entered Email address 
+    # besides just the comment. When using Defensio you're only required to set 
+    # the comment:
     #
-    #     plugin(:anti_spam, :defensio, nil, nil, nil, 'Hello, this is a comment.')
+    #     plugin(
+    #       :anti_spam, :defensio, nil, nil, nil, 'Hello, this is a comment.'
+    #     )
     #
     # ## Supported Systems
     #
-    # Currently the plugin only supports Defensio, this engine requires the setting
-    # "defensio_key" to contain a valid Defensio API key.
+    # Currently the plugin only supports Defensio, this engine requires the 
+    # setting "defensio_key" to contain a valid Defensio API key.
     #
     # ## Adding Systems
     #
     # Adding a system is done in two steps. First you should update the hash
-    # Comments::PLugin::AntiSpam::Registered so that it includes your system. The keys of
-    # this hash are symbols that match the name of the engine used when calling the
-    # plugin() method. The values are the Gems to require.
+    # Comments::PLugin::AntiSpam::Registered so that it includes your system. 
+    # The keys of this hash are symbols that match the name of the engine used 
+    # when calling the plugin() method. The values are the Gems to require.
     #
     # Once this has been done you should add a method to the class
-    # Comments::Plugin::AntiSpam who's name matches the key set in the Registered hash. If
-    # your anti-spam solution is called "cake" then you'd do something like the following:
+    # Comments::Plugin::AntiSpam who's name matches the key set in the 
+    # Registered hash. If your anti-spam solution is called "cake" then you'd 
+    # do something like the following:
     #
     #     Comments::Plugin::AntiSpam::Registered[:cake] = 'cake-gem'
     #
@@ -44,8 +48,8 @@ module Comments
     #       end
     #     end
     #
-    # The return value of the method added should be a boolean, true for spam and false
-    # for ham. 
+    # The return value of the method added should be a boolean, true for spam 
+    # and false for ham. 
     #
     # @author Yorick Peterse
     # @since  0.2.6
@@ -54,7 +58,8 @@ module Comments
       include ::Zen::Plugin::Helper
 
       ##
-      # Hash containing all the supported anti-spam engines and their Gems to load.
+      # Hash containing all the supported anti-spam engines and their Gems to 
+      # load.
       #
       # @author Yorick Peterse
       # @since  0.2.6
@@ -75,13 +80,17 @@ module Comments
       # @param  [String] comment The comment.
       #
       def initialize(engine, author, email, url, comment)
-        @engine, @author, @email, @url, @comment = engine, author, email, url, comment
+        @engine, @author, @email, @url, @comment = engine, author, email, \
+          url, comment
 
         validate_type(engine, :engine, [Symbol])
 
         # Load the correct gem
         if !Registered.key?(@engine) or !respond_to?(@engine)
-          raise(::Zen::PluginError, "The anti-spam engine \"#{@engine}\" is invalid")
+          raise(
+            ::Zen::PluginError, 
+            "The anti-spam engine \"#{@engine}\" is invalid"
+          )
         end
 
         begin