vote-schulze 0.2.0 → 0.4.0

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

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/examples/vote4names.list

@@ -0,0 +1,6 @@
+4
+3=alpha;charlie;delta;bravo
+9=bravo;alpha;charlie;delta
+8=charlie;delta;alpha;bravo
+5=delta;alpha;bravo;charlie
+5=delta;bravo;charlie;alpha

data/exe/vote-schulze

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'vote/schulze'
+
+class Cli
+  def self.call
+    new.call
+  end
+
+  def initialize
+    @options = parse_options
+    @input_file = @options[:input_file]
+  end
+
+  def parse_options # rubocop:disable Metrics/MethodLength
+    {}.tap do |options|
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: vote-schulze [options]'
+
+        opts.on('-f FILE', '--file FILE', 'Input file with voting data') do |file|
+          options[:input_file] = file
+        end
+
+        # opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        #   options[:verbose] = v
+        # end
+
+        opts.on('-h', '--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+      end.parse!
+    end
+  end
+
+  def call
+    voting_data = File.open(@input_file)
+    voting = Vote::Schulze.basic(voting_data)
+    puts <<~RESULTDATA
+      Voting data:
+
+      Total amount of candidates: #{format('%5<count>i', count: voting.candidate_count)}
+      Total amount of voters:     #{format('%5<count>i', count: voting.voting_count)}
+
+      Voting result as ABC ranking:
+
+      #{voting.ranking_abc}
+
+      Note: Number represents position, 1=winner(s);
+            always listed as there can be more on same position.
+    RESULTDATA
+  end
+end
+
+Cli.call

data/lib/vote/matrix.rb

@@ -1,15 +1,13 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
-# extend matrix with method []=(i,j,v)
-# usage: m = ::Matrix.scalar(size,value).extend(Vote::Matrix)
+require 'matrix'
 
+# extend matrix with method []=(i, j, v)
+# usage: m = ::Matrix.scalar(size, value).extend(Vote::Matrix)
 module Vote
   module Matrix
-
-    def []=(i,j,v)
+    def []=(i, j, v) # rubocop:disable Naming/MethodParameterName
       @rows[i][j] = v
     end
-
   end
 end
-

data/lib/vote/schulze/basic.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Vote
+  module Schulze
+    class Basic
+      # All-in-One class method to get a calculated SchulzeBasic object
+      def self.call(voting_data, candidate_count = nil)
+        new(voting_data, candidate_count).call
+      end
+
+      attr_reader :voting_matrix, :play_matrix, :result_matrix,
+                  :ranking, :ranking_abc, :candidate_count, :voting_count,
+                  :candidate_names, :votes
+
+      def initialize(voting_data, candidate_count = nil)
+        unless voting_data.is_a?(Vote::Schulze::Input)
+          voting_data = Vote::Schulze::Input.new(voting_data, candidate_count)
+        end
+        @voting_matrix = voting_data.voting_matrix
+        @candidate_count = voting_data.candidate_count
+        @voting_count = voting_data.voting_count
+        @candidate_names = voting_data.candidate_names
+        @votes = voting_data.votes
+        @play_matrix = ::Matrix.scalar(@candidate_count, 0).extend(Vote::Matrix)
+        @result_matrix = ::Matrix.scalar(@candidate_count, 0).extend(Vote::Matrix)
+      end
+
+      def call
+        tap do
+          find_matches_with_wins
+          find_strongest_paths
+          calculate_result
+          calculate_ranking
+          calculate_ranking_abc
+        end
+      end
+
+      private
+
+      def find_matches_with_wins
+        @candidate_count.times do |i|
+          @candidate_count.times do |j|
+            next if i == j
+
+            @play_matrix[i, j] = @voting_matrix[i, j] if @voting_matrix[i, j] > @voting_matrix[j, i]
+          end
+        end
+      end
+
+      def find_strongest_paths # rubocop:disable Metrics/MethodLength
+        @candidate_count.times do |i|
+          @candidate_count.times do |j|
+            next if i == j
+
+            @candidate_count.times do |k|
+              next if i == k
+              next if j == k
+
+              @play_matrix[j, k] = [
+                @play_matrix[j, k],
+                [@play_matrix[j, i], @play_matrix[i, k]].min
+              ].max
+            end
+          end
+        end
+      end
+
+      def calculate_result
+        @result_matrix.each_with_index do |e, x, y|
+          next if x == y
+
+          @result_matrix[x, y] = e + 1 if @play_matrix[x, y] > @play_matrix[y, x]
+        end
+      end
+
+      def calculate_ranking
+        @ranking = @result_matrix.row_vectors.map(&:sum)
+      end
+
+      def calculate_ranking_abc
+        @ranking_abc =
+          @ranking
+          .map.with_index { |e, i| [e, @candidate_names[i]] }
+          .sort
+          .reverse
+          .map do |(idx, name)|
+            "#{name.length == 1 ? name.upcase : name}:#{@ranking.max - idx + 1}"
+          end
+      end
+    end
+  end
+end

data/lib/vote/schulze/input.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Vote
+  module Schulze
+    class Input
+      attr_reader :candidate_count, :voting_count, :voting_matrix,
+                  :candidate_names, :votes
+
+      def initialize(voting_data, candidate_count = nil)
+        @voting_data = voting_data
+        @candidate_count = candidate_count
+
+        if @candidate_count.nil?
+          insert_voting_file(@voting_data) if voting_data.is_a?(File)
+        else
+          @voting_matrix = ::Matrix.scalar(@candidate_count, 0).extend(Vote::Matrix)
+          insert_voting_array(@voting_data) if voting_data.is_a?(Array)
+          insert_voting_string(@voting_data) if voting_data.is_a?(String)
+        end
+      end
+
+      def insert_voting_array(voting_array)
+        @votes = voting_array
+        voting_array.each do |vote|
+          @voting_matrix.each_with_index do |_e, x, y|
+            next if x == y
+
+            @voting_matrix[x, y] += 1 if vote[x] > vote[y]
+          end
+        end
+        @voting_count = voting_array.size
+      end
+
+      def insert_voting_string(voting_string) # rubocop:todo all
+        voting_array = []
+        voting_string.split(/\n|\n\r|\r/).each do |voter|
+          voter = voter.split('=')
+          vcount = voter.size == 1 ? 1 : voter[0].to_i
+
+          tmp = voter.last.split(';')
+          tmp2 = []
+
+          tmp.map! { |e| [e, @candidate_count - tmp.index(e)] }
+          # find equal-weighted candidates
+          tmp.map do |e|
+            if e[0].size > 1
+              e[0].split(',').each do |f|
+                tmp2 << [f, e[1]]
+              end
+            else
+              tmp2 << e
+            end
+          end
+
+          @candidate_names ||= tmp2.map { |e| e[0] }.sort
+          vote = tmp2.sort.map { |e| e[1] } # order, strip & add
+          vcount.times do
+            voting_array << vote
+          end
+        end
+
+        insert_voting_array(voting_array)
+      end
+
+      def insert_voting_file(voting_file)
+        voting_file.rewind
+        @candidate_count = voting_file.first.strip.to_i # reads first line for count
+        @voting_matrix = ::Matrix.scalar(@candidate_count, 0).extend(Vote::Matrix)
+        insert_voting_string(voting_file.read) # reads rest of file (w/o line 1)
+        voting_file.close
+      end
+    end
+  end
+end

data/lib/vote/schulze/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Vote
+  module Schulze
+    VERSION = '0.4.0'
+  end
+end

data/lib/vote/schulze.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'vote/matrix'
+require 'vote/schulze/input'
+require 'vote/schulze/basic'
+
+module Vote
+  # Consult README.md for usage
+  module Schulze
+    # Shortcut to Vote::Schulze::Basic.call(...)
+    def self.basic(*arguments)
+      Basic.call(*arguments)
+    end
+  end
+end

data/lib/vote.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-module Vote
-  autoload :Condorcet, 'vote/condorcet'
-end
+# frozen_string_literal: true
 
+require 'vote/schulze'

data/lib/vote_schulze.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'vote/schulze'

data/vote-schulze.gemspec

@@ -1,67 +1,41 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name = %q{vote-schulze}
-  s.version = "0.2.0"
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vote/schulze/version'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Christoph Grabo"]
-  s.date = %q{2011-05-22}
-  s.description = %q{This gem is a Ruby implementation of the Schulze voting method (with help of the Floyd–Warshall algorithm), a type of the Condorcet voting methods.}
-  s.email = %q{chris@dinarrr.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    ".rvmrc",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "examples/vote4.list",
-    "examples/vote6.list",
-    "lib/vote-schulze.rb",
-    "lib/vote.rb",
-    "lib/vote/condorcet.rb",
-    "lib/vote/condorcet/schulze.rb",
-    "lib/vote/condorcet/schulze/basic.rb",
-    "lib/vote/condorcet/schulze/input.rb",
-    "lib/vote/condorcet/schulze/win_and_lost.rb",
-    "lib/vote/matrix.rb",
-    "spec/spec_helper.rb",
-    "spec/vote-schulze_spec.rb",
-    "vote-schulze.gemspec"
-  ]
-  s.homepage = %q{http://github.com/asaaki/vote-schulze}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Schulze method implementation in Ruby (Condorcet voting method)}
+Gem::Specification.new do |spec|
+  spec.name          = 'vote-schulze'
+  spec.version       = Vote::Schulze::VERSION
+  spec.authors       = ['Christoph Grabo']
+  spec.email         = ['asaaki@mannaz.cc']
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  spec.summary       = 'Schulze method implementation (a type of the Condorcet method)'
+  spec.description   = 'This gem is a Ruby implementation of the Schulze voting method (using Floyd–Warshall ' \
+                       'algorithm), a type of the Condorcet voting methods.'
+  spec.homepage      = 'https://github.com/asaaki/vote-schulze'
+  spec.license       = 'MIT'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
-    else
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-    end
-  else
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 3.0'
+
+  spec.add_runtime_dependency 'matrix', '>= 0.4.2'
 
+  spec.add_development_dependency 'bundler', '~> 2.4'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.50'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.10'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.22'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -1,108 +1,187 @@
 --- !ruby/object:Gem::Specification
 name: vote-schulze
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Christoph Grabo
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2011-05-22 00:00:00.000000000 +02:00
-default_executable: 
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: matrix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &28284620 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *28284620
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &28284140 !ruby/object:Gem::Requirement
-    none: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '13.0'
   type: :development
   prerelease: false
-  version_requirements: *28284140
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &28283660 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '1.50'
   type: :development
   prerelease: false
-  version_requirements: *28283660
-description: This gem is a Ruby implementation of the Schulze voting method (with
-  help of the Floyd–Warshall algorithm), a type of the Condorcet voting methods.
-email: chris@dinarrr.com
-executables: []
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+description: This gem is a Ruby implementation of the Schulze voting method (using
+  Floyd–Warshall algorithm), a type of the Condorcet voting methods.
+email:
+- asaaki@mannaz.cc
+executables:
+- vote-schulze
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 files:
-- .document
-- .rspec
-- .rvmrc
+- ".editorconfig"
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/dependabot-auto-merge.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
+- bin/console
+- bin/rspec
+- bin/rubocop
+- bin/setup
 - examples/vote4.list
+- examples/vote4names.list
 - examples/vote6.list
-- lib/vote-schulze.rb
+- exe/vote-schulze
 - lib/vote.rb
-- lib/vote/condorcet.rb
-- lib/vote/condorcet/schulze.rb
-- lib/vote/condorcet/schulze/basic.rb
-- lib/vote/condorcet/schulze/input.rb
-- lib/vote/condorcet/schulze/win_and_lost.rb
 - lib/vote/matrix.rb
-- spec/spec_helper.rb
-- spec/vote-schulze_spec.rb
+- lib/vote/schulze.rb
+- lib/vote/schulze/basic.rb
+- lib/vote/schulze/input.rb
+- lib/vote/schulze/version.rb
+- lib/vote_schulze.rb
 - vote-schulze.gemspec
-has_rdoc: true
-homepage: http://github.com/asaaki/vote-schulze
+homepage: https://github.com/asaaki/vote-schulze
 licenses:
 - MIT
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -2878999466654239120
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.6.2
-signing_key: 
-specification_version: 3
-summary: Schulze method implementation in Ruby (Condorcet voting method)
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: Schulze method implementation (a type of the Condorcet method)
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt