adva_comments 0.1.0

data/app/views/admin/comments/index.html.erb

@@ -0,0 +1,43 @@
+<%= content_for :sidebar do %>
+  <!--
+  <div class="tabs">
+    <ul>
+      <li class="active"><a href="#filters" onclick="return false;"><%= t(:'adva.titles.filters') %></a></li>
+    </ul>
+    <div class="tab active" id="tab_filters">
+      <%= filter_for(Comment) %>
+    </div>
+  </div>
+  -->
+<% end %>
+
+<%= will_paginate @comments %>
+
+<ul id="comments_list">
+  <% if @comments.present? %>
+    <% @comments.each do |comment, i| %>
+    <li class="<%= cycle 'alt', '' %>" id="<%= dom_id(comment) %>">
+			<h4><%= link_to comment.commentable.title, [comment.commentable.section, comment.commentable] if comment.commentable %></h4>
+			<div class="actions">
+				<%= comment.approved? ?
+					    link_to(t(:'adva.comments.links.unapprove'), admin_comment_path(comment, "comment[approved]" => 0, :return_to => request.fullpath), :class => 'text', :method => :put) :
+					 	  link_to(t(:'adva.comments.links.approve'), admin_comment_path(comment, "comment[approved]" => 1, :return_to => request.fullpath), :class => 'text', :method => :put) %> 
+			  <%= link_to_edit(comment, :url => edit_admin_comment_path(comment, :return_to => request.fullpath)) %> 
+			  <%= link_to_delete(comment, :url => admin_comment_path(comment, :return_to => request.fullpath)) %> 
+			</div>
+			<cite>
+			  <%= link_to_author(comment) %>
+			  <%= "(#{comment.author_email})" %> 
+			  <%= t(:'adva.comments.said_time_ago', :time => time_ago_in_words(comment.created_at)) %> 
+			</cite>
+			<blockquote>
+			  <%= strip_tags(comment.body) %>
+			</blockquote>
+    </li>
+    <% end %>
+  <% else %>
+    <li class="alt"><%= params[:filters] ? t(:'adva.comments.no_filtered_comments') : t(:'adva.comments.no_comments') %></li>
+  <% end %>
+</ul>
+
+<%= will_paginate @comments %>

data/app/views/admin/sections/_comments_settings.html.erb

@@ -0,0 +1,7 @@
+<h2><%= t(:'adva.titles.comments') %></h2>
+
+<% f.field_set :comments_settings do %>
+  <% column do %>
+    <%= f.select :comment_age, comment_expiration_options, {}, :label => :'adva.comments.labels.comments' %>
+	<% end %>
+<% end %>

data/app/views/admin/sites/_comments_settings.html.erb

@@ -0,0 +1,7 @@
+<h2><%= t(:'adva.titles.comments') %></h2>
+
+<% f.field_set :comments_settings do %>
+	<% column do %>
+  	<%= f.select :comment_filter, filter_options, {}, :label => true, :hint => :'adva.comments.hints.comments_filter' %>
+	<% end %>
+<% end %>

data/app/views/comment_mailer/comment_notification.html.erb

@@ -0,0 +1,12 @@
+<p>Hello,</p>
+
+<p>A new comment has been posted on <%= @comment.site.name %>. Please <%= link_to "log in", admin_comments_url(@comment.site, :host => @comment.site.host) %> and approve or delete it.</p>
+
+<p>
+Page: <%= @comment.commentable.title %><br />
+Name: <%= @comment.author_name %><br />
+Email: <%= @comment.author_email %><br />
+Homepage: <%= @comment.author_homepage %><br />
+</p>
+
+<p><%= @comment.body %></p>

data/app/views/comments/_comment.html.erb

@@ -0,0 +1,13 @@
+<li id="<%= dom_id(comment) %>" class="<%= cycle 'alt', '' %> clearing">
+  <div class="meta">
+    <p><%= link_to_author(comment) %></p>
+    <p><%= datetime_with_microformat(comment.created_at, :format => :long) %></p>
+    <% unless comment.approved? %>
+      <p><%= t(:'adva.comments.info.under_review') %></p>
+    <% end  %>
+  </div>
+  <div class="comment">
+    <%= comment.body_html %>
+    <a href="#<%= dom_id(comment) %>" title="" style="display:none;">#</a>
+  </div>
+</li>

data/app/views/comments/_form.html.erb

@@ -0,0 +1,44 @@
+<%# @comment ||= commentable.comments.build %>
+<% if @comment %>
+	<% authorized_tag(:div, :create, @comment, :id => 'comment_form_wrapper') do %>
+    <div id="registered_author" style="display: none;">
+      <p><%= t(:'adva.info.greeting_logged_in') %></p>
+    </div>
+
+    <h2><%= @comment.new_record? ? t(:'adva.comments.titles.add_reply') : t(:'adva.comments.titles.edit') %></h2>
+
+    <%= form_for :comment, @comment, :url => (@comment.new_record? ? comments_path : comment_path(@comment)), :html => { :id => 'comment_form', :method => (@comment.new_record? ? :post : :put) } do |f| -%>
+      <%= invisible_captcha :homepage, :comment %>
+      <%= comment_form_hidden_fields commentable %>
+
+      <%= fields_for @comment.author do |author| %>
+        <div id="anonymous_author">
+          <p>
+            <%= author.label :name, 'Name' %>
+            <%= author.text_field :name %>
+          </p>
+          <p> 
+            <%= author.label :email, 'E-Mail' %>
+            <%= author.email_field :email %>
+          </p>
+          <p> 
+            <%= author.label :homepage %>
+            <%= author.text_field :homepage %>
+          </p>
+        </div>
+      <% end %>
+
+      <p>
+        <%= f.text_area :body %>
+      </p>
+
+      <p id="preview"></p>
+
+      <p>
+        <input type="text" name="comment[url]" style="background-color: transparent; border: 0px" />
+        <%= submit_tag (@comment.new_record? ? t(:'adva.comments.titles.submit_comment') : t(:'adva.comments.titles.save_comment')) %>
+        <%= link_to_remote_comment_preview %>
+      </p>
+    <% end %>
+	<% end %>
+<% end %>

data/app/views/comments/_list.html.erb

@@ -0,0 +1,8 @@
+<% if comments.present? %>
+  <div id="comments">
+    <h2><%= t(:'adva.comments.titles.comment_with_count', :count => comments.size) %></h2>
+    <ol>
+      <%= render :partial => 'comments/comment', :collection => comments %>
+    </ol>
+  </div>
+<% end %>

data/app/views/comments/comments.atom.builder

@@ -0,0 +1,16 @@
+atom_feed :url => request.url do |feed|
+  feed.title comments_feed_title(@site, @section, @commentable)
+  feed.updated @comments.present? ? @comments.first.created_at : Time.now
+
+  @comments.each do |comment|
+    url = show_url(comment.commentable, :anchor => dom_id(comment))
+    feed.entry comment, :url => url do |entry|
+      entry.title I18n.t(:'adva.comments.titles.comment_on_by', :on => comment.commentable.title, :by => comment.author_name)
+      entry.content comment.body_html, :type => 'html'
+      entry.author do |author|
+        author.name comment.author_name
+        author.email comment.author_email
+      end
+    end
+  end
+end

data/app/views/comments/preview.html.erb

@@ -0,0 +1,3 @@
+<div id="comment_preview">
+  <%= @comment.body_html %>
+</div>

data/app/views/comments/show.html.erb

@@ -0,0 +1,12 @@
+<div id="comments">
+  <h2><%= t(:'adva.comments.titles.comment_number', :number => @comment.id) %></h2>
+  <p>
+		<%= t(:'adva.comments.labels.on') %>: <%= link_to_content @comment.commentable %>
+	</p>
+  <ol>
+    <%= render :partial => 'comments/comment', :object => @comment %>
+  </ol>
+</div>
+<% if !@comment.approved? && current_user.admin? %>
+  <%= render :partial => 'comments/form', :locals => { :commentable => @comment.commentable }  %>
+<% end %>

data/config/initializers/article.rb

@@ -0,0 +1,13 @@
+ActiveSupport::Reloader.to_prepare do
+  Article.class_eval do
+    def accept_comments?
+      published? && (comment_age > -1) && (comment_age == 0 || comments_expired_at > Time.zone.now)
+    end
+  end
+end
+
+class ArticleFormBuilder < ExtensibleFormBuilder
+  after(:article, :filter) do |f|
+    render :partial => 'admin/articles/comments_settings', :locals => { :f => f }
+  end
+end

data/config/initializers/content.rb

@@ -0,0 +1,17 @@
+ActiveSupport::Reloader.to_prepare do
+  Content.class_eval do
+    # has_many_comments :polymorphic => true
+    has_many_comments :as => :commentable
+
+    delegate :comment_filter, :to => :site
+    delegate :accept_comments?, :to => :section
+
+    def comments_expired_at
+      if comment_age == -1
+        9999.years.from_now
+      else
+        (published_at || Time.zone.now) + comment_age.days
+      end
+    end
+  end
+end

data/config/initializers/controllers.rb

@@ -0,0 +1,25 @@
+ActiveSupport::Reloader.to_prepare do
+  BaseController.class_eval do
+    helper :comments
+
+    def comments # FIXME why isn't this in acts_as_commentable ?
+      @comments = @commentable.approved_comments
+      respond_to do |format|
+        format.atom { render :template => 'comments/comments', :layout => false }
+      end
+    end
+  end
+  
+  Admin::BaseController.helper :comments, :'admin/comments'
+
+  ArticlesController.class_eval do
+    acts_as_commentable
+
+    private
+
+    def set_commentable
+      set_article if params[:permalink]
+      super
+    end
+  end
+end

data/config/initializers/menus.rb

@@ -0,0 +1,24 @@
+module Menus
+  module Admin
+    # will be concatenated onto existing sites menu via javascript
+    class Sites < Menu::Group
+      define do
+        namespace :admin
+        menu :left, :class => 'main' do
+          item :comments, :action => :index, :resource => :comment
+        end
+      end
+    end
+
+    class Comments < Menu::Group
+      define do
+        id :main
+        parent Sites.new.build(scope).find(:comments)
+
+        menu :left, :class => 'left' do
+          item :comments, :action => :index, :resource => :comment
+        end
+      end
+    end
+  end
+end

data/config/initializers/section.rb

@@ -0,0 +1,15 @@
+class SectionFormBuilder < ExtensibleFormBuilder
+  before(:section, :submit_buttons) do |f|
+    unless @section.type == 'Forum'
+      render :partial => 'admin/sections/comments_settings', :locals => { :f => f }
+    end
+  end
+
+  ActiveSupport::Reloader.to_prepare do
+    Section.class_eval do
+      def accept_comments?
+        true
+      end
+    end
+  end
+end

data/config/initializers/site.rb

@@ -0,0 +1,11 @@
+class SiteFormBuilder < ExtensibleFormBuilder
+  after(:site, :default_fields) do |f|
+    render :partial => 'admin/sites/comments_settings', :locals => { :f => f }
+  end
+end
+
+ActiveSupport::Reloader.to_prepare do
+  Site.class_eval do
+    has_many_comments
+  end
+end

data/config/routes.rb

@@ -0,0 +1,9 @@
+Rails.application.routes.draw do
+  resources :comments, :except => :index do
+    post :preview, :on => :collection
+  end
+
+  namespace :admin do
+    resources :comments
+  end
+end

data/db/migrate/20080401000007_create_comments_table.rb

@@ -0,0 +1,22 @@
+class CreateCommentsTable < ActiveRecord::Migration
+  def self.up
+    create_table :comments, :force => true do |t|
+      t.references :site
+      t.references :section
+      # t.references :topic # TODO can we use the commentable reference as the topic reference?
+      t.references :commentable, :polymorphic => true
+      t.references :author, :polymorphic => true
+      t.string     :author_name, :limit => 40
+      t.string     :author_email, :limit => 40
+      t.string     :author_homepage
+      t.text       :body
+      t.text       :body_html
+      t.integer    :approved, :null => false, :default => 0
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

data/db/migrate/20080721141112_add_comment_board_id.rb

@@ -0,0 +1,9 @@
+class AddCommentBoardId < ActiveRecord::Migration
+  def self.up
+    add_column :comments, :board_id, :integer
+  end
+
+  def self.down
+    remove_column :comments, :board_id
+  end
+end

data/lib/action_controller/acts_as_commentable.rb

@@ -0,0 +1,43 @@
+module ActionController
+  module ActsAsCommentable
+    def self.included(base)
+      base.class_eval do
+        extend ActMacro
+      end
+    end
+
+    module ActMacro
+      def acts_as_commentable(options = {})
+        return if acts_as_commentable?
+        include InstanceMethods
+
+        before_action :set_commentable, :only => :comments
+        before_action :set_comment, :except => :comments
+        helper :comments
+      end
+
+      def acts_as_commentable?
+        included_modules.include?(ActionController::ActsAsCommentable::InstanceMethods)
+      end
+    end
+
+    module InstanceMethods
+      def comments
+        @comments = @commentable.approved_comments
+        respond_to do |format|
+          format.atom do
+            render :template => 'comments/comments', :layout => false
+          end
+        end
+      end
+
+      protected
+
+        def set_comment
+          @comment = Comment.new params[:comment]
+          @comment.author = User.anonymous
+        end
+    end
+  end
+end
+

data/lib/active_record/has_many_comments.rb

@@ -0,0 +1,49 @@
+module ActiveRecord
+  module HasManyComments
+    def self.included(base)
+      base.extend ActMacro
+    end
+
+    module ActMacro
+      def has_many_comments(options = {})
+        return if has_many_comments?
+
+        order_options = options.delete(:order) || [:created_at, :id]
+        options[:class_name] ||= 'Comment'
+
+        has_counter :comments,
+                    :as => options[:as]
+
+        has_counter :approved_comments,
+                    :as => options[:as],
+                    :class_name => 'Comment',
+                    :callbacks => { 
+                      :after_approve   => :increment!, 
+                      :after_unapprove => :decrement!, 
+                      :after_destroy  => lambda { |record| :decrement! if record.approved? }
+                    }
+
+        options.delete(:as) unless options[:as] == :commentable
+        with_options options do |c|
+          c.has_many :comments, -> { order(order_options) }, dependent: :delete_all do
+            def by_author(author)
+              find_all_by_author_id_and_author_type(author.id, author.class.name)
+            end
+          end
+          c.has_many :approved_comments,   -> { where(["comments.approved = ?", 1]).order(order_options) }
+          c.has_many :unapproved_comments, -> { where(["comments.approved = ?", 0]).order(order_options) }
+        end
+
+        include InstanceMethods
+      end
+
+      def has_many_comments?
+        included_modules.include? ActiveRecord::HasManyComments::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+    end
+  end
+end
+ActiveRecord::Base.send :include, ActiveRecord::HasManyComments

data/lib/adva_comments/version.rb

@@ -0,0 +1,3 @@
+module AdvaComments
+  VERSION = "0.1.0"
+end

data/lib/adva_comments.rb

@@ -0,0 +1,19 @@
+# require "adva_comments/version"
+require "rails"
+
+require "active_record/has_many_comments"
+require "action_controller/acts_as_commentable"
+require "invisible_captcha"
+
+module AdvaComments
+  class Engine < Rails::Engine
+    initializer "add assets to precompilation list" do |app|
+      app.config.assets.precompile += %w(adva_comments/admin/comments.css)
+    end
+
+    initializer "adva_comments.init" do
+      ActiveRecord::Base.send :include, ActiveRecord::HasManyComments
+      ActionController::Base.send :include, ActionController::ActsAsCommentable
+    end
+  end
+end

data/lib/format.rb

@@ -0,0 +1,3 @@
+module Format
+  EMAIL = /(\A(\s*)\Z)|(\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z)/i
+end

data/test/contexts.rb

@@ -0,0 +1,29 @@
+class Test::Unit::TestCase
+  share :valid_comment_params do
+    before do
+      @params = { :comment => { :commentable_id => @article.id, 
+                                :commentable_type => 'Article', 
+                                :body => 'the comment body' } }
+    end
+  end
+  
+  share :invalid_comment_params do
+    before do
+      @params = { :comment => { :commentable_id => @article.id, 
+                                :commentable_type => 'Article', 
+                                :body => nil } }
+    end
+  end
+
+  share :an_approved_comment do
+    before do 
+      @comment = @section.approved_comments.first
+    end
+  end
+
+  share :an_unapproved_comment do
+    before do 
+      @comment = @section.unapproved_comments.first
+    end
+  end
+end