acts_as_debatable 0.0.1 → 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "rails", ">= 3.0.1"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3-ruby", :require => "sqlite3"
+
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/README.md

@@ -1,7 +1,13 @@
 Acts\_as\_debatable
 ===================
 
-This plugin is still on its pre-alpha stage, which means that you may use it on your own risk.
+This plugin is still on its pre-alpha stage, which means that you may use it on your own risk. 
+
+## Prerequirements
+
+You have to have a User model with fields: admin:boolean, username:string (or login:string).
+We need admin field for approving comments. Username field gives us a chance to display something like "This comment was written by USERNAME".
+You can use 'login' field instead of 'username' as acts\_as\_debatable is looking for that name if it can't find the latter.
 
 ## Install
 
@@ -10,14 +16,17 @@ First of all you'll need to add some gems. Add this to your app's Gemfile **befo
     gem 'devise'
     gem 'ancestry'
 
+Acts\_as\_debatable doesn't make any use of Devise except it uses its user\_signed\_in? and current\_user helper methods. If you can provide that methods on your own or your authentication module has those methods there is no need to add gem 'devise'!
+Gem Ancestry will be used for comments threading.
+
 then add:
 
-    gem 'acts_as_debatable', :git => 'git://github.com/espresse/acts_as_debatable.git'
+    gem 'acts_as_debatable', :git=> 'git://github.com/espresse/acts_as_debatable.git'
 
 Run
 
     bundle install
-    rails g acts_as_debatable:migrations
+    rails g acts_as_debatable:migration
     rake db:migrate
 
 Now you're ready to rock your models.
@@ -36,41 +45,44 @@ So far so good. Next, let's show comments  on the page.
 
 In your show.html.erb file add these partials:
 
