zen 0.3 → 0.4

data/lib/zen/package/categories/lib/categories/view/admin/category-groups/index.xhtml

@@ -1,98 +1,95 @@
 <section>
-    #{render_search_form(::Categories::Controller::CategoryGroups.r(:index))}
-
-    <header>
+    <header class="with_search">
         <h1>#{get_breadcrumbs}</h1>
-    </header>
-
-    <form method="post"
-    action="#{Categories::Controller::CategoryGroups.r(:delete)}">
-        <input type="hidden" name="csrf_token" value="#{get_csrf_token}" />
-
-        <?r if !@category_groups.empty? ?>
-
-        <table>
-            <thead>
-                <tr>
-                    <?r if user_authorized?(:delete_category_group) ?>
-                    <th class="no_sort">
-                        <input type="checkbox" />
-                    </th>
-                    <?r end ?>
-
-                    <th>#{lang('category_groups.labels.id')}</th>
-                    <th>#{lang('category_groups.labels.name')}</th>
-
-                    <?r if user_authorized?(:show_category) ?>
-                    <th></th>
-                    <?r end ?>
-                </tr>
-            </thead>
-            <tbody>
-                <?r @category_groups.each do |group| ?>
-                <tr>
-                    <?r if user_authorized?(:delete_category_group) ?>
-                    <td>
-                        <input type="checkbox" name="category_group_ids[]"
-                        value="#{group.id}" />
-                    </td>
-                    <?r end ?>
-
-                    <td>#{group.id}</td>
-
-                    <?r if user_authorized?(:edit_category_group) ?>
-
-                    <td>
-                        #{Categories::Controller::CategoryGroups.a(
-                          group.name, :edit, group.id
-                        )}
-                    </td>
-
-                    <?r else ?>
 
-                    <td>#{group.name}</td>
-
-                    <?r end ?>
+        #{render_search_form(::Categories::Controller::CategoryGroups.r(:index))}
+    </header>
 
-                    <?r if user_authorized?(:show_category) ?>
-                    <td>
-                        #{Categories::Controller::Categories.a(
-                          lang('category_groups.labels.manage'),
-                          :index,
-                          group.id
-                        )}
-                    </td>
+    <div class="body">
+        <form method="post"
+        action="#{Categories::Controller::CategoryGroups.r(:delete)}">
+            <input type="hidden" name="csrf_token" value="#{get_csrf_token}" />
+
+            <?r if !@category_groups.empty? ?>
+
+            <table>
+                <thead>
+                    <tr>
+                        <?r if user_authorized?(:delete_category_group) ?>
+                        <th class="no_sort">
+                            <input type="checkbox" />
+                        </th>
+                        <?r end ?>
+
+                        <th>#{lang('category_groups.labels.id')}</th>
+                        <th>#{lang('category_groups.labels.name')}</th>
+
+                        <?r if user_authorized?(:show_category) ?>
+                        <th></th>
+                        <?r end ?>
+                    </tr>
+                </thead>
+                <tbody>
+                    <?r @category_groups.each do |group| ?>
+                    <tr>
+                        <?r if user_authorized?(:delete_category_group) ?>
+                        <td>
+                            <input type="checkbox" name="category_group_ids[]"
+                            value="#{group.id}" />
+                        </td>
+                        <?r end ?>
+
+                        <td>#{group.id}</td>
+
+                        <?r if user_authorized?(:edit_category_group) ?>
+                        <td>
+                            #{edit_link(
+                              Categories::Controller::CategoryGroups.r(
+                                :edit,
+                                group.id
+                              ),
+                              group.name
+                            )}
+                        </td>
+                        <?r else ?>
+                        <td>#{group.name}</td>
+                        <?r end ?>
+
+                        <?r if user_authorized?(:show_category) ?>
+                        <td>
+                            #{manage_link(
+                              Categories::Controller::Categories.r(
+                                :index,
+                                group.id
+                              ),
+                              lang('category_groups.labels.manage')
+                            )}
+                        </td>
+                        <?r end ?>
+                    </tr>
                     <?r end ?>
-                </tr>
-                <?r end ?>
-            </tbody>
-        </table>
+                </tbody>
+            </table>
 
-        #{if @category_groups.respond_to?(:navigation) \
-        and @category_groups.page_count > 1
-          @category_groups.navigation
-        end}
+            #{render_pagination(@category_groups)}
 
-        <?r else ?>
+            <?r else ?>
 
-        <p>#{lang('category_groups.messages.no_groups')}</p>
+            <p>#{lang('category_groups.messages.no_groups')}</p>
 
-        <?r end ?>
+            <?r end ?>
 
-        <?r if user_authorized?(:new_category_group) ?>
-        <div class="button">
-            #{Categories::Controller::CategoryGroups.a(
-              lang('category_groups.buttons.new'), :new
+            <?r if user_authorized?(:new_category_group) ?>
+            #{new_button(
+              Categories::Controller::CategoryGroups.r(:new),
+              lang('category_groups.buttons.new')
             )}
-        </div>
-        <?r end ?>
-
-        <?r if user_authorized?(:delete_category_group) \
-        and !@category_groups.empty? ?>
-        <div class="button">
-            <input type="submit"
-            value="#{lang('category_groups.buttons.delete')}" />
-        </div>
-        <?r end ?>
-    </form>
+            <?r end ?>
+
+            <?r if user_authorized?(:delete_category_group) \
+            and !@category_groups.empty? ?>
+            #{delete_button(lang('category_groups.buttons.delete'))}
+            <?r end ?>
+        </form>
+    </div>
 </section>

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

@@ -7,19 +7,15 @@ Zen::Package.add do |p|
   p.root       = __DIR__('comments')
   p.migrations = __DIR__('../migrations')
 
-  p.menu(
-    'comments.titles.index',
+  p.menu 'comments.titles.index',
     '/admin/comments',
     :permission => :show_comment
-  )
 
   p.permission :show_comment  , 'comments.permissions.show'
   p.permission :edit_comment  , 'comments.permissions.edit'
   p.permission :delete_comment, 'comments.permissions.delete'
 end
 
-Zen::Language.load('comments')
-
 require __DIR__('comments/model/comment_status')
 require __DIR__('comments/model/comment')
 require __DIR__('comments/controller/comments')
@@ -45,3 +41,7 @@ Settings::Setting.add do |setting|
   setting.group       = 'security'
   setting.type        = 'textbox'
 end
+
+Zen::Event.listen :post_start do
+  Zen::Language.load('comments')
+end

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

@@ -41,7 +41,7 @@ module Comments
     # ``/admin/comments``. This page will show an overview of all existing
     # comments (or a message if no comments were found).
     #
-    # ![Comments](../../_static/comments/comments.png)
+    # ![Comments](../../images/comments/comments.png)
     #
     # Comments can be edited by clicking on their name. Deleting comments can be
     # done by checking the checkboxes in each row followed by clicking the
@@ -49,7 +49,7 @@ module Comments
     #
     # ## Editing Comments
     #
-    # ![Edit Comment](../../_static/comments/edit_comment.png)
+    # ![Edit Comment](../../images/comments/edit_comment.png)
     #
     # When editing a comment you can specify/update the following fields:
     #
@@ -77,39 +77,8 @@ module Comments
     # * new_comment
     # * delete_comment
     #
-    # ## Events
-    #
-    # All events called in this controller receive an instance of
-    # {Comments::Model::Comment}. However, just like all other controllers the
-    # ``delete_comment`` receives an instance of this model that has already
-    # been destroyed.
-    #
-    # An example of using one of these events is to notify a user when his
-    # comment has been marked as spam:
-    #
-    #     require 'mail'
-    #
-    #     Zen::Event.call(:after_edit_comment) do |comment|
-    #       email = comment.user.email
-    #       spam  = Comments::Model::CommentStatus[:name => 'spam']
-    #
-    #       if comment.comment_status_id == spam.id
-    #         Mail.deliver do
-    #           from    'example@domain.tld'
-    #           to      email
-    #           subject 'Your comment has been marked as spam'
-    #           body    "Dear #{comment.user.name}, your comment has been " \
-    #             "marked as spam"
-    #        end
-    #      end
-    #    end
-    #
     # @since  0.1
     # @map    /admin/comments
-    # @event  before_edit_comment
-    # @event  after_edit_comment
-    # @event  beore_delete_comment
-    # @event  after_delete_comment
     #
     class Comments < Zen::Controller::AdminController
       map    '/admin/comments'
