irv 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fe22d8d2db89a748b5dc0c9452b40aa714307b835d5b9202b0241475f1cd785
-  data.tar.gz: fa5fade892d5ad2cc30e400d7c2246de1c4fa1c28bf1f0f59de74b6aa944774c
+  metadata.gz: b8a99789b0cbe5756c7d1dfd5666e9096102c748a82dc51c8b032f8c9667fe94
+  data.tar.gz: bf4f6f58576731266a3d825a7bdb910ec1ddd7b355f39f3647bd40262d1f0a01
 SHA512:
-  metadata.gz: 27986dd0a0d5d445dff7d07bb3477d81c964838a7c5fa02ab2029e55a19acb8f4700d194936cdc3ac96fac005f9186e31ba332f0a108eeb8bfdeef6a83eb36b9
-  data.tar.gz: 01a026b38a4c84cad76181d8c0934e637d7852092766f27befaa786edb7c0d71f6226fd740d56bbc75662a69ae83eee5830ce819da2d5293f9a3ec46a9eb8fd5
+  metadata.gz: c4e2ec30b5492857c20edc92587e62f81c0720d0c20005b7c3e1537e82d3d01b865393601fc567b8be517df25d70b25000721c0757ef8b6bdf8c1f31462bd934
+  data.tar.gz: 3125e2cf89fda760e11bc0102feec0411f08d58c16e9d0e5e73e4e633ba30f8200481562f5df071118d632948e0029de7acf3838f76a2e38f762744f3d7a047e

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in irv.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    irv (0.1.0)
+    irv (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,6 @@
 # Irv
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/irv`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem provides [Instant-Runoff Voting](https://en.wikipedia.org/wiki/Instant-runoff_voting) for Ruby program.
 
 ## Installation
 
@@ -22,7 +20,77 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'irv'
+
+irv = Irv.new(['John', 'Paul', 'Ringo', 'George'])
+
+ballots = []
+5.times { ballots << irv.issue_ballot }
+
+ballots[0].fill!(['John', 'George', 'Ringo'])
+ballots[1].fill!(['John', 'Ringo', 'George', 'Paul'])
+ballots[2].fill!(['Paul', 'George', 'Ringo', 'John'])
+ballots[3].fill!(['Ringo', 'Paul', 'George'])
+ballots[4].fill!(['George', 'Ringo', 'John'])
+
+ballots.each { |ballot| irv.poll!(ballot) }
+
+puts irv.winner
+
+# => 'George'
+```
+
+### Why George was choosen in this example?
+
+#### Round 1
+
+|      |A|B|C|D|E|
+|:-:|:-:|:-:|:-:|:-:|:-:|
+|John  |1|1|4|-|3|
+|Paul  |-|4|1|2|-|
+|Ringo |3|2|3|1|2|
+|George|2|3|2|3|1|
+
+John got two first ranked votes. But it wasn't the majority.
+So, Election goes on without last place candidate.
+
+In this case, Paul, Ringo and George got one first ranked vote.
+How was second ranked vote?  Paul got only one vote. Ringo and George got two.
+Therefore Paul got lose in this round.
+
+#### Round 2
+
+|      |A|B|C|D|E|
+|:-:|:-:|:-:|:-:|:-:|:-:|
+|John  |1|1|3|-|3|
+|Ringo |3|2|2|1|2|
+|George|2|3|1|2|1|
+
+John and George got two first ranked votes. Ringo got one.
+So, Ringo got lose in this round
+
+#### Round 3
+
+|      |A|B|C|D|E|
+|:-:|:-:|:-:|:-:|:-:|:-:|
+|John  |1|1|2|-|2|
+|George|2|2|1|1|1|
+
+George got three first ranked votes! It was a majority. So George became winner.
+
+#### If you know these stuff in a Ruby program
+
+```ruby
+# After polled...
+
+result = irv.result
+result.process.each { |pr| puts "round: #{pr.order} /majority: #{pr.majority} / loser: #{pr.loser}" }
+
+# => round: 1 /majority:  / loser: Paul
+# => round: 2 /majority:  / loser: Ringo
+# => round: 3 /majority: George / loser:
+```
 
 ## Development
 

data/Rakefile

@@ -5,4 +5,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "irv"
+require 'bundler/setup'
+require 'irv'
 
 # 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.
@@ -10,5 +11,5 @@ require "irv"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/irv.gemspec

@@ -1,30 +1,31 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "irv/version"
+require 'irv/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "irv"
+  spec.name          = 'irv'
   spec.version       = Irv::VERSION
-  spec.authors       = ["highwide"]
-  spec.email         = ["hochweit728@gmail.com"]
+  spec.authors       = ['highwide']
+  spec.email         = ['hochweit728@gmail.com']
 
-  spec.summary       = %q{Providing a Instant-runoff Voting.}
-  spec.description   = %q{Instant-runoff Voting is a type of ranked preferential voting method. This gem makes it enable Ruby program.}
-  spec.homepage      = "https://github.com/highwide/irv"
-  spec.license       = "MIT"
+  spec.summary       = 'Providing a Instant-runoff Voting.'
+  spec.description   = 'Instant-runoff Voting is a type of ranked preferential voting method. This gem makes it enable Ruby program.'
+  spec.homepage      = 'https://github.com/highwide/irv'
+  spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", '~> 0.71.0'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.71.0'
 end

data/lib/irv/result.rb

@@ -10,12 +10,14 @@ module Irv
       @process = []
       round_order = 1
       round = Round.new(round_order, candidates, ballots.map(&:ranked_candidates))
-      while !round.exist_majority?
+
+      (candidates.count - 1).times do
         @process << round
+        break if round.exist_majority?
+
         round_order += 1
         round = Round.new(round_order, round.next_candidates, round.next_votes)
       end
-      @process << round
     end
 
     def winner

data/lib/irv/round.rb

@@ -2,7 +2,7 @@
 
 module Irv
   class Round
-    attr_reader :order, :majority, :loser
+    attr_reader :order, :tallied_votes, :majority, :loser
 
     def initialize(order, candidates, votes)
       @order = order

data/lib/irv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Irv
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: irv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - highwide
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-23 00:00:00.000000000 Z
+date: 2019-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler