swissper 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d81d7fa6507c58f7f020445f7e88e23bab3c558
-  data.tar.gz: 37f688e1ca9b4f8deda36870af6bb8f9bfbbfab3
+  metadata.gz: 472c0070be8d6f75e08bdacb6b93886408bda5fd
+  data.tar.gz: be5dd1b4d7c781faa1ba395b35a65b5d982e0e05
 SHA512:
-  metadata.gz: 8815a39e425d0a75758f5915cfef36f9366b2c45f38668d7232d00aa7a16108093591ad60ab049546b7430f2373d281b821c627a3cde33b2601596072a16826a
-  data.tar.gz: 96bde4fbacf0deacff2e1a29d4da8abf9990f426a1f31739c77289a3360450b0ea18123a097cce1a7f490f22a0cee054d2804226ee49a373b9f78dcf39676a31
+  metadata.gz: de53e20408c56dbe56d59e2d1b8a450bd76c0815f02d141869b705ded29f5f58fa26a8d80b3cc2e341debeeaebac730b2c455aab7fda1323794acb4931ddf564
+  data.tar.gz: 52424d4134fdeaa160d7797cbde272b7033ed2bb9461206d1c525573069534af0459b2ccb896b40b9e45669d3b95557a090bc3f0eebc2ab7792a78595ec0fef3

data/.gitignore

@@ -8,5 +8,7 @@
 /spec/reports/
 /tmp/
 
+*.gem
+
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -19,6 +19,7 @@ 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.
@@ -92,6 +93,29 @@ Swissper.pair(players, exclude_key: :previous_opponents)
 # Player objects should respond to `previous_opponents`
 ```
 
+## Byes
+
+If your array of players contains an odd number, one player will be paired with the `Swissper::Bye` class.
+
+You can prevent players from receiving byes (e.g. if they've already received one) by passing `Swissper::Bye` in the `exclude` parameter of any player.
+
+```ruby
+snap = Swissper::Player.new
+crackle = Swissper::Player.new
+pop = Swissper::Player.new
+
+snap.exclude = [Swissper::Bye]
+crackle.exclude = [Swissper::Bye]
+
+Swissper.pair([snap, crackle, pop])
+# [
+#   [Swissper::Bye, #<Swissper::Player:0x007fb2f99cb838 @delta=0, @exclude=[]>],
+#   [#<Swissper::Player:0x007fb2f9accac0 @delta=0, @exclude=[Swissper::Bye]>, #<Swissper::Player:0x007fb2f91a8f98 @delta=0, @exclude=[Swissper::Bye]>]
+# ]
+```
+
+Please don't manually pass in `Swissper::Bye` in your array of players, passing in an odd-length array is the correct way to use byes.
+
 ## 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.

data/lib/swissper/bye.rb

@@ -0,0 +1,4 @@
+module Swissper
+  class Bye
+  end
+end

data/lib/swissper/version.rb

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

data/lib/swissper.rb

@@ -1,5 +1,6 @@
 require 'swissper/version'
 require 'swissper/player'
+require 'swissper/bye'
 require 'graph_matching'
 
 module Swissper
@@ -14,7 +15,7 @@ module Swissper
     end
 
     def pair(player_data)
-      @players = player_data.shuffle
+      @player_data = player_data
       graph.maximum_weighted_matching(true).edges.map do |pairing|
         [players[pairing[0]], players[pairing[1]]]
       end
@@ -22,7 +23,7 @@ module Swissper
 
     private
 
-    attr_reader :delta_key, :exclude_key, :players
+    attr_reader :delta_key, :exclude_key
 
     def graph
       edges = [].tap do |e|
@@ -58,5 +59,11 @@ module Swissper
 
       []
     end
+
+    def players
+      @players ||= @player_data.clone.tap do |data|
+        data << Swissper::Bye unless data.length.even?
+      end.shuffle
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swissper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - John O'Brien
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graph_matching
@@ -97,8 +97,10 @@ files:
 - bin/console
 - bin/setup
 - lib/swissper.rb
+- lib/swissper/bye.rb
 - lib/swissper/player.rb
 - lib/swissper/version.rb
+- swissper-0.1.0.gem
 - swissper.gemspec
 homepage: https://github.com/muyjohno/swissper
 licenses:
@@ -120,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for pairing Swiss tournaments