commenter_mongoid 0.1.0

data/Gemfile

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.1.0.rc1'
+gem 'rake', '0.8.7'
+
+gem 'bson_ext'
+gem 'mongoid', '2.0.2'
+gem 'devise'
+gem 'inherited_resources'
+
+group :development, :test do
+  gem 'jeweler'
+end
+

data/Gemfile.lock

@@ -0,0 +1,116 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.0.rc1)
+      actionpack (= 3.1.0.rc1)
+      mail (~> 2.3.0)
+    actionpack (3.1.0.rc1)
+      activemodel (= 3.1.0.rc1)
+      activesupport (= 3.1.0.rc1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6.0beta1)
+      rack (~> 1.3.0.beta2)
+      rack-cache (~> 1.0.1)
+      rack-mount (~> 0.8.1)
+      rack-test (~> 0.6.0)
+      sprockets (~> 2.0.0.beta.5)
+      tzinfo (~> 0.3.27)
+    activemodel (3.1.0.rc1)
+      activesupport (= 3.1.0.rc1)
+      bcrypt-ruby (~> 2.1.4)
+      builder (~> 3.0.0)
+      i18n (~> 0.6.0beta1)
+    activerecord (3.1.0.rc1)
+      activemodel (= 3.1.0.rc1)
+      activesupport (= 3.1.0.rc1)
+      arel (~> 2.1.1)
+      tzinfo (~> 0.3.27)
+    activeresource (3.1.0.rc1)
+      activemodel (= 3.1.0.rc1)
+      activesupport (= 3.1.0.rc1)
+    activesupport (3.1.0.rc1)
+      multi_json (~> 1.0)
+    arel (2.1.1)
+    bcrypt-ruby (2.1.4)
+    bson (1.3.1)
+    bson_ext (1.3.1)
+    builder (3.0.0)
+    devise (1.3.4)
+      bcrypt-ruby (~> 2.1.2)
+      orm_adapter (~> 0.0.3)
+      warden (~> 1.0.3)
+    erubis (2.7.0)
+    git (1.2.5)
+    has_scope (0.5.0)
+    hike (1.0.0)
+    i18n (0.6.0)
+    inherited_resources (1.2.2)
+      has_scope (~> 0.5.0)
+      responders (~> 0.6.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mongo (1.3.1)
+      bson (>= 1.3.1)
+    mongoid (2.0.2)
+      activemodel (~> 3.0)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+    multi_json (1.0.3)
+    orm_adapter (0.0.5)
+    polyglot (0.3.1)
+    rack (1.3.0)
+    rack-cache (1.0.2)
+      rack (>= 0.4)
+    rack-mount (0.8.1)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.0)
+      rack (>= 1.0)
+    rails (3.1.0.rc1)
+      actionmailer (= 3.1.0.rc1)
+      actionpack (= 3.1.0.rc1)
+      activerecord (= 3.1.0.rc1)
+      activeresource (= 3.1.0.rc1)
+      activesupport (= 3.1.0.rc1)
+      bundler (~> 1.0)
+      railties (= 3.1.0.rc1)
+    railties (3.1.0.rc1)
+      actionpack (= 3.1.0.rc1)
+      activesupport (= 3.1.0.rc1)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      thor (~> 0.14.6)
+    rake (0.8.7)
+    responders (0.6.4)
+    sprockets (2.0.0.beta.8)
+      hike (~> 1.0)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    thor (0.14.6)
+    tilt (1.3.1)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.27)
+    warden (1.0.4)
+      rack (>= 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext
+  devise
+  inherited_resources
+  jeweler
+  mongoid (= 2.0.2)
+  rails (= 3.1.0.rc1)
+  rake (= 0.8.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tyler Gannon
+
+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,27 @@
+= commenter
+
+Adds basic commentability to any model.
+
+== Installation
+
+* Add to the Gemfile:
+  gem 'commenter'
+
+* Add a call to the helper into the view for your model:
+  = commentable :resource => @my_resource
+
+== Contributing to commenter
+ 
+* 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 Tyler Gannon. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+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 is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "commenter_mongoid"
+  gem.homepage = "http://github.com/tylergannon/commenter_mongoid"
+  gem.license = "MIT"
+  gem.summary = %Q{A very simple rails comment engine designed for mongoid.}
+  gem.description = %Q{
+    Handles adding comments to models in a very simple way.
+  }
+  gem.email = "tgannon@gmail.com"
+  gem.authors = ["Tyler Gannon"]
+  gem.files = Dir["{app}/**/*", "{lib}/**/*", "{vendor}/**/*", "Gemfile*",
+              "config.ru", "Rakefile", "README.rdoc", "commenter_mongoid.gemspec"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "commenter_mongoid #{version}"
+  rdoc.rdoc_files.include('README*', 'LICENSE.txt', 'Gemfile*', 'Rakefile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('app/**/*.rb')
+end
+

data/app/controllers/comments_controller.rb

@@ -0,0 +1,59 @@
+class CommentsController < ApplicationController
+  respond_to :html, :js, :json, :xml, :except => [:index, :show, :edit]
+  before_filter :new_comment, :only => [:create]
+  before_filter :load_comment, :only => [:update, :destroy]
+  authorize_resource :comment, :only => [:create, :update, :destroy]
+  
+  helper_method :container_id
+
+  def create
+    @comment.user_id = current_user.id
+    @comment.date_created = DateTime.now
+    if @comment.save
+      respond_with @comment do |format|
+        format.html { redirect_to resource }
+      end
+    end
+  end
+  
+  def destroy
+    @comment.destroy
+    respond_with @comment do |format|
+      format.html { redirect_to resource }
+    end
+  end
+  
+  def resource
+    @resource ||= @comment.resource
+  end
+  
+  protected
+  def new_comment
+    @comment = Comment.new params[:comment]
+  end
+  def load_comment
+    @comment = Comment.find params[:id]
+  end
+  
+  def resource_class
+    @resource_class ||= params[:resource_class].camelize.constantize unless params[:resource_class].blank?
+  end
+  
+  def resource_id
+    @resource_id ||= params[:resource_id] unless params[:resource_id].blank?
+  end
+  def container_id
+    @container_id ||= lambda{
+      resource_type = self.class.to_s.underscore.split('_')[0].singularize
+      if params[:container_id]
+        params[:container_id]
+      elsif params[:id]
+        "#{resource_type}_#{params[:id]}"
+      else
+        raise "I don't know"
+      end
+    }.call
+  end
+  
+  
+end

data/app/models/comment.rb

@@ -0,0 +1,24 @@
+class Comment
+  include Mongoid::Document
+  belongs_to :user
+  field :text, :type => String
+  field :resource_class, :type => String
+  field :resource_id, :type => String
+  field :date_created, :type => DateTime
+  
+  validates :text, :presence => true
+  validates :resource_class, :presence => true
+  validates :resource_id, :presence => true
+  validates :date_created, :presence => true
+  
+  default_scope order_by([:date_created, :asc])
+  
+  scope :find_by_resource_class_and_id, lambda{|resource_class, resource_id|
+    where(:resource_id => resource_id,
+          :resource_class => resource_class.to_s)
+  }
+  
+  def resource
+    @resource ||= self.resource_class.camelize.constantize.find(self.resource_id) unless resource_class.blank? or resource_id.blank?
+  end
+end

data/app/views/comments/_index.html.haml

@@ -0,0 +1,6 @@
+%div[resource, :comments]
+  - for comment in comments
+    = render :partial => 'comments/show', :locals => {:comment => comment}
+  - if can? :create, new_comment
+    = render :partial => 'comments/new', :locals => {:new_comment => new_comment}
+

data/app/views/comments/_new.html.haml

@@ -0,0 +1,8 @@
+%div[new_comment]
+  = form_for new_comment, :remote => true do |f|
+    = hidden_field_tag :container_id, "comment_#{new_comment.id}"
+    = f.text_area :text
+    = f.hidden_field :resource_class
+    = f.hidden_field :resource_id
+    = f.submit 'Add comment'
+

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

@@ -0,0 +1,6 @@
+%div[comment]
+  .comment_header By #{comment.user.email} on #{comment.date_created}
+  .comment_text= comment.text.html_safe
+  - if can? :destroy, comment
+    = link_to 'Delete', comment, :confirm => 'Are you sure?', :method => :delete, :remote => true
+

data/app/views/comments/create.js.erb

@@ -0,0 +1,2 @@
+$('#<%= container_id %>').before('<%= raw escape_javascript(render(:partial=>'show', :locals => {:comment=>@comment})) %>');
+

data/app/views/comments/destroy.js.erb

@@ -0,0 +1,2 @@
+$('#<%= container_id %>').remove();
+

data/lib/commenter.rb

@@ -0,0 +1,17 @@
+require 'commenter/commentable'
+require 'commenter/controller_extensions'
+require 'commenter/helpers'
+
+module Commenter
+  class Engine < ::Rails::Engine
+    initializer 'commenter' do |app|
+      unless defined? ::Mongoid
+        raise "I only work with Mongoid."
+      end
+
+      ApplicationController.send :helper,  Commenter::Helpers
+      ApplicationController.send :include, Commenter::ControllerExtensions      
+      CommentsController.send :include, Commenter::ControllerExtensions      
+    end
+  end
+end

data/lib/commenter/commentable.rb

@@ -0,0 +1,12 @@
+module Commenter
+  module Commentable
+    extend ActiveSupport::Concern
+    
+    module InstanceMethods
+      def commentable(params={})
+        resource = params[:resource]
+        
+      end
+    end
+  end
+end

data/lib/commenter/controller_extensions.rb

@@ -0,0 +1,40 @@
+module Commenter
+  module ControllerExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :container_id
+      alias_method_chain :render, :responses
+    end
+    
+    module ClassMethods
+      def js_responses params={}
+        @js_responses = params
+        puts "Laggerbagger \n|\n|\n|\n|\n|\n|\n|\n|\n|\n|\n|\n|"
+      end
+    end
+    
+    module InstanceMethods
+      def container_id
+        @container_id ||= lambda{
+          resource_type = self.class.to_s.underscore.split('_')[0].singularize
+          if params[:container_id]
+            params[:container_id]
+          elsif params[:id]
+            "#{resource_type}_#{params[:id]}"
+          else
+            raise "I don't know"
+          end
+        }.call
+      end
+      
+      def render_with_responses params={}
+        if params.blank? and params[:format] == :js and @js_responses
+          params[:layout] ||= "responses/#{params[:action]}"
+          puts "Juggerbugger \n$\n$\n$\n$\n$\n$\n$\n$\n$\n$\n$"
+        end
+        render_without_responses params
+      end
+    end
+  end
+end

data/lib/commenter/helpers.rb

@@ -0,0 +1,21 @@
+module Commenter
+  module Helpers
+    def commentable(params={})
+      if res=params[:resource]
+        id = res.id
+        klass = res.class.to_s
+      else
+        raise "invalid parameters"
+      end
+      comments = Comment.where(:resource_class => klass, :resource_id => id)
+      new_comment = Comment.new(:resource_class => klass, :resource_id => id)
+      locals = {:comments => comments, 
+                :new_comment => new_comment, 
+                :resource => res}
+      html = render(:partial => 'comments/index', :locals => locals)
+      html.html_safe
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification 
+name: commenter_mongoid
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tyler Gannon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-07 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 3.1.0.rc1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: devise
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: inherited_resources
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: "\n    Handles adding comments to models in a very simple way.\n  "
+email: tgannon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- app/controllers/comments_controller.rb
+- app/models/comment.rb
+- app/views/comments/_index.html.haml
+- app/views/comments/_new.html.haml
+- app/views/comments/_show.html.haml
+- app/views/comments/create.js.erb
+- app/views/comments/destroy.js.erb
+- lib/commenter.rb
+- lib/commenter/commentable.rb
+- lib/commenter/controller_extensions.rb
+- lib/commenter/helpers.rb
+- LICENSE.txt
+has_rdoc: true
+homepage: http://github.com/tylergannon/commenter_mongoid
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      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: A very simple rails comment engine designed for mongoid.
+test_files: []
+