mongoid_commentable 0.0.1 → 0.0.2

data/Gemfile

@@ -4,6 +4,7 @@ gem "mongoid", "~> 2.0"
 gem "bson_ext", "~> 1.3"
 
 group :development do
+  gem "rr"
   gem "rspec", "~> 2.3.0"
   gem "database_cleaner"
   gem "bundler", "~> 1.0.0"

data/Gemfile.lock

@@ -26,6 +26,7 @@ GEM
       will_paginate (~> 3.0.pre)
     rake (0.8.7)
     rcov (0.9.9)
+    rr (1.0.2)
     rspec (2.3.0)
       rspec-core (~> 2.3.0)
       rspec-expectations (~> 2.3.0)
@@ -47,4 +48,5 @@ DEPENDENCIES
   jeweler (~> 1.6.0)
   mongoid (~> 2.0)
   rcov
+  rr
   rspec (~> 2.3.0)

data/README.rdoc

@@ -9,6 +9,9 @@ You can use latest gem:
 or in Gemfile:
   gem 'mongoid_commentable'
 
+Then install required model and views:
+  rails generate mongoid_commentable:install
+
 == Usage
 To make model commentable you need to include Mongoid::Commentable into your document:
   class Article
@@ -30,11 +33,13 @@ And in your view file:
 For a reply link add parent comment id:
   <%= link_to "Reply", new_article_comment_path(:article_id => @article.id.to_s, :parent => comment.id.to_s) %>
 
-If you want to make a custom views for a comments, run:
-  rails g mongoid_commentable:views
-
 To get a list of all comments, use following method:
   @article.comments_list
+Example: 
+  <% @article.comments_list.each do |comment| %>
+    <p> <%= comment.author %> </p>
+    <p> <%= comment.text %> </p> 
+  <% end %>
 it will return comments in ascending order. To get comments in descending order use:
   @article.comments_list(:sort => :desc)
 NOTE: For descending ordered comments you need to add index to your model manually:
@@ -48,10 +53,10 @@ To get comment level, use following method:
   comment.level
 
 To mark comment as deleted, use following method:
-  @article.mark_comment_deleted(comment_id)
+  @article.comments.find(comment_id).remove
 
-To get comments count, use:
-  @article.comments_count
+To restore comment, use method restore:
+  @article.comments.find(comment_id).restore
 
 == Contributing to mongoid_commentable
  

data/Rakefile

@@ -18,6 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Mongoid_commentable provides methods to create commentable documents}
   gem.email = "mgolovnia@gmail.com"
   gem.authors = ["Max Golovnia"]
+  gem.version = File.read('VERSION').chomp
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/comment.rb

@@ -0,0 +1,30 @@
+module Mongoid_Commentable
+  module Comment
+    extend ActiveSupport::Concern
+
+    included do |base|
+      base.attr_accessible :path,:parent
+      base.field :path, :type => String, :default => ""
+      base.field :parent, :type => String
+      base.field :deleted_at, :type => Time
+      base.embedded_in :commentable, :polymorphic => true, :inverse_of => :comments
+    end
+
+    def level
+      path.count('.')
+    end
+
+    def remove
+      self.update_attribute(:deleted_at, Time.now)
+    end
+
+    def restore
+      self.update_attribute(:deleted_at, nil)
+    end
+
+    def deleted?
+      !!self.deleted_at
+    end
+    
+  end
+end

data/lib/generators/mongoid_commentable/install_generator.rb

@@ -0,0 +1,20 @@
+require 'tmpdir'
+module Mongoid_Commentable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates mongoid_commentable views and model for your application."
+      argument :scope, :required => false, :default => nil,
+                       :desc => "The scope to copy views to"
+      def copy_views
+        directory "views/comments", "app/views/#{scope || :comments}"
+      end
+
+      def copy_model
+        template "models/comment.rb", "app/models/comment.rb"
+      end
+
+    end
+  end
+end
+

data/lib/generators/templates/models/comment.rb

@@ -0,0 +1,7 @@
+class Comment
+  include Mongoid::Document
+  include Mongoid_Commentable::Comment
+  attr_accessible :text, :author
+  field :text, :type => String
+  field :author, :type => String
+end

data/lib/mongoid/commentable.rb

@@ -1,25 +1,20 @@
 module Mongoid::Commentable
   extend ActiveSupport::Concern
-
   included do |base|
     base.embeds_many :comments, :as => :commentable
-    base.field :comments_count, :type => Integer, :default => 0
     base.index [['comments', Mongo::ASCENDING]]
   end
     
   module ClassMethods
-    
+  
     def commentable?
       true
     end
-  
   end
-
     
   def create_comment!(params)
     comment = comments.create!(params)
     comment.path = comment.parent ? comments.find(comment.parent).path + '.' + comment.id.to_s : "root."+comment.id.to_s
-    self.inc(:comments_count,1)
     comment
   end
 
@@ -35,9 +30,5 @@ module Mongoid::Commentable
     comments.select{|i| i.path =~ Regexp.new('^' + comments.find(comment_id).path)}
   end
 
-  def mark_comment_deleted(comment_id)
-    comments.find(comment_id).deleted = true
-    self.inc(:comments_count,-1)
-  end
-
 end
+

data/lib/mongoid_commentable.rb

@@ -1,6 +1,6 @@
+require 'comment'
 require File.join(File.dirname(__FILE__), 'mongoid/commentable')
-
-%w{ models controllers }.each do |dir|
+%w{ controllers }.each do |dir|
   path = File.join(File.dirname(__FILE__), '../app', dir)
   $LOAD_PATH << path
   ActiveSupport::Dependencies.autoload_paths << path

data/mongoid_commentable.gemspec

@@ -0,0 +1,82 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongoid_commentable}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Max Golovnia}]
+  s.date = %q{2011-05-09}
+  s.description = %q{Mongoid_commentable provides methods to create commentable documents}
+  s.email = %q{mgolovnia@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/comments_controller.rb",
+    "lib/comment.rb",
+    "lib/generators/mongoid_commentable/install_generator.rb",
+    "lib/generators/templates/models/comment.rb",
+    "lib/generators/templates/views/comments/_form.html.erb",
+    "lib/generators/templates/views/comments/edit.html.erb",
+    "lib/generators/templates/views/comments/index.html.erb",
+    "lib/generators/templates/views/comments/new.html.erb",
+    "lib/generators/templates/views/comments/show.html.erb",
+    "lib/mongoid/commentable.rb",
+    "lib/mongoid_commentable.rb",
+    "mongoid_commentable.gemspec",
+    "spec/models/comment.rb",
+    "spec/models/commentable_model.rb",
+    "spec/mongoid/commentable_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mgolovnia/mongoid_commentable}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.1}
+  s.summary = %q{Comments for Mongoid documents}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongoid>, ["~> 2.0"])
+      s.add_runtime_dependency(%q<bson_ext>, ["~> 1.3"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 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<mongoid>, ["~> 2.0"])
+      s.add_dependency(%q<bson_ext>, ["~> 1.3"])
+      s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, ["~> 2.0"])
+    s.add_dependency(%q<bson_ext>, ["~> 1.3"])
+    s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<database_cleaner>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/models/comment.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__),'..','..','lib','comment')
+class Comment
+  include Mongoid::Document
+  include Mongoid_Commentable::Comment
+  attr_accessible :text, :author
+  field :text, :type => String
+  field :author, :type => String
+end

data/spec/models/commentable_model.rb

@@ -0,0 +1,5 @@
+class CommentableModel
+  include Mongoid::Document
+  include Mongoid::Commentable
+end
+

data/spec/mongoid/commentable_spec.rb

@@ -1,53 +1,48 @@
 require 'spec_helper'
-class TestModel
-  include Mongoid::Document
-  include Mongoid::Commentable
-end
-describe 'Make commentable' do
-  
-   let(:test_model){TestModel.create!}
-  
-
-  it 'should be commentable' do
-    test_model.class.commentable?.should == true
-  end
-
-  it 'should allow to add a comment' do
-    comment = test_model.create_comment!(:author => 'Test author', :text => 'Hello, World!')
-    comment.author.should == 'Test author'
-    comment.text.should == 'Hello, World!'
-    comment.path.should == "root.#{comment.id.to_s}"
-    comment.deleted.should == false
-    test_model.comments_count == 1
-  end
-
-  it 'should allow to add a reply to a comment' do
-    comment = test_model.create_comment!(:author => 'Author', :text => 'Parent')
-    reply = test_model.create_comment!(:author => 'Author2', :text => 'Reply', :parent => comment.id.to_s)
-    test_model.comments.find(reply.id).path.should == "#{comment.path}.#{reply.id.to_s}"
-  end
 
-  it 'should mark comment as deleted' do
-    comment = test_model.create_comment!(:author => 'Author', :text => 'Parent')
-    test_model.comments_count == 1
-    test_model.mark_comment_deleted(comment.id)
-    test_model.comments.find(comment.id).deleted.should == true
-    test_model.comments_count == 0
-  end
-
-  it 'should return a branch of comments' do
-    parent1 = test_model.create_comment!(:author => 'Test author', :text => 'Parent1')
-    child1 = test_model.create_comment!(:author => 'Test author', :text => 'Child1', :parent => parent1.id.to_s)
-    child2 = test_model.create_comment!(:author => 'Test author', :text => 'Parent1', :parent => child1.id.to_s)
-    parent2 = test_model.create_comment!(:author => 'Test author', :text => 'Parent2')
-    branch = test_model.branch_for(parent1.id)
-    branch.should == [parent1,child1,child2]
-  end
-
-  it 'should return wrong argument error' do
-    expect{test_model.comments_list(:wrong_argument)}.to raise_error ArgumentError
+describe Mongoid::Commentable do
+  
+  describe Comment do
+   
+    context 'creating new comment' do 
+      subject {CommentableModel.new.create_comment!(:author => 'Author', :text => 'test') }
+      its(:class){should == Comment} 
+      its(:author){should == 'Author'} 
+      its(:text){should == 'test'}
+      specify{subject.path.should == "root.#{subject.id}"}
+   end
+
+    context 'replying to a comment' do
+      before do
+        @commentable_model = CommentableModel.new  
+        3.times{|i| @commentable_model.create_comment!(nil)}
+        @parent = @commentable_model.comments.first
+      end
+
+      subject{@child = @commentable_model.create_comment!(:parent => @parent.id.to_s)}
+      specify{subject.path.should == "root.#{@parent.id}.#{subject.id}"}
+    end
+
+    context 'marking comment as deleted' do
+      before do
+        @comment = CommentableModel.new.create_comment!(nil)
+        @comment.remove 
+      end
+      subject {@comment}
+      its(:deleted_at){should_not be_nil}
+      its(:deleted?){should be_true}
+    end
+
+    context 'getting branch' do
+      before do
+        @commentable_model = CommentableModel.new  
+        @comment1 = @commentable_model.create_comment!(nil)
+        @comment2 = @commentable_model.create_comment!(nil)
+        @child1 = @commentable_model.create_comment!(:parent => @comment1.id.to_s)
+        @child2 = @commentable_model.create_comment!(:parent => @child1.id.to_s)
+      end
+      subject{@commentable_model}
+      specify{subject.branch_for(@comment1.id).should == [@comment1,@child1,@child2]}
+    end
   end
-
-
-
 end

data/spec/spec_helper.rb

@@ -1,16 +1,19 @@
-
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.join(File.dirname(__FILE__),'..','lib'))
+$:.unshift(File.join(File.dirname(__FILE__),'models'))
 require 'mongoid'
 require 'rubygems'
 require 'bundler'
 require 'logger'
 require 'rspec'
+require 'rr'
 require 'database_cleaner'
 require 'mongoid_commentable'
+require 'models/comment'
+require 'models/commentable_model'
 
 
 RSpec.configure do |config|
-  config.mock_with :rspec
+  config.mock_with :rr
   config.before(:suite) do
     DatabaseCleaner.strategy = :truncation
     DatabaseCleaner.orm = "mongoid"

metadata

@@ -2,7 +2,7 @@
 name: mongoid_commentable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Max Golovnia
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-02 00:00:00 +03:00
-default_executable: 
+date: 2011-05-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mongoid
@@ -36,8 +35,19 @@ dependencies:
   prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: rr
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -45,10 +55,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: database_cleaner
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -56,10 +66,10 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -67,10 +77,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -78,10 +88,10 @@ dependencies:
         version: 1.6.0
   type: :development
   prerelease: false
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rcov
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -89,7 +99,7 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id007
+  version_requirements: *id008
 description: Mongoid_commentable provides methods to create commentable documents
 email: mgolovnia@gmail.com
 executables: []
@@ -100,8 +110,6 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files: 
-- .document
-- .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -109,18 +117,21 @@ files:
 - Rakefile
 - VERSION
 - app/controllers/comments_controller.rb
-- app/models/comment.rb
-- app/views/comments/_form.html.erb
-- app/views/comments/edit.html.erb
-- app/views/comments/index.html.erb
-- app/views/comments/new.html.erb
-- app/views/comments/show.html.erb
-- lib/generators/mongoid_commentable/views_generator.rb
+- lib/comment.rb
+- lib/generators/mongoid_commentable/install_generator.rb
+- lib/generators/templates/models/comment.rb
+- lib/generators/templates/views/comments/_form.html.erb
+- lib/generators/templates/views/comments/edit.html.erb
+- lib/generators/templates/views/comments/index.html.erb
+- lib/generators/templates/views/comments/new.html.erb
+- lib/generators/templates/views/comments/show.html.erb
 - lib/mongoid/commentable.rb
 - lib/mongoid_commentable.rb
+- mongoid_commentable.gemspec
+- spec/models/comment.rb
+- spec/models/commentable_model.rb
 - spec/mongoid/commentable_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/mgolovnia/mongoid_commentable
 licenses: 
 - MIT
@@ -134,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3250783174328786593
+      hash: 3455755614861241426
       segments: 
       - 0
       version: "0"
@@ -147,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.1
 signing_key: 
 specification_version: 3
 summary: Comments for Mongoid documents

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.rspec

@@ -1 +0,0 @@
---color

data/app/models/comment.rb

@@ -1,17 +0,0 @@
-class Comment
-  include Mongoid::Document
-  attr_accessible :text, :author, :path, :parent
-  field :text, :type => String
-  field :author, :type => String
-  field :path, :type => String, :default => ""
-  field :deleted, :type => Boolean, :default => false
-  field :parent, :type => String
-  embedded_in :commentable, :polymorphic => true
- 
-  def level
-    path.count('.')
-  end
-
-  
-
- end

data/lib/generators/mongoid_commentable/views_generator.rb

@@ -1,15 +0,0 @@
-require 'tmpdir'
-module Mongoid_Commentable
-  module Generators
-    class ViewsGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../../../app/views", __FILE__)
-      desc "Copies all mongoid_commentable views to your application."
-      argument :scope, :required => false, :default => nil,
-                       :desc => "The scope to copy views to"
-      def copy_views
-        directory "comments", "app/views/#{scope || :comments}"
-      end
-    end
-  end
-end
-