mdarby-pollster 0.1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.textile

@@ -0,0 +1,37 @@
+h2. pollster
+
+A Rails gem that generates an entire MVC stack for user polling on your app
+
+h3. What it does
+
+pollster adds a generator to your Rails app that creates the MVC stack for polling of your users. It has a pretty chart.
+
+h3. Requirements
+
+pollster requires the super amazing "RESTful_Authentication":http://weblog.techno-weenie.net/2006/8/1/restful-authentication-plugin plugin, along with the "googlecharts":http://github.com/mattetti/googlecharts/tree/master gem.
+
+<pre>
+  ./script/plugin install git://github.com/technoweenie/restful-authentication.git
+  sudo gem install mattetti-googlecharts
+</pre>
+
+Make sure to follow the instructions on RESTful_Authentication, and add this line to your config/environment.rb file:
+<pre>config.gem "googlecharts", :lib => 'gchart', :version => ">= 1.3.6"</pre>
+
+h3. How to Install
+
+<pre>sudo gem install mdarby-pollster</pre>
+
+h3. How to Use
+
+<pre>./script/generate pollster WhateverYouWantToNameYourPollModel</pre>
+
+h3. How to Test
+
+Complete Rspec specs are included automatically. Well, complete aside from view specs as you'll just change the damned things anyway.
+
+h3. About the Author
+
+My name is Matt Darby. I'm the Web Developer and IT Manager at "Dynamix Engineering":http://dynamix-ltd.com and hold a Master's Degree in Computer Science from "Franklin University":http://franklin.edu in Columbus, OH.
+
+Feel free to check out my "blog":http://blog.matt-darby.com or to "recommend me":http://www.workingwithrails.com/recommendation/new/person/10908-matt-darby

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the pollster plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the pollster plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Pollster'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/pollster/pollster_generator.rb

@@ -0,0 +1,93 @@
+class PollsterGenerator < Rails::Generator::NamedBase
+  
+  def initialize(*runtime_args)
+    super(*runtime_args)
+  end
+
+  def manifest
+    record do |m|
+      install_routes(m)
+      
+      m.directory(File.join('app/models'))
+      m.directory(File.join('app/controllers'))
+      m.directory(File.join('app/helpers'))
+      m.directory(File.join('app/views'))
+      m.directory(File.join("app/views/#{table_name}"))
+      m.directory(File.join('db/migrate'))
+      
+      if has_rspec?
+        m.directory(File.join('spec/controllers'))
+        m.directory(File.join('spec/models'))
+        m.directory(File.join('spec/helpers'))
+        m.directory(File.join('spec/views'))
+        m.directory(File.join("spec/views/#{table_name}"))
+        
+        # Controllers
+        m.template "spec/polls_controller_spec.rb", File.join('spec/controllers', "#{table_name}_controller_spec.rb")
+        m.template "spec/polls_routing_spec.rb", File.join('spec/controllers', "#{table_name}_routing_spec.rb")
+        
+        # Models
+        m.template "spec/poll_spec.rb", File.join('spec/models', "#{table_name.singularize}_spec.rb")
+        m.template "spec/poll_vote_spec.rb", File.join('spec/models', "#{table_name.singularize}_vote_spec.rb")
+
+        # Helpers
+        m.template "spec/polls_helper_spec.rb", File.join('spec/helpers', "#{table_name}_helper_spec.rb")
+      end
+      
+      # Controllers
+      m.template "polls_controller.rb", File.join('app/controllers', "#{table_name}_controller.rb")
+      
+      # Models
+      m.template "poll.rb", File.join('app/models', "#{table_name.singularize}.rb")
+      m.template "poll_vote.rb", File.join('app/models', "#{table_name.singularize}_vote.rb")
+      
+      # Helpers
+      m.template "polls_helper.rb", File.join('app/helpers', "#{table_name}_helper.rb")
+      
+      # Migrations
+      m.migration_template "create_pollster_tables.rb", "db/migrate", :migration_file_name => "create_pollster_tables"
+      
+      # Views
+      for view in views
+        new_name = (view == "_poll") ? "_#{object_name}" : view
+        m.template "views/#{view}.html.erb", File.join("app/views/#{table_name}", "#{new_name}.html.erb")
+      end
+      
+    end
+  end
+  
+  def table_name
+    class_name.tableize
+  end
+  
+  def model_name 
+    class_name.demodulize
+  end
+  
+  def object_name
+    table_name.singularize
+  end
+  
+  def install_routes(m)
+    route_string = ":#{table_name}, :member => { :vote => :post }"
+    def route_string.to_sym; to_s; end
+    def route_string.inspect; to_s; end
+    m.route_resources route_string
+  end
+  
+  def has_rspec?
+    spec_dir = File.join(RAILS_ROOT, 'spec')
+    options[:rspec] ||= (File.exist?(spec_dir) && File.directory?(spec_dir)) unless (options[:rspec] == false)
+  end
+  
+  def views
+    %w[ _current_results _final_results _option_form _poll _vote edit index new ]
+  end
+  
+  protected
+  
+    def banner
+      "Usage: #{$0} #{spec.name} ModelName"
+    end
+    
+end

data/generators/pollster/templates/create_pollster_tables.rb

@@ -0,0 +1,27 @@
+class CreatePollsterTables < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.string :name
+      t.text :description
+      t.text :options
+      t.date :ends_at
+      t.text :string
+      t.integer :created_by_id
+      
+      t.timestamps
+    end
+    
+    create_table :<%= object_name %>_votes do |t|
+      t.integer :user_id
+      t.string :vote
+      t.integer :<%= object_name %>_id
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+    drop_table :<%= table_name %>_votes
+  end
+end

data/generators/pollster/templates/poll.rb

@@ -0,0 +1,104 @@
+class <%= class_name %> < ActiveRecord::Base
+  
+  serialize :options
+  
+  has_many :votes, :class_name => "<%= class_name %>Vote", :dependent => :destroy
+  has_many :voters, :through => :votes, :source => :user
+  belongs_to :author, :foreign_key => 'created_by_id', :class_name => 'User'
+  
+  validates_presence_of :ends_at, :name, :created_by_id
+  
+  
+  def can_by_voted_on_by(user)
+    active? && !has_already_voted?(user)
+  end
+  
+  def has_already_voted?(user)
+    voters.include?(user)
+  end
+  
+  def active?
+    Time.now < ends_at.end_of_day
+  end
+    
+  def visible?
+    Date.today < (ends_at + 7.days)
+  end
+  
+  def winner
+    return nil if active?
+    
+    index = current_results_percentages.index(winning_percentage)
+    options[index]
+  end
+  
+  def winners
+    return nil if active? || !ends_in_tie?
+    
+    winners = []
+    percentage = winning_percentage
+    
+    current_results_percentages.each_with_index do |p, index|
+      winners << options[index] if p == winning_percentage
+    end
+    
+    winners
+  end
+  
+  def ends_in_tie?
+    percentage = winning_percentage
+    current_results_percentages.select{|p| p == percentage}.size > 1
+  end
+  
+  def winning_percentage
+    current_results_percentages.sort.reverse.first
+  end
+  
+  def self.visible
+    all.select{|p| p.visible?}
+  end
+  
+  def current_results_percentages
+    options.inject([]) do |memo, option|
+      num_votes = num_votes_for(option)
+      memo << percentage_of_votes_for(option)
+    end
+  end
+  
+  def num_votes_for(option)
+    return 0 unless has_votes?
+    votes.select{|v| v.vote == option}.size
+  end
+  
+  def pie_legend
+    legend = []
+
+    options.each_with_index do |option, index|
+      legend << "%23#{index + 1} (#{formatted_percentage_of_votes_for(option)})"
+    end
+    
+    legend
+  end
+  
+  def total_votes
+    votes.size.to_f
+  end
+  
+  def percentage_of_votes_for(option)
+    return 0.0 unless has_votes?
+    num_votes_for(option) / total_votes
+  end
+  
+  def formatted_percentage_of_votes_for(option)
+    "#{sprintf("%0.0f", percentage_of_votes_for(option) * 100)}%"
+  end
+  
+  def has_votes?
+    total_votes > 0
+  end
+  
+  def options=(arr)
+    write_attribute(:options, [*arr].map{|x| x["options"]})
+  end
+  
+end

