mm-voteable 1.0.0 → 1.1.0

data/Gemfile

@@ -1,14 +1,10 @@
 source "http://rubygems.org"
 
 group :development do
-  gem 'mongo', '1.1.2'
-  gem 'bson_ext', '1.1.2'
-  gem 'mongo_ext'
+  gem 'bson_ext'
   gem 'mongo_mapper'
   gem 'i18n'
   
-  gem 'log_buddy'
-  
   gem 'ruby-debug'
   gem "rspec", "~> 2.1.0"
   gem "yard", "~> 0.6.0"

data/Gemfile.lock

@@ -1,24 +1,22 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.0.1)
-    bson (1.1.2)
-    bson_ext (1.1.2)
+    activesupport (3.0.4)
+    bson (1.2.4)
+    bson_ext (1.2.4)
     columnize (0.3.2)
     diff-lcs (1.1.2)
     git (1.2.5)
-    i18n (0.4.2)
-    jeweler (1.5.1)
+    i18n (0.5.0)
+    jeweler (1.5.2)
       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 (1.2.4)
+      bson (>= 1.2.4)
     mongo_mapper (0.8.6)
       activesupport (>= 2.3.4)
       jnunemaker-validatable (~> 1.8.4)
@@ -40,19 +38,16 @@ GEM
       ruby-debug-base (~> 0.10.4.0)
     ruby-debug-base (0.10.4)
       linecache (>= 0.3)