@@ -118,6 +87,8 @@ module Comments
 
       csrf_protection :save, :delete
 
+      autosave Model::Comment, Model::Comment::COLUMNS, :edit_comment
+
       ##
       # Shows an overview of all existing comments and allows the user to edit
       # or remove these comments.
@@ -156,7 +127,8 @@ module Comments
           @page_title
         )
 
-        @comment = flash[:form_data] || validate_comment(id)
+        @comment = validate_comment(id)
+        @comment.set(flash[:form_data]) if flash[:form_data]
 
         render_view(:form)
       end
@@ -166,45 +138,26 @@ module Comments
       #
       # @since      0.1
       # @permission edit_comment
-      # @event      before_edit_comment
-      # @event      after_edit_comment
       #
       def save
         authorize_user!(:edit_comment)
 
-        # Copy the POST data so we can work with it without messing things up
-        post = request.subset(
-          :id,
-          :user_id,
-          :name,
-          :website,
-          :email,
-          :comment,
-          :comment_status_id,
-          :section_entry_id
-        )
-
-        comment = validate_comment(post['id'])
-
-        post.delete('id')
+        post    = post_fields(*Model::Comment::COLUMNS)
+        comment = validate_comment(request.params['id'])
 
         begin
-          post.each { |k, v| comment.send("#{k}=", v) }
-          Zen::Event.call(:before_edit_comment, comment)
-
+          comment.set(post)
           comment.save
         rescue => e
-          Ramaze::Log.error(e.inspect)
+          Ramaze::Log.error(e)
           message(:error, lang('comments.errors.save'))
 
           flash[:form_errors] = comment.errors
-          flash[:form_data]   = comment
+          flash[:form_data]   = post
 
           redirect_referrer
         end
 
-        Zen::Event.call(:after_edit_comment, comment)
-
         message(:success, lang('comments.success.save'))
         redirect(Comments.r(:edit, comment.id))
       end
@@ -215,8 +168,6 @@ module Comments
       #
       # @since      0.1
       # @permission delete_comment
-      # @event      before_delete_comment
-      # @event      after_delete_comment
       #
       def delete
         authorize_user!(:delete_comment)
@@ -233,18 +184,15 @@ module Comments
           comment = ::Comments::Model::Comment[id]
 
           next if comment.nil?
-          Zen::Event.call(:before_delete_comment, comment)
 
           begin
             comment.destroy
           rescue => e
-            Ramaze::Log.error(e.inspect)
+            Ramaze::Log.error(e)
             message(:error, lang('comments.errors.delete') % id)
 
             redirect_referrer
           end
-
-          Zen::Event.call(:after_delete_comment, comment)
         end
 
         message(:success, lang('comments.success.delete'))

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

@@ -63,22 +63,8 @@ module Comments
     #
     #     Zen::Controller::MainController.helper(:some_helper_name)
     #
-    # ## Events
-    #
-    # Just like {Comments::Controller::Comments} newly created comments are
-    # passed to an event called "new_comment".
-    #
-    # @example Logging whenever a new comment is created
-    #  Zen::Event.call(:new_comment) do |comment|
-    #    Ramaze::Log.info(
-    #      "A new comment has been created with ID ##{comment.id}"
-    #    )
-    #  end
-    #
-    # @since  0.1
-    # @map    /comments-form
-    # @event  before_new_comment
-    # @event  after_new_comment
+    # @since 0.1
+    # @map   /comments-form
     #
     class CommentsForm < Zen::Controller::FrontendController
       map    '/comments-form'
@@ -91,12 +77,10 @@ module Comments
       # saved the user will be redirected back to the previous page.
       #
       # @since  0.1
-      # @event  before_new_comment
-      # @event  after_new_comment
       #
       def save
         comment = ::Comments::Model::Comment.new
-        post    = request.subset(
+        post    = post_fields(
           :section_entry,
           :user_id,
           :comment,
@@ -202,10 +186,9 @@ module Comments
 
         # Save the comment
         begin
-          Zen::Event.call(:before_new_comment, comment)
           comment.save
         rescue => e
-          Ramaze::Log.error(e.inspect)
+          Ramaze::Log.error(e)
           message(:error, lang('comments.errors.new'))
 
           flash[:form_data]   = comment
@@ -220,7 +203,6 @@ module Comments
           message(:success, lang('comments.success.new'))
         end
 
-        Zen::Event.call(:after_new_comment, comment)
         redirect_referrer
       end
     end # CommentsForm

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

@@ -4,19 +4,71 @@ module Comments
     ##
     # Model for managing and retrieving comments.
     #
-    # @since  0.1
+    # ## Events
+    #
+    # All events called in this model receive an instance of
+    # {Comments::Model::Comment}. However, just like all other models the
+    # ``delete_comment`` event receives an instance of this model that has
+    # already been destroyed.
+    #
+    # An example of using one of these events is to notify a user when his
+    # comment has been marked as spam:
+    #
+    #     require 'mail'
+    #
+    #     Zen::Event.call(:after_edit_comment) do |comment|
+    #       email = comment.user.email
+    #       spam  = Comments::Model::CommentStatus[:name => 'spam']
+    #
+    #       if comment.comment_status_id == spam.id
+    #         Mail.deliver do
+    #           from    'example@domain.tld'
+    #           to      email
+    #           subject 'Your comment has been marked as spam'
+    #           body    "Dear #{comment.user.name}, your comment has been " \
+    #             "marked as spam"
+    #        end
+    #      end
+    #    end
+    #
+    # @since 0.1
+    # @event before_new_comment
+    # @event after_new_comment
+    # @event before_edit_comment
+    # @event after_edit_comment
+    # @event beore_delete_comment
+    # @event after_delete_comment
     #
     class Comment < Sequel::Model
       include Zen::Model::Helper
 
-      many_to_one :section_entry, :class => 'Sections::Model::SectionEntry',
+      ##
+      # Array containing all the columns that can be set by the user.
+      #
+      # @since 17-02-2012
+      #
+      COLUMNS = [
+        :user_id, :name, :website, :email, :comment, :comment_status_id,
+        :section_entry_id
+      ]
+
+      many_to_one :section_entry,
+        :class => 'Sections::Model::SectionEntry',
         :eager => [:section]
 
-      many_to_one :user          , :class => 'Users::Model::User'
+      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
 
+      plugin :events,
+        :before_create  => :before_new_comment,
+        :after_create   => :after_new_comment,
+        :before_update  => :before_edit_comment,
+        :after_update   => :after_edit_comment,
+        :before_destroy => :before_delete_comment,
+        :after_destroy  => :after_delete_comment
+
       ##
       # Searches for a number of comments based on the given search query. The
       # following fields can be searched:
@@ -86,15 +138,7 @@ module Comments
       # @since  0.2.6
       #
       def before_save
-        [:name, :website, :email, :comment].each do |field|
-          got = send(field)
-
-          if !got.nil?
-            send("#{field}=", Loofah.fragment(got) \
-              .scrub!(:whitewash) \
-              .scrub!(:nofollow).to_s)
-          end
-        end
+        sanitize_fields([:name, :website, :email, :comment], true)
 
         # Get the default status of a comment
         if self.comment_status_id.nil?
@@ -143,9 +187,10 @@ module Comments
       # @since  16-10-2011
       # @param  [TrueClass|FalseClass] with_link When set to true the website
       #  will be returned as an ``<a>`` tag.
+      # @param  [String] text The alternative text to use for the link tag.
       # @return [String]
       #
-      def user_website(with_link = false)
+      def user_website(with_link = false, text = nil)
         if user.nil?
           website = website
         else
@@ -153,10 +198,11 @@ module Comments
         end
 
         if !website.nil? and !website.empty? and with_link == true
-          website = '<a href="%s" title="%s">%s</a>' % [
+          link_text = text || website
+          website = '<a href="%s" title="%s" class="icon external">%s</a>' % [
             website,
             website,
-            website
+            link_text
           ]
         end
 
@@ -177,7 +223,10 @@ module Comments
         _comment = _comment[0, 15] + '...'
 
         if with_link == true
-          return ::Comments::Controller::Comments.a(_comment, :edit, id)
+          return '<a href="%s" class="icon edit">%s</a>' % [
+            Comments::Controller::Comments.r(:edit, id),
+            _comment
+          ]
         else
           return _comment
         end