mm-commentable 1.0.0

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+
+
+group :development do
+
+  gem 'mongo', '1.1.2'
+  gem 'bson_ext', '1.1.2'
+  gem 'mongo_ext'
+  gem 'mongo_mapper'
+  gem 'i18n'
+  
+  gem 'log_buddy'
+  
+  gem 'ruby-debug'
+  gem "rspec", "~> 2.1.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,60 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.1)
+    bson (1.1.2)
+    bson_ext (1.1.2)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    i18n (0.4.2)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    jnunemaker-validatable (1.8.4)
+      activesupport (>= 2.3.4)
+    linecache (0.43)
+    log_buddy (0.5.0)
+    mongo (1.1.2)
+      bson (>= 1.1.1)
+    mongo_ext (0.19.3)
+    mongo_mapper (0.8.6)
+      activesupport (>= 2.3.4)
+      jnunemaker-validatable (~> 1.8.4)
+      plucky (~> 0.3.6)
+    plucky (0.3.6)
+      mongo (~> 1.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    yard (0.6.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext (= 1.1.2)
+  bundler (~> 1.0.0)
+  i18n
+  jeweler (~> 1.5.1)
+  log_buddy
+  mongo (= 1.1.2)
+  mongo_ext
+  mongo_mapper
+  rcov
+  rspec (~> 2.1.0)
+  ruby-debug
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Luke Cunningham
+
+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,19 @@
+= mm-acts_as_commentable
+
+Description goes here.
+
+== Contributing to mm-acts_as_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) 2010 Luke. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,43 @@
+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 = "mm-commentable"
+  gem.homepage = "http://github.com/icaruswings/mm-commentable"
+  gem.license = "MIT"
+  gem.summary = %Q{A very simple mongomapper plugin to make you models commentable}
+  gem.description = %Q{A very simple mongomapper plugin to make you models commentable}
+  gem.email = "luke@icaruswings.com"
+  gem.authors = ["Luke Cunningham"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+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 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/mm-commentable.rb

@@ -0,0 +1,3 @@
+require 'mongo_mapper'
+
+require File.join(File.dirname(__FILE__), 'mongo_mapper', 'plugins', 'commentable')

data/lib/mongo_mapper/plugins/commentable/comment.rb

@@ -0,0 +1,11 @@
+class Comment
+  include MongoMapper::EmbeddedDocument
+  
+  key :created_at, Time
+  key :body, String, :required => true
+
+  key :commentor_id, ObjectId
+  belongs_to :commentor, :class_name => 'User'
+
+  embedded_in :commentable
+end

data/lib/mongo_mapper/plugins/commentable.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), 'commentable', 'comment')
+
+module MongoMapper
+  module Plugins
+    module Commentable
+      
+      def self.configure(model)
+        model.class_eval do
+          key :comments_count, Integer, :default => 0
+          has_many :comments
+        
+          def commentable?; true; end
+        end
+      end
+      
+      module InstanceMethods
+
+        def add_comment!(comment_body, commentor)
+          
+          comment = self.comments.build({
+            :body => comment_body,
+            :commentor => commentor,
+            :created_at => Time.now
+          })
+          
+          return false unless comment.valid?
+          
+          self.increment('comments_count' => 1)
+          on_add_comment(comment)
+
+          true
+        end
+
+        def on_add_comment(comment)
+          raise NotImplementedError
+        end
+
+      end
+
+      module ClassMethods
+        
+      end
+    
+    end
+  end
+end

data/mm-commentable.gemspec

