TODO has been modified to relfect bug changes already delt with. Also, autogenerated...

[selectricity] / app / controllers / graph_controller.rb

diff --git a/app/controllers/graph_controller.rb b/app/controllers/graph_controller.rb
index 825688476485d114f1583cdb6774c6962e40528d..92e1a1efcf3f5048ae3dacf18405213632e19aff 100644 (file)
--- a/app/controllers/graph_controller.rb
+++ b/app/controllers/graph_controller.rb
@@ -1,24 +1,70 @@
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program.  If not, see
+# <http://www.gnu.org/licenses/>.
+

 require 'date'
 require 'date'

-class GraphController < ApplicationController
-  
+class GraphController < ApplicationController  

   class GruffGraff
   class GruffGraff

-  
+    
+    COLORS = ['#74CE00', '#005CD9', '#DC0D13', '#131313', '#A214A4', 'EFF80E',
+              '90E5E6', 'F58313', '437D3D', '0E026C']
+    BACKGROUND_COLORS = ['#74CE00', '#FFFFFF'] #for green and white background
+    

     def initialize(options)
     def initialize(options)

-      size = "700x400"
+      size = options[:size] ? options[:size] : "400x300" #allow custom sizing

       @graph = options[:graph_type].new(size)
       @graph = options[:graph_type].new(size)

-
-      @graph.theme = { :background_colors => ['#73BF26', '#ffffff'] }
+      
+      @graph.no_data_message = "No Voters"
+      
+      @graph.theme = { :colors => COLORS,
+                       :background_colors => ['#e5e5e5', '#FFFFFF']  }

       @graph.font = File.expand_path('/usr/X11R6/lib/X11/fonts/TTF/Vera.ttf',
                                    RAILS_ROOT)
       
       @graph.font = File.expand_path('/usr/X11R6/lib/X11/fonts/TTF/Vera.ttf',
                                    RAILS_ROOT)
       

+      if options[:legend_font_size]
+        @graph.legend_font_size = options[:legend_font_size] 
+      end
+      
+      if options[:title_font_size]  
+        @graph.title_font_size = options[:title_font_size]
+      end
+      
+      #marker count doesn't include minimum value line, default is 4
+      @graph.marker_count = options[:marker_count] if options[:marker_count]
+      
+      @graph.marker_font_size = options[:marker_font_size] if options[:marker_font_size]
+      
+      @graph.marker_color = options[:marker_color] if options[:marker_color]
+      

       # fill in the data with the optional data name
       # fill in the data with the optional data name

-      #Check to see if multiple datasets, if so, fill them all!     
-      if options[:data].size > 1 && options[:data].all?  {|i| i.is_a?(Array)}
+      #Check to see if multiple datasets, if so, fill them all!
+      #Sort by biggest first piece of data.
+      if options[:data].is_a?(Hash) 
+        options[:data].sort {|a,b| b[1][0] <=> a[1][0]}.each do |dataset|
+          @graph.data(dataset[0], dataset[1])
+        end
+      #if each dataset nameless, will have only multiple arrays    
+      elsif options[:data].size > 1 && options[:data].all?  {|i| i.is_a?(Array)}

         options[:data].each do |array|
           @graph.data( options.fetch(:data_name, "Data"), array)
         end
       else #one dimensional array, just pass it in
       @graph.data( options.fetch(:data_name, "Data"), options[:data] )
         options[:data].each do |array|
           @graph.data( options.fetch(:data_name, "Data"), array)
         end
       else #one dimensional array, just pass it in
       @graph.data( options.fetch(:data_name, "Data"), options[:data] )

+      @graph.hide_legend = true

       end
       
       # set the labels or create an empty hash
       end
       
       # set the labels or create an empty hash


@@ -61,42 +107,71 @@ class GraphController < ApplicationController
     @election = Election.find(params[:id])
     data, labels, scale = get_votes_per_interval_data(@election)
     
     @election = Election.find(params[:id])
     data, labels, scale = get_votes_per_interval_data(@election)
     

+    hide_legend = true
+    

     graph = GruffGraff.new( :graph_type => Gruff::Line,
                             :data_name => @election.name,
                             :data => data,
                             :interval_labels => labels,
                             :title => "Voters Over Time",
     graph = GruffGraff.new( :graph_type => Gruff::Line,
                             :data_name => @election.name,
                             :data => data,
                             :interval_labels => labels,
                             :title => "Voters Over Time",

+                            :size => "330x232", 
+                            :legend_font_size => 40,
+                            :title_font_size => 50,
+                            :marker_count => 2,
+                            :marker_font_size => 30,
+                            :marker_color => '#999999',

                             :x_axis_label => scale,
                             :y_axis_label => "Number of Votes")
     send_data(*graph.output)
   end
                             :x_axis_label => scale,
                             :y_axis_label => "Number of Votes")
     send_data(*graph.output)
   end

