voterable 0.0.3.0001 → 0.0.4
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +1 -0
- data/README.md +35 -0
- data/Rakefile +9 -9
- data/lib/voterable/functions.rb +5 -0
- data/lib/voterable/tally.rb +3 -0
- data/lib/voterable/version.rb +2 -2
- data/lib/voterable/vote.rb +11 -0
- data/lib/voterable/voteable.rb +7 -1
- data/lib/voterable.rb +5 -0
- data/spec/factories.rb +4 -4
- data/spec/spec_helper.rb +2 -2
- data/spec/voteable_spec.rb +1 -1
- data/spec/voting_spec.rb +1 -1
- metadata +27 -26
data/.gitignore
CHANGED
data/README.md
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
Voterable
|
2
|
+
=========
|
3
|
+
|
4
|
+
About
|
5
|
+
-----
|
6
|
+
|
7
|
+
This is a mongoid dependant gem that adds voteable charactistics to voteable things and the voters that can vote on these things.
|
8
|
+
|
9
|
+
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.
|
10
|
+
|
11
|
+
Dependencies
|
12
|
+
------------
|
13
|
+
|
14
|
+
- Mongoid (2.3.0+)
|
15
|
+
|
16
|
+
Useage
|
17
|
+
======
|
18
|
+
|
19
|
+
To add a class that can vote on something (in this case a User), subclass your user from Voterable::Voter
|
20
|
+
|
21
|
+
class User < Voterable::Voter
|
22
|
+
...
|
23
|
+
end
|
24
|
+
|
25
|
+
To add a class that can be voted on (in this case a thing), subclass the thing from Voterable::Voteable
|
26
|
+
|
27
|
+
class Thing < Voterable::Voteable
|
28
|
+
...
|
29
|
+
end
|
30
|
+
|
31
|
+
|
32
|
+
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
|
33
|
+
|
34
|
+
-Tata for now
|
35
|
+
-Ben
|
data/Rakefile
CHANGED
@@ -8,12 +8,12 @@ end
|
|
8
8
|
|
9
9
|
task :default => :spec
|
10
10
|
|
11
|
-
require 'rdoc/task'
|
12
|
-
RDoc::Task.new do |rdoc|
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
end
|
11
|
+
# require 'rdoc/task'
|
12
|
+
# RDoc::Task.new do |rdoc|
|
13
|
+
# require 'voterable/version'
|
14
|
+
# rdoc.rdoc_dir = 'rdoc'
|
15
|
+
# rdoc.title = "Voterable #{Voterable::VERSION}"
|
16
|
+
# rdoc.rdoc_files.include("README*")
|
17
|
+
# rdoc.rdoc_files.include("CHANGELOG*")
|
18
|
+
# rdoc.rdoc_files.include("lib/**/*.rb")
|
19
|
+
# end
|
data/lib/voterable/functions.rb
CHANGED
data/lib/voterable/tally.rb
CHANGED
data/lib/voterable/version.rb
CHANGED
@@ -1,3 +1,3 @@
|
|
1
|
-
module Voterable
|
2
|
-
VERSION = "0.0.
|
1
|
+
module Voterable # :nodoc:
|
2
|
+
VERSION = "0.0.4"
|
3
3
|
end
|
data/lib/voterable/vote.rb
CHANGED
@@ -1,4 +1,15 @@
|
|
1
1
|
module Voterable
|
2
|
+
##
|
3
|
+
# A vote object represents a vote made on a voteable object by a voter
|
4
|
+
#
|
5
|
+
# Example:
|
6
|
+
# == Vote.vote = :up
|
7
|
+
# => :up
|
8
|
+
# == Vote.vote
|
9
|
+
# => :up
|
10
|
+
#
|
11
|
+
# A vote belongs_to both a Voterable::Voter and a Voterable::Voteable
|
12
|
+
#
|
2
13
|
class Vote
|
3
14
|
include Mongoid::Document
|
4
15
|
include Mongoid::Timestamps
|
data/lib/voterable/voteable.rb
CHANGED
@@ -1,9 +1,15 @@
|
|
1
1
|
|
2
2
|
require "voterable/functions"
|
3
|
-
# require 'kaminari'
|
4
3
|
|
5
4
|
# DUDE! Remember you need to restart the sever to get this file to reload!
|
6
5
|
module Voterable
|
6
|
+
|
7
|
+
##
|
8
|
+
# A Voteable is any object that can be voted on, Voteables can be voted
|
9
|
+
# up or down, Voteables keep track of the votes in either direction
|
10
|
+
#
|
11
|
+
# Voteables has_many votes, Voteables can belong_to one voter. It is up
|
12
|
+
# to the outsied program to assign voteables to voters
|
7
13
|
class Voteable
|
8
14
|
|
9
15
|
include Mongoid::Document
|
data/lib/voterable.rb
CHANGED
data/spec/factories.rb
CHANGED
@@ -1,20 +1,20 @@
|
|
1
1
|
#-- Voterable
|
2
2
|
require 'voterable'
|
3
3
|
|
4
|
-
class Voteable < Voterable::Voteable
|
4
|
+
class Voteable < Voterable::Voteable # :nodoc:
|
5
5
|
|
6
6
|
voteable self, :up => +5, :down => -2 #, :index => true
|
7
7
|
voteback self, :up => +1, :down => -2
|
8
8
|
end
|
9
9
|
|
10
|
-
class Voter < Voterable::Voter
|
10
|
+
class Voter < Voterable::Voter # :nodoc:
|
11
11
|
|
12
12
|
end
|
13
13
|
|
14
|
-
class Vote < Voterable::Vote
|
14
|
+
class Vote < Voterable::Vote # :nodoc:
|
15
15
|
end
|
16
16
|
|
17
|
-
FactoryGirl.define do
|
17
|
+
FactoryGirl.define do # :nodoc: all
|
18
18
|
|
19
19
|
factory :voter do
|
20
20
|
end
|
data/spec/spec_helper.rb
CHANGED
@@ -14,14 +14,14 @@ require 'factory_girl'
|
|
14
14
|
FactoryGirl.find_definitions
|
15
15
|
|
16
16
|
#Setup Mongoid Database
|
17
|
-
Mongoid.configure do |config|
|
17
|
+
Mongoid.configure do |config| # :nodoc: all
|
18
18
|
name = 'voterable_test'
|
19
19
|
host = 'localhost'
|
20
20
|
config.master = Mongo::Connection.new.db(name)
|
21
21
|
config.autocreate_indexes = true
|
22
22
|
end
|
23
23
|
|
24
|
-
RSpec.configure do |config|
|
24
|
+
RSpec.configure do |config| # :nodoc: all
|
25
25
|
# == Mock Framework
|
26
26
|
# If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
|
27
27
|
config.mock_with :rspec
|
data/spec/voteable_spec.rb
CHANGED
data/spec/voting_spec.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: voterable
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.4
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,11 +9,11 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2011-12-
|
12
|
+
date: 2011-12-09 00:00:00.000000000Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: mongoid
|
16
|
-
requirement: &
|
16
|
+
requirement: &70274674400260 !ruby/object:Gem::Requirement
|
17
17
|
none: false
|
18
18
|
requirements:
|
19
19
|
- - =
|
@@ -21,10 +21,10 @@ dependencies:
|
|
21
21
|
version: 2.3.0
|
22
22
|
type: :runtime
|
23
23
|
prerelease: false
|
24
|
-
version_requirements: *
|
24
|
+
version_requirements: *70274674400260
|
25
25
|
- !ruby/object:Gem::Dependency
|
26
26
|
name: bson
|
27
|
-
requirement: &
|
27
|
+
requirement: &70274674399620 !ruby/object:Gem::Requirement
|
28
28
|
none: false
|
29
29
|
requirements:
|
30
30
|
- - =
|
@@ -32,10 +32,10 @@ dependencies:
|
|
32
32
|
version: 1.4.0
|
33
33
|
type: :runtime
|
34
34
|
prerelease: false
|
35
|
-
version_requirements: *
|
35
|
+
version_requirements: *70274674399620
|
36
36
|
- !ruby/object:Gem::Dependency
|
37
37
|
name: bson_ext
|
38
|
-
requirement: &
|
38
|
+
requirement: &70274674399020 !ruby/object:Gem::Requirement
|
39
39
|
none: false
|
40
40
|
requirements:
|
41
41
|
- - =
|
@@ -43,10 +43,10 @@ dependencies:
|
|
43
43
|
version: 1.4.0
|
44
44
|
type: :runtime
|
45
45
|
prerelease: false
|
46
|
-
version_requirements: *
|
46
|
+
version_requirements: *70274674399020
|
47
47
|
- !ruby/object:Gem::Dependency
|
48
48
|
name: rspec
|
49
|
-
requirement: &
|
49
|
+
requirement: &70274674398520 !ruby/object:Gem::Requirement
|
50
50
|
none: false
|
51
51
|
requirements:
|
52
52
|
- - ! '>='
|
@@ -54,10 +54,10 @@ dependencies:
|
|
54
54
|
version: '0'
|
55
55
|
type: :development
|
56
56
|
prerelease: false
|
57
|
-
version_requirements: *
|
57
|
+
version_requirements: *70274674398520
|
58
58
|
- !ruby/object:Gem::Dependency
|
59
59
|
name: factory_girl
|
60
|
-
requirement: &
|
60
|
+
requirement: &70274674397840 !ruby/object:Gem::Requirement
|
61
61
|
none: false
|
62
62
|
requirements:
|
63
63
|
- - ~>
|
@@ -65,10 +65,10 @@ dependencies:
|
|
65
65
|
version: 2.1.0
|
66
66
|
type: :development
|
67
67
|
prerelease: false
|
68
|
-
version_requirements: *
|
68
|
+
version_requirements: *70274674397840
|
69
69
|
- !ruby/object:Gem::Dependency
|
70
70
|
name: guard
|
71
|
-
requirement: &
|
71
|
+
requirement: &70274674397300 !ruby/object:Gem::Requirement
|
72
72
|
none: false
|
73
73
|
requirements:
|
74
74
|
- - ! '>='
|
@@ -76,10 +76,10 @@ dependencies:
|
|
76
76
|
version: '0'
|
77
77
|
type: :development
|
78
78
|
prerelease: false
|
79
|
-
version_requirements: *
|
79
|
+
version_requirements: *70274674397300
|
80
80
|
- !ruby/object:Gem::Dependency
|
81
81
|
name: guard-rspec
|
82
|
-
requirement: &
|
82
|
+
requirement: &70274674396640 !ruby/object:Gem::Requirement
|
83
83
|
none: false
|
84
84
|
requirements:
|
85
85
|
- - ! '>='
|
@@ -87,10 +87,10 @@ dependencies:
|
|
87
87
|
version: '0'
|
88
88
|
type: :development
|
89
89
|
prerelease: false
|
90
|
-
version_requirements: *
|
90
|
+
version_requirements: *70274674396640
|
91
91
|
- !ruby/object:Gem::Dependency
|
92
92
|
name: guard-spork
|
93
|
-
requirement: &
|
93
|
+
requirement: &70274674396020 !ruby/object:Gem::Requirement
|
94
94
|
none: false
|
95
95
|
requirements:
|
96
96
|
- - ! '>='
|
@@ -98,10 +98,10 @@ dependencies:
|
|
98
98
|
version: '0'
|
99
99
|
type: :development
|
100
100
|
prerelease: false
|
101
|
-
version_requirements: *
|
101
|
+
version_requirements: *70274674396020
|
102
102
|
- !ruby/object:Gem::Dependency
|
103
103
|
name: database_cleaner
|
104
|
-
requirement: &
|
104
|
+
requirement: &70274674395420 !ruby/object:Gem::Requirement
|
105
105
|
none: false
|
106
106
|
requirements:
|
107
107
|
- - ! '>='
|
@@ -109,10 +109,10 @@ dependencies:
|
|
109
109
|
version: '0'
|
110
110
|
type: :development
|
111
111
|
prerelease: false
|
112
|
-
version_requirements: *
|
112
|
+
version_requirements: *70274674395420
|
113
113
|
- !ruby/object:Gem::Dependency
|
114
114
|
name: rb-fsevent
|
115
|
-
requirement: &
|
115
|
+
requirement: &70274674389380 !ruby/object:Gem::Requirement
|
116
116
|
none: false
|
117
117
|
requirements:
|
118
118
|
- - ! '>='
|
@@ -120,10 +120,10 @@ dependencies:
|
|
120
120
|
version: '0'
|
121
121
|
type: :development
|
122
122
|
prerelease: false
|
123
|
-
version_requirements: *
|
123
|
+
version_requirements: *70274674389380
|
124
124
|
- !ruby/object:Gem::Dependency
|
125
125
|
name: growl
|
126
|
-
requirement: &
|
126
|
+
requirement: &70274674388880 !ruby/object:Gem::Requirement
|
127
127
|
none: false
|
128
128
|
requirements:
|
129
129
|
- - ! '>='
|
@@ -131,10 +131,10 @@ dependencies:
|
|
131
131
|
version: '0'
|
132
132
|
type: :development
|
133
133
|
prerelease: false
|
134
|
-
version_requirements: *
|
134
|
+
version_requirements: *70274674388880
|
135
135
|
- !ruby/object:Gem::Dependency
|
136
136
|
name: rdoc
|
137
|
-
requirement: &
|
137
|
+
requirement: &70274674387240 !ruby/object:Gem::Requirement
|
138
138
|
none: false
|
139
139
|
requirements:
|
140
140
|
- - ! '>='
|
@@ -142,7 +142,7 @@ dependencies:
|
|
142
142
|
version: '0'
|
143
143
|
type: :development
|
144
144
|
prerelease: false
|
145
|
-
version_requirements: *
|
145
|
+
version_requirements: *70274674387240
|
146
146
|
description: Hackish implementaiton of voting on of voteable objects by a voter
|
147
147
|
email:
|
148
148
|
- benguest@gmail.com
|
@@ -155,6 +155,7 @@ files:
|
|
155
155
|
- .rvmrc
|
156
156
|
- Gemfile
|
157
157
|
- Guardfile
|
158
|
+
- README.md
|
158
159
|
- Rakefile
|
159
160
|
- lib/voterable.rb
|
160
161
|
- lib/voterable/functions.rb
|