data/generators/pollster/templates/poll_vote.rb

@@ -0,0 +1,6 @@
+class <%= class_name %>Vote < ActiveRecord::Base
+  
+  belongs_to :user
+  belongs_to :<%= object_name %>
+
+end

data/generators/pollster/templates/polls_controller.rb

@@ -0,0 +1,64 @@
+class <%= class_name.pluralize %>Controller < ApplicationController
+  
+  before_filter :load_items
+  
+  def load_items
+    @<%= object_name %> = <%= class_name %>.find(params[:id]) if params[:id]
+  end
+  
+  def index
+    @<%= object_name %>s = <%= class_name %>.visible
+  end
+
+  def show
+    redirect_to <%= object_name %>s_path
+  end
+
+  def new
+    @<%= object_name %> = <%= class_name %>.new
+  end
+
+  def edit
+  end
+
+  def create
+    @<%= object_name %> = <%= class_name %>.new(params[:<%= object_name %>])
+
+    if @<%= object_name %>.save
+      flash[:notice] = "<%= class_name %> successfully created"
+      redirect_to <%= object_name %>s_path
+    else
+      render :action => "new"
+    end
+  end
+
+  def update
+    if @<%= object_name %>.update_attributes(params[:<%= object_name %>])
+      flash[:notice] = '<%= class_name %> was successfully updated.'
+      redirect_to <%= object_name %>s_path
+    else
+      flash[:error] = "An error occurred"
+      render :action => "edit"
+    end
+  end
+
+  def destroy
+    @<%= object_name %>.destroy
+    redirect_to <%= object_name %>s_path
+  end
+  
+  def vote
+    unless @<%= object_name %>.has_already_voted?(current_user)
+      v = @<%= object_name %>.votes.build(:user => current_user, :vote => params[:<%= object_name %>]["vote"])
+    
+      if v.save
+        flash[:notice] = "Vote cast!"
+      else
+        flash[:error] = "Something happened..."
+      end
+    end
+    
+    redirect_to <%= object_name %>s_path
+  end
+  
+end

data/generators/pollster/templates/polls_helper.rb

@@ -0,0 +1,9 @@
+module <%= class_name.pluralize %>Helper
+
+  def add_option_link(<%= object_name %>, name)
+    link_to_function name do |page|
+      page.insert_html :bottom, :options, :partial => 'option_form', :locals => {:option => []}
+    end
+  end
+
+end

data/generators/pollster/templates/spec/poll_spec.rb

