swissper 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 1d81d7fa6507c58f7f020445f7e88e23bab3c558
4
+ data.tar.gz: 37f688e1ca9b4f8deda36870af6bb8f9bfbbfab3
5
+ SHA512:
6
+ metadata.gz: 8815a39e425d0a75758f5915cfef36f9366b2c45f38668d7232d00aa7a16108093591ad60ab049546b7430f2373d281b821c627a3cde33b2601596072a16826a
7
+ data.tar.gz: 96bde4fbacf0deacff2e1a29d4da8abf9990f426a1f31739c77289a3360450b0ea18123a097cce1a7f490f22a0cee054d2804226ee49a373b9f78dcf39676a31
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.2.3
5
+ before_install: gem install bundler -v 1.14.3
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in swissper.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 John O'Brien
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,107 @@
1
+ # Swissper
2
+
3
+ Swissper lets you generate swiss pairings for tournaments of all kinds.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'swissper'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install swissper
20
+
21
+ ## Usage
22
+ Use `Swissper.pair(players, options)` where `players` is an array of objects, and `options` is an optional hash of options.
23
+
24
+ The `player` objects you pass can be any type of object you like, so long as there are no duplicates. There is a simple `Swissper::Player` class available for ease of use.
25
+
26
+ ```ruby
27
+ player1 = Swissper::Player.new
28
+ player2 = Swissper::Player.new
29
+
30
+ Swissper.pair([player1, player2])
31
+ # [
32
+ # [#<Swissper::Player:0x007ffc22e456d0 @delta=0, @exclude=[]>, #<Swissper::Player:0x007ffc22e3d318 @delta=0, @exclude=[]>]
33
+ # ]
34
+ ```
35
+
36
+ `Swissper.pair` returns an array of tuples, each of which contains exactly two objects. These objects will be the objects you pass in.
37
+
38
+ ### Making players more likely to play
39
+
40
+ If the player is an object that responds to `delta`, Swissper will weight pairings so that players with similar deltas are more likely to be paired. In a typical tournament, the `delta` value might be the player's ranking, or points they've scored.
41
+
42
+ ```ruby
43
+ jack = Swissper::Player.new
44
+ jack.delta = 3
45
+ jill = Swissper::Player.new
46
+ jill.delta = 3
47
+ hansel = Swissper::Player.new
48
+ hansel.delta = 0
49
+ gretel = Swissper::Player.new
50
+ gretel.delta = 0
51
+
52
+ Swissper.pair([jack, jill, hansel, gretel])
53
+ # outputs:
54
+ [
55
+ [#<Swissper::Player:0x007ffc209fd7a0 @delta=0, @exclude=[]>, #<Swissper::Player:0x007ffc22d34818 @delta=0, @exclude=[]>],
56
+ [#<Swissper::Player:0x007ffc209f4df8 @delta=3, @exclude=[]>, #<Swissper::Player:0x007ffc21846ca8 @delta=3, @exclude=[]>]
57
+ ]
58
+ ```
59
+
60
+ You can customise the method called on the player objects with the `delta_key` option.
61
+
62
+ ```ruby
63
+ Swissper.pair(players, delta_key: :tournament_points)
64
+ # The player objects should respond to `tournament_points`
65
+ ```
66
+
67
+ ### Avoiding specific pairings
68
+
69
+ You're likely to need to avoid repeat pairings, such as players who have already faced each other. You can pass an array of players to be avoided to the `exclude` method of each player.
70
+
71
+ ```ruby
72
+ jack = Swissper::Player.new
73
+ jill = Swissper::Player.new
74
+ hansel = Swissper::Player.new
75
+ gretel = Swissper::Player.new
76
+
77
+ jack.exclude = [jill, hansel]
78
+
79
+ Swissper.pair([jack, jill, hansel, gretel])
80
+ # [
81
+ # [#<Swissper::Player:0x007fe1b89a1f18 @delta=0, @exclude=[]>, #<Swissper::Player:0x007fe1b8bacb78 @delta=0, @exclude=[]>],
82
+ # [#<Swissper::Player:0x007fe1b8bf4428 @delta=0, @exclude=[#<Swissper::Player:0x007fe1b8bacb78 @delta=0, @exclude=[]>, #<Swissper::Player:0x007fe1b89a1f18 @delta=0, @exclude=[]>]>, #<Swissper::Player:0x007fe1b8b15fc0 @delta=0, @exclude=[]>]
83
+ # ]
84
+ ```
85
+
86
+ Players cannot be paired against players returned from the `exclude` method. In this example, Jack was paired with Gretel because that was the only valid remaining opponent for him.
87
+
88
+ You can customise this key with the `exclude_key` option.
89
+
90
+ ```ruby
91
+ Swissper.pair(players, exclude_key: :previous_opponents)
92
+ # Player objects should respond to `previous_opponents`
93
+ ```
94
+
95
+ ## Development
96
+
97
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
98
+
99
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
100
+
101
+ ## Contributing
102
+
103
+ Bug reports and pull requests are welcome on GitHub at https://github.com/muyjohno/swissper.
104
+
105
+ ## License
106
+
107
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "swissper"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/swissper.rb ADDED
@@ -0,0 +1,62 @@
1
+ require 'swissper/version'
2
+ require 'swissper/player'
3
+ require 'graph_matching'
4
+
5
+ module Swissper
6
+ def self.pair(players, options = {})
7
+ Pairer.new(options).pair(players)
8
+ end
9
+
10
+ class Pairer
11
+ def initialize(options = {})
12
+ @delta_key = options[:delta_key] || :delta
13
+ @exclude_key = options[:exclude_key] || :exclude
14
+ end
15
+
16
+ def pair(player_data)
17
+ @players = player_data.shuffle
18
+ graph.maximum_weighted_matching(true).edges.map do |pairing|
19
+ [players[pairing[0]], players[pairing[1]]]
20
+ end
21
+ end
22
+
23
+ private
24
+
25
+ attr_reader :delta_key, :exclude_key, :players
26
+
27
+ def graph
28
+ edges = [].tap do |e|
29
+ players.each_with_index do |player, i|
30
+ players.each_with_index do |opp, j|
31
+ e << [i, j, delta(player,opp)] if permitted?(player, opp)
32
+ end
33
+ end
34
+ end
35
+ GraphMatching::Graph::WeightedGraph.send('[]', *edges)
36
+ end
37
+
38
+ def permitted?(a, b)
39
+ targets(a).include?(b) && targets(b).include?(a)
40
+ end
41
+
42
+ def delta(a, b)
43
+ 0 - (delta_value(a) - delta_value(b))**2
44
+ end
45
+
46
+ def targets(player)
47
+ players - [player] - excluded_opponents(player)
48
+ end
49
+
50
+ def delta_value(player)
51
+ return player.send(delta_key) if player.respond_to?(delta_key)
52
+
53
+ 0
54
+ end
55
+
56
+ def excluded_opponents(player)
57
+ return player.send(exclude_key) if player.respond_to?(exclude_key)
58
+
59
+ []
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,10 @@
1
+ module Swissper
2
+ class Player
3
+ attr_accessor :delta, :exclude
4
+
5
+ def initialize
6
+ @delta = 0
7
+ @exclude = []
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,3 @@
1
+ module Swissper
2
+ VERSION = "0.1.0"
3
+ end
data/swissper.gemspec ADDED
@@ -0,0 +1,30 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'swissper/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "swissper"
8
+ spec.version = Swissper::VERSION
9
+ spec.authors = ["John O'Brien"]
10
+ spec.email = ["strayjohno@gmail.com"]
11
+
12
+ spec.summary = "A Ruby gem for pairing Swiss tournaments"
13
+ spec.description = "This gem allows you to create Swiss pairings for all kinds of tournaments"
14
+ spec.homepage = "https://github.com/muyjohno/swissper"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_dependency "graph_matching", "~> 0.0"
25
+
26
+ spec.add_development_dependency "bundler", "~> 1.14"
27
+ spec.add_development_dependency "rake", "~> 10.0"
28
+ spec.add_development_dependency "rspec", "~> 3.0"
29
+ spec.add_development_dependency "pry", "~> 0.10"
30
+ end
metadata ADDED
@@ -0,0 +1,127 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: swissper
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - John O'Brien
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-03-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: graph_matching
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.14'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.14'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '0.10'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '0.10'
83
+ description: This gem allows you to create Swiss pairings for all kinds of tournaments
84
+ email:
85
+ - strayjohno@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - Gemfile
94
+ - LICENSE.txt
95
+ - README.md
96
+ - Rakefile
97
+ - bin/console
98
+ - bin/setup
99
+ - lib/swissper.rb
100
+ - lib/swissper/player.rb
101
+ - lib/swissper/version.rb
102
+ - swissper.gemspec
103
+ homepage: https://github.com/muyjohno/swissper
104
+ licenses:
105
+ - MIT
106
+ metadata: {}
107
+ post_install_message:
108
+ rdoc_options: []
109
+ require_paths:
110
+ - lib
111
+ required_ruby_version: !ruby/object:Gem::Requirement
112
+ requirements:
113
+ - - ">="
114
+ - !ruby/object:Gem::Version
115
+ version: '0'
116
+ required_rubygems_version: !ruby/object:Gem::Requirement
117
+ requirements:
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ requirements: []
122
+ rubyforge_project:
123
+ rubygems_version: 2.4.5.1
124
+ signing_key:
125
+ specification_version: 4
126
+ summary: A Ruby gem for pairing Swiss tournaments
127
+ test_files: []