loudmouth 0.1.0 → 0.2.0

data/Gemfile

@@ -8,3 +8,4 @@ group :development do
 end
 
 gem "acts_as_tree"
+gem "haml"

data/Gemfile.lock

@@ -3,6 +3,7 @@ GEM
   specs:
     acts_as_tree (0.1.1)
     git (1.2.5)
+    haml (3.1.2)
     jeweler (1.6.0)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
@@ -17,6 +18,7 @@ PLATFORMS
 DEPENDENCIES
   acts_as_tree
   bundler (~> 1.0.0)
+  haml
   jeweler (~> 1.6.0)
   rcov
   shoulda

data/README.md

@@ -1,10 +1,10 @@
-Loudmouth
----------
+## Loudmouth
+
 
 Loudmouth adds comments to any model.
 
-Installation
-------------
+## Installation
+
 Install the gem (or add to your Gemfile & bundle install)
 
     gem install loudmouth
@@ -13,16 +13,24 @@ Run the loudmouth installer to copy an initializer file to your app.
 
     rails g loudmouth:install
     
-Usage
------
+## Usage
+
 Assuming you want to have 'users' comment on 'articles' add the following to your routes.rb:
 
     comments_on :articles, :by => :users
-    
+
 run the generator to create the comment model (ArticleComments):
 
     rails generate loudmouth Article User
     
+run the new migrations
+
+    rake db:migrate
+    
+add the following to your Article model (app/models/article.rb)
+
+    loudmouths_can_comment
+    
 and you get nested routes like these:
 
     /articles/:article_id/comments
@@ -31,8 +39,47 @@ and you get nested routes like these:
 
 Browse to an article and append '/comments' to the end of the URL.
 
-Contributing to loudmouth
--------------------------
+If you want to render comments in-line on Articles#show
+
+    render_comments_for(@article)
+    
+or to render a new comment form
+
+    render_comment_form_for(@article)
+    
+## Advanced Usage
+
+### Customizing
+
+To further customize loudmouth, edit the values in the installed initializer file (config/initializers/loudmouth.rb):
+
+    # Optionally specify a layout to use for the loudmouth controller
+    config.use_layout = ''
+
+    # Default comment text for the new comment form
+    config.new_comment_content = "Enter new Comment..."
+
+### Overriding the Loudmouth Controller
+
+Any loudmouth method can be overridden.  And hey...there's a generator for that!
+
+    rails g loudmouth:override_controller
+    
+This will install a loudmouth override controller into your application (into app/controllers).
+
+To activate the override controller, make sure to update all of your comments_on calls in your routes.rb file:
+
+    comments_on :articles, :by => :users, :controller => 'comments'
+
+Some common functions to override:
+
+* **after\_create\_path** - where to direct the user after successfully posting a comment
+* **validate\_destroy** - validates whether the current user can delete a comment (e.g. admin or comment author)
+* **after\_destroy\_path** - where to direct the user after successfully deleting a comment
+
+See the installed override controller [source](https://github.com/pglombardo/loudmouth/blob/master/lib/generators/loudmouth/templates/comments_controller.rb) for full details.
+
+## Contributing to loudmouth
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -42,8 +89,13 @@ Contributing to loudmouth
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-Copyright
----------
+## Background
+
+This gem was built for [Gameface](http://g.ameface.com) to unify duplicate commenting code.
+
+Thanks to [plataformatec/devise](https://github.com/plataformatec/devise) and [aarongough/has\_threaded\_comments](https://github.com/aarongough/has_threaded_comments) for insight into how gems work.
+
+## Copyright
 
 Copyright (c) 2011 Peter Giacomo Lombardo. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/app/controllers/loudmouth/comments_controller.rb

@@ -3,7 +3,7 @@ class Loudmouth::CommentsController < ApplicationController
   before_filter :authenticate_user!, :except => [ :index ]
   
   helper_method :topic, :topic_c, :topic_comment, :topic_comment_c, :user, :user_c
-  helper_method :new_comment_content
+  helper_method :new_comment_content, :validate_create, :validate_destroy
 
   def index
     @topic = topic_c.find(params[topic.foreign_key.to_sym])
@@ -22,9 +22,12 @@ class Loudmouth::CommentsController < ApplicationController
   end
 
   def create
+    @topic = topic_c.find(params[topic_comment.to_sym][topic.foreign_key.to_sym])
+
+    redirect_to :back unless validate_create(@topic)
+    
     @comment = topic_comment_c.new(params[topic_comment.to_sym])
     @user = user_c.find(params[topic_comment.to_sym][('author_' + user.foreign_key).to_sym])
-    @topic = topic_c.find(params[topic_comment.to_sym][topic.foreign_key.to_sym])
     
     if params[topic_comment.to_sym][:content] == new_comment_content()
       flash[:error] = new_comment_content().
@@ -115,28 +118,47 @@ class Loudmouth::CommentsController < ApplicationController
     Loudmouth.new_comment_content
   end
   
-  def topic_path
-  end
+  ################
+  # Paths
+  ################
   
-  def edit_topic_path
+  # The path the user is redirected to after a successful update of a comment
+  def after_update_path
+    url_for(@topic)
   end
   
+  # The path the user is redirected to after a successful creation of a comment
   def after_create_path
     url_for(@user)
   end
   
+  # The path the user is redirected to after a successful destroy of a comment
   def after_destroy_path
-    :back
+    url_for(@topic)
+  end
+  
+  ######################
+  # Validation Routines
+  ######################
+
+  # Used to validate that the current user can comment on topic.
+  # Override to provide application specific commenting validation
+  def validate_create(topic)
+    true
   end
 
+  # Used to validate that the current user can destroy the comment.
+  # Override to provide application specific validation
   def validate_destroy(comment)
-    # Check if the app if there are corresponding instance variables for
+    
+    # Check if there are corresponding instance variables for
     # topic and user.  If so attempt to validate with those.
     # Otherwise, this function can be overridden.
     user = instance_variable_get(:"@#{user}")
     topic = instance_variable_get(:"@#{topic}")
     
     if user and topic
+      # is the comment owner?
       if user.id == topic.send(:"#{user.foreign_key}")
         return true
       end

data/app/views/loudmouth/comments/_comment.html.haml

@@ -1,14 +1,10 @@
-.comment{ :id => dom_id(comment) }
-  %table{ :style => 'border-top: 1px solid black;' }
-    %tr{ :style => 'vertical-align: top;' }
-      %td{ :style => '' }
-        - cc = simple_format(comment.content)
-        = auto_link(cc)
-    %tr
-      %td{ :style => 'text-align: right;' }
-        = time_ago_in_words(comment.created_at)
-        ago
-        = link_to "Delete", topic_comment_path(topic, comment), :method => :delete, :confirm => "This will delete the comment from your profile.  Are you sure?"
-      
-  / - if comment.children and comment.children.length > 0
-  /   = indented_render 1, :partial => 'loudmouth/comments/comment', :collection => comment.children
+%table{ :style => 'background: #fff; border: 1px solid #ccc;' }
+  %tr{ :style => 'border: 1px solid #ccc; padding: 5px;' }
+    %td{ :style => 'border: 1px solid #ccc; padding: 5px;' }
+      - cc = sanitize(cc)
+      - cc = simple_format(comment.content)
+      = auto_link(cc).html_safe
+  %tr{ :style => 'border: 1px solid #ccc; padding: 5px;' }
+    %th{ :style => 'background: #eee; text-align: right; font-size: 80%;' }
+      == Posted #{time_ago_in_words(comment.created_at)} ago
+

data/app/views/loudmouth/comments/_comment_form.html.haml

@@ -17,15 +17,15 @@
 
 %h3 New Comment
 
-- author_key = 'author_' + user.class.name.underscore.downcase.foreign_key
-- topic_comment = topic.class.name.underscore.downcase + '_comment'
+- author_key = 'author_' + user.class.name.underscore.foreign_key
+- topic_comment = topic.class.name.underscore + '_comment'
 
-= form_for topic_comment.to_sym, :url => send("#{topic.class.name.underscore.downcase}_comments_path", topic) do |f|
+= form_for topic_comment.to_sym, :url => send("#{topic.class.name.underscore}_comments_path", topic) do |f|
   %table
     %tr 
       %td{ :style => 'width: 80%;' }
         = f.text_area :content, :style => 'width: 100%; height: 50px;', :value => content, :onfocus => "prepareTextField(this);", :onblur => "revertTextField(this);"
-        = f.hidden_field topic.class.name.underscore.downcase.foreign_key.to_sym, { :value => topic.id }
+        = f.hidden_field topic.class.name.underscore.foreign_key.to_sym, { :value => topic.id }
         = f.hidden_field author_key.to_sym,  { :value => user.id }
     %tr 
       %td{ :style => 'text-align: right;' }

data/app/views/loudmouth/comments/index.html.haml

@@ -4,7 +4,5 @@
 
 = render_comment_form_for(@topic, user)
 
-- @comments.each do |comment|
-  = render :partial => 'loudmouth/comments/comment', :object => comment  
-
+= render_comments_for(@topic)
 

data/lib/extensions/active_record.rb

@@ -0,0 +1,17 @@
+module LoudmouthExtension
+  def self.included(base)  
+    base.send :extend, ClassMethods 
+  end  
+  
+  module ClassMethods
+    def loudmouths_can_comment(options = {})
+      has_many :comments, :class_name => "#{self.name}Comment", :dependent => :destroy, :order => 'created_at DESC'
+      send :include, InstanceMethods
+    end   
+  end  
+  
+  module InstanceMethods 
+  end 
+end
+
+ActiveRecord::Base.send :include, LoudmouthExtension

data/lib/extensions/helper.rb

@@ -2,13 +2,14 @@ module Loudmouth
   module Controllers
     module Helpers
       extend ActiveSupport::Concern
+      include ActionView::Helpers::SanitizeHelper
       
       included do
-        helper_method :render_comment_form_for
+        # helper_method :render_comment_form_for, :render_comments_for
       end
       
       def render_comment_form_for(topic, user)
-        unless Loudmouth.treasure_map.has_key?(topic.class.name.underscore.downcase.to_sym)
+        unless Loudmouth.treasure_map.has_key?(topic.class.name.underscore.to_sym)
           raise "loudmouth not setup for #{topic.class.name.underscore.downcase.to_sym}"
         end
 
@@ -16,8 +17,16 @@ module Loudmouth
                 :locals => { :topic => topic, :user => user, :content => Loudmouth.new_comment_content }
       end
       
+      def render_comments_for(topic)
+        unless Loudmouth.treasure_map.has_key?(topic.class.name.underscore.to_sym)
+          raise "loudmouth not setup for #{topic.class.name.underscore.downcase.to_sym}"
+        end
+
+        render :partial => 'loudmouth/comments/comment', :collection => topic.comments, :as => :comment
+      end
+      
       def topic_comment_path(topic)
-        send("#{topic.class.name.underscore.downcase}_comments_path", topic)
+        send("#{topic.class.name.underscore}_comments_path", topic)
       end
       
     end

data/lib/generators/loudmouth/templates/comments_controller.rb

@@ -12,49 +12,75 @@ class CommentsController < Loudmouth::CommentsController
   # def index
   #   if topic.to_sym == :game
   #     @game = Game.find(params[:game_id])
-  #   elsif topic.to_sym == :profile
-  #     @profile = Profile.find(params[:profile_id], :include => [ :primary_pic ])
   #   else
   #     raise "unknown model in Comments#index"
   #   end
   #   super
   # end
+  #   
+  # def edit
+  # end
+  # 
+  # def create
+  # end
+  # 
+  # def update
+  # end
+  # 
+  # def destroy
+  # end
   
-  #
-  # after_create_path specifies the path the user is redirected to after
-  # successfully posting a comment.
-  #
+  ################
+  # Paths
+  ################
+  
+  # The path the user is redirected to after a successful update of a comment
+  # def after_update_path
+  #   url_for(@topic)
+  # end
+  
+  # The path the user is redirected to after a successful creation of a comment
   # def after_create_path
-  #   if topic.to_sym == :game
-  #     game_comments_path(@game)
-  #   elsif topic.to_sym == :profile
-  #     profile_comments_path(@profile)
-  #   elsif topic.to_sym == :profile_pic
-  #     profile_face_path(@profile, @profile_pic)
-  #   else
-  #     raise "unknown model in Comments#after_create_path"
-  #   end
+  #   url_for(@user)
   # end
   
-  #
-  # validate_destroy is called prior to destroying a comment.
+  # The path the user is redirected to after a successful destroy of a comment
+  # def after_destroy_path
+  #   url_for(@topic)
+  # end
+  
+  ######################
+  # Validation Routines
+  ######################
+
+  # Used to validate that the current user can comment on topic.
+  # Override to provide application specific commenting validation
+  # def validate_create(topic)
+  #   true
+  # end
+
+  # Used to validate that the current user can destroy the comment.
+  # Override to provide application specific validation
   # Return true or false to indicate whether the current user is authorized to do so.
   #
   # def validate_destroy(comment)
   #   [ code to determine if the current user is authorized to destroy comment ]
   #   return true/false
   # end
-  
+
+  ######################
+  # Validation Routines
+  ######################
   #
-  # You can have a dynamic layout specified under conditions defined below.
+  # You can have a dynamic layout specified under the conditions defined below.
   #
   # def determine_layout
   #   if params.has_key?(:profile_id)
-  #     'with_left_sidebar'
+  #     'special_layout'
   #   elsif params.has_key?(:game_id)
-  #     'one_column_900px'
+  #     'application_layout'
   #   else
-  #     'one_column_900px'
+  #     'frames_layout'
   #   end
   # end
 end

data/lib/generators/loudmouth/templates/loudmouth_initializer.rb

@@ -1,6 +1,6 @@
 
 Loudmouth.setup do |config|
-  # Optionally specify a layout to use when rendering comments#index
+  # Optionally specify a layout to use for the loudmouth controller
   config.use_layout = ''
   
   # Default comment text for the new comment form

data/lib/loudmouth.rb

@@ -1,6 +1,7 @@
 require "loudmouth"
 require "rails/routes"
 require "extensions/helper"
+require "extensions/active_record"
 
 module Loudmouth
   class Engine < Rails::Engine
@@ -25,12 +26,12 @@ module Loudmouth
   end
   
   def self.include_helpers
-    ActiveSupport.on_load(:action_controller) do
-      include Loudmouth::Controllers::Helpers
-    end
-
-    # ActiveSupport.on_load(:action_view) do
+    # ActiveSupport.on_load(:action_controller) do
     #   include Loudmouth::Controllers::Helpers
     # end
+
+    ActiveSupport.on_load(:action_view) do
+      include Loudmouth::Controllers::Helpers
+    end
   end
 end

data/loudmouth.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{loudmouth}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Peter Giacomo Lombardo}]
-  s.date = %q{2011-06-12}
+  s.date = %q{2011-06-16}
   s.description = %q{Loudmouth adds commenting to one or many of your models.}
   s.email = %q{pglombardo@gmail.com}
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "app/views/loudmouth/comments/_comment.html.haml",
     "app/views/loudmouth/comments/_comment_form.html.haml",
     "app/views/loudmouth/comments/index.html.haml",
+    "lib/extensions/active_record.rb",
     "lib/extensions/helper.rb",
     "lib/generators/loudmouth/install_generator.rb",
     "lib/generators/loudmouth/loudmouth_generator.rb",
@@ -58,12 +59,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<acts_as_tree>, [">= 0"])
+      s.add_runtime_dependency(%q<haml>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<acts_as_tree>, [">= 0"])
+      s.add_dependency(%q<haml>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
@@ -71,6 +74,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<acts_as_tree>, [">= 0"])
+    s.add_dependency(%q<haml>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.0"])

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: loudmouth
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Peter Giacomo Lombardo
@@ -15,11 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-12 00:00:00 Z
+date: 2011-06-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  name: acts_as_tree
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -28,12 +29,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: acts_as_tree
-  version_requirements: *id001
-  type: :runtime
-- !ruby/object:Gem::Dependency 
+  requirement: *id001
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  type: :runtime
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -42,12 +43,26 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
   name: shoulda
-  version_requirements: *id002
   type: :development
-- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -58,12 +73,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  name: bundler
-  version_requirements: *id003
-  type: :development
-- !ruby/object:Gem::Dependency 
+  requirement: *id004
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  type: :development
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -74,12 +89,12 @@ dependencies:
         - 6
         - 0
         version: 1.6.0
-  name: jeweler
-  version_requirements: *id004
-  type: :development
-- !ruby/object:Gem::Dependency 
+  requirement: *id005
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  type: :development
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -88,9 +103,8 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rcov
-  version_requirements: *id005
-  type: :development
+  requirement: *id006
+  prerelease: false
 description: Loudmouth adds commenting to one or many of your models.
 email: pglombardo@gmail.com
 executables: []
@@ -113,6 +127,7 @@ files:
 - app/views/loudmouth/comments/_comment.html.haml
 - app/views/loudmouth/comments/_comment_form.html.haml
 - app/views/loudmouth/comments/index.html.haml
+- lib/extensions/active_record.rb
 - lib/extensions/helper.rb
 - lib/generators/loudmouth/install_generator.rb
 - lib/generators/loudmouth/loudmouth_generator.rb