bridge 0.0.4 → 0.0.5

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/bridge.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bridge}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Kuźma"]
-  s.date = %q{2010-02-22}
+  s.date = %q{2010-02-23}
   s.description = %q{Useful contract bridge utilities - deal generator, id to deal and deal to id conversion}
   s.email = %q{qoobaa+github@gmail.com}
   s.extra_rdoc_files = [
@@ -25,8 +25,12 @@ Gem::Specification.new do |s|
      "VERSION",
      "bridge.gemspec",
      "lib/bridge.rb",
+     "lib/bridge/contract.rb",
+     "lib/bridge/deal.rb",
      "test/helper.rb",
-     "test/test_bridge.rb"
+     "test/test_bridge.rb",
+     "test/test_contract.rb",
+     "test/test_deal.rb"
   ]
   s.homepage = %q{http://github.com/qoobaa/bridge}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -34,8 +38,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Contract bridge utilities}
   s.test_files = [
-    "test/helper.rb",
-     "test/test_bridge.rb"
+    "test/test_bridge.rb",
+     "test/test_deal.rb",
+     "test/helper.rb",
+     "test/test_contract.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/bridge/contract.rb

@@ -0,0 +1,23 @@
+module Bridge
+  module Contract
+    def self.contracts_compare(first, second)
+      CONTRACTS.index(first) <=> CONTRACTS.index(second)
+    end
+
+    def self.contract?(contract)
+      CONTRACTS.include?(value)
+    end
+
+    def self.pass?(value)
+      value == PASS
+    end
+
+    def self.double?(value)
+      value == DOUBLE
+    end
+
+    def self.redouble?(value)
+      value == REDOUBLE
+    end
+  end
+end

data/lib/bridge/deal.rb

@@ -0,0 +1,116 @@
+module Bridge
+
+  # Class representing bridge deal
+  class Deal
+    include Comparable
+
+    attr_reader :n, :e, :s, :w
+
+    # Returns cards of given direction
+    def [](direction)
+      must_be_direction!(direction)
+      send("#{direction.to_s.downcase}")
+    end
+
+    # Compares the deal with given deal
+    def <=>(other)
+      id <=> other.id
+    end
+
+    # Creates new deal object with cards given in hash of directions
+    #
+    # ==== Example
+    #   Bridge::Deal.new(:n => ["HA", ...], :s => ["SA"], ...)
+    def initialize(hands)
+      hands.each { |hand, cards| self[hand] = cards }
+    end
+
+    # Converts given id to deal
+    def self.from_id(id)
+      raise ArgumentError, "invalid deal id: #{id}" unless Bridge.deal_id?(id)
+      n = []; e = []; s = []; w = []; k = DEALS
+      DECK.each_with_index do |card, i|
+        x = k * (13 - n.size) / (52 - i)
+        if id < x
+          n << card
+        else
+          id -= x
+          x = k * (13 - e.size) / (52 - i)
+          if id < x
+            e << card
+          else
+            id -= x
+            x = k * (13 - s.size) / (52 - i)
+            if id < x
+              s << card
+            else
+              id -= x
+              x = k * (13 - w.size) / (52 - i)
+              w << card
+            end
+          end
+        end
+        k = x
+      end
+      new(:n => n, :e => e, :s => s, :w => w)
+    end
+
+    # Converts given deal (hash) to id
+    def id
+      k = DEALS; id = 0; n = self.n.dup; e = self.e.dup; s = self.s.dup; w = self.w.dup
+      DECK.each_with_index do |card, i|
+        x = k * n.size / (52 - i)
+        unless n.delete(card)
+          id += x
+          x = k * e.size / (52 - i)
+          unless e.delete(card)
+            id += x
+            x = k * s.size / (52 - i)
+            unless s.delete(card)
+              id += x
+              x = k * w.size / (52 - i)
+              w.delete(card)
+            end
+          end
+        end
+        k = x
+      end
+      id
+    end
+
+    # Returns a random deal id
+    def self.random_id
+      rand(DEALS)
+    end
+
+    # Returns a random deal
+    def self.random
+      from_id(random_id)
+    end
+
+    # Checks if the deal is a valid deal
+    def valid?
+      if DIRECTIONS.all? { |d| self[d] && self[d].size == 13 }
+        cards = (n + e + s + w).uniq
+        if cards.size == 52
+          cards.all? { |card| Bridge.card?(card) }
+        else
+          false
+        end
+      else
+        false
+      end
+    end
+
+    private
+
+    def must_be_direction!(string)
+      raise ArgumentError, "invalid direction: #{string}" unless Bridge.direction?(string.to_s.upcase)
+    end
+
+    def []=(direction, cards)
+      must_be_direction!(direction)
+      instance_variable_set("@#{direction.to_s.downcase}", cards)
+    end
+  end
+end

data/lib/bridge.rb

@@ -1,94 +1,47 @@
-module Bridge
+require "bridge/deal"
 
+module Bridge
   # Number of possible deals in bridge
   DEALS = 53_644_737_765_488_792_839_237_440_000
 
-  # Array with cards in the bridge deck (AKQJT98765432, four suits)
+  # Array with card strings in the bridge deck (AKQJT98765432, four
+  # suits). Contains "SA", "HT", etc.
   DECK = %w(S H D C).inject([]) do |d, s|
     d += %w(A K Q J T 9 8 7 6 5 4 3 2).map { |c| s + c }
   end
 
-  # Converts given id to deal (hash)
-  def self.id_to_deal(id)
-    deal = { :n => [], :e => [], :s => [], :w => [] }
-    k = DEALS
-    DECK.each_with_index do |card, i|
-      x = k * (13 - deal[:n].size) / (52 - i)
-      if id < x
-        deal[:n] << card
-      else
-        id -= x
-        x = k * (13 - deal[:e].size) / (52 - i)
-        if id < x
-          deal[:e] << card
-        else
-          id -= x
-          x = k * (13 - deal[:s].size) / (52 - i)
-          if id < x
-            deal[:s] << card
-          else
-            id -= x
-            x = k * (13 - deal[:w].size) / (52 - i)
-            deal[:w] << card
-          end
-        end
-      end
-      k = x
-    end
-    deal
-  end
+  # Direction strings "N", "E", "S" and "W"
+  DIRECTIONS = %w(N E S W)
 
-  # Converts given deal (hash) to id
-  def self.deal_to_id(d)
-    k = DEALS; id = 0
-    deal = { :n => d[:n].dup, :e => d[:e].dup, :s => d[:s].dup, :w => d[:w].dup }
-    DECK.each_with_index do |card, i|
-      x = k * deal[:n].size / (52 - i)
-      unless deal[:n].delete(card)
-        id += x
-        x = k * deal[:e].size / (52 - i)
-        unless deal[:e].delete(card)
-          id += x
-          x = k * deal[:s].size / (52 - i)
-          unless deal[:s].delete(card)
-            id += x
-            x = k * deal[:w].size / (52 - i)
-            deal[:w].delete(card)
-          end
-        end
-      end
-      k = x
-    end
-    id
+  # Possible contracts in ascending order. Contains "1C", "6NT", etc.
+  CONTRACTS = %w(1 2 3 4 5 6 7).inject([]) do |b, l|
+    b += %w(C D H S NT).map { |s| l + s }
   end
 
-  # Returns a random deal id
-  def self.random_deal_id
-    rand(DEALS)
-  end
+  # Pass string
+  PASS = "PASS"
 
-  # Returns a random deal
-  def self.random_deal
-    id_to_deal(random_deal_id)
-  end
+  # Double string
+  DOUBLE = "X"
 
-  # Checks if the given number is valid deal id
-  def self.deal_id?(n)
-    (0..DEALS - 1).include?(n)
+  # Redouble string
+  REDOUBLE = "XX"
+
+  # Modifier bids (double and redouble)
+  MODIFIERS = [DOUBLE, REDOUBLE]
+
+  # All possible bids (including contracts, modifiers and pass)
+  BIDS = CONTRACTS + MODIFIERS + [PASS]
+
+  def self.direction?(string)
+    DIRECTIONS.include?(string)
   end
 
-  # Checks if the given hash is valid deal
-  def self.deal?(h)
-    if [:n, :e, :s, :w].all? { |s| h[s] && h[s].size == 13 }
-      cards = (h[:n] + h[:e] + h[:s] + h[:w]).uniq
-      if cards.size == 52
-        cards.all? { |card| DECK.include?(card) }
-      else
-        false
-      end
-    else
-      false
-    end
+  def self.deal_id?(integer)
+    (0..DEALS - 1).include?(integer)
   end
 
+  def self.card?(string)
+    DECK.include?(string)
+  end
 end

data/test/test_bridge.rb

@@ -1,67 +1,6 @@
-require 'helper'
+require "helper"
 
 class TestBridge < Test::Unit::TestCase
-  test "first deal conversion" do
-    id = 0
-    deal = Bridge.id_to_deal(id)
-    assert Bridge.deal?(deal)
-    assert_equal %w(AS KS QS JS TS 9S 8S 7S 6S 5S 4S 3S 2S), deal[:n]
-    assert_equal %w(AH KH QH JH TH 9H 8H 7H 6H 5H 4H 3H 2H), deal[:e]
-    assert_equal %w(AD KD QD JD TD 9D 8D 7D 6D 5D 4D 3D 2D), deal[:s]
-    assert_equal %w(AC KC QC JC TC 9C 8C 7C 6C 5C 4C 3C 2C), deal[:w]
-    assert_equal id, Bridge.deal_to_id(deal)
-  end
-
-  test "last deal conversion" do
-    id = Bridge::DEALS - 1
-    deal = Bridge.id_to_deal(id)
-    assert Bridge.deal?(deal)
-    assert_equal %w(AC KC QC JC TC 9C 8C 7C 6C 5C 4C 3C 2C), deal[:n]
-    assert_equal %w(AD KD QD JD TD 9D 8D 7D 6D 5D 4D 3D 2D), deal[:e]
-    assert_equal %w(AH KH QH JH TH 9H 8H 7H 6H 5H 4H 3H 2H), deal[:s]
-    assert_equal %w(AS KS QS JS TS 9S 8S 7S 6S 5S 4S 3S 2S), deal[:w]
-    assert_equal id, Bridge.deal_to_id(deal)
-  end
-
-  test "deal no 1 000 000 000" do
-    id = 1_000_000_000
-    deal = Bridge.id_to_deal(id)
-    assert Bridge.deal?(deal)
-    assert_equal id, Bridge.deal_to_id(deal)
-  end
-
-  test "sample deal to id conversion" do
-    deal = {
-      :n => %w(AS KS QS JS AH KH QH AD KD QD AC KC QC),
-      :e => %w(TS 9S 8S 7S 6S 5S 4S 3S 2S JH TH 9H 8H),
-      :s => %w(7H 6H 5H 4H 3H 2H JD TD 9D 8D 7D 6D 5D),
-      :w => %w(4D 3D 2D JC TC 9C 8C 7C 6C 5C 4C 3C 2C)
-    }
-    assert Bridge.deal?(deal)
-    id = Bridge.deal_to_id(deal)
-    assert_equal deal, Bridge.id_to_deal(id)
-  end
-
-  test "deal with doubled cards is not valid deal" do
-    deal = {
-      :n => %w(AS AS QS JS AH KH QH AD KD QD AC KC QC),
-      :e => %w(TS 9S 8S 7S 6S 5S 4S 3S 2S JH TH 9H 8H),
-      :s => %w(7H 6H 5H 4H 3H 2H JD TD 9D 8D 7D 6D 5D),
-      :w => %w(4D 3D 2D JC TC 9C 8C 7C 6C 5C 4C 3C 2C)
-    }
-    assert_false Bridge.deal?(deal)
-  end
-
-  test "deal with different length hands is not valid deal" do
-    deal = {
-      :n => %w(AS KS QS JS AH KH QH AD KD QD AC KC QC TS),
-      :e => %w(9S 8S 7S 6S 5S 4S 3S 2S JH TH 9H 8H),
-      :s => %w(7H 6H 5H 4H 3H 2H JD TD 9D 8D 7D 6D 5D),
-      :w => %w(4D 3D 2D JC TC 9C 8C 7C 6C 5C 4C 3C 2C)
-    }
-    assert_false Bridge.deal?(deal)
-  end
-
   test "negative number is not valid deal id" do
     assert_false Bridge.deal_id?(-1)
   end
@@ -69,14 +8,4 @@ class TestBridge < Test::Unit::TestCase
   test "number of possible bridge deals is not valid deal id" do
     assert_false Bridge.deal_id?(Bridge::DEALS)
   end
-
-  test "random deal id is valid deal id" do
-    id = Bridge.random_deal_id
-    assert Bridge.deal_id?(id)
-  end
-
-  test "random deal is valid deal" do
-    deal = Bridge.random_deal
-    assert Bridge.deal?(deal)
-  end
 end

data/test/test_contract.rb

@@ -0,0 +1,5 @@
+require "helper"
+
+class TestContract < Test::Unit::TestCase
+
+end

data/test/test_deal.rb

@@ -0,0 +1,87 @@
+require "helper"
+
+class TestDeal < Test::Unit::TestCase
+  test "first deal conversion" do
+    id = 0
+    deal = Bridge::Deal.from_id(id)
+    assert deal.valid?
+    assert_equal %w(SA SK SQ SJ ST S9 S8 S7 S6 S5 S4 S3 S2), deal.n
+    assert_equal %w(HA HK HQ HJ HT H9 H8 H7 H6 H5 H4 H3 H2), deal.e
+    assert_equal %w(DA DK DQ DJ DT D9 D8 D7 D6 D5 D4 D3 D2), deal.s
+    assert_equal %w(CA CK CQ CJ CT C9 C8 C7 C6 C5 C4 C3 C2), deal.w
+    assert_equal id, deal.id
+  end
+
+  test "last deal conversion" do
+    id = Bridge::DEALS - 1
+    deal = Bridge::Deal.from_id(id)
+    assert deal.valid?
+    assert_equal %w(CA CK CQ CJ CT C9 C8 C7 C6 C5 C4 C3 C2), deal.n
+    assert_equal %w(DA DK DQ DJ DT D9 D8 D7 D6 D5 D4 D3 D2), deal.e
+    assert_equal %w(HA HK HQ HJ HT H9 H8 H7 H6 H5 H4 H3 H2), deal.s
+    assert_equal %w(SA SK SQ SJ ST S9 S8 S7 S6 S5 S4 S3 S2), deal.w
+    assert_equal id, deal.id
+  end
+
+  test "deal no 1 000 000 000 000" do
+    id = 1_000_000_000_000
+    deal = Bridge::Deal.from_id(id)
+    assert deal.valid?
+    assert_equal id, deal.id
+  end
+
+  test "sample deal to id conversion" do
+    deal = Bridge::Deal.new("N" => %w(SA SK SQ SJ HA HK HQ DA DK DQ CA CK CQ),
+                            "E" => %w(ST S9 S8 S7 S6 S5 S4 S3 S2 HJ HT H9 H8),
+                            "S" => %w(H7 H6 H5 H4 H3 H2 DJ DT D9 D8 D7 D6 D5),
+                            "W" => %w(D4 D3 D2 CJ CT C9 C8 C7 C6 C5 C4 C3 C2))
+    assert deal.valid?
+    id = deal.id
+    assert_equal deal, Bridge::Deal.from_id(id)
+  end
+
+  test "deal with doubled cards is not valid deal" do
+    deal = Bridge::Deal.new("N" => %w(SA SA SQ SJ HA HK HQ DA DK DQ CA CK CQ),
+                            "E" => %w(ST S9 S8 S7 S6 S5 S4 S3 S2 HJ HT H9 H8),
+                            "S" => %w(H7 H6 H5 H4 H3 H2 DJ DT D9 D8 D7 D6 D5),
+                            "W" => %w(D4 D3 D2 CJ CT C9 C8 C7 C6 C5 C4 C3 C2))
+    assert_false deal.valid?
+  end
+
+  test "deal with different length hands is not valid deal" do
+    deal = Bridge::Deal.new("N" => %w(SA SK SQ SJ HA HK HQ DA DK DQ CA CK CQ ST),
+                            "E" => %w(S9 S8 S7 S6 S5 S4 S3 S2 HJ HT H9 H8),
+                            "S" => %w(H7 H6 H5 H4 H3 H2 DJ DT D9 D8 D7 D6 D5),
+                            "W" => %w(D4 D3 D2 CJ CT C9 C8 C7 C6 C5 C4 C3 C2))
+    assert_false deal.valid?
+  end
+
+  test "random deal id is valid deal id" do
+    id = Bridge::Deal.random_id
+    assert Bridge.deal_id?(id)
+  end
+
+  test "random deal is valid deal" do
+    deal = Bridge::Deal.random
+    assert deal.valid?
+  end
+
+  test "comparison of two deals" do
+    deal1 = Bridge::Deal.from_id(1_000_000_000_000_000)
+    deal2 = Bridge::Deal.from_id(9_000_000_000_000_000)
+    assert deal1 < deal2
+  end
+
+  test "fetching wrong direction raises an error" do
+    deal = Bridge::Deal.random
+    assert_raises(ArgumentError) do
+      deal[:h]
+    end
+  end
+
+  test "passing incorrect id to from_id raises an error" do
+    assert_raises(ArgumentError) do
+      Bridge::Deal.from_id(-1)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bridge
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - "Jakub Ku\xC5\xBAma"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-22 00:00:00 +01:00
+date: 2010-02-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,8 +40,12 @@ files:
 - VERSION
 - bridge.gemspec
 - lib/bridge.rb
+- lib/bridge/contract.rb
+- lib/bridge/deal.rb
 - test/helper.rb
 - test/test_bridge.rb
+- test/test_contract.rb
+- test/test_deal.rb
 has_rdoc: true
 homepage: http://github.com/qoobaa/bridge
 licenses: []
@@ -71,5 +75,7 @@ signing_key:
 specification_version: 3
 summary: Contract bridge utilities
 test_files: 
-- test/helper.rb
 - test/test_bridge.rb
+- test/test_deal.rb
+- test/helper.rb
+- test/test_contract.rb