sapor 0.3.0

data/lib/sapor/single_district_proportional.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+#
+# Statistical Analysis of Polling Results (SAPoR)
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
+#
+# This file is part of SAPoR.
+#
+# SAPoR is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# SAPoR 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 General Public License for more details.
+#
+# You can find a copy of the GNU General Public License in /doc/gpl.txt
+#
+
+module Sapor
+  #
+  # Class representing a proportional electoral system with only one district.
+  #
+  class SingleDistrictProportional
+    def initialize(no_of_seats, denominators_class, threshold = 0, bonus = 0)
+      @no_of_seats = no_of_seats
+      @denominators_class = denominators_class
+      @threshold = threshold
+      @bonus = bonus
+    end
+
+    def project(simulation)
+      threshold = simulation.values.inject(:+).to_f * @threshold
+      quotients = quotients(simulation, threshold)
+      sorted_quotients = quotients.sort { |a, b| b.last <=> a.last }
+      seats = sorted_quotients.map(&:first).slice(0, @no_of_seats)
+      result = create_empty_result(simulation)
+      add_seats_to_result(result, seats)
+      result
+    end
+
+    private
+
+    def create_empty_result(simulation)
+      result = {}
+      simulation.each_key do |choice|
+        result[choice] = 0
+      end
+      result[simulation.max { |a, b| a.last <=> b.last }[0]] = @bonus
+      result[OTHER] = 0
+      result
+    end
+
+    def add_seats_to_result(result, seats)
+      seats.each do |seat|
+        if result.key?(seat)
+          result[seat] += 1
+        else
+          result[seat] = 1
+        end
+      end
+    end
+
+    def quotients(votes, threshold)
+      quotients = []
+      votes.each_pair do |choice, new_value|
+        next if new_value < threshold
+        @denominators_class.get(@no_of_seats).each do |d|
+          quotients << [choice, new_value.to_f / d]
+        end
+      end
+      quotients
+    end
+  end
+end

data/sapor.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+#
+# Statistical Analysis of Polling Results (SAPoR)
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
+#
+# This file is part of SAPoR.
+#
+# SAPoR is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# SAPoR 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 General Public License for more details.
+#
+# You can find a copy of the GNU General Public License in /doc/gpl.txt
+#
+
+Gem::Specification.new do |gem|
+  gem.name = 'sapor'
+  gem.version = '0.3.0'
+  gem.authors = ['Filip van Laenen']
+  gem.email = ['f.a.vanlaenen@ieee.org']
+
+  gem.description = 'SAPoR'
+  gem.summary = 'Statistical Analysis of Polling Results'
+  gem.homepage = 'https://github.com/filipvanlaenen/sapor'
+  gem.license = 'GPL'
+
+  gem.require_paths = ['lib']
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- spec`.split("\n")
+  gem.extra_rdoc_files = %w(LICENSE README.md)
+end

data/spec/integration/area_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+#
+# Statistical Analysis of Polling Results (SAPoR)
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
+#
+# This file is part of SAPoR.
+#
+# SAPoR is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# SAPoR 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 General Public License for more details.
+#
+# You can find a copy of the GNU General Public License in /doc/gpl.txt
+#
+
+require 'spec_helper'
+
+describe Sapor::Area, '#load_election_results' do
+  it 'loads four constituencies for the 2012 election results for Catalonia' do
+    area = Sapor::Area.new
+    catalonia_2012 = area.load_election_results('catalonia-2012.psv')
+    expect(catalonia_2012.size).to eq(4)
+  end
+end

data/spec/integration/poll_spec.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+#
+# Statistical Analysis of Polling Results (SAPoR)
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
+#
+# This file is part of SAPoR.
+#
+# SAPoR is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# SAPoR 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 General Public License for more details.
+#
+# You can find a copy of the GNU General Public License in /doc/gpl.txt
+#
+
+require 'spec_helper'
+
+SAMPLE_FILE = File.join('spec', 'integration', 'sample.poll')
+MAX_ERROR = 0.05
+
+#
+# Logger logging messages to an array.
+#
+class ArrayLogger
+  attr_reader :messages
+
+  def initialize
+    @messages = []
+  end
+
+  def info(message)
+    @messages << message
+  end
+end
+
+#
+# LoggerBuilder that creates ArrayLogger instances.
+#
+class ArrayLoggerBuilder
+  def create_logger
+    ArrayLogger.new
+  end
+end
+
+Sapor::LogFacade.logger_builder = ArrayLoggerBuilder.new
+
+describe Sapor::Poll, '#from_file' do
+  it 'reads a poll from a file and extracts area' do
+    poll = Sapor::Poll.from_file(SAMPLE_FILE)
+    expect(poll.area.area_code).to eq('UT')
+  end
+
+  it 'reads a poll from a file and extracts type' do
+    poll = Sapor::Poll.from_file(SAMPLE_FILE)
+    expect(poll.type).to eq('Election')
+  end
+
+  it 'reads a poll from a file and extracts first result' do
+    poll = Sapor::Poll.from_file(SAMPLE_FILE)
+    expect(poll.result('Red')).to eq(1)
+  end
+
+  it 'reads a poll from a file and extracts last result' do
+    poll = Sapor::Poll.from_file(SAMPLE_FILE)
+    expect(poll.result('Blue')).to eq(3)
+  end
+end
+
+describe Sapor::Poll, '#analyze' do
+  it 'logs “Analyzing as a set of dichotomies...”' do
+    poll = Sapor::Poll.from_file(SAMPLE_FILE)
+    poll.analyze(MAX_ERROR)
+    expect(poll.logger.messages).to include('Analyzing as a set of' \
+                                            ' dichotomies...')
+  end
+
+  it 'logs “Analyzing as a polychotomy...”' do
+    poll = Sapor::Poll.from_file(SAMPLE_FILE)
+    poll.analyze(MAX_ERROR)
+    expect(poll.logger.messages).to include('Analyzing as a polychotomy...')
+  end
+
+  it 'logs “Done.” at the end' do
+    poll = Sapor::Poll.from_file(SAMPLE_FILE)
+    poll.analyze(MAX_ERROR)
+    expect(poll.logger.messages.last).to eq('Done.')
+  end
+
+  it 'logs error estimates' do
+    poll = Sapor::Poll.from_file(SAMPLE_FILE)
+    poll.analyze(MAX_ERROR)
+    expect(poll.logger.messages).to include('Error estimate: ε ≤ 33.3%.')
+  end
+
+  it 'logs MPV and CI(95%) reports from Dichotomies' do
+    poll = Sapor::Poll.from_file(SAMPLE_FILE)
+    poll.analyze(MAX_ERROR)
+    expected_report = 'Most probable fractions and 95% confidence' \
+                      " intervals:\n" \
+                      "Choice    MPF      CI(95%)\n" \
+                      "Yellow   46.3%   22.2%– 74.1%\n" \
+                      "Blue     24.1%    7.4%– 51.9%\n" \
+                      "Green    16.7%    3.7%– 44.4%\n" \
+                      "Red       9.3%    0.0%– 37.0%\n" \
+                      'Other     9.3%    0.0%– 37.0%'
+    expect(poll.logger.messages).to include(expected_report)
+  end
+end

data/spec/integration/sample.poll

@@ -0,0 +1,8 @@
+Area=UT
+Type=Election
+==
+Red=1
+Green=2
+Blue=3
+Yellow=6
+Other=1

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+# Statistical Analysis of Polling Results (SAPoR)
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
+#
+# This file is part of SAPoR.
+#
+# SAPoR is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# SAPoR 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 General Public License for more details.
+#
+# You can find a copy of the GNU General Public License in /doc/gpl.txt
+#
+
+$LOAD_PATH << 'lib'
+require 'sapor'
+
+require 'timeout'
+
+RSpec.configure do |config|
+  config.around do |example|
+    Timeout.timeout(2) do
+      example.run
+    end
+  end
+end

data/spec/unit/area_spec.rb

@@ -0,0 +1,115 @@
+# encoding: utf-8
+#
+# Statistical Analysis of Polling Results (SAPoR)
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
+#
+# This file is part of SAPoR.
+#
+# SAPoR is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# SAPoR 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 General Public License for more details.
+#
+# You can find a copy of the GNU General Public License in /doc/gpl.txt
+#
+
+require 'spec_helper'
+
+NORTH = 'North'
+SOUTH = 'South'
+
+RED = 'Red'
+BLUE = 'Blue'
+
+NORTH_RED_LINE = "#{NORTH} | #{RED} | 5"
+NORTH_BLUE_LINE = "#{NORTH} | #{BLUE} | 6"
+SOUTH_RED_LINE = "#{SOUTH} | #{RED} | 7"
+SOUTH_BLUE_LINE_WITH_THOUSANDS_SEPARATOR = "#{SOUTH} | #{BLUE} | 8,888,888"
+EMPTY_LINE = ' '
+COMMENT = '# A comment'
+BROKEN_LINE = 'Broken line'
+
+describe Sapor::Area, '#lines_to_election_results' do
+  it 'converts a single line to 1 constituency' do
+    area = Sapor::Area.new
+    election_results = area.lines_to_election_results(NORTH_RED_LINE)
+    expect(election_results.size).to eq(1)
+  end
+
+  it 'converts two lines for the same constituency to 1 constituency' do
+    area = Sapor::Area.new
+    lines = [NORTH_RED_LINE, NORTH_BLUE_LINE].join("\n")
+    election_results = area.lines_to_election_results(lines)
+    expect(election_results.size).to eq(1)
+  end
+
+  it 'converts two lines for two constituencies to 2 constituencies' do
+    area = Sapor::Area.new
+    lines = [NORTH_RED_LINE, SOUTH_RED_LINE].join("\n")
+    election_results = area.lines_to_election_results(lines)
+    expect(election_results.size).to eq(2)
+  end
+
+  it 'ignores empty lines' do
+    area = Sapor::Area.new
+    lines = [NORTH_RED_LINE, EMPTY_LINE].join("\n")
+    election_results = area.lines_to_election_results(lines)
+    expect(election_results.size).to eq(1)
+  end
+
+  it 'ignores comments' do
+    area = Sapor::Area.new
+    lines = [NORTH_RED_LINE, COMMENT].join("\n")
+    election_results = area.lines_to_election_results(lines)
+    expect(election_results.size).to eq(1)
+  end
+
+  it 'sets the number of votes for a party in a constituency correctly' do
+    area = Sapor::Area.new
+    election_results = area.lines_to_election_results(NORTH_RED_LINE)
+    expect(election_results[NORTH][RED]).to eq(5)
+  end
+
+  it 'ignores thousands separators' do
+    area = Sapor::Area.new
+    election_results = area.lines_to_election_results(\
+      SOUTH_BLUE_LINE_WITH_THOUSANDS_SEPARATOR)
+    expect(election_results[SOUTH][BLUE]).to eq(8_888_888)
+  end
+
+  it 'raises an ArgumentError when a line is broken' do
+    area = Sapor::Area.new
+    expect { area.lines_to_election_results(BROKEN_LINE) }.to \
+      raise_error(ArgumentError, "Broken line: #{BROKEN_LINE}.")
+  end
+
+  it 'raises an ArgumentError if the same choice is added twice to the same ' \
+     'constituency' do
+    area = Sapor::Area.new
+    lines = [NORTH_RED_LINE, NORTH_RED_LINE].join("\n")
+    expect { area.lines_to_election_results(lines) }.to \
+      raise_error(ArgumentError, "Choice #{RED} appeared twice in " \
+                                 "constituency #{NORTH}.")
+  end
+end
+
+describe Sapor::Area, '#summarize_election_results' do
+  it 'summarizes one result to one result' do
+    area = Sapor::Area.new
+    election_results = area.lines_to_election_results(NORTH_RED_LINE)
+    summary = area.summarize_election_results(election_results)
+    expect(summary[RED]).to eq(5)
+  end
+
+  it 'summarizes results of same choice in two constituencies' do
+    area = Sapor::Area.new
+    lines = [NORTH_RED_LINE, SOUTH_RED_LINE].join("\n")
+    election_results = area.lines_to_election_results(lines)
+    summary = area.summarize_election_results(election_results)
+    expect(summary[RED]).to eq(12)
+  end
+end

data/spec/unit/austria_spec.rb

@@ -0,0 +1,76 @@
+#
+# Statistical Analysis of Polling Results (SAPoR)
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
+#
+# This file is part of SAPoR.
+#
+# SAPoR is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# SAPoR 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 General Public License for more details.
+#
+# You can find a copy of the GNU General Public License in /doc/gpl.txt
+#
+
+require 'spec_helper'
+
+describe Sapor::Austria, '#area_code' do
+  it 'returns AT as the area code' do
+    expect(Sapor::Austria.instance.area_code).to eq('AT')
+  end
+end
+
+describe Sapor::Austria, '#no_of_seats' do
+  it 'returns 183 as the number of seats' do
+    expect(Sapor::Austria.instance.no_of_seats).to eq(183)
+  end
+end
+
+describe Sapor::Austria, '#population_size' do
+  it 'returns a population size of 5,069,929' do
+    expect(Sapor::Austria.instance.population_size).to \
+      eq(5_069_929)
+  end
+end
+
+describe Sapor::Austria, '#seats' do
+  it 'calculates the number of seats for the election of 2017' do
+    results = { 'Österreichische Volkspartei' => 1_595_526,
+                'Sozialdemokratische Partei Österreichs' => 1_361_746,
+                'Freiheitliche Partei Österreichs' => 1_316_442,
+                'NEOS–Das Neue Österreich und Liberales Forum' => 268_518,
+                'Liste Peter Pilz' => 223_544,
+                'Die Grünen–Die Grüne Alternative' => 192_638,
+                'Meine Stimme GILT' => 48_233,
+                'Kommunistische Partei Österreichs' => 39_689,
+                'Die Weissen' => 9_167,
+                'Freie Liste Österreich' => 8_889,
+                'Neue Bewegung für die Zukunft' => 2_724,
+                'Obdachlose in der Politik' => 761,
+                'Sozialistische Linkspartei' => 713,
+                'EU-Austrittspartei' => 693,
+                'Christliche Partei Österreichs' => 425,
+                'Männerpartei' => 221 }
+    seats = Sapor::Austria.instance.seats(results)
+    expect(seats['Österreichische Volkspartei']).to eq(62)
+    expect(seats['Sozialdemokratische Partei Österreichs']).to eq(52)
+    expect(seats['Freiheitliche Partei Österreichs']).to eq(51)
+    expect(seats['NEOS–Das Neue Österreich und Liberales Forum']).to eq(10)
+    expect(seats['Liste Peter Pilz']).to eq(8)
+    expect(seats['Die Grünen–Die Grüne Alternative']).to eq(0)
+    expect(seats['Meine Stimme GILT']).to eq(0)
+    expect(seats['Kommunistische Partei Österreichs']).to eq(0)
+    expect(seats['Die Weissen']).to eq(0)
+    expect(seats['Freie Liste Österreich']).to eq(0)
+    expect(seats['Neue Bewegung für die Zukunft']).to eq(0)
+    expect(seats['Obdachlose in der Politik']).to eq(0)
+    expect(seats['Sozialistische Linkspartei']).to eq(0)
+    expect(seats['EU-Austrittspartei']).to eq(0)
+    expect(seats['Christliche Partei Österreichs']).to eq(0)
+    expect(seats['Männerpartei']).to eq(0)
+  end
+end