voterable 0.0.3.0001 → 0.0.4

data/.gitignore

@@ -5,3 +5,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+doc/*

data/README.md

@@ -0,0 +1,35 @@
+Voterable
+=========
+
+About
+-----
+
+This is a mongoid dependant gem that adds voteable charactistics to voteable things and the voters that can vote on these things.
+
+It's my first gem, and quite honestly it's probably not the right way to do things, but it's working great for me, so knock yourself out if you need something more robust than voteable_mongo.
+
+Dependencies
+------------
+
+- Mongoid (2.3.0+)
+
+Useage
+======
+
+To add a class that can vote on something (in this case a User), subclass your user from Voterable::Voter
+
+    class User < Voterable::Voter
+    ...
+    end
+
+To add a class that can be voted on (in this case a thing), subclass the thing from Voterable::Voteable
+
+    class Thing < Voterable::Voteable
+    ...
+    end
+
+
+Because I'm pretty much assuming that the only person that is using this is me, for now, you can look through the source to figure out how things work. If you want me to do a better job documenting stuff, email me and I'll start working on it
+
+-Tata for now
+-Ben

data/Rakefile

@@ -8,12 +8,12 @@ end
 
 task :default => :spec
 
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-   require 'voterable/version'
-   rdoc.rdoc_dir = 'rdoc'
-   rdoc.title = "Voterable #{Voterable::VERSION}"
-   rdoc.rdoc_files.include("README*")
-   rdoc.rdoc_files.include("CHANGELOG*")
-   rdoc.rdoc_files.include("lib/**/*.rb")
-end
+# require 'rdoc/task'
+# RDoc::Task.new do |rdoc|
+#    require 'voterable/version'
+#    rdoc.rdoc_dir = 'rdoc'
+#    rdoc.title = "Voterable #{Voterable::VERSION}"
+#    rdoc.rdoc_files.include("README*")
+#    rdoc.rdoc_files.include("CHANGELOG*")
+#    rdoc.rdoc_files.include("lib/**/*.rb")
+# end

data/lib/voterable/functions.rb

@@ -1,4 +1,9 @@
+##
+# The TimeConversions module adds methods to number varibles to translate 
+# Between different types of time (seconds, days, ect)
 module TimeConversion
+
+   #Converts self from days into seconds
    def days_in_seconds
       self*86400
    end

data/lib/voterable/tally.rb

@@ -1,4 +1,7 @@
 module Voterable
+   ##
+   # Tally class represents a count of votes
+   # a tally is embeded in a voteable object
    class Tally
       include Mongoid::Document
 

data/lib/voterable/version.rb

@@ -1,3 +1,3 @@
-module Voterable
-  VERSION = "0.0.3.0001"
+module Voterable # :nodoc:
+  VERSION = "0.0.4"
 end

data/lib/voterable/vote.rb

@@ -1,4 +1,15 @@
 module Voterable
+   ##
+   # A vote object represents a vote made on a voteable object by a voter
+   # 
+   # Example:
+   # == Vote.vote = :up
+   # => :up
+   # == Vote.vote
+   # => :up
+   # 
+   # A vote belongs_to both a Voterable::Voter and a Voterable::Voteable
+   #
    class Vote
       include Mongoid::Document
       include Mongoid::Timestamps

data/lib/voterable/voteable.rb

@@ -1,9 +1,15 @@
 
 require "voterable/functions"
-# require 'kaminari'
 
 # DUDE! Remember you need to restart the sever to get this file to reload!
 module Voterable
+
+   ##
+   # A Voteable is any object that can be voted on, Voteables can be voted
+   # up or down, Voteables keep track of the votes in either direction
+   #
+   # Voteables has_many votes, Voteables can belong_to one voter. It is up
+   # to the outsied program to assign voteables to voters
    class Voteable
 
       include Mongoid::Document

data/lib/voterable.rb

@@ -1,3 +1,8 @@
+# ----------------------------------------
+# :section: Voterable
+# Voterable source code is on github at https://github.com/bguest/Voterable
+# ----------------------------------------
+
 require "mongoid"
 
 require "voterable/version"

data/spec/factories.rb

@@ -1,20 +1,20 @@
 #-- Voterable 
 require 'voterable'
 
-class Voteable < Voterable::Voteable
+class Voteable < Voterable::Voteable # :nodoc:
 
    voteable self, :up => +5, :down => -2 #, :index => true
    voteback self, :up => +1, :down => -2
 end
 
-class Voter < Voterable::Voter
+class Voter < Voterable::Voter # :nodoc:
 
 end
 
-class Vote < Voterable::Vote
+class Vote < Voterable::Vote # :nodoc:
 end
 
-FactoryGirl.define do
+FactoryGirl.define do # :nodoc: all
 
    factory :voter do
    end

data/spec/spec_helper.rb

@@ -14,14 +14,14 @@ require 'factory_girl'
 FactoryGirl.find_definitions
 
 #Setup Mongoid Database
-Mongoid.configure do |config|
+Mongoid.configure do |config| # :nodoc: all
    name = 'voterable_test'
    host = 'localhost'
    config.master = Mongo::Connection.new.db(name)
    config.autocreate_indexes = true
 end
 
-RSpec.configure do |config|
+RSpec.configure do |config| # :nodoc: all
    # == Mock Framework
    # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
    config.mock_with :rspec

data/spec/voteable_spec.rb

@@ -1,7 +1,7 @@
 
 require 'spec_helper'
 
-describe Voterable::Voteable do
+describe Voterable::Voteable do #:nodoc: all
 
 
    context "when voteables are present" do 

data/spec/voting_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "Voting" do
+describe "Voting" do # :nodoc: all
 
    before(:each) do
       @voteable = Factory.create(:voteable)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voterable
 version: !ruby/object:Gem::Version
-  version: 0.0.3.0001
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-07 00:00:00.000000000Z
+date: 2011-12-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70220984898000 !ruby/object:Gem::Requirement
+  requirement: &70274674400260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70220984898000
+  version_requirements: *70274674400260
 - !ruby/object:Gem::Dependency
   name: bson
-  requirement: &70220984897440 !ruby/object:Gem::Requirement
+  requirement: &70274674399620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70220984897440
+  version_requirements: *70274674399620
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70220984896940 !ruby/object:Gem::Requirement
+  requirement: &70274674399020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,10 +43,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70220984896940
+  version_requirements: *70274674399020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70220984896560 !ruby/object:Gem::Requirement
+  requirement: &70274674398520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70220984896560
+  version_requirements: *70274674398520
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &70220984896000 !ruby/object:Gem::Requirement
+  requirement: &70274674397840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *70220984896000
+  version_requirements: *70274674397840
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70220984895540 !ruby/object:Gem::Requirement
+  requirement: &70274674397300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70220984895540
+  version_requirements: *70274674397300
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70220984895080 !ruby/object:Gem::Requirement
+  requirement: &70274674396640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70220984895080
+  version_requirements: *70274674396640
 - !ruby/object:Gem::Dependency
   name: guard-spork
-  requirement: &70220984894600 !ruby/object:Gem::Requirement
+  requirement: &70274674396020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70220984894600
+  version_requirements: *70274674396020
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &70220984894120 !ruby/object:Gem::Requirement
+  requirement: &70274674395420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70220984894120
+  version_requirements: *70274674395420
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70220984893640 !ruby/object:Gem::Requirement
+  requirement: &70274674389380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70220984893640
+  version_requirements: *70274674389380
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70220984893080 !ruby/object:Gem::Requirement
+  requirement: &70274674388880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70220984893080
+  version_requirements: *70274674388880
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70220984892040 !ruby/object:Gem::Requirement
+  requirement: &70274674387240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +142,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70220984892040
+  version_requirements: *70274674387240
 description: Hackish implementaiton of voting on of voteable objects by a voter
 email:
 - benguest@gmail.com
@@ -155,6 +155,7 @@ files:
 - .rvmrc
 - Gemfile
 - Guardfile
+- README.md
 - Rakefile
 - lib/voterable.rb
 - lib/voterable/functions.rb