-   <%= render :partial => "comments/show", :locals => {:model => @article} %>
-   <%= render :partial => "comments/form", :locals => {:model => @article} %>
-Change @article according to your model variable.
-
-You can overwrite them in yours app/views/comments/.
-
-As there is no autoinstall yet, you have to copy all files from public/* to your app public folder. This will change in future versions.
+   <%= show_debate @article %>
+   <%= debate_form @article %>
+Change @article according to what your controller returns.
 
-You can also use those methods:
+There are several methods created to help you with comments:
 
-Your\_class.latest\_debate - this will give you 10 last comments on Model
-Your\_class.count\_comments - self-explaining; a number of all comments on Model
+Your\_class.latest\_debate - this will give you 10 last comments in Model
+Your\_class.count\_comments - self-explaining; a number of all comments in Model
 
 @your\_class\_object.has\_comments? - returns true if there is at least one comment and false if not
 @your\_class\_object.latest\_debate - returns last 10 comments for this object
 
+User.find(1).comments will return all comments wrote by User with id 1. 
+
 ## I18n
 
 Take a look at config/locales/en.yml in this gem. You'll need to translate the file to have it localized.
 
+## How to change comments look&feel?
+
+There is some basic CSS, you can find them in gems public directory. Feel free to use them in your application. If you want to do so, you need to copy them to your app's public folder. Change them to suits your needs.
+
+## How to approve comments?
+
+As for now, approving is possible only in rails console. You can overwrite comments controller in yours app/controllers/comments_controller.rb and customize approving.  
+
 ## TODO
 
-- better db indexing
-- better validation
-- comments approval system
 - CSS/JS
 - better use of ancestry gem
 - ajax for creating/updating comments
 - akismet spam checking
 - recaptcha
-- User model should have a field username/login/full_name, now we are displaying user's email address, which is not so wise...
-- for approval there's a need to have an admin field in User's model?
+- notifications
+- votes
 
 ##Bugs? Features?
 
 Please post an issue on http://github.com/espresse/acts_as_debatable/issues
 
-Copyright © 2011 Michał Ostrowski, released under the MIT license
+Copyright © 2011 Michał Ostrowski, released under the MIT license

data/acts_as_debatable.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "acts_as_debatable"
+  s.version = "0.1.0"
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Michał Ostrowski"]
+  s.email = ["michol@linuxcsb.org"]
+  s.summary = %q{Comment system for Ruby On Rails}
+  s.description = %q{Ruby on Rails gem to provide simple and easy commenting system for any model.}
+
+  s.files = `git ls-files`.split("\n")
+  #s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  #s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency("bundler", ["~> 1.0"])
+end
+

data/app/controllers/comments_controller.rb

@@ -0,0 +1,60 @@
+class CommentsController < ActionController::Base
+
+    unloadable
+
+    before_filter :find_comment, :except => [:create, :new]
+    
+    def new      
+      @comment = Comment.new      
+    end
+
+    def create
+      @comment = Comment.new(params[:comment])
+      
+      if @comment.save
+         if @comment.approved
+          flash[:notice] = t("comment_ok")
+         else
+          flash[:notice] = t("awaiting_moderation")
+         end
+         redirect_to :back
+      else
+         redirect_to :back, :alert => t("fill_out_fields")
+      end
+    end
+
+    def edit
+      if @comment.user_id
+        unless @comment.user.id == current_user.id
+	        redirect_to :back
+        end
+      else
+        redirect_to :back
+      end
+      store_location
+    end
+
+    def update
+      if @comment.update_attributes(params[:comment])
+	      redirect_back
+      else
+	      render :action => :edit
+      end
+    end
+
+    private
+
+    def find_comment
+      @comment = Comment.find(params[:id])
+    end
+
+    def store_location
+      session[:return_to] = request.referer if request.get?
+    end
+
+    def redirect_back
+      redirect_to(session[:return_to])
+    end
+
+    
+  end

data/app/helper/comments_helper.rb

@@ -0,0 +1,18 @@
+module CommentsHelper
+  def link_to_comment(comment)
+    
+  end
+
+  def small_avatar_url(email)
+    gravatar_id = Digest::MD5::hexdigest(email).downcase
+    "http://gravatar.com/avatar/#{gravatar_id}.png?s=24"
+  end
+
+  def show_debate(model)
+    render :partial => "comments/show", :locals => {:model => model}
+  end
+
+  def debate_form(model)
+    render :partial => "comments/form", :locals => {:model => model}
+  end
+end

data/app/models/comment.rb

@@ -0,0 +1,25 @@
+class Comment < ActiveRecord::Base
+  belongs_to :commentable, :polymorphic => true
+  belongs_to :user
+  
+  validates_presence_of :content
+  validates_presence_of :author_email, :author, :unless => :user_id
+  validates_format_of :author_email, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i, :on => :create, :alert => "is invalid", :unless => :user_id
+
+  #comments can be approved (set to true), not approved (set to false) and awaiting approval (nil)
+  scope :approved, where(:approved => true)
+  scope :awaiting_approval, where(:approved => nil)
+  scope :not_approved, where(:approved => false)
+
+  before_save :comment_approval
+  
+  def comment_approval
+    if user_id
+      self.approved = true
+    end
+  end
+
+  #db is prepared for has_ancestry although Comment is not fully prepared to use it
+  #has_ancestry
+end
+

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

@@ -0,0 +1,22 @@
+<%= form_for(@comment) do |f| %>
+  <% if @comment.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@comment.errors.count, "error") %> prohibited this comment from being saved:</h2>
+
+      <ul>
+      <% @comment.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+   <div class="field" id="debate_content">
+      <%= f.label :content %><br />
+      <%= f.text_area :content %>
+    </div>
+
+  <div class="actions">
+    <%= f.submit t("update_comment")%>
+  </div>
+<% end %>

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

@@ -0,0 +1,44 @@
+<a name="commentform"></a>
+<div class="debate_form">
+  <%= form_for [@commentable, Comment.new] do |f| %>
+
+    <!-- move this to partial _alert.html.erb -->
+    <p id="notice"><%= alert %><%= notice %></p>
+    <!-- -->
+
+    <% unless user_signed_in? %>
+	    <div class="field" id="debate_author">
+	      <%= f.label t("author") %><br />
+	      <%= f.text_field :author %>
+	    </div>
+	    <div class="field" id="debate_author_url">
+	      <%= f.label t("author_url") %><br />
+	      <%= f.text_field :author_url %>
+	    </div>
+	    <div class="field" id="debate_author_email">
+	      <%= f.label t("author_email") %><br />
+	      <%= f.text_field :author_email %>
+	    </div>
+
+    <% else %>
+      <%= f.hidden_field :user_id, :value => current_user.id %>
+
+    <% end %>
+
+
+    <div class="field" id="debate_content">
+      <%= f.label t("content") %><br />
+      <%= f.text_area :content %>
+    </div>
+
+
+    <%= f.hidden_field :commentable_type, :value => model.class %>
+    <%= f.hidden_field :commentable_id, :value => model.id %>
+    <%= f.hidden_field :user_ip, :value => request.remote_ip %>
+  	<%= f.hidden_field :user_agent, :value => request.user_agent %>
+
+    <div class="actions">
+      <%= f.submit t("create_comment") %>
+    </div>
+  <% end %>
+</div>

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

@@ -0,0 +1,40 @@
+
+  <div class="debate">
+    <a name="comments"><b><%= t("comments") %> - <%= model.comments.approved.count %> (<%= t("waiting_for_approval") %>: <%= model.comments.awaiting_approval.count %>)</b></a>
+
+    <% model.comments.approved.each do |comment| %>
+      <div class="comment depth<%= comment.ancestry_depth %>">
+
+	<div class="comment_header">
+	  <a name="<%= comment.id %>">
+      <% if comment.user.blank? %>
+  	    <%= image_tag small_avatar_url("anonymous") %>
+   	  <% else %>
+  	    <%= image_tag(small_avatar_url(comment.user.email)) %>
+  	  <% end %>
+
+	    <%= t("posted_on") %> <%= comment.created_at %>, <%= t("by") %>
+	    <% if comment.user.blank? %>
+	      <%= comment.author %></a>
+	    <% else %>
+	      <%= comment.user.email %>
+	      <% if user_signed_in? %>
+		<%= link_to t("edit_comment"), edit_comment_path(comment) %>
+	      <% end %>
+	    <% end %>
+	  </a>
+	</div>
+
+	<div class="comment_body">
+	  
+	  <%= comment.content %>
+	</div>
+  <div style="clear: both"></div>
+	<div class="comment_footer">
+	  <% if comment.created_at != comment.updated_at %>
+	    <%= t("last_modified") %> <%= comment.updated_at %>
+	  <% end %>   
+	</div>
+      </div>
+    <% end %>
+  </div>

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

@@ -0,0 +1,3 @@
+<h1>Editing Comment</h1>
+
+<%= render 'edit_form' %>

data/config/locales/en.yml

@@ -0,0 +1,17 @@
+en:
+  posted_on: Posted on
+  last_modified: Last modified
+  by: by
+  comments: Comments
+  edit_comment: Edit
+  comment_ok: Comment has been accepted
+  author: Author
+  author_email: Author's email
+  author_url: Author's www
+  content: Content
+  create_comment: Create Comment
+  awaiting_moderation: Your comment has been submited and is awaiting moderation.
+  fill_out_fields: Fields marked with asterix have to be filled out.
+  waiting_for_approval: waiting for approval
+  update_comment: Update Comment
+  answer: Answer

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do |map|
+   resources :comments
+ end
+ 

data/public/stylesheets/debate_style.css

@@ -0,0 +1,15 @@
+.debate .depth0 {
+  margin-left: 0px;
+}
+
+.debate .depth1 {
+  margin-left: 10px;
+}
+
+.debate .depth2 {
+  margin-left: 20px;
+}
+
+.debate .depth3 {
+  margin-left: 30px;
+}

data/public/stylesheets/sass/debate_style.sass

@@ -0,0 +1,11 @@
+.debate .depth0 
+  margin-left: 0px
+
+.debate .depth1 
+  margin-left: 10px
+
+.debate .depth2
+  margin-left: 20px
+
+.debate .depth3
+  margin-left: 30px

data/test/acts_as_debatable_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ActsAsDebatableTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, ActsAsDebatable
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>