mongoid_commentable 0.0.1

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "mongoid", "~> 2.0"
+gem "bson_ext", "~> 1.3"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "database_cleaner"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.7)
+    bson (1.3.0)
+    bson_ext (1.3.0)
+    builder (2.1.2)
+    database_cleaner (0.6.6)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mongo (1.3.0)
+      bson (>= 1.3.0)
+    mongoid (2.0.1)
+      activemodel (~> 3.0)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    tzinfo (0.3.27)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext (~> 1.3)
+  bundler (~> 1.0.0)
+  database_cleaner
+  jeweler (~> 1.6.0)
+  mongoid (~> 2.0)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Max Golovnia
+
+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,70 @@
+= mongoid_commentable
+
+Mongoid_commentable provides methods to create commentable documents
+
+== Installation
+You can use latest gem:
+  gem install mongoid_commentable
+
+or in Gemfile:
+  gem 'mongoid_commentable'
+
+== Usage
+To make model commentable you need to include Mongoid::Commentable into your document:
+  class Article
+    include Mongoid::Document
+    include Mongoid::Commentable
+    
+    field author
+    field content
+  end
+
+Then you need to set up a nested resource in your routes.rb:
+  resources :articles do
+    resources :comments
+  end
+
+And in your view file:
+  <%= link_to "Leave a comment", new_article_comment_path(:article_id => @article.id.to_s) %>
+
+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
+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:
+  index [['comments', MONGO::DESCENDING]]
+
+To get branch for a comment, use following method:
+  @article.branch_for(parent_comment_id)
+it will return whole branch with all childrens for a certain comment
+
+To get comment level, use following method: 
+  comment.level
+
+To mark comment as deleted, use following method:
+  @article.mark_comment_deleted(comment_id)
+
+To get comments count, use:
+  @article.comments_count
+
+== Contributing to mongoid_commentable
+ 
+* 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
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* 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
+
+Copyright (c) 2011 Max Golovnia. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "mongoid_commentable"
+  gem.homepage = "http://github.com/mgolovnia/mongoid_commentable"
+  gem.license = "MIT"
+  gem.summary = %Q{Comments for Mongoid documents}
+  gem.description = %Q{Mongoid_commentable provides methods to create commentable documents}
+  gem.email = "mgolovnia@gmail.com"
+  gem.authors = ["Max Golovnia"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongoid_commentable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/controllers/comments_controller.rb

@@ -0,0 +1,76 @@
+class CommentsController < ActionController::Base
+  
+  prepend_before_filter :get_model
+  before_filter :get_comment, :only => [:show, :edit, :update]
+
+  respond_to :html
+  
+  def index
+    @comments = @model.comments
+    respond_with([@model,@comments])
+  end
+
+  def show
+    respond_with([@model,@comment])
+  end
+
+  def new
+    respond_with([@model,@comment = Comment.new(:parent => params[:parent])])
+  end
+
+  def edit
+    respond_with([@model,@comment])
+  end
+
+  def create
+    @comment = @model.create_comment!(params[:comment])
+    if @comment.save
+      flash[:notice] = 'Comment was successfully created.'
+    else
+      flash[:error] = 'Comment wasn\'t created.'
+    end
+    respond_with(@model)
+  end
+
+  def update
+    if @comment.update_attributes(params[:comment])
+      flash[:notice] = 'Comment was successfully updated.'
+    else
+      flash[:error] = 'Comment wasn\'t deleted.'
+    end
+    respond_with([@model,@comment], :location => @model)
+  end
+
+  def destroy
+    @model.mark_deleted(params[:comment])
+    respond_with(@model)
+  end
+
+  private
+  
+  def classname
+     params.each do |name, value|
+      if name =~ /(.+)_id$/
+        return $1.classify.constantize
+      end
+    end
+  end
+
+  def model_id
+    params.each do |name, value|
+      if name =~ /.+_id$/
+        return name
+      end
+    end  
+    nil
+  end
+
+  def get_model
+    @model = classname.find(params[model_id.to_sym])
+  end
+  
+  def get_comment
+    @comment = @model.comments.find(params[:id])
+  end
+
+end

data/app/models/comment.rb

@@ -0,0 +1,17 @@
+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/app/views/comments/_form.html.erb

@@ -0,0 +1,27 @@
+<p>Leave a comment</p>
+<%= form_for [model,comment] do |f| %>
+  <% if model.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(model.errors.count, "error") %> prohibited this comment from being saved:</h2>
+      <ul>
+      <% model.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+  <% if comment.parent %>
+    <%= f.hidden_field :parent, :value => comment.parent %>
+  <% end %>
+  <div class="field">
+    <%= f.label :author %><br />
+    <%= f.text_field :author %>
+  </div>
+   <div class="field">
+    <%= f.label :text %><br />
+    <%= f.text_area :text %>
+  </div>
+<div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

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

@@ -0,0 +1,3 @@
+<h1>Update Comment</h1>
+
+<%= render :partial => 'form', :locals => {:model => @model,:comment => @comment} %>

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

@@ -0,0 +1,9 @@
+<% @model.comments_list.each do |comment| %>
+  <p>
+  <% if comment.deleted %>
+  <strong>DELETED</strong>
+<% end %>
+  <%= comment.text%>
+  </p>
+<% end %>
+

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

@@ -0,0 +1 @@
+<%= render :partial => 'form', :locals => {:model => @model, :comment => @comment}%>

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

@@ -0,0 +1,6 @@
+<p>
+  <%=@comment.author%>
+</p>
+<p>
+  <%=@comment.text%>
+</p>

data/lib/generators/mongoid_commentable/views_generator.rb

@@ -0,0 +1,15 @@
+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
+

data/lib/mongoid/commentable.rb

@@ -0,0 +1,43 @@
+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
+
+  def comments_list(sort=:asc)
+    if Comment.respond_to?(sort)
+      comments.send(sort,:path)
+    else
+      raise ArgumentError, "Wrong argument!"
+    end
+  end
+
+  def branch_for(comment_id)
+    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

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

data/spec/mongoid/commentable_spec.rb

@@ -0,0 +1,53 @@
+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
+  end
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'mongoid'
+require 'rubygems'
+require 'bundler'
+require 'logger'
+require 'rspec'
+require 'database_cleaner'
+require 'mongoid_commentable'
+
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.orm = "mongoid"
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db("mongoid_commentable_test")
+end
+

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_commentable
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Max Golovnia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-02 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+description: Mongoid_commentable provides methods to create commentable documents
+email: mgolovnia@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- 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/mongoid/commentable.rb
+- lib/mongoid_commentable.rb
+- spec/mongoid/commentable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mgolovnia/mongoid_commentable
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3250783174328786593
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Comments for Mongoid documents
+test_files: []
+