mongoid_voteable 0.1.0

data/README.rdoc

@@ -0,0 +1,48 @@
+= Mongoid::Voteable
+
+Dead simple voting functionality for Mongoid models
+
+== Installation
+
+Add to Gemfile:
+  
+    gem 'mongoid_voteable'
+
+== Getting Started
+
+Include the module in models where you want it:
+
+    class Post
+      include Mongoid::Document
+      include Mongoid::Voteable
+      ...
+    end
+
+== Cast Votes
+
+You can vote by passing an integer and a voter model to the "vote" method:
+
+    @post = Post.first
+    @user = User.where(:name => 'Bill') # or more likely, current_user
+    
+    @post.vote 1, @user     # I like this!
+    @post.vote -1, @user    # I don't like this!
+
+Votes don't have to be up or down, they can include emphasis:
+
+    @post.vote 5, @user     # I LOVE this!
+    @post.vote -10, @user   # Delete it from the Interwebs
+
+== Additional Functionality
+
+You'll often want to know if a user can vote.  Simple:
+
+    @post.voted? @user      # True if they've voted
+
+You can also get a tally of the number of votes cast:
+
+    @post.vote_count        # Just one so far!
+
+You can get the average vote:
+
+    @post.vote_average      # votes / voters.count

data/lib/mongoid/voteable.rb

@@ -0,0 +1,44 @@
+module Mongoid
+  module Voteable
+
+    VERSION = "0.1.0"
+
+    extend ActiveSupport::Concern
+
+    included do
+      field :votes, :type => Integer, :default => 0
+      field :voters, :type => Array, :default => []
+    end
+
+    module InstanceMethods
+
+      def vote(num, voter)
+
+        unless voted? voter
+          self.votes += num.to_i
+          self.voters << voter._id
+          collection.update(  { "_id" => _id, "voters" => { "$ne" => voter._id } },
+                              { "$inc" => { "votes" => num.to_i }, "$push" => { "voters" => voter._id } } )
+        end
+
+      end
+
+      def voted?(voter)
+        voters.include? voter._id
+      end
+
+      def vote_count
+        voters.count
+      end
+
+      def vote_average
+        if voters.blank?
+          nil
+        else
+          votes.to_f / voters.count
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_voteable
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jason Coene
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-08 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196419
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 16
+        version: 2.0.0.beta.16
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7712042
+        segments: 
+        - 3
+        - 0
+        - 0
+        - rc
+        version: 3.0.0.rc
+  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 
+        hash: 31
+        segments: 
+        - 1
+        - 0
+        - 4
+        version: 1.0.4
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196421
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 19
+        version: 2.0.0.beta.19
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :development
+  version_requirements: *id005
+description: Provides fields and methods for the manipulation of votes on a Mongoid model.
+email: jcoene@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mongoid/voteable.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/jcoene/mongoid_voteable
+licenses: []
+
+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: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Voting functionality for Mongoid models
+test_files: []
+