@@ -0,0 +1,253 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module <%= class_name %>Attributes
+  def valid_attributes
+    {
+      :name          => "foo",
+      :description   => "foo",
+      :options       => ["first", "second", "third"],
+      :ends_at       => Date.parse("2009-01-09"),
+      :created_at    => Date.parse("2009-01-01"),
+      :updated_at    => Date.parse("2009-01-01"),
+      :created_by_id => 1
+    }
+  end
+end
+
+describe <%= class_name %> do
+
+  include <%= class_name %>Attributes
+
+  before do
+    @<%= object_name %> = <%= class_name %>.create!(valid_attributes)
+    @<%= object_name %>.stub!(:votes => [])
+    @author = mock_model(User)
+    @user = mock_model(User)
+    
+    @<%= object_name %>.stub!(:author => @author)
+  end
+
+  it "should be valid" do
+    @<%= object_name %>.valid?.should be_true
+  end
+
+  it "should serialize #options" do
+    @<%= object_name %>.options.is_a?(Array).should be_true
+  end
+
+  it "should know the total number of votes cast" do
+    vote = mock_model(<%= class_name %>Vote)
+    @<%= object_name %>.stub!(:votes => [vote])
+    
+    @<%= object_name %>.total_votes.should == 1
+  end
+
+  it "should know how to shave the options yak" do
+    @<%= object_name %>.options = [{"options" => "first"}, {"options" => "second"}, {"options" => "third"}]
+    @<%= object_name %>.save
+    @<%= object_name %>.options.should == ["first", "second", "third"]
+  end
+
+  it "should be visible for a week after its end date" do
+    Date.stub!(:today => Date.parse("2009-01-09"))
+    @<%= object_name %>.stub!(:ends_at => Date.parse("2009-01-07"))
+    
+    @<%= object_name %>.visible?.should be_true
+    
+    @<%= object_name %>.stub!(:ends_at => Date.parse("2009-01-01"))
+    @<%= object_name %>.visible?.should be_false
+    
+  end
+
+  it "should be able to find all visible <%= class_name %>s" do
+    <%= object_name %>_1 = mock_model(<%= class_name %>, :visible? => true)
+    <%= object_name %>_2 = mock_model(<%= class_name %>, :visible? => false)
+    <%= class_name %>.stub!(:all => [<%= object_name %>_1, <%= object_name %>_2])
+    
+    <%= class_name %>.visible.should == [<%= object_name %>_1]
+  end
+
+
+  describe " - Associations" do
+    it "should know about votes" do
+      @<%= object_name %>.votes.should == []
+    end
+    
+    it "should know about voters" do
+      @<%= object_name %>.voters.should == []
+    end
+    
+    it "should know about its author" do
+      @<%= object_name %>.author.should == @author
+    end
+    
+  end
+
+  describe " - Required attributes" do
+    it "should require name" do
+      @<%= object_name %>.name = nil
+      @<%= object_name %>.valid?.should be_false
+    end
+    
+    it "should require an end_date" do
+      @<%= object_name %>.ends_at = nil
+      @<%= object_name %>.valid?.should be_false
+    end
+    
+    it "should require an author" do
+      @<%= object_name %>.created_by_id = nil
+      @<%= object_name %>.valid?.should be_false
+    end
+    
+  end
+
+  describe " that has no votes" do
+    before do
+      @<%= object_name %>.stub!(:votes => [])
+    end
+  
+    it "should know that it has no votes" do
+      @<%= object_name %>.has_votes?.should be_false
+    end
+  end
+
+  describe " that has votes" do
+    before do
+      @vote = mock_model(<%= class_name %>Vote)
+      @<%= object_name %>.stub!(:votes => [@vote])
+    end
+  
+    it "should know that it has votes" do
+      @<%= object_name %>.has_votes?.should be_true
+    end
+    
+    it "should know how to calculate the current results" do
+      @<%= object_name %>.stub!(:options => ["first", "second", "third"])
+      @<%= object_name %>.stub!(:num_votes_for)
+      @<%= object_name %>.stub!(:percentage_of_votes_for).with("first").and_return(10.0)
+      @<%= object_name %>.stub!(:percentage_of_votes_for).with("second").and_return(60.0)
+      @<%= object_name %>.stub!(:percentage_of_votes_for).with("third").and_return(30.00)
+      
+      @<%= object_name %>.current_results_percentages.should == [10.0, 60.0, 30.0]
+    end
+
+    it "should know how to get a vote count for an option" do
+      vote_1 = mock_model(<%= class_name %>Vote, :vote => "first")
+      vote_2 = mock_model(<%= class_name %>Vote, :vote => "second")
+      vote_3 = mock_model(<%= class_name %>Vote, :vote => "first")
+      @<%= object_name %>.stub!(:votes => [vote_1, vote_2, vote_3])
+      
+      @<%= object_name %>.num_votes_for("first").should == 2
+    end
+  
+    it "should be able to generate a legend for the results chart" do
+      @<%= object_name %>.stub!(:options => ["first", "second", "third"])
+      @<%= object_name %>.stub!(:formatted_percentage_of_votes_for).with("first").and_return("10%")
+      @<%= object_name %>.stub!(:formatted_percentage_of_votes_for).with("second").and_return("60%")
+      @<%= object_name %>.stub!(:formatted_percentage_of_votes_for).with("third").and_return("20%")
+      
+      @<%= object_name %>.pie_legend.should == ["%231 (10%)", "%232 (60%)", "%233 (20%)"]
+    end
+  
+    it "should be able to calculate the percentage of votes cast for an option" do
+      @<%= object_name %>.should_receive(:num_votes_for).with("first").and_return(10)
+      @<%= object_name %>.stub!(:total_votes => 100.0)
+
+      @<%= object_name %>.percentage_of_votes_for("first").should == 0.1
+    end
+  
+    it "should be able to format the percentage of votes cast for an option" do
+      @<%= object_name %>.should_receive(:num_votes_for).with("first").and_return(10)
+      @<%= object_name %>.stub!(:total_votes => 100.0)
+
+      @<%= object_name %>.formatted_percentage_of_votes_for("first").should == "10%"
+    end
+  
+    it "should know if a User has already voted" do
+      user = mock_model(User)
+      user2 = mock_model(User)
+      @<%= object_name %>.stub!(:voters => [user])
+
+      @<%= object_name %>.has_already_voted?(user).should be_true
+      @<%= object_name %>.has_already_voted?(user2).should be_false
+    end
+  end
+
+  describe " that has not yet reached its end date" do
+    before do
+      @<%= object_name %>.ends_at = 3.days.from_now
+    end
+    
+    it "should be considered active" do
+      @<%= object_name %>.active?.should be_true
+    end
+    
+    it "should allow voting by a new voter" do
+      user = mock_model(User)
+      @<%= object_name %>.stub!(:has_already_voted? => false)
+      
+      @<%= object_name %>.can_by_voted_on_by(user).should be_true
+    end
+    
+  end
+  
+  describe " that is on its last day of voting" do
+    it "should know that it's still open" do
+      date = Date.parse("2009-01-10")
+      @<%= object_name %>.stub!(:ends_at => date)
+      Time.stub!(:now => date.end_of_day - 1.second)
+      
+      @<%= object_name %>.active?.should be_true
+    end
+  end
+  
+  describe " that has passed its end date" do
+    before do
+      @<%= object_name %>.ends_at = Date.yesterday
+    end
+    
+    it "should not be considered active" do
+      @<%= object_name %>.active?.should be_false
+    end
+    
+    it "should not allow voting by a new voter" do
+      user = mock_model(User)
+      @<%= object_name %>.stub!(:has_already_voted? => false)
+      
+      @<%= object_name %>.can_by_voted_on_by(user).should be_false
+    end
+  
+    it "should know who the winner is" do
+      @<%= object_name %>.stub!(:options => ["first", "second", "third"])
+      @<%= object_name %>.stub!(:winning_percentage => 0.9)
+      @<%= object_name %>.stub!(:current_results_percentages => [0.0, 0.9, 0.1])
+      
+      @<%= object_name %>.winner.should == "second"
+    end
+  
+    it "should know what the winning percentage was" do
+      @<%= object_name %>.stub!(:current_results_percentages => [0.4, 0.5, 0.1])
+      @<%= object_name %>.winning_percentage.should == 0.5
+    end
+    
+    
+    describe " and ends in a tie" do
+      before do
+        @<%= object_name %>.stub!(:options => ["first", "second", "third"])
+        @<%= object_name %>.stub!(:winning_percentage => 0.4)
+        @<%= object_name %>.stub!(:current_results_percentages => [0.4, 0.4, 0.2])
+      end
+      
+      it "should know that it ends in a tie" do
+        @<%= object_name %>.ends_in_tie?.should be_true
+      end
+      
+      it "should know which options tied" do
+        @<%= object_name %>.winners.should == ["first", "second"]
+      end
+      
+    end
+    
+  end
+  
+end

data/generators/pollster/templates/spec/poll_vote_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe <%= class_name %>Vote do
+  
+  before do
+    @vote = <%= class_name %>Vote.new(:user_id => 1, :<%= object_name %>_id => 1)
+  end
+  
+  it "should be valid" do
+    @vote.valid?.should be_true
+  end
+  
+  it "should know about the User" do
+    @vote.should respond_to(:user)
+  end
+  
+  it "should know about the <%= class_name %>" do
+    @vote.should respond_to(:<%= object_name %>)
+  end
+  
+end