tadpoll 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28c3afe72d6c4a263ee868ba436cada6885bd632
-  data.tar.gz: 89c5171dbe32f9f0712a44dd97323993ed18c805
+  metadata.gz: e8b3b0d8ad86074906b6e302f41759b08d66ad10
+  data.tar.gz: 29d4f95a527563efe6706f14203e3bc07357c466
 SHA512:
-  metadata.gz: f7e3bc6cd4a7f8c643643c41a6bcbd2cb49d0766dd60e03dc6fe5bfa549d4a1c6c01427f8481b13f9879f159f3a4fe5f4f76c6ccbf375d6592ee511bf77706cf
-  data.tar.gz: a30595a886138169e90433ef347c59cf6ebd7e9dee87326384c8e47f7ed6b9bedc9d59874984a196e4374ac834c031e98c80775ad6d78195ddc80d15234bcec8
+  metadata.gz: f99dc06882613e2a0a736c1b094dea6c97e5170c26bfbf48b3d285adf344711f0ad01fc34810d0f70a78555beec0eb56355766a57a90e595b6261e1c7c8479fd
+  data.tar.gz: cc11fc8b923a702c9900cd507ed1883a162c696bc4500ac8f3f75061f70841253f1a0c485c0d43a6bbedd5e7fe7830b26cab6bcae43185a82b9f7140d50fd1df

data/README.md

@@ -29,14 +29,67 @@ class User < ActiveRecord::Base
   is_voter
 end
 
-poll = Tadpoll::Poll.create_poll_with_options("Best Fruit", ["Orange", "Banana"])
+poll = Tadpoll::Poll.create_poll_with_options("Best P&R Character", ["Leslie Knope", "Ron Swanson"])
 option = poll.options.first
 @user.vote_for(option)
 
 @user.voted_on_option?(option) # => true
 @user.voted_on_poll?(poll) # => true
+
+@user.unvote_for_poll(poll)
+@user.voted_on_option?(option) # => false
+@user.voted_on_poll?(poll) # => false
+```
+
+### Polls
+
+Polls have a name, and mutually exclusive options for voter models to vote on.
+
+```ruby
+# create a poll with options
+poll = Tadpoll::Poll.create_poll_with_options("Best Star Wars Character", ["Han Solo", "Leia Organa"])
+poll.create_options(["Luke Skywalker"])
+poll.options.map{|o| o.name} # => ["Han Solo", "Leia Organa", "Luke Skywalker"]
+
+# voter models can vote for options on a poll
+option = poll.options.first
+@user.vote_for(option)
+
+poll.voted_on? # => true
+poll.voted_on_by?(@user) # => true
+
+# remove votes for a user
+poll.unvote(@user)
+poll.voted_on_by?(@user) # => false
 ```
 
+### Options
+
+Options belong to individual polls, and have many votes. 
+
+```ruby
+# create a poll and add new options
+poll = Tadpoll::Poll.create_poll_with_options("Best GoT Character", ["Jon Snow", "Brienne of Tarth"])
+Tadpoll::Option.new_option("Arya Stark", poll.id)
+poll.options.map{|o| o.name} # => ["Jon Snow", "Brienne of Tarth", "Arya Stark"]
+
+# vote on options
+option = poll.options.first
+option.vote(@user)
+
+option.vote_count # => 1
+option.voted_on? # => true
+option.voted_on_by?(@user) # => true
+
+# remove user votes
+option.unvote(@user)
+option.voted_on_by?(@user) # => false
+```
+
+## Testing
+
+All tests are located in the spec directory and follow the RSpec format.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/generators/tadpoll/migration/templates/active_record/migration.rb

@@ -1,7 +1,7 @@
 class TadpollMigration < ActiveRecord::Migration
   def self.up
     create_table :votes do |t|
-      t.references :voter
+      t.references :voter, :polymorphic => true
       t.belongs_to :poll, index: true
       t.belongs_to :option, index: true
 
@@ -21,7 +21,7 @@ class TadpollMigration < ActiveRecord::Migration
       t.timestamps
     end
 
-    add_index :votes, [:voter_id]
+    add_index :votes, [:voter_id, :voter_type]
   end
 
   def self.down

data/lib/tadpoll/extenders/controller.rb

@@ -4,7 +4,7 @@ module Tadpoll
     module Controller
 
       def voter_params(params_object = params[:vote])
-        params_object.permit(:voter_id, :vote)
+        params_object.permit(:voter_id, :voter_type)
       end
       
     end

data/lib/tadpoll/option.rb

@@ -22,12 +22,13 @@ module Tadpoll
     def vote(voter)
       return false if voter.nil?
 
-      if self.voted_on_by?(voter)
+      if self.poll.voted_on_by?(voter)
         return false
       else 
         vote = Tadpoll::Vote.new(
           option: self,
-          voter: voter,
+          voter_id: voter.id,
+          voter_type: voter.class.base_class.name,
           poll_id: self.poll_id
         )
       end

data/lib/tadpoll/poll.rb

@@ -14,7 +14,7 @@ module Tadpoll
       poll = Tadpoll::Poll.new(name: name)
 
       if poll.save
-        poll.create_options(poll, options)
+        poll.create_options(options)
         return poll
       else
         return false
@@ -22,10 +22,10 @@ module Tadpoll
     end
 
     # Create new option for a poll
-    def create_options(poll, options = [])
+    def create_options(options = [])
       if options.any?
         options.each do |option|
-          Tadpoll::Option.new_option(option, poll.id)
+          Tadpoll::Option.new_option(option, self)
         end
       end
     end

data/lib/tadpoll/version.rb

@@ -1,3 +1,3 @@
 module Tadpoll
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/lib/tadpoll/vote.rb

@@ -2,7 +2,7 @@ module Tadpoll
   class Vote < ::ActiveRecord::Base
 
     if defined?(ProtectedAttributes) || ::ActiveRecord::VERSION::MAJOR < 4
-      attr_accessible :voter_id, :voter
+      attr_accessible :voter_id, :voter_type
     end
 
     belongs_to :voter

data/lib/tadpoll/voter.rb

@@ -3,7 +3,7 @@ module Tadpoll
 
     def self.included(base)
       base.class_eval do
-        has_many :votes, :class_name => 'Tadpoll::Vote', :dependent => :destroy 
+        has_many :votes, :class_name => 'Tadpoll::Vote', :as => :voter, :dependent => :destroy
       end
     end
 
@@ -24,8 +24,7 @@ module Tadpoll
 
     # T / F votes for given params
     def voted_on?(args = {})
-      found_votes = votes.where(args)
-      found_votes.count > 0
+      votes.where(args).count > 0
     end
 
     # T / F Voter voted on given poll

data/tadpoll.gemspec

@@ -19,9 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rspec"
   spec.add_development_dependency "sqlite3", '~> 1.3.9'
   spec.add_development_dependency "activerecord"
 end

metadata

@@ -1,83 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: tadpoll
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kayla
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-31 00:00:00.000000000 Z
+date: 2016-06-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.9
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby Gem designed to easily create polls with mutually exclusive options
@@ -88,8 +60,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .DS_Store
-- .gitignore
+- ".DS_Store"
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -117,12 +89,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []