tadpoll 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28c3afe72d6c4a263ee868ba436cada6885bd632
+  data.tar.gz: 89c5171dbe32f9f0712a44dd97323993ed18c805
+SHA512:
+  metadata.gz: f7e3bc6cd4a7f8c643643c41a6bcbd2cb49d0766dd60e03dc6fe5bfa549d4a1c6c01427f8481b13f9879f159f3a4fe5f4f76c6ccbf375d6592ee511bf77706cf
+  data.tar.gz: a30595a886138169e90433ef347c59cf6ebd7e9dee87326384c8e47f7ed6b9bedc9d59874984a196e4374ac834c031e98c80775ad6d78195ddc80d15234bcec8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tadpoll.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kayla Gallatin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Tadpoll
+
+Tadpoll is a Ruby Gem designed to easily create polls with mutually exclusive options for voters to vote on.
+
+## Installation
+
+Add the following to your application's Gemfile:
+
+```ruby
+gem 'tadpoll'
+```
+
+Followed by a ``bundle install``.
+
+### Database Migrations
+
+Tadpoll uses 3 tables: Vote, Poll, and Option to store all voting information.  To
+generate and run the migration do:
+
+    rails generate tadpoll:migration
+    rake db:migrate
+
+## Usage
+
+### Voter Models
+
+```ruby
+class User < ActiveRecord::Base
+  is_voter
+end
+
+poll = Tadpoll::Poll.create_poll_with_options("Best Fruit", ["Orange", "Banana"])
+option = poll.options.first
+@user.vote_for(option)
+
+@user.voted_on_option?(option) # => true
+@user.voted_on_poll?(poll) # => true
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tadpoll"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/tadpoll/migration/migration_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/migration'
+
+module Tadpoll
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/tadpoll_migration.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+class TadpollMigration < ActiveRecord::Migration
+  def self.up
+    create_table :votes do |t|
+      t.references :voter
+      t.belongs_to :poll, index: true
+      t.belongs_to :option, index: true
+
+      t.timestamps
+    end
+
+    create_table :polls do |t|
+      t.string :name
+
+      t.timestamps
+    end
+
+    create_table :options do |t|
+      t.string :name
+      t.belongs_to :poll, index: true
+
+      t.timestamps
+    end
+
+    add_index :votes, [:voter_id]
+  end
+
+  def self.down
+    drop_table :votes
+    drop_table :polls
+    drop_table :options
+  end
+end

data/lib/tadpoll.rb

@@ -0,0 +1,23 @@
+require 'active_record'
+require 'active_support/inflector'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module Tadpoll 
+
+  if defined?(ActiveRecord::Base)
+    require 'tadpoll/version'
+    require 'tadpoll/option'
+    require 'tadpoll/poll'
+    require 'tadpoll/vote'
+    require 'tadpoll/voter'
+    require 'tadpoll/extenders/voter'
+    ActiveRecord::Base.extend Tadpoll::Extenders::Voter
+  end
+ 
+end
+
+require 'tadpoll/extenders/controller'
+ActiveSupport.on_load(:action_controller) do
+  include Tadpoll::Extenders::Controller
+end

data/lib/tadpoll/extenders/controller.rb

@@ -0,0 +1,12 @@
+module Tadpoll
+  module Extenders
+
+    module Controller
+
+      def voter_params(params_object = params[:vote])
+        params_object.permit(:voter_id, :vote)
+      end
+      
+    end
+  end
+end

data/lib/tadpoll/extenders/voter.rb

@@ -0,0 +1,22 @@
+module Tadpoll
+  module Extenders
+    module Voter
+
+      def voter?
+        false
+      end
+
+      def is_voter(*args)
+        require 'tadpoll/voter'
+        include Tadpoll::Voter
+
+        class_eval do
+          def self.voter?
+            true
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/tadpoll/option.rb

@@ -0,0 +1,75 @@
+module Tadpoll
+  class Option < ::ActiveRecord::Base
+
+    belongs_to :poll
+    has_many :votes
+    has_many :voters, :through => :votes
+
+    # Create Option
+    def self.new_option(name, poll_id)
+      return false if name.blank?
+
+      option = Tadpoll::Option.new(name: name, poll_id: poll_id)
+
+      if option.save
+        return option
+      else
+        return false
+      end
+    end
+
+    # Vote 
+    def vote(voter)
+      return false if voter.nil?
+
+      if self.voted_on_by?(voter)
+        return false
+      else 
+        vote = Tadpoll::Vote.new(
+          option: self,
+          voter: voter,
+          poll_id: self.poll_id
+        )
+      end
+
+      if vote.save
+        return true
+      else
+        return false
+      end
+    end
+
+    # Destory Votes with given parameters
+    def unvote(voter)
+      return false if voter.nil?
+      if self.voted_on_by?(voter)
+        _votes_ = find_votes_for(voter)
+        _votes_.each(&:destroy)
+      end
+      return true
+    end
+
+    # Votes with given parameters
+    def find_votes_for(voter)
+      votes.where(voter_id: voter.id)
+    end
+
+    # Count of Votes for an Option
+    def vote_count
+      votes.count
+    end
+
+    # T / F Has the Option been voted on
+    def voted_on?
+      votes.count > 0
+    end
+
+    # T / F Has this Option been voted on by given Voter
+    def voted_on_by?(voter)
+      votes = find_votes_for(voter)
+      votes.count > 0
+    end
+
+
+  end
+end

data/lib/tadpoll/poll.rb

@@ -0,0 +1,60 @@
+module Tadpoll
+  class Poll < ::ActiveRecord::Base
+
+    has_many :options, dependent: :destroy
+    has_many :votes, dependent: :destroy
+    has_many :voters, :through => :votes
+
+    validates_presence_of :name
+
+    # Create new poll with option
+    def self.create_poll_with_options(name, options = [])
+      return false if name.blank?
+
+      poll = Tadpoll::Poll.new(name: name)
+
+      if poll.save
+        poll.create_options(poll, options)
+        return poll
+      else
+        return false
+      end
+    end
+
+    # Create new option for a poll
+    def create_options(poll, options = [])
+      if options.any?
+        options.each do |option|
+          Tadpoll::Option.new_option(option, poll.id)
+        end
+      end
+    end
+
+    # Remove vote from poll for given voter
+    def unvote(voter)
+      return false if voter.nil?
+      if self.voted_on_by?(voter)
+        _votes_ = find_votes_for({voter_id: voter.id})
+        _votes_.each(&:destroy)
+      end
+      return true
+    end
+
+    # Votes with given parameters
+    def find_votes_for(args = {})
+      votes.where(args)
+    end
+
+    # T / F Has this Poll been voted on
+    def voted_on?
+      votes.count > 0
+    end
+
+    # T / F Has this Poll been voted on by given Voter
+    def voted_on_by?(voter)
+      votes = find_votes_for({voter_id: voter.id})
+      votes.count > 0
+    end
+
+  end
+end

data/lib/tadpoll/version.rb

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

data/lib/tadpoll/vote.rb

@@ -0,0 +1,17 @@
+module Tadpoll
+  class Vote < ::ActiveRecord::Base
+
+    if defined?(ProtectedAttributes) || ::ActiveRecord::VERSION::MAJOR < 4
+      attr_accessible :voter_id, :voter
+    end
+
+    belongs_to :voter
+    belongs_to :poll
+    belongs_to :option
+
+    validates_presence_of :voter_id
+    validates_presence_of :poll_id
+    validates_presence_of :option_id
+
+  end
+end

data/lib/tadpoll/voter.rb

@@ -0,0 +1,42 @@
+module Tadpoll
+  module Voter 
+
+    def self.included(base)
+      base.class_eval do
+        has_many :votes, :class_name => 'Tadpoll::Vote', :dependent => :destroy 
+      end
+    end
+
+    # Vote for an option
+    def vote_for(option)
+      option.vote(self)
+    end
+
+    # Unvote for an option
+    def unvote_for_option(option)
+      option.unvote(self)
+    end
+
+    # Unvote for a poll
+    def unvote_for_poll(poll)
+      poll.unvote(self)
+    end
+
+    # T / F votes for given params
+    def voted_on?(args = {})
+      found_votes = votes.where(args)
+      found_votes.count > 0
+    end
+
+    # T / F Voter voted on given poll
+    def voted_on_poll?(poll)
+      voted_on?({poll_id: poll.id})
+    end
+
+    # T / F Voter voted for given option
+    def voted_on_option?(option)
+      voted_on?({poll_id: option.poll_id, option_id: option.id})
+    end
+
+  end
+end

data/tadpoll.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tadpoll/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tadpoll"
+  spec.version       = Tadpoll::VERSION
+  spec.authors       = ["Kayla"]
+  spec.email         = ["kaylacgallatin@gmail.com"]
+
+  spec.summary       = %q{Simple vote system}
+  spec.description   = %q{Ruby Gem designed to easily create polls with mutually exclusive options for voters to vote on.}
+  spec.homepage      = "https://github.com/KaylaGallatin/Tadpoll"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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 "sqlite3", '~> 1.3.9'
+  spec.add_development_dependency "activerecord"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: tadpoll
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Kayla
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-31 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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
+  for voters to vote on.
+email:
+- kaylacgallatin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/tadpoll/migration/migration_generator.rb
+- lib/generators/tadpoll/migration/templates/active_record/migration.rb
+- lib/tadpoll.rb
+- lib/tadpoll/extenders/controller.rb
+- lib/tadpoll/extenders/voter.rb
+- lib/tadpoll/option.rb
+- lib/tadpoll/poll.rb
+- lib/tadpoll/version.rb
+- lib/tadpoll/vote.rb
+- lib/tadpoll/voter.rb
+- tadpoll.gemspec
+homepage: https://github.com/KaylaGallatin/Tadpoll
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Simple vote system
+test_files: []