swisspairing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ba88b0ac4cfe33e44110048f6977183d94ba8babfde073352827acb43d97028
+  data.tar.gz: 64f33d60708d7935b05f3c5c903496e6a3ffb6e84767a4c245691ca4d2efa48f
+SHA512:
+  metadata.gz: b6ea11a8f4dc241f77c0835af2b3505ea8db8c28327cd285374996196243351cc3f55f8be215d3e33ae44065e3c2d234a2b7aa5e122e7c5674dbf9b2da7c56e2
+  data.tar.gz: 2c25b7666e8c57ce2d6d0a66b61a62ff1414c5363e37a8059a06d7458b81e6e6c83cc31d4ae4f7410c604ae62e7736ff352d909b3c1a2d75643c516f74236e28

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2025-05-02
+
+### Added
+- Initial release with FIDE-compliant Swiss pairing system
+- Player management with ratings and FIDE titles
+- Tournament management with configurable rounds
+- Color allocation following FIDE rules
+- Bye handling for odd numbers of players
+- Advanced acceleration system for large tournaments
+- Tie-break systems:
+  - Buchholz score
+  - Sonneborn-Berger score
+  - Rating-based sorting
+- Enhanced color allocation with strict FIDE compliance
+- Comprehensive test suite
+- Full documentation with examples

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Lapo Elisacci
+
+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,155 @@
+# SwissPairing
+
+A Ruby gem that implements FIDE-compliant Swiss pairing system for chess tournaments. This gem follows the official FIDE Swiss Rules effective from July 1, 2025.
+
+## Features
+
+- FIDE-compliant Swiss pairing system
+- Handles player ratings and FIDE titles
+- Supports tournament scoring and results
+- Manages color allocation according to FIDE rules
+- Handles byes for odd numbers of players
+- Prevents rematches between players
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swisspairing'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install swisspairing
+```
+
+## Usage
+
+### Creating Players
+
+```ruby
+require 'swisspairing'
+
+# Create players with ratings and optional FIDE titles
+players = [
+  Swisspairing::Player.new(name: "GM Smith", rating: 2500, title: "GM", id: 1),
+  Swisspairing::Player.new(name: "IM Jones", rating: 2400, title: "IM", id: 2),
+  Swisspairing::Player.new(name: "FM Brown", rating: 2300, title: "FM", id: 3),
+  Swisspairing::Player.new(name: "Alice", rating: 2200, id: 4)
+]
+```
+
+### Setting Up a Tournament
+
+```ruby
+# Create a new tournament with players and number of rounds
+tournament = Swisspairing::Tournament.new(players: players, total_rounds: 5)
+```
+
+### Generating Pairings
+
+```ruby
+# Generate pairings for the current round
+pairings = tournament.generate_pairings
+
+# Process each pairing
+pairings.each do |pairing|
+  if pairing.is_bye
+    puts "#{pairing.white.name} receives a bye"
+    tournament.apply_result(pairing, "1")
+  else
+    puts "#{pairing.white.name} (White) vs #{pairing.black.name} (Black)"
+    # After the game, apply the result:
+    # "1-0" for white win
+    # "0-1" for black win
+    # "½-½" for draw
+    tournament.apply_result(pairing, "1-0") # example: white wins
+  end
+end
+```
+
+## Advanced Features
+
+### Acceleration
+
+For tournaments with many players, you can enable acceleration to help stronger players meet each other earlier:
+
+```ruby
+tournament = Swisspairing::Tournament.new(
+  players: players,
+  total_rounds: 5,
+  accelerated: true # Enable acceleration
+)
+```
+
+### Tie-Breaks
+
+The system implements official FIDE tie-break systems:
+
+1. Direct score
+2. Buchholz score (sum of opponents' scores)
+3. Sonneborn-Berger score
+4. Rating
+
+Get tournament standings with tie-breaks:
+
+```ruby
+standings = tournament.standings
+standings.each_with_index do |player, index|
+  puts "#{index + 1}. #{player.name} (#{player.score} pts)"
+end
+```
+
+### Color Allocation
+
+The system follows strict FIDE color allocation rules:
+
+- No player gets the same color three times in a row
+- Color difference cannot exceed +2 or -2
+- Players alternate colors when possible
+- Color allocation considers previous tournament history
+
+## FIDE Compliance
+
+This gem strictly follows FIDE Swiss Rules from the FIDE Handbook C.04:
+
+- C.04.1: Basic Rules for Swiss Systems
+- C.04.2: General Handling Rules
+- C.04.3: FIDE (Dutch) System
+
+Features include:
+- Proper initial ranking by rating and title
+- Score-based pairing groups
+- Correct color allocation rules
+- Acceleration method for large tournaments
+- Official tie-break systems
+- Proper handling of byes and odd numbers of players
+
+## Error Handling
+
+The system includes various safeguards:
+
+```ruby
+begin
+  tournament.generate_pairings
+rescue Swisspairing::Error => e
+  puts "Tournament error: #{e.message}"
+end
+```
+
+Common errors:
+- Tournament already complete
+- Invalid result format
+- Invalid player data
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/swisspairing/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Swisspairing
+  VERSION = "0.1.0"
+end

data/lib/swisspairing.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require_relative "swisspairing/version"
+
+module Swisspairing
+  class Error < StandardError; end
+
+  FIDE_TITLES = %w[GM IM WGM FM WIM CM WFM WCM].freeze
+
+  class Player
+    attr_reader :name, :rating, :title, :id
+    attr_accessor :score, :opponents, :colors
+
+    def initialize(name:, rating:, title: nil, id: nil)
+      @name = name
+      @rating = rating.to_i
+      @title = title if FIDE_TITLES.include?(title)
+      @id = id
+      @score = 0
+      @opponents = []
+      @colors = [] # 'W' for white, 'B' for black, '=' for bye
+    end
+
+    def color_balance
+      colors.count('W') - colors.count('B')
+    end
+
+    def can_receive_bye?
+      !colors.include?('=')
+    end
+
+    def played_against?(player)
+      opponents.include?(player.id)
+    end
+  end
+
+  class Tournament
+    attr_reader :players, :current_round, :total_rounds, :results
+
+    def initialize(players:, total_rounds:, accelerated: false)
+      @players = players
+      @total_rounds = total_rounds
+      @current_round = 0
+      @results = []
+      @accelerated = accelerated
+      validate_and_sort_players
+    end
+
+    def generate_pairings
+      raise Error, "Tournament is complete" if @current_round >= @total_rounds
+
+      @current_round += 1
+      score_groups = players.group_by(&:score).sort_by { |score, _| -score }.to_h
+      pairings = []
+      unpaired_players = []
+
+      score_groups.each do |score, players_in_group|
+        # Add any unpaired players from higher score groups
+        group_players = unpaired_players + players_in_group
+        unpaired_players = []
+
+        while group_players.size >= 2
+          white_candidate = group_players.first
+          possible_opponents = group_players[1..]
+                               .reject { |p| white_candidate.played_against?(p) }
+                               .select { |p| valid_colors?(white_candidate, p) }
+
+          if possible_opponents.empty?
+            unpaired_players << group_players.shift
+            next
+          end
+
+          black_candidate = select_best_opponent(white_candidate, possible_opponents)
+          group_players.delete(black_candidate)
+          group_players.shift # remove white_candidate
+
+          # Determine colors based on previous allocations
+          if should_swap_colors?(white_candidate, black_candidate)
+            pairings << Pairing.new(white: black_candidate, black: white_candidate)
+          else
+            pairings << Pairing.new(white: white_candidate, black: black_candidate)
+          end
+        end
+
+        # Add remaining player to unpaired list for next score group
+        unpaired_players.concat(group_players) if group_players.any?
+      end
+
+      # Handle remaining unpaired player with a bye if necessary
+      if unpaired_players.any?
+        bye_player = select_bye_player(unpaired_players)
+        pairings << Pairing.new(white: bye_player)
+      end
+
+      if @accelerated && @current_round <= 2
+        accelerate_pairings(score_groups)
+      end
+
+      pairings
+    end
+
+    def apply_result(pairing, result)
+      case result
+      when "1-0"
+        pairing.white.score += 1
+      when "0-1"
+        pairing.black.score += 1
+      when "1/2-1/2"
+        pairing.white.score += 0.5
+        pairing.black.score += 0.5
+      when "0-0"
+        # Both players get 0 points (double forfeit)
+      when "1"  # bye
+        pairing.white.score += 1 if pairing.is_bye
+      else
+        raise Error, "Invalid result: #{result}"
+      end
+
+      unless pairing.is_bye
+        pairing.white.opponents << pairing.black.id
+        pairing.black.opponents << pairing.white.id
+        pairing.white.colors << "W"
+        pairing.black.colors << "B"
+      else
+        pairing.white.colors << "="
+      end
+
+      @results << [pairing, result]
+    end
+
+    private
+
+    def validate_and_sort_players
+      # Sort by rating, title, and name as per FIDE rules 2.2
+      @players.sort_by! do |player|
+        [
+          -player.rating,
+          -(FIDE_TITLES.index(player.title) || FIDE_TITLES.length),
+          player.name
+        ]
+      end
+    end
+
+    def accelerate_pairings(score_groups)
+      return unless @accelerated && @current_round <= 2
+
+      # Split players into top and bottom half for acceleration
+      mid_point = (@players.length / 2.0).ceil
+      top_half = @players[0...mid_point]
+      bottom_half = @players[mid_point..]
+
+      # Add virtual point to top half players in first two rounds
+      top_half.each { |p| p.score += 1 } if @current_round <= 2
+    end
+
+    def valid_colors?(player1, player2)
+      return true if player1.colors.empty? || player2.colors.empty?
+
+      # Enhanced color allocation rules
+      [player1, player2].none? do |p|
+        # No more than two same colors in a row
+        p.colors.last(2) == ["W", "W"] || p.colors.last(2) == ["B", "B"] ||
+        # No color difference > 2
+        p.color_balance.abs > 2 ||
+        # No same color three times more than the other
+        p.colors.count("W") > (p.colors.count("B") + 2) ||
+        p.colors.count("B") > (p.colors.count("W") + 2)
+      end
+    end
+
+    def should_swap_colors?(white, black)
+      return true if white.color_balance > black.color_balance + 1
+      return true if white.colors.last == "W" && black.colors.last == "B"
+      false
+    end
+
+    def select_best_opponent(player, candidates)
+      # Select opponent with closest score and rating
+      candidates.min_by do |candidate|
+        [
+          (candidate.score - player.score).abs,
+          (candidate.rating - player.rating).abs
+        ]
+      end
+    end
+
+    def select_bye_player(candidates)
+      # Select player with lowest score who hasn't had a bye
+      candidates.select(&:can_receive_bye?)
+                .min_by { |p| [p.score, p.rating] } || candidates.first
+    end
+  end
+
+  class Pairing
+    attr_reader :white, :black, :is_bye
+
+    def initialize(white:, black: nil)
+      @white = white
+      @black = black
+      @is_bye = black.nil?
+    end
+  end
+end

data/sig/swisspairing.rbs

@@ -0,0 +1,51 @@
+module Swisspairing
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  class Error < StandardError
+  end
+
+  FIDE_TITLES: Array[String]
+
+  class Player
+    attr_reader name: String
+    attr_reader rating: Integer
+    attr_reader title: String?
+    attr_reader id: Integer?
+    attr_accessor score: Float
+    attr_accessor opponents: Array[Integer]
+    attr_accessor colors: Array[String]
+
+    def initialize: (name: String, rating: Integer, ?title: String?, ?id: Integer?) -> void
+    def color_balance: -> Integer
+    def can_receive_bye?: -> bool
+    def played_against?: (Player) -> bool
+  end
+
+  class Tournament
+    attr_reader players: Array[Player]
+    attr_reader current_round: Integer
+    attr_reader total_rounds: Integer
+    attr_reader results: Array[[Pairing, String]]
+
+    def initialize: (players: Array[Player], total_rounds: Integer, ?accelerated: bool) -> void
+    def generate_pairings: -> Array[Pairing]
+    def apply_result: (Pairing, String) -> void
+
+    private
+    def validate_and_sort_players: -> void
+    def accelerate_pairings: (Hash[Float, Array[Player]]) -> void
+    def valid_colors?: (Player, Player) -> bool
+    def should_swap_colors?: (Player, Player) -> bool
+    def select_best_opponent: (Player, Array[Player]) -> Player
+    def select_bye_player: (Array[Player]) -> Player
+  end
+
+  class Pairing
+    attr_reader white: Player
+    attr_reader black: Player?
+    attr_reader is_bye: bool
+
+    def initialize: (white: Player, ?black: Player?) -> void
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: swisspairing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lapo Elisacci
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: This gem provides functionality to create a Swiss pairing system for
+  tournaments, allowing for fair and efficient matchups.
+email:
+- lapoelisacci@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/swisspairing.rb
+- lib/swisspairing/version.rb
+- prd.md
+- sig/swisspairing.rbs
+homepage: https://github.com/LapoElisacci/swisspairing.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/LapoElisacci/swisspairing.git
+  source_code_uri: https://github.com/LapoElisacci/swisspairing.git
+  changelog_uri: https://github.com/LapoElisacci/swisspairing/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: The gem allows to create a Swiss pairing system for tournaments.
+test_files: []