muck-comments 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,43 @@
+= MuckComments
+
+Add comments to any object.  This gem is the muck version of acts_as_commentable_with_threading (http://github.com/elight/acts_as_commentable_with_threading/tree/master)
+
+== Setup
+Install the the awesome_nested_set gem (http://github.com/collectiveidea/awesome_nested_set/tree/master)
+
+  gem sources -a http://gems.github.com
+  sudo gem install collectiveidea-awesome_nested_set
+
+Then add it to your environment.rb:
+
+  config.gem "collectiveidea-awesome_nested_set", :lib => 'awesome_nested_set'
+
+== Usage
+
+=== Comment model
+Create a model called comment in your project and add the following:
+  
+  class Comment < ActiveRecord::Base
+    acts_as_muck_comment
+  end
+This let's you add any other methods to the comment model that you see fit.
+
+=== Comment controller
+Override the comments controller to change the the security model.  For example:
+
+  class Muck::CommentsController < ApplicationController
+    
+    before_filter :login_required # require the user to be logged in to make a comment
+    
+    # Modify this method to change how permissions are checked to see if a user can comment.
+    # Each model that implements 'acts_as_muck_comment' can override can_comment? to 
+    # change how comment permissions are handled.
+    def has_permission_to_comment(user, parent)
+      parent.can_comment?(user)
+    end
+    
+  end
+
+
+
+Copyright (c) 2009 Justin Ball, released under the MIT license

data/Rakefile

@@ -0,0 +1,76 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the muck_comments plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the muck_comments plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MuckComments'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "muck-comments"
+    gemspec.summary = "The comment engine for the muck system"
+    gemspec.email = "justinball@gmail.com"
+    gemspec.homepage = "http://github.com/jbasdf/muck_comments"
+    gemspec.description = "The comment engine for the muck system."
+    gemspec.authors = ["Justin Ball"]
+    gemspec.rubyforge_project = 'muck-comments'
+    gemspec.add_dependency "muck-engine"
+    gemspec.add_dependency "muck-users"
+    gemspec.files.include %w( tasks/*
+                          db/migrate/*.rb
+                          app/**/**/**/*
+                          config/*
+                          locales/*
+                          rails/*
+                          test/*
+                          lib/**/*
+                          public/javascripts/* )
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+# rubyforge tasks
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/muck-comments/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/muck/comments_controller.rb

@@ -0,0 +1,75 @@
+class Muck::CommentsController < ApplicationController
+  unloadable
+  
+  before_filter :get_parent, :only => [:create]
+  before_filter :get_comment, :only => [:destroy]
+
+  def create
+    @comment = @parent.comments.build(params[:comment])
+    @comment.user = current_user
+    @comment.save!
+    respond_to do |format|
+      format.html do
+        redirect_back_or_default(@parent)
+      end
+      format.json { render :json => { :success => true, :comment => @comment } }
+    end
+  rescue ActiveRecord::RecordInvalid => ex
+    if @comment
+      @errors = @comment.errors.full_messages.to_sentence
+    else
+      @errors = ex
+    end
+    message = t('muck.comments.create_error', :errors => @errors)
+    respond_to do |format|
+      format.html do
+        flash[:error] = message
+        redirect_back_or_default(@parent)
+      end
+      format.json { render :json => { :success => false, :message => message, :errors => @errors } }
+    end
+  end
+
+  def destroy
+    @comment.destroy
+    respond_to do |format|
+      format.html do
+        flash[:notice] = t('muck.comments.comment_removed')
+        redirect_back_or_default(current_user)
+      end
+      format.json { render :json => { :success => true, :message => t("muck.comments.comment_removed"), :comment_id => @comment.id } }
+    end
+  end  
+
+  protected
+
+  def get_parent
+    if !params[:parent_type] || !params[:parent_id]
+      raise t('muck.comments.missing_parent_id_error')
+      return
+    end
+    @klass = params[:parent_type].to_s.capitalize.constantize
+    @parent = @klass.find(params[:parent_id])
+    unless has_permission_to_comment(current_user, @parent)
+      permission_denied
+    end
+  end
+
+  def get_comment
+    @comment = Comment.find(params[:id])
+    unless @comment.can_edit?(current_user)
+      respond_to do |format|
+        format.html do
+          flash[:notice] = I18n.t('muck.comments.cant_delete_comment')
+          redirect_back_or_default current_user
+        end
+        format.js { render(:update){|page| page.alert I18n.t('muck.comments.cant_delete_comment')}}
+      end
+    end
+  end
+
+  def has_permission_to_comment(user, parent)
+    parent.can_comment?(user)
+  end
+  
+end

data/app/helpers/muck_comments_helper.rb

@@ -0,0 +1,17 @@
+module MuckCommentsHelper
+  
+  # parent is the object to which the comments will be attached
+  # comment is the optional parent comment for the new comment.
+  def comment_form(parent, comment = nil)
+    render :partial => 'comments/form', :locals => {:parent => parent, :comment => comment}
+  end
+
+  def new_comment_path_with_parent(parent)
+    comments_path(make_parent_params(parent))
+  end
+  
+  def make_parent_params(parent)
+    { :parent_id => parent.id, :parent_type => parent.class.to_s }
+  end
+  
+end

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

@@ -0,0 +1,8 @@
+<div class="activity activity-status-update delete-container" id="<%= activity.dom_id %>">
+  <div class="actor-icon"><%= icon activity.source %></div>
+  <div class="activity-content">
+    <p><span class="actor"><%= link_to activity.source.display_name, activity.source %></span> <%= activity.content %></p>
+    <span class="activity-time"><%= t("muck.activities.time_ago", :time_in_words => time_ago_in_words(activity.created_at)) %></span>
+    <%= delete_activity(activity, :image) %>
+  </div>
+</div>

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

@@ -0,0 +1,26 @@
+<%-
+comment ||= @comment
+return if comment.user.nil?
+truncate = false
+youtube_videos = comment.comment.scan(/\[youtube:+.+\]/)
+c = comment.comment.dup.gsub(/\[youtube:+.+\]/, '')
+-%>
+
+<div id="<%= comment.dom_id %>" class="comment_holder">
+  <%= icon comment.user, :small, :class => 'left avatar_on_comment' %> 
+  <div class="date_details">
+    <%= _("%{comment_age} ago %{user_name_link} wrote :") % {:comment_age => time_ago_in_words(comment.created_at), :user_name_link => (link_to h(comment.user.full_name), profile_path(comment.user))} %> 
+  </div>
+  <div class="comment_message">
+    <%= sanitize(textilize(c)) %>
+		<%= x_comment_link(comment) -%>
+  </div>
+	
+  <% unless youtube_videos.empty? %>
+    <strong><%= pluralize youtube_videos.size, 'video' %>:</strong><br/>
+    <% youtube_videos.each do |o| %>
+    <%= tb_video_link(o.gsub!(/\[youtube\:|\]/, '')) %>
+  <% end
+  end %>
+  <div class="clear"></div>
+</div>

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

@@ -0,0 +1,14 @@
+<% c = comment_title.comment.dup.gsub(/\[youtube:+.+\]/, '') %>
+
+<div id="<%= comment_title.dom_id %>" class="comment_holder">
+  <%= icon comment_title.user, :small, :class => 'left avatar_on_comment' %> 
+	<div class="date_details">
+	  <%= _("%{comment_age} ago %{user_name_link} wrote :") % {:comment_age => time_ago_in_words(comment_title.created_at), 
+																														 :user_name_link => (link_to h(comment_title.user.full_name),
+																														 										profile_path(comment_title.user))} %> 
+	</div>
+	<div class="comment_message">
+      <%= sanitize(textilize(c)) %>
+  </div>
+  <div class="clear"></div>
+</div>

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

@@ -0,0 +1,7 @@
+<div id="<%= parent.dom_id %>_new_comment" class="comment-form-wrapper">
+  <% form_for(:comment, :url => new_comment_path_with_parent(parent), :html => { :id => "#{parent.dom_id}_comment_form", :class => "comment-form"} ) do |f| -%>
+    <%= f.text_area :body, :class => 'min' %>
+    <%= hidden_field_tag :parent_comment_id, comment.id unless comment.blank? -%>
+    <%= f.submit t('muck.comments.add_comment'), :class => "button" %>
+  <% end -%>
+</div>

data/config/muck_comments_routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :comments, :controller => 'muck/comments'
+end

data/db/migrate/20090613173314_create_comments.rb

@@ -0,0 +1,24 @@
+class CreateComments < ActiveRecord::Migration
+  def self.up
+    create_table :comments, :force => true do |t|
+      t.integer   :commentable_id, :default => 0
+      t.string    :commentable_type, :limit => 15, :default => ""
+      t.text      :body, :default => ""
+      t.integer   :user_id, :default => 0, :null => false
+      t.integer   :parent_id
+      t.integer   :lft
+      t.integer   :rgt
+      t.integer   :is_denied,        :default => 0,     :null => false
+      t.boolean   :is_reviewed,      :default => false
+      t.timestamps
+    end
+
+    add_index :comments, ["user_id"]
+    add_index :comments, ["commentable_id", "commentable_type"]
+    
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/active_record/acts/muck_comment.rb

@@ -0,0 +1,78 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module MuckComment #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        def acts_as_muck_comment(options = {})
+
+          acts_as_nested_set :scope => [:commentable_id, :commentable_type]
+          validates_presence_of :body
+          belongs_to :user
+          belongs_to :commentable, :polymorphic => true
+
+          named_scope :by_newest, :order => "created_at DESC"
+          named_scope :recent, lambda { { :conditions => ['created_at > ?', 1.week.ago] } }
+                            
+          class_eval <<-EOV
+
+            # prevents a user from submitting a crafted form that bypasses activation
+            attr_protected :created_at, :updated_at
+          EOV
+
+          include ActiveRecord::Acts::MuckComment::InstanceMethods
+          extend ActiveRecord::Acts::MuckComment::SingletonMethods
+          
+        end
+      end
+
+      # class methods
+      module SingletonMethods
+        
+        # Helper class method to lookup all comments assigned
+        # to all commentable types for a given user.
+        def find_comments_by_user(user)
+          find(:all,
+            :conditions => ["user_id = ?", user.id],
+            :order => "created_at DESC"
+          )
+        end
+
+        # Helper class method to look up all comments for 
+        # commentable class name and commentable id.
+        def find_comments_for_commentable(commentable_str, commentable_id)
+          find(:all,
+            :conditions => ["commentable_type = ? and commentable_id = ?", commentable_str, commentable_id],
+            :order => "created_at DESC"
+          )
+        end
+
+        # Helper class method to look up a commentable object
+        # given the commentable class name and id 
+        def find_commentable(commentable_str, commentable_id)
+          commentable_str.constantize.find(commentable_id)
+        end
+
+      end
+      
+      # All the methods available to a record that has had <tt>acts_as_muck_comment</tt> specified.
+      module InstanceMethods
+
+        #helper method to check if a comment has children
+        def has_children?
+          self.children.size > 0 
+        end
+
+        # override this method to change the way permissions are handled on comments
+        def can_edit?(user)
+          return true if check_user(user)
+          false
+        end
+
+      end
+    end
+  end
+end

data/lib/acts_as_commentable_with_threading.rb

@@ -0,0 +1,75 @@
+# ActsAsCommentableWithThreading
+module Acts #:nodoc:
+  module CommentableWithThreading #:nodoc:
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_commentable
+        has_many :comments, :as => :commentable, :dependent => :destroy, :order => 'created_at ASC'
+        include Acts::CommentableWithThreading::InstanceMethods
+        extend Acts::CommentableWithThreading::SingletonMethods
+      end
+    end
+    
+    # This module contains class methods
+    module SingletonMethods
+      # Helper method to lookup for comments for a given object.
+      # This method is equivalent to obj.comments.
+      def find_comments_for(obj)
+        commentable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
+       
+        Comment.find(:all,
+          :conditions => ["commentable_id = ? and commentable_type = ?", obj.id, commentable],
+          :order => "created_at DESC"
+        )
+      end
+      
+      # Helper class method to lookup comments for
+      # the mixin commentable type written by a given user.  
+      # This method is NOT equivalent to Comment.find_comments_for_user
+      def find_comments_by_user(user) 
+        commentable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
+        
+        Comment.find(:all,
+          :conditions => ["user_id = ? and commentable_type = ?", user.id, commentable],
+          :order => "created_at DESC"
+        )
+      end
+    end
+    
+    # This module contains instance methods
+    module InstanceMethods
+      
+      # Helper method to display only root threads, no children/replies
+      def root_comments
+        self.comments.find(:all, :conditions => {:parent_id => nil})
+      end
+      
+      # Helper method to sort comments by date
+      def comments_ordered_by_submitted
+        Comment.find(:all,
+          :conditions => ["commentable_id = ? and commentable_type = ?", id, self.class.name],
+          :order => "created_at DESC"
+        )
+      end
+      
+      # Helper method that defaults the submitted time.
+      def add_comment(comment)
+        comments << comment
+      end
+      
+      # Determines whether or not the give user can comment on the parent object
+      def can_comment?(user)
+        return true unless user.blank?
+        false
+      end
+      
+    end
+    
+  end
+end
+
+ActiveRecord::Base.send(:include, Acts::CommentableWithThreading)

data/lib/muck_comments/initialize_routes.rb

@@ -0,0 +1,8 @@
+class ActionController::Routing::RouteSet
+  def load_routes_with_muck_comments!
+    muck_comments_routes = File.join(File.dirname(__FILE__), *%w[.. .. config muck_comments_routes.rb])
+    add_configuration_file(muck_comments_routes) unless configuration_files.include? muck_comments_routes
+    load_routes_without_muck_comments!
+  end
+  alias_method_chain :load_routes!, :muck_comments
+end

data/lib/muck_comments/tasks.rb

@@ -0,0 +1,28 @@
+require 'rake'
+require 'rake/tasklib'
+require 'fileutils'
+
+module MuckComments
+  class Tasks < ::Rake::TaskLib
+    def initialize
+      define
+    end
+  
+    private
+    def define
+      
+      namespace :muck do
+        namespace :comments do
+          desc "Sync required files from muck comments."
+          task :sync do
+            path = File.join(File.dirname(__FILE__), *%w[.. ..])
+            system "rsync -ruv #{path}/db ."
+            #system "rsync -ruv #{path}/public ."
+          end
+        end
+      end
+
+    end
+  end
+end
+MuckComments::Tasks.new

data/lib/muck_comments.rb

@@ -0,0 +1,5 @@
+require 'acts_as_commentable_with_threading'
+
+ActiveRecord::Base.class_eval { include ActiveRecord::Acts::MuckComment }
+ActionController::Base.send :helper, MuckCommentsHelper
+I18n.load_path += Dir[ File.join(File.dirname(__FILE__), '..', 'locales', '*.{rb,yml}') ]

data/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  muck:
+    comments:
+      cant_delete_comment: "You don't have permission to delete that comment"
+      missing_parent_id_error: "Please specify a parent object"
+      comment_removed: "Comment successfully removed."
+      create_error: "Could not create the comment {{errors}}"
+      add_comment: "Comment"

data/muck-comments.gemspec

@@ -0,0 +1,97 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{muck-comments}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Justin Ball"]
+  s.date = %q{2009-06-13}
+  s.description = %q{The comment engine for the muck system.}
+  s.email = %q{justinball@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/muck/comments_controller.rb",
+     "app/controllers/muck/comments_controller.rb",
+     "app/helpers/muck_comments_helper.rb",
+     "app/helpers/muck_comments_helper.rb",
+     "app/views/activity_templates/_comment.html.erb",
+     "app/views/activity_templates/_comment.html.erb",
+     "app/views/comments/_comment.html.erb",
+     "app/views/comments/_comment.html.erb",
+     "app/views/comments/_comment_title.html.erb",
+     "app/views/comments/_comment_title.html.erb",
+     "app/views/comments/_form.html.erb",
+     "app/views/comments/_form.html.erb",
+     "config/muck_comments_routes.rb",
+     "config/muck_comments_routes.rb",
+     "db/migrate/20090613173314_create_comments.rb",
+     "db/migrate/20090613173314_create_comments.rb",
+     "install.rb",
+     "lib/active_record/acts/muck_comment.rb",
+     "lib/active_record/acts/muck_comment.rb",
+     "lib/acts_as_commentable_with_threading.rb",
+     "lib/acts_as_commentable_with_threading.rb",
+     "lib/muck_comments.rb",
+     "lib/muck_comments.rb",
+     "lib/muck_comments/initialize_routes.rb",
+     "lib/muck_comments/initialize_routes.rb",
+     "lib/muck_comments/tasks.rb",
+     "lib/muck_comments/tasks.rb",
+     "locales/en.yml",
+     "locales/en.yml",
+     "muck-comments.gemspec",
+     "pkg/muck-comments-0.1.0.gem",
+     "rails/init.rb",
+     "rails/init.rb",
+     "tasks/muck_comments_tasks.rake",
+     "tasks/muck_comments_tasks.rake",
+     "test/db/database.yml",
+     "test/db/schema.rb",
+     "test/factories.rb",
+     "test/factories.rb",
+     "test/functional/comments_controller_test.rb",
+     "test/test_helper.rb",
+     "test/test_helper.rb",
+     "test/unit/comment_test.rb",
+     "test/unit/commentable_test.rb",
+     "uninstall.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/jbasdf/muck_comments}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{muck-comments}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{The comment engine for the muck system}
+  s.test_files = [
+    "test/db/schema.rb",
+     "test/factories.rb",
+     "test/functional/comments_controller_test.rb",
+     "test/test_helper.rb",
+     "test/unit/comment_test.rb",
+     "test/unit/commentable_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<muck-engine>, [">= 0"])
+      s.add_runtime_dependency(%q<muck-users>, [">= 0"])
+    else
+      s.add_dependency(%q<muck-engine>, [">= 0"])
+      s.add_dependency(%q<muck-users>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<muck-engine>, [">= 0"])
+    s.add_dependency(%q<muck-users>, [">= 0"])
+  end
+end

data/rails/init.rb

@@ -0,0 +1,4 @@
+ActiveSupport::Dependencies.load_once_paths << lib_path # disable reloading of this plugin
+
+require 'muck_comments'
+require 'muck_comments/initialize_routes'

data/tasks/muck_comments_tasks.rake

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '/../lib/muck_comments/tasks')

data/test/db/database.yml

@@ -0,0 +1,18 @@
+sqlite3:
+  adapter: sqlite3
+  dbfile: muck_comments.sqlite3.db
+sqlite3mem:
+  :adapter: sqlite3
+  :dbfile: ":memory:"
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: muck_comments_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password:
+  :database: muck_comments_test

data/test/db/schema.rb

@@ -0,0 +1,25 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table "users", :force => true do |t|
+    t.timestamps
+  end
+  
+  create_table "commentables", :force => true do |t|
+    t.timestamps
+  end
+
+  create_table "comments", :force => true do |t|
+    t.integer "commentable_id", :default => 0
+    t.string "commentable_type", :limit => 15, :default => ""
+    t.string "title", :default => ""
+    t.text "body", :default => ""
+    t.string "subject", :default => ""
+    t.integer "user_id", :default => 0, :null => false
+    t.integer "parent_id"
+    t.integer "lft"
+    t.integer "rgt"
+    t.timestamps
+  end
+
+  add_index "comments", "user_id"
+  add_index "comments", "commentable_id"
+end

data/test/factories.rb

@@ -0,0 +1,8 @@
+Factory.sequence :name do |n|
+  "a_name#{n}"
+end
+
+Factory.define :comment do |f|
+  f.body { Factory.next(:name) }
+  f.user {|a| a.association(:user)}
+end

data/test/functional/comments_controller_test.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class Muck::CommentsControllerTest < ActionController::TestCase
+
+  def setup
+    @controller = Muck::CommentsController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+  context "delete comment" do
+    setup do
+      @comment = Factory(:comment)
+    end
+    should "delete comment" do
+      assert_difference "Comment.count", -1 do
+        delete :destroy, { :id => @comment.to_param, :format => 'json' }
+        ensure_flash(/comment successfully removed/i)
+      end
+    end
+  end
+
+  context "create comment" do
+    setup do
+      @user = Factory(:user)
+    end
+    should " be able to create a comment" do
+      assert_difference "Comment.count" do
+        post :create, { :type => 'User', :id => @user.id, :format => 'json', :comment => { :body => 'test' } }
+      end
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,44 @@
+$:.reject! { |e| e.include? 'TextMate' }
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+ENV["RAILS_ENV"] = "test"
+
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'action_controller'
+require 'test_help'
+require 'factory_girl'
+require 'ruby-debug'
+require 'mocha'
+require 'redgreen' rescue LoadError
+require File.expand_path(File.dirname(__FILE__) + '/factories')
+require File.join(File.dirname(__FILE__), 'shoulda_macros', 'controller')
+
+plugin_test_dir = File.dirname(__FILE__)
+
+ActiveRecord::Base.logger = Logger.new(File.join(plugin_test_dir, "debug.log"))
+
+ActiveRecord::Base.configurations = YAML::load(IO.read(File.join(plugin_test_dir, "db", "database.yml")))
+ActiveRecord::Base.establish_connection(ENV["DB"] || "sqlite3mem")
+ActiveRecord::Migration.verbose = false
+load(File.join(plugin_test_dir, "db", "schema.rb"))
+
+require File.join(plugin_test_dir, '..', 'init')
+
+class ActiveSupport::TestCase 
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures  = false
+end
+
+class User < ActiveRecord::Base
+  has_many :comments
+end
+
+class Commentable < ActiveRecord::Base
+  acts_as_commentable
+end
+
+class Comment < ActiveRecord::Base
+  acts_as_muck_comment
+end

data/test/unit/comment_test.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), "..", "test_helper")
+
+# some of the behavior of awesome_nested_set although does so to demonstrate the use of this gem
+context "Comment" do
+  setup do
+    @user = User.create!
+    @comment = Comment.create!(:body => "Root comment", :user => @user)
+  end
+
+  context "that is valid" do
+    should "have a user" do
+      assert_not_nil @comment.user
+    end
+    
+    should "have a body" do
+      assert_not_nil @comment.body
+    end
+  end
+    
+  should "not have a parent if it is a root Comment" do
+    assert_nil @comment.parent
+  end
+
+  should " be able to see how many child Comments it has" do
+    assert_equal @comment.children.size, 0
+  end
+
+  should "be able to add child Comments" do
+    grandchild = Comment.new(:body => "This is a grandchild", :user => @user)
+    grandchild.save!
+    grandchild.move_to_child_of(@comment)
+    assert_equal @comment.children.size, 1
+  end    
+
+  context "after having a child added" do
+    setup do
+      @child = Comment.create!(:body => "Child comment", :user => @user)
+      @child.move_to_child_of(@comment)
+    end
+    
+    should "be able to be referenced by its child" do    
+      assert_equal @child.parent, @comment
+    end
+    
+    should "be able to see its child" do
+      assert_equal @comment.children.first, @child
+    end
+  end
+end

data/test/unit/commentable_test.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), "..", "test_helper")
+
+context "A class that is commentable" do
+  should "be able to have many root comments" do
+    assert Commentable.new.comment_threads.is_a?(Enumerable)
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: muck-comments
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Justin Ball
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-13 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: muck-engine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: muck-users
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: The comment engine for the muck system.
+email: justinball@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- app/controllers/muck/comments_controller.rb
+- app/helpers/muck_comments_helper.rb
+- app/views/activity_templates/_comment.html.erb
+- app/views/comments/_comment.html.erb
+- app/views/comments/_comment_title.html.erb
+- app/views/comments/_form.html.erb
+- config/muck_comments_routes.rb
+- db/migrate/20090613173314_create_comments.rb
+- install.rb
+- lib/active_record/acts/muck_comment.rb
+- lib/acts_as_commentable_with_threading.rb
+- lib/muck_comments.rb
+- lib/muck_comments/initialize_routes.rb
+- lib/muck_comments/tasks.rb
+- locales/en.yml
+- muck-comments.gemspec
+- pkg/muck-comments-0.1.0.gem
+- rails/init.rb
+- tasks/muck_comments_tasks.rake
+- test/db/database.yml
+- test/db/schema.rb
+- test/factories.rb
+- test/functional/comments_controller_test.rb
+- test/test_helper.rb
+- test/unit/comment_test.rb
+- test/unit/commentable_test.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/jbasdf/muck_comments
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: muck-comments
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: The comment engine for the muck system
+test_files: 
+- test/db/schema.rb
+- test/factories.rb
+- test/functional/comments_controller_test.rb
+- test/test_helper.rb
+- test/unit/comment_test.rb
+- test/unit/commentable_test.rb