matchy_matchy 0.1.0

data/.rubocop_todo.yml

@@ -0,0 +1 @@
+# Nothing to do 🍸

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fauxparse@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in matchy_matchy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    matchy_matchy (0.1.0)
+      cry (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cry (0.1.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    json (2.1.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  matchy_matchy!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4.1)
+  simplecov
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Matt Powell
+
+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,118 @@
+# MatchyMatchy
+
+A cute little implementation of the [Stable Match
+algorithm](http://www.nrmp.org/), built by and for
+the [New Zealand Improv Festival](https://nzif.info).
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/e9b46ac5ed632d5c83f6/maintainability)](https://codeclimate.com/github/fauxparse/matchy_matchy/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/e9b46ac5ed632d5c83f6/test_coverage)](https://codeclimate.com/github/fauxparse/matchy_matchy/test_coverage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'matchy_matchy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install matchy_matchy
+
+## Usage
+
+The `MatchMaker` takes two sets of data:
+
+* a `Hash` of `candidates` and their preferred targets
+* a `Hash` of `targets` to tuples containing their preferred targets and the
+  number of candidates they're allowed to select
+
+Calling `perform` on a `MatchMaker` yields an object that can return the
+assignments keyed either `by_candidate` or `by_target`.
+
+```ruby
+candidates = {
+  'Arthur'  => %w[City],
+  'Sunny'   => %w[City Mercy],
+  'Joseph'  => %w[City General Mercy],
+  'Latha'   => %w[Mercy City General],
+  'Darrius' => %w[City Mercy General],
+}
+
+targets = {
+  'Mercy'   => [%w[Darrius Joseph], 2],
+  'City'    => [%w[Darrius Arthur Sunny Latha Joseph], 2],
+  'General' => [%w[Darrius Arthur Joseph Latha], 2],
+}
+
+results = MatchyMatchy::MatchMaker.perform(
+  targets: targets,
+  candidates: candidates
+)
+
+results.by_candidate
+# {
+#  'Arthur'  => 'City',
+#  'Sunny'   => nil,
+#  'Joseph'  => 'General',
+#  'Latha'   => 'General',
+#  'Darrius' => 'City',
+# }
+
+results.by_target
+# {
+#  'Mercy'   => []
+#  'City'    => ['Darrius', 'Arthur'],
+#  'General' => ['Joseph', 'Latha'],
+# }
+```
+
+The `candidates` and `targets` can be pretty much any type of object.  They can
+even clash, which makes it safe to use things like database IDs unambiguously:
+equal objects that are referenced in both collections will be treated separately
+by the `MatchMaker`.
+
+You can also specify the `targets` without an explicit capacity, in which case a
+default capacity of `1` will be assumed:
+
+```ruby
+targets = {
+  'Mercy'   => %w[Darrius Joseph],
+  'City'    => %w[Darrius Arthur Sunny Latha Joseph],
+  'General' => %w[Darrius Arthur Joseph Latha],
+}
+```
+
+## 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](https://github.com/fauxparse/matchy_matchy).
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor
+Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MatchyMatchy project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/fauxparse/matchy_matchy/blob/master/CODE_OF_CONDUCT.md).

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 'matchy_matchy'
+
+# 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/matchy_matchy.rb

@@ -0,0 +1,19 @@
+require 'matchy_matchy/version'
+require 'matchy_matchy/candidate'
+require 'matchy_matchy/target'
+require 'matchy_matchy/match'
+require 'matchy_matchy/matchbook'
+require 'matchy_matchy/match_list'
+require 'matchy_matchy/match_results'
+require 'matchy_matchy/matchmaker'
+
+# An implementation of the Stable Match algorithm.
+#
+# @see MatchyMatchy::MatchMaker
+module MatchyMatchy
+  private_constant :Candidate
+  private_constant :Match
+  private_constant :Matchbook
+  private_constant :MatchList
+  private_constant :Target
+end

data/lib/matchy_matchy/candidate.rb

@@ -0,0 +1,66 @@
+module MatchyMatchy
+  # Represents a candidate in the Stable Match algorithm.
+  # Since the concept of a wrapped object with an ordered list of preferences
+  # is common to both candidates and targets, +Target+ inherits directly
+  # from +Candidate+, so when reading this documentation in that context,
+  # the words ‘candidate’ and ‘target’ should be reversed.
+  class Candidate
+    # Returns the wrapped object being represented by this candidate
+    attr_reader :object
+
+    # Returns an ordered list of this candidate’s preferred targets
+    attr_reader :preferences
+
+    # @param object The object being represented by this candidate.
+    def initialize(object)
+      @object = object
+      @preferences = []
+    end
+
+    # Indicates an order of preference for this candidate’s matches.
+    # The given targets will be appended to any existing preferences.
+    # Returns +self+ to maintain the semantics of `<<`.
+    #
+    # @param targets [Array] One or more targets, in order of preference.
+    def prefer(*targets)
+      preferences.push(*targets)
+      self
+    end
+
+    alias << prefer
+
+    # Returns true if this candidate has expressed a preference for
+    # the given target, false otherwise.
+    #
+    # @param target A target entity
+    # @return [Boolean] True if the candidate prefers the target
+    def include?(target)
+      preferences.include?(target)
+    end
+
+    # Returns true if two candidates’ objects are equal, false otherwise.
+    #
+    # @param other [MatchyMatchy::Candidate] Another object for comparison
+    # @return [Boolean] True if the two candidates are equal, false otherwise
+    def eql?(other)
+      object.eql?(other.object)
+    end
+
+    # Determine the index of the given target within the candidate’s
+    # preferences.
+    #
+    # @param target [MatchyMatchy::Candidate] A target entity to search for
+    # @return [Integer] The target’s position, or +nil+
+    def index(target)
+      preferences.find_index(target)
+    end
+
+    # Returns a string representation of the candidate.
+    # Delegates to the wrapped object.
+    #
+    # @return [String] a string for display
+    def to_s
+      object.to_s
+    end
+  end
+end

data/lib/matchy_matchy/match.rb

@@ -0,0 +1,77 @@
+require 'cry'
+
+module MatchyMatchy
+  # Represents a proposed match in the Stable Match algorithm.
+  class Match
+    include Comparable
+    include Cry
+
+    # Returns the candidate being matched.
+    attr_reader :candidate
+
+    # Returns the (zero-based) index of this match in the candidate’s
+    # preferences.
+    attr_reader :index
+
+    # Initializes the match with a candidate and an index.
+    #
+    # @param candidate [MatchyMatchy::Candidate] A candidate
+    # @param index [Integer] (Zero-based) index of preference to try.
+    #  Defaults to 0, indicating the candidate’s first choice.
+    def initialize(candidate:, index: 0)
+      raise ArgumentError, "candidate does not have #{i+1} choices" \
+        if index > candidate.preferences.size
+
+      @candidate = candidate
+      @index = index
+    end
+
+    # Returns the target of the match by looking it up in the candidate’s
+    # preferences
+    #
+    # @return [MatchyMatchy::Target] The target object
+    def target
+      candidate.preferences[index]
+    end
+
+    # Returns true if two matches are equal.
+    # True if the two matches’ candidates and targets are identical,
+    # respectively.
+    #
+    # @return [Boolean] True if `self` and `other` are equal, false otherwise.
+    def eql?(other)
+      target.eql?(other.target) && candidate.eql?(other.candidate)
+    end
+
+    # Compares two matches, in order of preference within the target.
+    # For comparison to be meaningful, the two matches must have the same
+    # target, and both matches’ candidates must be preferred by the target.
+    #
+    # @param other [MatchyMatchy::Match] A second match for comparison
+    # @return [Integer]
+    #   * negative if `self < other`
+    #   * 0 if `self == other`
+    #   * positive if `self > other`
+    def <=>(other)
+      raise ArgumentError, "matches must have the same target" \
+        unless target == other.target
+      target.index(candidate) <=> target.index(other.candidate)
+    end
+
+    # Returns true if the target also prefers the candidate.
+    #
+    # @return True if target’s preferences include this match’s candidate,
+      #   false otherwise.
+    def mutual?
+      target.include?(candidate)
+    end
+
+    # Rejects the match.
+    # This may be handled by attaching a block with Cry’s `on` semantics:
+    #
+    #   match.on(:reject) { do_something }
+    def reject!
+      publish!(:reject)
+    end
+  end
+end