tcollier-sommelier 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aec6ab221e7b53607609c6a5f7b3f84945461bb
-  data.tar.gz: a759cd1e83e4933366ae5b28d2fffb806d5c8ace
+  metadata.gz: b069aee84c44d4bde4c6482d81c47b8bfcf7ae65
+  data.tar.gz: 4f8b1044d8973656f19dd921a1e6051edd87869d
 SHA512:
-  metadata.gz: 43f4525771fec89eb6fc7703eb0503d15439c8c78c4ae5c7867eadcaae80c28ad208cc04818074b51908231de9a06068d58b1a83f0df9c21d06b8823d54c072e
-  data.tar.gz: c39b125857e32674f126970486399b3d9d98d47b44ab2960aade9c7cbcc920db8d6ab71a438094d1881a5ff29149c3ecfed166ae7c65d0b6b9ad306f9828b7af
+  metadata.gz: 459dc2eef3cddd6194f42ded392a32ed3e166759fb30b0edb4216215de9c47aef588fbcc1d51aed19ea5d6454cde51b2f6b995fce1a509977add818e73e609c7
+  data.tar.gz: 40fca90df92292e7f5e29810ae039094f155661f7e45a5ad04662b8a446515dedeefe98a11e282a82cb0630dfac2565f8415674449e5b48d04e5127e213dc20c

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.4.4
+  - 2.5.1
+branches:
+  only: master

data/CHANGELOG.txt

@@ -1,3 +1,7 @@
-Version 0.1.0, 2018-07-20
+Version 0.2.0, 2018-07-21
 -------------------------
-e66dc58 Initial release with Gale-Shapely variant
+fab29e5 Add rake task to apply Sommelier to a CSV
+
+Version 0.1.0, 2018-07-21
+-------------------------
+b5c4925 Initial release with Gale-Shapely variant

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/tcollier/sommelier.svg?branch=master)](https://travis-ci.org/tcollier/sommelier)
+
 # Sommelier
 
 Sommelier provides a solution to a variant of the Stable Marriage problem in
@@ -11,7 +13,7 @@ restaurant menu and the brides-to-be are wines.
 The [Stable Marriage Problem](https://en.wikipedia.org/wiki/Stable_marriage_problem)
 is a mathematical problem that attempts to uniquely match a set of _N_ items
 (classically male suitors) with another set of _N_ items (classically females the
-suitors wish to marry). The final matches are referred to as proposals.
+suitors wish to marry).
 
 ## Gale-Shapely Algorithm
 
@@ -23,17 +25,18 @@ this is not always practical.
 
 ## Variation
 
-The algorithm applied here has 2 primary differences from Gale-Shapely
+The algorithm applied here has a few key differences from Gale-Shapely
 
-1. Neither suitors nor suitees need to have a complete ranking of the other set.
-2. The rankings are determined by a symmetrical match score. For example, the match
-score for Alice and Steve is the same as for Steve and Alice. Though scores are
-relative, so Alice's match score for Steve may be her highest scoring match, but
-that same score may only be the fifth highest scoring match for Steve.
+1. The number of dishes and wines do not need to be equal.
+2. Neither dishes nor wines need to have a complete ranking of the other set.
+3. The rankings are determined by a symmetrical match score. For example, the match
+score for Eggplant and Cabernet is the same as for Cabernet and Eggplant. Though scores are
+relative, so Eggplant's match score for Cabernet may be its highest scoring match, but
+that same score may only be the fifth highest scoring match for Cabernet.
 
-Because of these differences, not every suitor or suitee is guaranteed to have
-a proposal. Swapping the suitor and suitee sets can have dramatic effects on the
-final set of proposals.
+Because of these differences, not every dish or wine is guaranteed to be in the
+pairings map. Swapping the dish and wine sets in the match catalog alter the final
+set of pairings.
 
 ## Usage
 
@@ -51,16 +54,49 @@ sommelier = Sommelier.new
 sommelier.add_match('Asparagus', 'Pinot Noir', 0.366)
 sommelier.add_match('Asparagus', 'Sauvignon Blanc', 0.453)
 sommelier.add_match('Asparagus', 'Chardonnay', 0.245)
-sommelier.add_match('Tofu', 'Rose', 0.486)
+sommelier.add_match('Tofu', 'Rosé', 0.486)
 sommelier.add_match('Tofu', 'Sauvignon Blanc', 0.304)
 sommelier.add_match('Eggplant', 'Sauvignon Blanc', 0.299)
 sommelier.add_match('Salmon', 'Sauvignon Blanc', 0.602)
 puts sommelier.pairings
 # {
 #   "Salmon" => "Sauvignon Blanc",
-#   "Tofu" => "Rose",
+#   "Tofu" => "Rosé",
 #   "Asparagus" => "Pinot Noir"
 # }
 
 # Note: neither "Eggplant" nor "Chardonnay" were matched in the pairings map
 ```
+
+### CSV
+
+This gem provides a rake task to apply the Sommelier algorithm to a CSV file.
+The file must have a header row and the columns are expected to be in the following
+order:
+
+1. `dish`
+2. `wine`
+3. `score`
+
+Note: the header row is simply ignored, so the columns can be named anything.
+
+Any additional columns will be ignored.
+
+```csv
+# matches.csv
+dish,wine,score
+Asparagus,Pinot Noir,0.366
+Asparagus,Sauvignon Blanc,0.453
+Asparagus,Chardonnay,0.245
+Tofu,Rosé,0.486
+Tofu,Sauvignon Blanc,0.304
+Eggplant,Sauvignon Blanc,0.299
+Salmon,Sauvignon Blanc,0.602
+```
+
+```bash
+rake sommelier:from_csv matches.csv
+# Salmon => Sauvignon Blanc
+# Tofu => Rosé
+# Asparagus => Pinot Noir
+```

data/Rakefile

@@ -1,5 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'sommelier'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/sommelier.rb

@@ -1,3 +1,6 @@
+require 'rake'
+load 'tasks/sommelier.rake'
+
 require_relative 'sommelier/match_maker'
 require_relative 'sommelier/match_catalog'
 
@@ -11,14 +14,14 @@ require_relative 'sommelier/match_catalog'
 #   sommelier.add_match('Asparagus', 'Pinot Noir', 0.366)
 #   sommelier.add_match('Asparagus', 'Sauvignon Blanc', 0.453)
 #   sommelier.add_match('Asparagus', 'Chardonnay', 0.245)
-#   sommelier.add_match('Tofu', 'Rose', 0.486)
+#   sommelier.add_match('Tofu', 'Rosé', 0.486)
 #   sommelier.add_match('Tofu', 'Sauvignon Blanc', 0.304)
 #   sommelier.add_match('Eggplant', 'Sauvignon Blanc', 0.299)
 #   sommelier.add_match('Salmon', 'Sauvignon Blanc', 0.602)
 #   puts sommelier.pairings
 #   # {
 #   #   "Salmon" => "Sauvignon Blanc",
-#   #   "Tofu" => "Rose",
+#   #   "Tofu" => "Rosé",
 #   #   "Asparagus" => "Pinot Noir"
 #   # }
 #

data/lib/sommelier/match_maker/decider.rb

@@ -1,18 +1,22 @@
 class Sommelier
   class MatchMaker
+    # Decide a single dish's pairing request to accept for each wine
     class Decider
       def initialize(match_catalog)
         @match_catalog = match_catalog
       end
 
-      # Decide a single dish's pairing request to accept for each wine
+      # Decide on which requested pairings to accepts (up to one per wine) and
+      # update the `accepted` and `reversed` input maps.
       #
       # @param requests [Hash<Object, Array<Object>>] mapping of wines to
-      #   the list of dishes that have requested pairing in the current round
+      #   the list of dishes that have requested pairing in the current round.
       # @param accepted [Hash<Object, Object>] mapping of dishes to the wine
-      #   that has accepted its pairing request
+      #   that has accepted its pairing request. Note: invoking this method may
+      #   cause modifications to this object.
       # @param reversed [Hash<Object, Object>] mapping of wines to the dish
-      #   that has its pairing request accepted by wine
+      #   that has its pairing request accepted by wine. Note: invoking this
+      #   method may cause modifications to this object.
       def decide!(requests, accepted, reversed)
         requests.each do |wine, current_dishes|
           # Be sure to consider the full set of current dishes and potentially

data/lib/sommelier/match_maker/generator.rb

@@ -1,16 +1,15 @@
 class Sommelier
   class MatchMaker
+    # Generate all of the requested pairings for a single round of the
+    # algorithm. Each dish that isn't currently locked in a pairing from a
+    # prior round and hasn't exhausted its list of preferred wines will
+    # request a pairing with the highest matching wine it has not yet
+    # requested.
     class Generator
       def initialize(match_catalog)
         @match_catalog = match_catalog
       end
 
-      # Generate all of the requested pairings for a single round of the
-      # algorithm. Each dish that isn't currently locked in a pairing from a
-      # prior round and hasn't exhausted its list of preferred wines will
-      # request a pairing with the highest matching wine it has not yet
-      # requested.
-      #
       # @param round [Integer] the round number
       # @param accepted [Hash<Object, Object>] mapping of dishes to the wine
       #   that has accepted his pairing

data/lib/sommelier/version.rb

@@ -1,3 +1,3 @@
 class Sommelier
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/tasks/sommelier.rake

@@ -0,0 +1,20 @@
+namespace :sommelier do
+  desc 'Apply Sommelier to a CSV with a headers row ["dish", "wine", "score"]'
+  task :from_csv do
+    unless ARGV.length == 2
+      raise ArgumentError, 'Expecting a file as the first argument'
+    end
+
+    require 'csv'
+    require 'sommelier'
+
+    csv = CSV.open(ARGV[1], headers: true)
+    sommelier = Sommelier.new
+    csv.each do |row|
+      sommelier.add_match(row[0], row[1], row[2].to_f)
+    end
+    sommelier.pairings.each do |dish, wine|
+      puts "#{dish} => #{wine}"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tcollier-sommelier
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tom Collier
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CHANGELOG.txt
 - Gemfile
 - Gemfile.lock
@@ -103,6 +104,7 @@ files:
 - lib/sommelier/match_maker/generator.rb
 - lib/sommelier/preference.rb
 - lib/sommelier/version.rb
+- lib/tasks/sommelier.rake
 - sommelier.gemspec
 homepage: https://github.com/tcollier/sommelier
 licenses: