commentable 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://gems.simplesideias.com.br"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    commentable (0.1.0)
+      activerecord
+
+GEM
+  remote: http://gems.simplesideias.com.br/
+  specs:
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.9)
+    archive-tar-minitar (0.5.2)
+    arel (2.0.10)
+    builder (2.1.2)
+    columnize (0.3.4)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    notifier (0.1.3)
+    rake (0.8.7)
+    redcarpet (1.17.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    sqlite3 (1.3.4)
+    test_notifier (0.3.6)
+      notifier
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  commentable!
+  rake (~> 0.8.7)
+  redcarpet (~> 1.17)
+  rspec (~> 2.6)
+  ruby-debug19
+  sqlite3 (~> 1.3)
+  test_notifier (~> 0.3.6)

data/README.rdoc

@@ -0,0 +1,82 @@
+= Commentable
+
+This is a really simple ActiveRecord plugin that allows models to be commented.
+
+Commentable is tightly coupled to an User model. If you don't have it, there's no game for you here.
+
+== Installation
+
+  gem install commentable
+
+== Usage
+
+First, you'll have to create the comments table. Run `rails generate migration create_comments` and add the following code:
+
+	class CreateComments < ActiveRecord::Migration
+	  def self.up
+	    create_table :comments do |t|
+	      t.text :body, :formatted_body
+	      t.references :commentable, :polymorphic => true
+	      t.references :user
+	      t.timestamps
+	    end
+
+	    add_index :comments, [:commentable_id, :commentable_type], :name => "index_on_commentable"
+	    add_index :comments, [:commentable_id, :commentable_type, :user_id], :name => "index_on_commentable_and_user"
+	  end
+
+	  def self.down
+	    drop_table :comments
+	  end
+	end
+
+Run `rake db:migrate` to apply this new migration.
+
+Now, add the `commentable` macro to all models that can be commented.
+
+	class Task < ActiveRecord::Base
+	  commentable
+	end
+
+This will create an association called `comments`. You can now create comments like any ActiveRecord model.
+
+	comment = @task.comments.create(:body => "Awesome job!", :user => @user)
+
+There's a shortcut for that.
+
+	comment = @task.add_comment(:body => "Awesome job!", :user => @user)
+
+You can have formatted comments. This is specially useful if you want to provide Markdown support, for instance. Just use the `:format` option passing any variable that responds to the `call` method. The block's return will be used as the `formatted_body` attribute.
+
+	class Task < ActiveRecord::Base
+	  commentable :format => proc {|comment| Redcarpet.new(comment.body.to_s).to_html}
+	end
+
+<b>Final note:</b> remember to add a `comments_count` column to every single model that will be commentable. This is required by the Comment model.
+
+== Maintainer
+
+* Nando Vieira (http://nandovieira.com.br)
+
+== License
+
+(The MIT License)
+
+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/Rakefile

@@ -0,0 +1,5 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new

data/commentable.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "commentable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "commentable"
+  s.version     = Commentable::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nando Vieira"]
+  s.email       = ["fnando.vieira@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/commentable"
+  s.summary     = "Add comment support for ActiveRecord models."
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord"
+  s.add_development_dependency "rake", "~> 0.8.7"
+  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_development_dependency "sqlite3", "~> 1.3"
+  s.add_development_dependency "test_notifier", "~> 0.3.6"
+  s.add_development_dependency "ruby-debug19"
+  s.add_development_dependency "redcarpet", "~> 1.17"
+end

data/lib/commentable.rb

@@ -0,0 +1,22 @@
+require "active_record"
+require "commentable/comment"
+require "commentable/user"
+
+module Commentable
+  autoload :Version, "commentable/version"
+  autoload :InstanceMethods, "commentable/instance_methods"
+  autoload :ClassMethods, "commentable/class_methods"
+
+  def self.extended(base)
+    base.class_eval do
+      include InstanceMethods
+      extend ClassMethods
+
+      class << self
+        attr_accessor :commentable_options
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend(Commentable)

data/lib/commentable/class_methods.rb

@@ -0,0 +1,8 @@
+module Commentable
+  module ClassMethods
+    def commentable(options = {})
+      self.commentable_options = options
+      has_many :comments, :as => :commentable, :dependent => :destroy
+    end
+  end
+end

data/lib/commentable/comment.rb

@@ -0,0 +1,15 @@
+class Comment < ActiveRecord::Base
+  belongs_to :commentable, :polymorphic => true, :counter_cache => true
+  belongs_to :user
+
+  validates_presence_of :body
+  validates_presence_of :user, :commentable
+
+  before_save :generate_formatted_body
+
+  private
+  def generate_formatted_body
+    formatter = commentable.class.commentable_options[:format]
+    write_attribute :formatted_body, formatter.call(self) if formatter.respond_to?(:call)
+  end
+end

data/lib/commentable/instance_methods.rb

@@ -0,0 +1,7 @@
+module Commentable
+  module InstanceMethods
+    def add_comment(options = {})
+      comments.create(options)
+    end
+  end
+end

data/lib/commentable/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_many :comments, :dependent => :nullify
+end

data/lib/commentable/version.rb

@@ -0,0 +1,8 @@
+module Commentable
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/spec/commentable/comment_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe Comment do
+  let(:user) { User.create }
+  let(:project) { Project.create }
+  let(:task) { Task.create }
+  subject { project.add_comment(:body => "Some comment", :user => user) }
+
+  context "validations" do
+    it "requires body" do
+      subject.body = nil
+      subject.valid?
+      subject.errors[:body].should_not be_empty
+    end
+
+    it "requires user" do
+      subject.user = nil
+      subject.valid?
+      subject.errors[:user].should_not be_empty
+    end
+  end
+
+  context "associations" do
+    its(:user) { should be_an(User) }
+    its(:commentable) { should be_a(Project) }
+  end
+
+  context "counter" do
+    it "increments counter" do
+      expect {
+        project.add_comment(:body => "Some comment", :user => user)
+      }.to change { project.reload.comments_count }.by(1)
+    end
+  end
+
+  context "formatting" do
+    it "saves formatted body" do
+      subject = task.comments.create(:body => "# Commentable", :user => user)
+      subject.formatted_body.should include("<h1>Commentable</h1>")
+    end
+  end
+
+  context "removing" do
+    let(:user) { User.create }
+    let(:task) { Task.create }
+    let(:comment) { task.add_comment(:body => "Some comment", :user => user) }
+
+    it "nullifies existing records when user is removed" do
+      user.destroy
+      comment.reload.user.should be_nil
+    end
+
+    it "removes existing records when commentable is removed" do
+      task.destroy
+      Comment.where(:commentable_id => task.id, :commentable_type => task.class.name).count.should be_zero
+    end
+  end
+end

data/spec/commentable_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Commentable do
+  let(:user) { User.create }
+  let(:project) { Project.create }
+
+  it "injects association" do
+    Project.new.should respond_to(:comments)
+    Task.new.should respond_to(:comments)
+  end
+
+  it "skips association" do
+    List.new.should_not respond_to(:comments)
+  end
+
+  it "adds new comment shortcut" do
+    project.comments.should_receive(:create).with(:body => "Some comment", :user => user)
+    project.add_comment(:body => "Some comment", :user => user)
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,26 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :comments do |t|
+    t.text :body, :formatted_body
+    t.references :commentable, :polymorphic => true
+    t.references :user
+    t.timestamps
+  end
+
+  add_index :comments, [:commentable_id, :commentable_type], :name => "index_on_commentable"
+  add_index :comments, [:commentable_id, :commentable_type, :user_id], :name => "index_on_commentable_and_user"
+
+  create_table :projects do |t|
+    t.integer :comments_count, :null => false, :default => 0
+  end
+
+  create_table :tasks do |t|
+    t.integer :comments_count, :null => false, :default => 0
+  end
+
+  create_table :lists do |t|
+    t.integer :comments_count, :null => false, :default => 0
+  end
+
+  create_table :users do |t|
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler"
+Bundler.setup(:default, :development)
+Bundler.require
+
+require "commentable"
+require "test_notifier/runner/rspec"
+require "redcarpet"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+load File.dirname(__FILE__) + "/schema.rb"
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each do |file|
+  require file
+end

data/spec/support/models.rb

@@ -0,0 +1,10 @@
+class Project < ActiveRecord::Base
+  commentable
+end
+
+class Task < ActiveRecord::Base
+  commentable :format => proc {|comment| Redcarpet.new(comment.body.to_s).to_html}
+end
+
+class List < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: commentable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2156389380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156389380
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2156388840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *2156388840
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156388300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *2156388300
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2156387820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *2156387820
+- !ruby/object:Gem::Dependency
+  name: test_notifier
+  requirement: &2156387340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+  type: :development
+  prerelease: false
+  version_requirements: *2156387340
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &2156386960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156386960
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &2156264260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: *2156264260
+description: Add comment support for ActiveRecord models.
+email:
+- fnando.vieira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- commentable.gemspec
+- lib/commentable.rb
+- lib/commentable/class_methods.rb
+- lib/commentable/comment.rb
+- lib/commentable/instance_methods.rb
+- lib/commentable/user.rb
+- lib/commentable/version.rb
+- spec/commentable/comment_spec.rb
+- spec/commentable_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+homepage: http://rubygems.org/gems/commentable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1833029340048367188
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1833029340048367188
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Add comment support for ActiveRecord models.
+test_files:
+- spec/commentable/comment_spec.rb
+- spec/commentable_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/support/models.rb