-
+  

   def borda_bar
     @election = Election.find(params[:id])
   def borda_bar
     @election = Election.find(params[:id])

-    pref_tally = make_preference_tally(@election)
+    @election.results unless @election.borda_result
+    data, labels = get_borda_points(@election.borda_result)
+    
+    size = "400x300"
+    size = "580x300" if @election.candidates.size >= 5

     
     

-    @borda_result = BordaVote.new(pref_tally).result
-    data, labels = get_borda_points(@borda_result)
+   if @election.candidates.size >= 5
+     marker_font_size = 17
+   else
+     marker_font_size = 20
+   end

     
     graph = GruffGraff.new( :graph_type => Gruff::Bar,
                             :data_name => @election.name,
                             :data => data,
                             :interval_labels => labels,
     
     graph = GruffGraff.new( :graph_type => Gruff::Bar,
                             :data_name => @election.name,
                             :data => data,
                             :interval_labels => labels,

+                            :size => size,

                             :title => "Points Per Candidate",
                             :title => "Points Per Candidate",

+                            :marker_color => '#999999',
+                            :marker_font_size => marker_font_size,

                             :y_axis_label => "Points",
                             :y_axis_label => "Points",

-                            :x_axis_label => "Candidate")
+                            :x_axis_label => "Candidates")

     send_data(*graph.output)
   end
     send_data(*graph.output)
   end

- 
+  #Acording to Tufte, small, concomparitive, highly labeled data sets usually
+  #belong in tables. The following is a bar graph...but would it be better
+  #as a table?

   def choices_positions
     @election = Election.find(params[:id])
   def choices_positions
     @election = Election.find(params[:id])

-    pref_tally = make_preference_tally(@election)
+    legend = Hash.new   
+    alldata, labels = get_positions_info(@election)    
+    @election.results unless @election.condorcet_result || @election.ssd_result
+    ranked_candidates = @election.condorcet_result.ranked_candidates.flatten
+    
+    names = Hash.new
+    candidates = @election.candidates.sort.collect {|candidate| candidate.id}
+    candidates.each do |candidate|
+      names[candidate]= (Candidate.find(candidate)).name
+    end
+    
+    ranked_candidates.each_with_index \
+    {|candidate, index| legend[names[candidate]] = alldata[index]}

     
     

-    fulldata, labels = get_positions_info(@election)
-    labels = @candidates

     graph = GruffGraff.new( :graph_type => Gruff::Bar,
     graph = GruffGraff.new( :graph_type => Gruff::Bar,

-                            :data_name => @election.name,
-                            :data => fulldata,
+                            :data => legend,

                             :interval_labels => labels,
                             :title => "Times Voted in Each Position",
                             :y_axis_label => "Number of Times Ranked",
                             :interval_labels => labels,
                             :title => "Times Voted in Each Position",
                             :y_axis_label => "Number of Times Ranked",


@@ -104,38 +179,61 @@ class GraphController < ApplicationController
     send_data(*graph.output) 
   end
   
     send_data(*graph.output) 
   end
   

+  def plurality_pie
+    @election = Election.find(params[:id])
+    @election.results unless @election.plurality_result || @election.approval_result
+    votes = @election.votes.size
+    data = Hash.new
+    names = @election.names_by_id
+    
+    @election.plurality_result.points.each do |candidate, votes|
+      data[names[candidate]] = votes
+    end
+     
+    pie = GruffGraff.new( :graph_type => Gruff::Pie,
+                           :title => "Percentage of First Place Votes",
+                           :data => data)
+    send_data(*pie.output)
+                           
+  end
+  

  private 
  private 

- 

   def get_positions_info(election)
     buckets = Hash.new
     buckets2= Hash.new
     rank_labels = Hash.new
   def get_positions_info(election)
     buckets = Hash.new
     buckets2= Hash.new
     rank_labels = Hash.new

-  
-    election.candidates.each do |candidate|
-      buckets[candidate.id] = []
-      buckets2[candidate.id] = []
-    end
-     
+    
+    #attach the ranking to the candidate's array to which is belongs
+    #creating a key if necessary

     election.votes.each do |vote|
       vote.rankings.each do |ranking|
     election.votes.each do |vote|
       vote.rankings.each do |ranking|

+        
+         unless buckets.has_key?(ranking.candidate_id)
+           buckets[ranking.candidate_id] = []
+         end

         buckets[ranking.candidate_id] << ranking.rank
         buckets[ranking.candidate_id] << ranking.rank

+        

       end
     end
       end
     end

-       
+    
+    #count how many times each candidate has been ranked at a certain level

     buckets.each_pair do |id, array|
       (1..election.candidates.size).each do |i|
     buckets.each_pair do |id, array|
       (1..election.candidates.size).each do |i|

+        buckets2[id] = [] unless buckets2.has_key?(id)

         buckets2[id] << (array.find_all {|rank| rank == i}).size
       end
     end
     
         buckets2[id] << (array.find_all {|rank| rank == i}).size
       end
     end
     

+    #sort by amount of 1st place votes
+    sorted_data = buckets2.values.sort {|a,b| b[0] <=> a[0]}
+    

     election.votes.each do |vote|
       vote.rankings.size.times do |i|
         rank_labels[i] = (i+1).to_s
       end
     end
     election.votes.each do |vote|
       vote.rankings.size.times do |i|
         rank_labels[i] = (i+1).to_s
       end
     end

-   
-    return buckets2.values, rank_labels

     
     

+    return sorted_data, rank_labels   

   end
    
   # generate the data and labels for each graph
   end
    
   # generate the data and labels for each graph


@@ -157,7 +255,8 @@ class GraphController < ApplicationController
     
     # Now I need to create an array with all the times votes were made
     election.votes.each do |vote|
     
     # Now I need to create an array with all the times votes were made
     election.votes.each do |vote|

-        voter_days << Date.parse(vote.time.to_s)
+      next unless vote.time
+      voter_days << Date.parse(vote.time.to_s)

     end
     voter_days.sort!
     
     end
     voter_days.sort!
     


@@ -203,6 +302,7 @@ class GraphController < ApplicationController
     # Will build a graph over time, as each successive interval will have more
     # vote objects  
     election.votes.each do |vote|
     # Will build a graph over time, as each successive interval will have more
     # vote objects  
     election.votes.each do |vote|

+      next unless vote.time

       buckets.keys.sort.each do |inter|
         if vote.time < inter
           buckets[inter] << vote
       buckets.keys.sort.each do |inter|
         if vote.time < inter
           buckets[inter] << vote


@@ -215,15 +315,15 @@ class GraphController < ApplicationController
     # Create the hash for the labels. Each graph has ten columns, and three
     # will be labeled
     if timedelta < 2.hours #under two hours use minutes for labels
     # Create the hash for the labels. Each graph has ten columns, and three
     # will be labeled
     if timedelta < 2.hours #under two hours use minutes for labels

-      labels_hash[0] = starttime.min.to_s
-      labels_hash[(numcols/2)-1] = (starttime + (timedelta/2)).min.to_s
-      labels_hash[numcols-1] = Time.now.min.to_s
-      interval_type = "Minute of the Hour"
+      labels_hash[0] = "Start"
+      labels_hash[(numcols/2)-1] = fmt_decimal((timedelta/120)) #halfway
+      labels_hash[numcols-1] = fmt_decimal((timedelta/60))
+      interval_type = "Minutes After Start"

     elsif timedelta < 2.days #more than 2 hours means use hours for labels
     elsif timedelta < 2.days #more than 2 hours means use hours for labels

-      labels_hash[0] = starttime.hour.to_s
-      labels_hash[(numcols/2)-1] = (starttime + (timedelta/2)).hour.to_s
-      labels_hash[numcols-1] = Time.now.hour.to_s
-      interval_type = "Hour of the Day on 24 hour scale"
+      labels_hash[0] = "Start"
+      labels_hash[(numcols/2)-1] = fmt_decimal((timedelta/7200))
+      labels_hash[numcols-1] = fmt_decimal((timedelta/3600))
+      interval_type = "Hours After Start (Up to 48)"

     else #more than 2 days means use dates for labels
       labels_hash[0] = (Date.parse(starttime.to_s)).to_s
       labels_hash[(numcols/2)-1] = (Date.parse((starttime + (timedelta/2)).to_s)).to_s
     else #more than 2 days means use dates for labels
       labels_hash[0] = (Date.parse(starttime.to_s)).to_s
       labels_hash[(numcols/2)-1] = (Date.parse((starttime + (timedelta/2)).to_s)).to_s


@@ -235,15 +335,17 @@ class GraphController < ApplicationController
     return total_per_interval, labels_hash, interval_type   
   end
   
     return total_per_interval, labels_hash, interval_type   
   end
   

+  def fmt_decimal(number)
+    sprintf( "%0.1f", number)
+  end
+  

   def get_borda_points(result)
   def get_borda_points(result)

-    #points holds how mnay points each candidate has received in array form
-    #becasue Gruff::Bar#data takes only an array

     points = Array.new
     labels = Hash.new
 
     #Populate points with an sorted array from election.votes hash
     #biggest to smallest will go from left to right
     points = Array.new
     labels = Hash.new
 
     #Populate points with an sorted array from election.votes hash
     #biggest to smallest will go from left to right

-    points = result.election.votes.sort do |a, b|
+    points = result.points.sort do |a, b|

       b[1] <=> a[1]
     end.collect {|i| i[1]}
 
       b[1] <=> a[1]
     end.collect {|i| i[1]}
 


@@ -265,5 +367,4 @@ class GraphController < ApplicationController
     end
   return preference_tally
   end
     end
   return preference_tally
   end

-

 end
 end