zen 0.2.8 → 0.3b

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

@@ -1,43 +1,47 @@
-#:nodoc:
 module Comments
   #:nodoc:
   module Model
     ##
-    # Model that represents a single comment. This model has the following
-    # relations:
+    # Model for managing and retrieving comments.
     #
-    # * 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
-      include ::Zen::Language
+      include Zen::Model::Helper
 
-      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'
+      many_to_one :section_entry, :class => 'Sections::Model::SectionEntry',
+        :eager => [:section]
+
+      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.
+      # Searches for a number of comments based on the given search query. The
+      # following fields can be searched:
       #
-      # @author Yorick Peterse
-      # @since  0.1
+      # * comments.comment
+      # * comments.email
+      # * comments.name
+      # * users.email
+      # * users.name
       #
-      def validate
-        validates_presence [:comment, :section_entry_id]
-        validates_integer  [:comment_status_id, :section_entry_id]
-
-        if user_id.nil?
-          validates_presence :email
-        end
+      # @since  16-10-2011
+      # @param  [String] query The search query.
+      # @return [Array]
+      #
+      def self.search(query)
+        return select_all(:comments) \
+          .filter(
+            search_column(:comment, query) |
+            search_column(:users__email, query) |
+            search_column(:comments__email, query) |
+            search_column(:comments__name, query) |
+            search_column(:users__name, query)
+          ) \
+          .eager(:user, :comment_status) \
+          .left_join(:users, :comments__user_id => :users__id)
       end
 
       ##
@@ -46,57 +50,48 @@ module Comments
       # @example
       #  Comments::Model::Comment.status_hash
       #
-      # @author Yorick Peterse
       # @since  0.2
       # @return [Hash]
       #
       def self.status_hash
-        ::Zen::Language.load('comments')
-
         statuses = {}
 
         ::Comments::Model::CommentStatus.all.each do |status|
-          statuses[status.id] = lang("comments.labels.#{status.name}")
+          statuses[status.id] = Zen::Language.lang(
+            "comments.labels.#{status.name}"
+          )
         end
 
         return statuses
       end
 
       ##
-      # Hook run before creating a new comment.
+      # Specify the validation rules for each comment.
       #
-      # @author Yorick Peterse
-      # @since  0.2.6
+      # @since  0.1
       #
-      def before_create
-        prepare_comment
-        super
+      def validate
+        validates_presence([:comment, :section_entry_id])
+        validates_integer([:comment_status_id, :section_entry_id])
+        validates_max_length(255, [:name, :email, :website])
+
+        if user_id.nil?
+          validates_presence([:name, :email])
+        end
       end
 
       ##
       # Hook run before saving an existing comment.
       #
-      # @author Yorick Peterse
       # @since  0.2.6
       #
       def before_save
-        prepare_comment
-        super
-      end
-
-      ##
-      # Cleans all the input data of nasty stuff and ensures certain fields have
-      # the correct values.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.6
-      #
-      def prepare_comment
         [:name, :website, :email, :comment].each do |field|
           got = send(field)
 
           if !got.nil?
-            send("#{field}=", Loofah.fragment(got).scrub!(:whitewash) \
+            send("#{field}=", Loofah.fragment(got) \
+              .scrub!(:whitewash) \
               .scrub!(:nofollow).to_s)
           end
         end
@@ -107,6 +102,109 @@ module Comments
             :name => 'closed'
           ].id
         end
+
+        super
+      end
+
+      ##
+      # Gets the name of the author of the comment. This name is either
+      # retrieved from the current comment row or from an associated user
+      # object.
+      #
+      # @since  16-10-2011
+      # @return [String]
+      #
+      def user_name
+        if user.nil?
+          return name
+        else
+          return user.name
+        end
+      end
+
+      ##
+      # Gets the Email address of the author of the comment.
+      #
+      # @since  16-10-2011
+      # @return [String]
+      #
+      def user_email
+        if user.nil?
+          return email
+        else
+          return user.email
+        end
+      end
+
+      ##
+      # Gets the website of the author of the comment and optionally creates an
+      # anchor tag for it.
+      #
+      # @since  16-10-2011
+      # @param  [TrueClass|FalseClass] with_link When set to true the website
+      #  will be returned as an ``<a>`` tag.
+      # @return [String]
+      #
+      def user_website(with_link = false)
+        if user.nil?
+          website = website
+        else
+          website = user.website
+        end
+
+        if !website.nil? and !website.empty? and with_link == true
+          website = '<a href="%s" title="%s">%s</a>' % [
+            website,
+            website,
+            website
+          ]
+        end
+
+        return website
+      end
+
+      ##
+      # Returns the first 15 characters of a comment, optionally wrapped in a
+      # link that points to the form to edit the comment.
+      #
+      # @since  17-10-2011
+      # @param  [TrueClass|FalseClass] with_link When set to true the comment
+      #  will be wrapped in an ``<a>`` tag.
+      # @return [String]
+      #
+      def summary(with_link = false)
+        _comment = comment || ''
+        _comment = _comment[0, 15] + '...'
+
+        if with_link == true
+          return ::Comments::Controller::Comments.a(_comment, :edit, id)
+        else
+          return _comment
+        end
+      end
+
+      ##
+      # Returns the text of the comment in HTML based on the markup engine used
+      # by the section that the comment belongs to.
+      #
+      # @since  0.3
+      # @return [String]
+      #
+      def html
+        return Zen::Markup.convert(
+          section_entry.section.comment_format,
+          comment
+        )
+      end
+
+      ##
+      # Returns the name of the comment status.
+      #
+      # @since  17-10-2011
+      # @return [String]
+      #
+      def status_name
+        return lang("comments.labels.#{comment_status.name}")
       end
     end # Comment
   end # Model

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

@@ -1,11 +1,9 @@
-#: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

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

@@ -1,64 +1,61 @@
-<article>
+<section>
     <header>
         <h1>#{get_breadcrumbs}</h1>
     </header>
-    
-    #{
-      form_for(
-        @comment, 
-        :method => :post, 
-        :action => Comments::Controller::Comments.r(:save), 
+
+    #{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, 
+          lang('comments.labels.name'),
+          :name,
+          :value    => @comment.user_name,
           :disabled => :disabled
         )
 
+        if @comment.user.nil?
+
         f.input_text(
-          lang('comments.labels.website'), 
-          :website, 
-          :value => website
+          lang('comments.labels.website'),
+          :website,
+          :value     => @comment.website,
+          :maxlength => 255
         )
-        
+
         f.input_text(
-          lang('comments.labels.email'), 
-          :email, 
-          :value => email
+          lang('comments.labels.email'),
+          :email,
+          :value     => @comment.email,
+          :required  => :required,
+          :maxlength => 255
         )
-        
+
+        end
+
         f.select(
-          lang('comments.labels.status'), 
-          :comment_status_id, 
+          lang('comments.labels.status'),
+          :comment_status_id,
           :values   => Comments::Model::Comment.status_hash,
           :selected => @comment.comment_status_id,
-          :size     => 1
+          :size     => 1,
+          :required => :required
         )
-        
+
         f.textarea(
-          lang('comments.labels.comment'), 
-          :comment, 
-          :rows => 10
+          lang('comments.labels.comment'),
+          :comment,
+          :rows     => 10,
+          :required => :required
         )
-        
+
         f.g.div(:class => 'button') do
           f.g.input(:type => 'submit', :value => lang('comments.buttons.save'))
         end
-      end
-    }
-</article>
+      end}
+</section>

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

@@ -1,4 +1,6 @@
-<article>
+<section>
+    #{render_search_form(::Comments::Controller::Comments.r(:index))}
+
     <header>
         <h1>#{get_breadcrumbs}</h1>
     </header>
@@ -6,15 +8,16 @@
     <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? ?>
+        <?r if !@comments.empty? ?>
 
         <table>
             <thead>
-                <?r if user_authorized?([:delete]) ?>
+                <?r if user_authorized?(:delete_comment) ?>
                 <th class="no_sort">
                     <input type="checkbox" />
                 </th>
                 <?r end ?>
+
                 <th>#{lang('comments.labels.id')}</th>
                 <th>#{lang('comments.labels.comment')}</th>
                 <th>#{lang('comments.labels.entry')}</th>
@@ -27,7 +30,7 @@
             <tbody>
                 <?r @comments.each do |comment| ?>
                 <tr>
-                    <?r if user_authorized?([:delete]) ?>
+                    <?r if user_authorized?(:delete_comment) ?>
                     <td>
                         <input type="checkbox" name="comment_ids[]"
                         value="#{comment.id}" />
@@ -35,60 +38,38 @@
                     <?r end ?>
 
                     <td>#{comment.id}</td>
-
-                    <?r if user_authorized?([:update]) ?>
                     <td>
-                        #{Comments::Controller::Comments.a(
-                          comment.comment[0, 15].to_s + '...',
-                          :edit,
-                          comment.id
-                        )}
+                        #{if user_authorized?(:edit_comment)
+                          comment.summary(true)
+                        else
+                          comment.summary
+                        end}
                     </td>
-                    <?r else ?>
-                    <td>#{comment.comment[0, 15]}...</td>
-                    <?r end ?>
-
                     <td>#{comment.section_entry.title}</td>
-                    <td>
-                        #{lang(
-                          "comments.labels.#{comment.comment_status.name}"
-                        )}
-                    </td>
-
-                    <?r if !comment.user ?>
-                    <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.created_at.strftime(
-                          session[:user].date_format
-                        )}
-                    </td>
+                    <td>#{comment.status_name}</td>
+                    <td>#{comment.user_name}</td>
+                    <td>#{comment.user_email}</td>
+                    <td>#{comment.user_website(true)}</td>
+                    <td>#{format_date(comment.created_at)}</td>
                 </tr>
                 <?r end ?>
             </tbody>
         </table>
 
-        #{
-        if @comments.respond_to?(:navigation) and @comments.page_count > 1
+        #{if @comments.respond_to?(:navigation) and @comments.page_count > 1
           @comments.navigation
-        end
-        }
+        end}
 
         <?r else ?>
+
         <p>#{lang('comments.messages.no_comments')}</p>
+
         <?r end ?>
 
-        <?r if user_authorized?([:delete]) and !@comments.empty? ?>
+        <?r if user_authorized?(:delete_comment) and !@comments.empty? ?>
         <div class="button">
             <input type="submit" value="#{lang('comments.buttons.delete')}" />
         </div>
         <?r end ?>
     </form>
-</article>
+</section>