-    yard (0.6.2)
+    yard (0.6.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bson_ext (= 1.1.2)
+  bson_ext
   bundler (~> 1.0.0)
   i18n
   jeweler (~> 1.5.1)
-  log_buddy
-  mongo (= 1.1.2)
-  mongo_ext
   mongo_mapper
   rcov
   rspec (~> 2.1.0)

data/README.rdoc

@@ -1,6 +1,6 @@
 = mm-voteable
 
-A very simple mongomapper plugin to add vote up/down functionality to your application.
+A very simple mongomapper plugin to add vote up/down superpowers to your models.
 
 
 == Usage
@@ -20,12 +20,13 @@ Then add the voteable plugin to you MongoMapper::Document
       include MongoMapper::Document
       plugin MongoMapper::Plugins::Voteable
 
-      def on_add_vote(comment)
-        do something when a comment is added...
+      def on_add_vote(vote)
+        do something when a vote is added...
       end
     end
     
-You must implement the on_add_comment callback! - however it can be an empty implementation
+You must implement the on_add_vote callback! -
+It can be an empty implementation, but I use it to create ActivityStream Items after someone votes on a NewsArticle
   
     @post = Post.create
     @voter = User.create
@@ -37,9 +38,18 @@ You must implement the on_add_comment callback! - however it can be an empty imp
     @posts.votes #=> [<Vote>]
     @posts.voters #=> [<User>]
     @posts.voters.include?(@voter) #=> true
+    
+
+== Limitations
+
+I made this plugin for voting up and down on articles (kind of like stack overflow) so there are currently some limitations
+
+* the vote value can only be one of 1 or -1
+* the voteable model has a 'user' belongs_to association
+* a user can only vote once on a voteable item
+* the owner of a voteable item, cannot vote
 
-== Assumptions
-  * your voteable model has a 'user' association
+Feel free to code any of these limitations out and send me a patch, this is just how I have used it so far
 
 
 == Contributing to mm-voteable

data/Rakefile

@@ -15,8 +15,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "mm-voteable"
   gem.homepage = "http://github.com/icaruswings/mm-voteable"
   gem.license = "MIT"
-  gem.summary = %Q{A very simple mongomapper plugin to add vote up/down functionality to your application}
-  gem.description = %Q{A very simple mongomapper plugin to add vote up/down functionality to your application}
+  gem.summary = %Q{A very simple mongomapper plugin to add vote up/down superpowers to your models}
+  gem.description = %Q{A very simple mongomapper plugin to add vote up/down superpowers to your models}
   gem.email = "luke@icaruswings.com"
   gem.authors = ["Luke Cunningham"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/mongo_mapper/plugins/voteable/vote.rb

@@ -4,14 +4,12 @@ class Vote
   key :voter_id, ObjectId, :required => true
   belongs_to :voter, :class_name => 'User'
 
-  key :value, Integer, :required => true
+  key :value, Integer, :required => true, :in => [1,-1]
 
   key :voteable_id, ObjectId, :required => true
   key :voteable_type, String, :required => true
   belongs_to :voteable, :polymorphic => true
 
-  validates_inclusion_of :value, :within => [1,-1]
-
   validate :should_be_unique
   validate :should_not_be_owner
 

data/mm-voteable.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mm-voteable}
-  s.version = "1.0.0"
+  s.version = "1.1.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-18}
-  s.description = %q{A very simple mongomapper plugin to add vote up/down functionality to your application}
+  s.date = %q{2011-02-26}
+  s.description = %q{A very simple mongomapper plugin to add vote up/down superpowers to your models}
   s.email = %q{luke@icaruswings.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{A very simple mongomapper plugin to add vote up/down functionality to your application}
+  s.summary = %q{A very simple mongomapper plugin to add vote up/down superpowers to your models}
   s.test_files = [
     "spec/mm-voteable_spec.rb",
     "spec/spec_helper.rb",
@@ -49,12 +49,9 @@ Gem::Specification.new do |s|
     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<bson_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"])
@@ -62,12 +59,9 @@ Gem::Specification.new do |s|
       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<bson_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"])
@@ -76,12 +70,9 @@ Gem::Specification.new do |s|
       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<bson_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"])

data/spec/mm-voteable_spec.rb

@@ -17,14 +17,20 @@ describe "Vote" do
     @vote.should be_valid
   end
   
-  it "should be valid if already voted" do
-    voteable = VoteableWithCallback.create(:user_id => @user.id)
-    vote = voteable.votes.build(:value => 1, :voter => @user)
+  it "should not be valid if already voted" do
+    @vote.save
+    vote = @voteable.votes.build(:value => 1, :voter => @user)
     
     vote.should_not be_valid
   end
   
-  it "should be valid if voteable owner" do
+  it "should not be valid value is not one of 1 or -1" do
+    @vote.value = 3
+
+    @vote.should_not be_valid
+  end
+  
+  it "should not be valid if voteable owner" do
     voteable = VoteableWithCallback.create(:user_id => @user.id)
     vote = voteable.votes.build(:value => 1, :voter => @user)
     

data/spec/spec_helper.rb

@@ -4,10 +4,6 @@ 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-voteable'
@@ -16,25 +12,9 @@ require 'mm-voteable'
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
-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.connection = Mongo::Connection.new('127.0.0.1', 27017)
 MongoMapper.database = "mm-test-#{RUBY_VERSION.gsub('.', '-')}"
 MongoMapper.database.collections.each { |c| c.drop_indexes }
 
-
 RSpec.configure do |config|
-  
-  config.after(:each) do
-    MongoMapper.database.collections.collect do |collection|
-      unless %w(system.js system.indexes system.users).any? { |name| name == collection.name }
-        MongoMapper.database.drop_collection(collection.name)
-      end
-    end
-  end
-  
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mm-voteable
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Luke Cunningham
@@ -15,44 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-18 00:00:00 +11:00
+date: 2011-02-26 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: 
     - - ">="
@@ -61,12 +29,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: mongo_ext
-  requirement: *id003
+  name: bson_ext
+  requirement: *id001
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -76,11 +44,11 @@ dependencies:
         - 0
         version: "0"
   name: mongo_mapper
-  requirement: *id004
+  requirement: *id002
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,25 +58,11 @@ dependencies:
         - 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
+  requirement: *id003
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -118,11 +72,11 @@ dependencies:
         - 0
         version: "0"
   name: ruby-debug
-  requirement: *id007
+  requirement: *id004
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -134,11 +88,11 @@ dependencies:
         - 0
         version: 2.1.0
   name: rspec
-  requirement: *id008
+  requirement: *id005
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -150,11 +104,11 @@ dependencies:
         - 0
         version: 0.6.0
   name: yard
-  requirement: *id009
+  requirement: *id006
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -166,11 +120,11 @@ dependencies:
         - 0
         version: 1.0.0
   name: bundler
-  requirement: *id010
+  requirement: *id007
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -182,11 +136,11 @@ dependencies:
         - 1
         version: 1.5.1
   name: jeweler
-  requirement: *id011
+  requirement: *id008
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id012 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -196,9 +150,9 @@ dependencies:
         - 0
         version: "0"
   name: rcov
-  requirement: *id012
+  requirement: *id009
   type: :development
-description: A very simple mongomapper plugin to add vote up/down functionality to your application
+description: A very simple mongomapper plugin to add vote up/down superpowers to your models
 email: luke@icaruswings.com
 executables: []
 
@@ -256,7 +210,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A very simple mongomapper plugin to add vote up/down functionality to your application
+summary: A very simple mongomapper plugin to add vote up/down superpowers to your models
 test_files: 
 - spec/mm-voteable_spec.rb
 - spec/spec_helper.rb