seed_list 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Agora Games
+
+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,103 @@
+# SeedList
+*Seed management for tournament brackets*
+
+## Overview
+
+SeedList is designed for Rails-powered tournament engines that need to persist
+a 1-indexed ordered list of players (ranked low-to-high by skill or past performance)
+and then match them up appropriately in the first round of a bracket.
+
+Players are then matched up according to a strategy specified on a per-instance basis.
+
+See also: https://github.com/agoragames/bracket_tree
+
+## Example
+
+```ruby
+
+class Tournament < ActiveRecord::Base
+  has_many :players
+  seed :players
+end
+
+class Player < ActiveRecord::Base
+  belongs_to :tournament
+end
+```
+
+```ruby
+
+add_column :tournaments, :players_seed_list, :text
+
+```
+
+
+```ruby
+
+t = Tournament.create
+ => #<Tournament id: 2, players_seed_list: #<SeedList::List:0x00000002aeff68 @list=[]>>
+
+p = t.players.create
+ => #<Player id: 16, tournament_id: 2> 
+
+t.reload
+ => #<Tournament id: 2, players_seed_list: #<SeedList::List:0x00000002d342d8 @list=[16]>> 
+
+# Seed numbers start at 1
+p.seed
+ => 1
+
+```
+
+When a player is created, the `id` is pushed to the list in the highest (worst-place) seed
+position. You can then move the seed to another position in the list.
+
+```ruby
+
+3.times { t.players.create }
+
+p.seed = 4
+
+t.reload
+ => #<Tournament id: 2, players_seed_list: #<SeedList::List:0x00000002d342d8 @list=[17, 18, 19, 16]>> 
+
+```
+
+## Strategies
+
+Once your players have been created and moved to the appropriate seed positions, you can use
+the included seeding strategies to match them up appropriately in the first round of the bracket.
+
+You can easily implement your own strategies as well. The initializer must accept an array
+of objects that respond to #seed with an integer, and the #seed method must return an array
+of those objects sorted appropriately as pairs.
+
+```ruby
+
+t.players.map { |p| p.seed }
+ => [1, 2, 3 , 4]
+
+# A Knockout tournament matches players at random. The seed position is irrelevant.
+SeedList::Strategy::Knockout.new(t.players).seed.map { |p| p.seed }
+ => [2, 3, 4, 1]
+
+# A Playoff tournament matches the best players against the worst.
+SeedList::Strategy::Playoff.new(t.players).seed.map { |p| p.seed }
+ => [1, 4, 2, 3]
+
+# An Amateur tournament matches by skill similarity straight down
+SeedList::Strategy::Playoff.new(t.players).seed.map { |p| p.seed }
+ => [1, 2, 3, 4]
+
+```
+## License
+
+See the [MIT-LICENSE](https://github.com/agoragames/seed_list/blob/master/MIT-LICENSE) file.
+
+## Contributions
+
+Contributions are awesome. Feature branch pull requests are the preferred method.
+
+## Author
+
+Written by [Logan Koester](https://github.com/logankoester)

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SeedList'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/seed_list/list.rb

@@ -0,0 +1,36 @@
+module SeedList
+  class List
+    def initialize(*seeds)
+      @list = Array.new(seeds)
+    end
+
+    def move(s, i)
+      i -= 1
+      index = @list.index s
+      @list.delete_at index if index < i
+      @list.insert(i, s).uniq!
+      self
+    end
+
+    def unshift(s)
+      @list.unshift(s).uniq!
+      self
+    end
+
+    def push(s)
+      @list.push(s).uniq!
+      self
+    end
+
+    def delete(s)
+      @list.delete_if { |e| e == s }
+      self
+    end
+
+    def find(s)
+      i = @list.index(s)
+      i.nil? ? nil : i + 1
+    end
+
+  end
+end

data/lib/seed_list/model.rb

@@ -0,0 +1,38 @@
+module SeedList
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def seed(assoc_name)
+        assoc_name = assoc_name.to_s
+
+        eval "serialize :#{assoc_name}_seed_list, SeedList::List"
+
+        assoc_name.classify.constantize.class_eval <<-CODE
+          after_create  do |p| 
+            p.#{self.name.downcase}.#{assoc_name}_seed_list.push(p.id)
+            p.#{self.name.downcase}.save
+          end
+
+          after_destroy do |p|
+            p.#{self.name.downcase}.#{assoc_name}_seed_list.delete(p.id)
+            p.#{self.name.downcase}.save
+          end
+
+          def seed
+            #{self.name.downcase}.#{assoc_name}_seed_list.find(id)
+          end
+
+          def seed=(n)
+            #{self.name.downcase}.#{assoc_name}_seed_list.move(id, n)
+            #{self.name.downcase}.save
+          end
+        CODE
+
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, SeedList::Model

data/lib/seed_list/strategy.rb

@@ -0,0 +1,59 @@
+# Strategy classes are responsible for matching up players against each other
+# in the first round of a bracket. A strategy is chosen for each tournament by the host.
+#
+# Player objects have a numeric property #seed, which is set at creation
+# and may be reordered by the host. These positions are ranked by skill from 
+# best (1) to worst (max).
+#
+# When the Bracket is generated, the players are sorted in accordance with the
+# chosen strategy logic.
+module SeedList
+  module Strategy
+    class Base
+      attr_accessor :players
+      def initialize(players); @players = players; end
+      def seed; raise 'Abstract method called'; end
+    end
+
+    # Players matched against each other at random. A player's seed position is
+    # completely irrelevant.
+    class Knockout < Base
+      def seed
+        @players.shuffle
+      end
+    end
+
+    # Best matched against worst, second best against second worst, and so on.
+    # Optimized for serious players and viewer entertainment.
+    class Playoff < Base
+      def seed
+        input, output = @players.clone, []
+        input.size.times { |i| output << (i.even? ? input.shift : input.pop) }
+        output
+      end
+    end
+
+    # TODO This strategy is implemented incorrectly, with an associated pending test.
+    # Best matched against worst, second best against second worst, and so on.
+    # Ensures that if the higher seed wins, he will always face someone from the 
+    # lower half in the next round.
+    class MLGPlayoff < Base
+      def seed
+        input, sequence, pairs, output = @players.clone, [], [], []
+        input.size.times { |i| sequence << (i.even? ? input.shift : input.pop) }
+        loop { pairs << sequence.shift(2); break if sequence.empty? }
+        pairs.size.times { |i| output << (i.even? ? pairs.shift : pairs.pop) }
+        output.flatten
+      end
+    end
+
+    # Matched by similar skill straight through; best on the top, worst on the bottom.
+    # Optimized for friendly tournaments with diversely skilled players (to prevent casual
+    # players from being knocked out right away).
+    class Amateur < Base
+      def seed
+        @players.sort { |a,b| a.seed <=> b.seed }
+      end
+    end
+  end
+end

data/lib/seed_list/version.rb

@@ -0,0 +1,3 @@
+module SeedList
+  VERSION = "0.0.1"
+end

data/lib/seed_list.rb

@@ -0,0 +1,7 @@
+require 'seed_list/version'
+require 'seed_list/list'
+require 'seed_list/model'
+require 'seed_list/strategy'
+
+module SeedList
+end

data/lib/tasks/seed_list_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :seed_list do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: seed_list
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Logan Koester
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &6890660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *6890660
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &6889020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6889020
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &6887580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6887580
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &7428560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7428560
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &7427160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7427160
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: &7426500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7426500
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: &7425200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7425200
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: &7423820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7423820
+description: SeedList is designed for Rails-powered tournament engines that need to
+  persist a 1-indexed ordered list of players (ranked low-to-high by skill or past
+  performance) and then match them up appropriately in the first round of a bracket.
+email:
+- lkoester@majorleaguegaming.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/seed_list/strategy.rb
+- lib/seed_list/list.rb
+- lib/seed_list/version.rb
+- lib/seed_list/model.rb
+- lib/tasks/seed_list_tasks.rake
+- lib/seed_list.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/agoragames/seed_list
+licenses: []
+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: 1687580428413640907
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1687580428413640907
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Seed management for tournament brackets
+test_files: []