@@ -0,0 +1,93 @@
+# 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{mm-commentable}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Luke Cunningham"]
+  s.date = %q{2010-11-17}
+  s.description = %q{A very simple mongomapper plugin to make you models commentable}
+  s.email = %q{luke@icaruswings.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/mm-commentable.rb",
+    "lib/mongo_mapper/plugins/commentable.rb",
+    "lib/mongo_mapper/plugins/commentable/comment.rb",
+    "mm-commentable.gemspec",
+    "spec/mm-commentable_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/models.rb"
+  ]
+  s.homepage = %q{http://github.com/icaruswings/mm-commentable}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A very simple mongomapper plugin to make you models commentable}
+  s.test_files = [
+    "spec/mm-commentable_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/models.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<mongo>, ["= 1.1.2"])
+      s.add_development_dependency(%q<bson_ext>, ["= 1.1.2"])
+      s.add_development_dependency(%q<mongo_ext>, [">= 0"])
+      s.add_development_dependency(%q<mongo_mapper>, [">= 0"])
+      s.add_development_dependency(%q<i18n>, [">= 0"])
+      s.add_development_dependency(%q<log_buddy>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<mongo>, ["= 1.1.2"])
+      s.add_dependency(%q<bson_ext>, ["= 1.1.2"])
+      s.add_dependency(%q<mongo_ext>, [">= 0"])
+      s.add_dependency(%q<mongo_mapper>, [">= 0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<log_buddy>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mongo>, ["= 1.1.2"])
+    s.add_dependency(%q<bson_ext>, ["= 1.1.2"])
+    s.add_dependency(%q<mongo_ext>, [">= 0"])
+    s.add_dependency(%q<mongo_mapper>, [">= 0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<log_buddy>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/mm-commentable_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "MongoMapper::Plugins::ActsAsCommentable" do
+  
+  before(:each) do
+    @commentable = CommentableWithCallback.create()
+    @luke = User.create(:email => 'luke@icaruswings.com')
+  end
+
+  it "should be commentable" do
+    @commentable.should be_commentable
+  end
+
+  it "should have a comments_count attribute that defaults to 0" do
+     @commentable.comments_count.should equal 0
+  end
+
+  describe "add_vote!" do
+  
+    it "should increment the comments_count attribute" do
+      lambda {
+        @commentable.add_comment!("first comment", @luke)
+        @commentable.reload
+      }.should change(@commentable, :comments_count).by(1)    
+    end
+  
+    it "should add the comment" do
+      @commentable.add_comment!("first comment", @luke)
+      @commentable.comments.size.should equal 1
+    end
+    
+    it "should throw NotImplementedError if the :on_add_vote callback has not inplemented" do
+      commentable = CommentableWithoutCallback.new
+      lambda {
+        commentable.add_comment!(1, @luke)
+      }.should raise_error(NotImplementedError)
+    end
+    
+    it "should call :on_add_vote if the callback has been implemented" do
+      @commentable.should_receive(:on_add_comment)
+      @commentable.add_comment!(1, @luke)
+    end
+  
+  end
+  
+end
+
+describe "Comment" do
+  
+  before(:each) do
+    @comment = Comment.new
+  end
+  
+  it "should be embeddable?" do
+    Comment.embeddable?.should be_true
+  end
+  
+  it "should be embeddable?" do
+    Comment.embeddable?.should be_true
+  end
+  
+  it "should have a created_at key" do
+    @comment.should respond_to(:created_at=)
+    @comment.should respond_to(:created_at)
+  end
+  
+  it "should have a commentor association" do
+    @comment.should respond_to(:commentor_id=)
+    @comment.should respond_to(:commentor_id)
+    @comment.commentor.association.should be_belongs_to
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'fileutils'
+require 'ostruct'
+require 'log_buddy'
+
+require 'rspec'
+
+require 'mm-commentable'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+def Doc(name=nil, &block)
+  klass = Class.new do
+    include MongoMapper::Document
+    set_collection_name :test
+
+    if name
+      class_eval "def self.name; '#{name}' end"
+      class_eval "def self.to_s; '#{name}' end"
+    end
+  end
+
+  klass.class_eval(&block) if block_given?
+  klass.collection.remove
+  klass
+end
+
+def EDoc(name=nil, &block)
+  klass = Class.new do
+    include MongoMapper::EmbeddedDocument
+
+    if name
+      class_eval "def self.name; '#{name}' end"
+      class_eval "def self.to_s; '#{name}' end"
+    end
+  end
+
+  klass.class_eval(&block) if block_given?
+  klass
+end
+
+log_dir = File.expand_path('../../log', __FILE__)
+FileUtils.mkdir_p(log_dir) unless File.exist?(log_dir)
+
+logger = Logger.new(log_dir + '/test.log')
+LogBuddy.init(:logger => logger)
+
+MongoMapper.connection = Mongo::Connection.new('127.0.0.1', 27017, :logger => logger)
+MongoMapper.database = "mm-test-#{RUBY_VERSION.gsub('.', '-')}"
+MongoMapper.database.collections.each { |c| c.drop_indexes }
+
+
+RSpec.configure do |config|
+end

data/spec/support/models.rb

@@ -0,0 +1,18 @@
+class CommentableWithCallback
+  include MongoMapper::Document
+  plugin MongoMapper::Plugins::Commentable  
+  
+  def on_add_comment(comment)
+    true
+  end
+end
+
+class CommentableWithoutCallback
+  include MongoMapper::Document
+  plugin MongoMapper::Plugins::Commentable  
+end
+
+class User
+  include MongoMapper::Document
+  key :email, String
+end

metadata

@@ -0,0 +1,263 @@
+--- !ruby/object:Gem::Specification 
+name: mm-commentable
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Luke Cunningham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-17 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  name: mongo
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  name: bson_ext
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: mongo_ext
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: mongo_mapper
+  requirement: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: i18n
+  requirement: *id005
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: log_buddy
+  requirement: *id006
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: ruby-debug
+  requirement: *id007
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  name: rspec
+  requirement: *id008
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  requirement: *id009
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  requirement: *id010
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  name: jeweler
+  requirement: *id011
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  requirement: *id012
+  type: :development
+description: A very simple mongomapper plugin to make you models commentable
+email: luke@icaruswings.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mm-commentable.rb
+- lib/mongo_mapper/plugins/commentable.rb
+- lib/mongo_mapper/plugins/commentable/comment.rb
+- mm-commentable.gemspec
+- spec/mm-commentable_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+has_rdoc: true
+homepage: http://github.com/icaruswings/mm-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: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A very simple mongomapper plugin to make you models commentable
+test_files: 
+- spec/mm-commentable_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb