swissper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d81d7fa6507c58f7f020445f7e88e23bab3c558
+  data.tar.gz: 37f688e1ca9b4f8deda36870af6bb8f9bfbbfab3
+SHA512:
+  metadata.gz: 8815a39e425d0a75758f5915cfef36f9366b2c45f38668d7232d00aa7a16108093591ad60ab049546b7430f2373d281b821c627a3cde33b2601596072a16826a
+  data.tar.gz: 96bde4fbacf0deacff2e1a29d4da8abf9990f426a1f31739c77289a3360450b0ea18123a097cce1a7f490f22a0cee054d2804226ee49a373b9f78dcf39676a31

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.14.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swissper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 John O'Brien
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# Swissper
+
+Swissper lets you generate swiss pairings for tournaments of all kinds.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swissper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swissper
+
+## Usage
+Use `Swissper.pair(players, options)` where `players` is an array of objects, and `options` is an optional hash of options.
+
+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.
+
+```ruby
+player1 = Swissper::Player.new
+player2 = Swissper::Player.new
+
+Swissper.pair([player1, player2])
+# [
+#   [#<Swissper::Player:0x007ffc22e456d0 @delta=0, @exclude=[]>, #<Swissper::Player:0x007ffc22e3d318 @delta=0, @exclude=[]>]
+# ]
+```
+
+`Swissper.pair` returns an array of tuples, each of which contains exactly two objects. These objects will be the objects you pass in.
+
+### Making players more likely to play
+
+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.
+
+```ruby
+jack = Swissper::Player.new
+jack.delta = 3
+jill = Swissper::Player.new
+jill.delta = 3
+hansel = Swissper::Player.new
+hansel.delta = 0
+gretel = Swissper::Player.new
+gretel.delta = 0
+
+Swissper.pair([jack, jill, hansel, gretel])
+# outputs:
+[
+  [#<Swissper::Player:0x007ffc209fd7a0 @delta=0, @exclude=[]>, #<Swissper::Player:0x007ffc22d34818 @delta=0, @exclude=[]>],
+  [#<Swissper::Player:0x007ffc209f4df8 @delta=3, @exclude=[]>, #<Swissper::Player:0x007ffc21846ca8 @delta=3, @exclude=[]>]
+]
+```
+
+You can customise the method called on the player objects with the `delta_key` option.
+
+```ruby
+Swissper.pair(players, delta_key: :tournament_points)
+# The player objects should respond to `tournament_points`
+```
+
+### Avoiding specific pairings
+
+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.
+
+```ruby
+jack = Swissper::Player.new
+jill = Swissper::Player.new
+hansel = Swissper::Player.new
+gretel = Swissper::Player.new
+
+jack.exclude = [jill, hansel]
+
+Swissper.pair([jack, jill, hansel, gretel])
+# [
+#   [#<Swissper::Player:0x007fe1b89a1f18 @delta=0, @exclude=[]>, #<Swissper::Player:0x007fe1b8bacb78 @delta=0, @exclude=[]>],
+#   [#<Swissper::Player:0x007fe1b8bf4428 @delta=0, @exclude=[#<Swissper::Player:0x007fe1b8bacb78 @delta=0, @exclude=[]>, #<Swissper::Player:0x007fe1b89a1f18 @delta=0, @exclude=[]>]>, #<Swissper::Player:0x007fe1b8b15fc0 @delta=0, @exclude=[]>]
+# ]
+```
+
+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.
+
+You can customise this key with the `exclude_key` option.
+
+```ruby
+Swissper.pair(players, exclude_key: :previous_opponents)
+# Player objects should respond to `previous_opponents`
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/muyjohno/swissper.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swissper"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/lib/swissper.rb

@@ -0,0 +1,62 @@
+require 'swissper/version'
+require 'swissper/player'
+require 'graph_matching'
+
+module Swissper
+  def self.pair(players, options = {})
+    Pairer.new(options).pair(players)
+  end
+
+  class Pairer
+    def initialize(options = {})
+      @delta_key = options[:delta_key] || :delta
+      @exclude_key = options[:exclude_key] || :exclude
+    end
+
+    def pair(player_data)
+      @players = player_data.shuffle
+      graph.maximum_weighted_matching(true).edges.map do |pairing|
+        [players[pairing[0]], players[pairing[1]]]
+      end
+    end
+
+    private
+
+    attr_reader :delta_key, :exclude_key, :players
+
+    def graph
+      edges = [].tap do |e|
+        players.each_with_index do |player, i|
+          players.each_with_index do |opp, j|
+            e << [i, j, delta(player,opp)] if permitted?(player, opp)
+          end
+        end
+      end
+      GraphMatching::Graph::WeightedGraph.send('[]', *edges)
+    end
+
+    def permitted?(a, b)
+      targets(a).include?(b) && targets(b).include?(a)
+    end
+
+    def delta(a, b)
+      0 - (delta_value(a) - delta_value(b))**2
+    end
+
+    def targets(player)
+      players - [player] - excluded_opponents(player)
+    end
+
+    def delta_value(player)
+      return player.send(delta_key) if player.respond_to?(delta_key)
+
+      0
+    end
+
+    def excluded_opponents(player)
+      return player.send(exclude_key) if player.respond_to?(exclude_key)
+
+      []
+    end
+  end
+end

data/lib/swissper/player.rb

@@ -0,0 +1,10 @@
+module Swissper
+  class Player
+    attr_accessor :delta, :exclude
+
+    def initialize
+      @delta = 0
+      @exclude = []
+    end
+  end
+end

data/lib/swissper/version.rb

@@ -0,0 +1,3 @@
+module Swissper
+  VERSION = "0.1.0"
+end

data/swissper.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swissper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swissper"
+  spec.version       = Swissper::VERSION
+  spec.authors       = ["John O'Brien"]
+  spec.email         = ["strayjohno@gmail.com"]
+
+  spec.summary       = "A Ruby gem for pairing Swiss tournaments"
+  spec.description   = "This gem allows you to create Swiss pairings for all kinds of tournaments"
+  spec.homepage      = "https://github.com/muyjohno/swissper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "graph_matching", "~> 0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: swissper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John O'Brien
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graph_matching
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: This gem allows you to create Swiss pairings for all kinds of tournaments
+email:
+- strayjohno@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/swissper.rb
+- lib/swissper/player.rb
+- lib/swissper/version.rb
+- swissper.gemspec
+homepage: https://github.com/muyjohno/swissper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for pairing Swiss tournaments
+test_files: []