ruby-poker 0.2.4 → 0.3.0

data/CHANGELOG

@@ -1,24 +1,45 @@
-2008-01-10 (0.1.0)
-    * Initial version
-2008-01-12 (0.1.1)
-    * Ranks are now a class.
-    * Extracted card, rank, and arrays methods to individual files
-    * Added gem packaging
-2008-01-12 (0.1.2)
-    * Fixed critical bug that was stopping the whole program to not work
-    * Added some test cases as a result
-    * More test cases coming soon
+2008-05-17 (0.3.0)
+    * Changed Card#== to compare based on card suit and face value. Before it only compared the face value of two cards. Warning: This change may potentially break your program if you were comparing Card objects directly.
+    * Replaced `PokerHand#arranged_hand` with `PokerHand#sort_using_rank` which is more descriptive. This loosely corresponds to bug #20194.
+    * Bug [#20196] 'rank' goes into an infinite loop.
+    * Bug [#20195] Allows the same card to be entered into the hand.
+    * Bug [#20344] sort_using_rank does not return expected results
+    
+2008-04-20 (0.2.4)
+    * Modernized the Rakefile
+    * Updated to be compatible with Ruby 1.9    
+    
+2008-04-06 (0.2.2)
+    * Fixed bug where two hands that had the same values but different suits returned not equal    
+    
+2008-02-08 (0.2.1)
+    * Cards can be added to a hand after it is created by using (<<) on a PokerHand
+    * Cards can be deleted from a hand with PokerHand.delete()
+    
 2008-01-21 (0.2.0)
     * Merged Patrick Hurley's poker solver
     * Added support for hands with >5 cards
     * Straights with a low Ace count now
     * to_s on a PokerHand now includes the rank after the card list
-    * Finally wrote the Unit Tests suite
-2008-02-08 (0.2.1)
-    * Cards can be added to a hand after it is created by using (<<) on a PokerHand
-    * Cards can be deleted from a hand with PokerHand.delete()
-2008-04-06 (0.2.2)
-    * Fixed bug where two hands that had the same values but different suits returned not equal
-2008-04-20 (0.2.4)
-    * Modernized the Rakefile
-    * Updated to be compatible with Ruby 1.9
+    * Finally wrote the Unit Tests suite      
+    
+2008-01-12 (0.1.2)
+    * Fixed critical bug that was stopping the whole program to not work
+    * Added some test cases as a result
+    * More test cases coming soon      
+    
+2008-01-12 (0.1.1)
+    * Ranks are now a class.
+    * Extracted card, rank, and arrays methods to individual files
+    * Added gem packaging
+        
+2008-01-10 (0.1.0)
+    * Initial version
+
+
+
+
+
+
+
+    

data/README

@@ -41,6 +41,21 @@ In this section some examples show what can be done with this class.
     puts hand2.rank           => Three of a kind
     puts hand1 > hand2        => true
 
+== Duplicates
+
+By default ruby-poker will not raise an exception if you add the same card to a hand
+twice. You can tell ruby-poker to not allow duplicates by doing the following
+
+    PokerHand.allow_duplicates = false
+    
+Place that line near the beginning of your program. The change is program wide so
+once allow_duplicates is set to false, _all_ poker hands will raise an exception
+if a duplicate card is added to the hand.
+
+== Compatibility
+
+Ruby-Poker is compatible with Ruby 1.8 and Ruby 1.9.
+
 == Background
 
 The original version of ruby-poker was written entirely by myself (Robert Olson).

data/Rakefile

@@ -11,7 +11,7 @@ rescue LoadError
   nil
 end
 
-RUBYPOKER_VERSION = "0.2.4"
+RUBYPOKER_VERSION = "0.3.0"
 
 task :default => [:test]
 
@@ -41,6 +41,7 @@ end
 
 Rake::GemPackageTask.new(spec) do |pkg| 
   pkg.need_tar = true 
+  pkg.need_zip = true
 end
 
 Rake::TestTask.new do |test|
@@ -54,16 +55,10 @@ task :autotest do
   ruby "-I lib -w /usr/bin/autotest"
 end
 
-desc "Create Zentest tests"
-task :zentest do
-  `zentest card.rb test_card.rb > test_card_2.rb`
-  `zentest ruby-poker.rb test_poker_hand.rb > test_poker_hand_2.rb`
-end
-
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('README', 'CHANGELOG', 'LICENSE', 'lib/')
   rdoc.main     = 'README'
   rdoc.rdoc_dir = 'doc/html'
   rdoc.title    = 'Ruby Poker Documentation'
-  rdoc.options << '--all' << '--inline-source'
+  rdoc.options << '--inline-source'
 end

data/examples/deck.rb

@@ -1,3 +1,4 @@
+# This is a sample Deck implementation.
 class Deck
   def shuffle
     deck_size = @cards.size

data/lib/card.rb

@@ -109,4 +109,10 @@ class Card
   def <=> card2
     @face <=> card2.face
   end
+  
+  # Returns true if the cards are the same card. Meaning they
+  # have the same suit and the same face value.
+  def == card2
+    @value == card2.value
+  end
 end

data/lib/ruby-poker.rb

@@ -4,6 +4,10 @@ class PokerHand
   include Comparable
   attr_reader :hand
   
+  @@allow_duplicates = true    # true by default
+  def self.allow_duplicates; @@allow_duplicates; end
+  def self.allow_duplicates=(v); @@allow_duplicates = v; end
+  
   # Returns a new PokerHand object. Accepts the cards represented
   # in a string or an array
   #
@@ -47,6 +51,7 @@ class PokerHand
   def just_cards
     @hand.join(" ")
   end
+  alias :cards :just_cards
   
   # Returns an array of the card values in the hand.
   # The values returned are 1 less than the value on the card.
@@ -57,6 +62,12 @@ class PokerHand
     @hand.map { |c| c.face }
   end
 
+  # The =~ method does a regular expression match on the cards in this hand.
+  # This can be useful for many purposes. A common use is the check if a card
+  # exists in a hand.
+  #
+  #     PokerHand.new("3d 4d 5d") =~ /8h/           # => nil
+  #     PokerHand.new("3d 4d 5d") =~ /4d/           # => #<MatchData:0x615e18>
   def =~ (re)
     re.match(just_cards)
   end
@@ -134,13 +145,16 @@ class PokerHand
       transform = delta_transform
       # note we can have more than one delta 0 that we
       # need to shuffle to the back of the hand
-      until transform.match(/^\S{3}( [1-9x]\S\S)+( 0\S\S)*$/) do
-        transform.gsub!(/(\s0\S\S)(.*)/, "\\2\\1")
+      i = 0
+      until transform.match(/^\S{3}( [1-9x]\S\S)+( 0\S\S)*$/) or i >= hand.size  do
+        # only do this once per card in the hand to avoid entering an
+        # infinite loop if all of the cards in the hand are the same
+        transform.gsub!(/(\s0\S\S)(.*)/, "\\2\\1")    # moves the front card to the back of the string
+        i += 1
       end
       if (md = (/.(.). 1.. 1.. 1.. 1../.match(transform)))
         high_card = Card::face_value(md[1])
-        arranged_hand = fix_low_ace_display(md[0] + ' ' +
-            md.pre_match + ' ' + md.post_match)
+        arranged_hand = fix_low_ace_display(md[0] + ' ' + md.pre_match + ' ' + md.post_match)
         result = [[5, high_card], arranged_hand]
       end
     end
@@ -166,17 +180,24 @@ class PokerHand
   end
 
   def two_pair?
+    # \1 is the face value of the first pair
+    # \2 is the card in between the first pair and the second pair
+    # \3 is the face value of the second pair
     if (md = (by_face =~ /(.). \1.(.*) (.). \3./))
-      # get kicker
-      arranged_hand = arrange_hand(md[0] + ' ' +
+      # to get the kicker this does the following
+      # md[0] is the regex matched above which includes the first pair and
+      # the second pair but also some cards in the middle so we sub them out
+      # then we add on the cards that came before the first pair, the cards that
+      # we in between, and the cards that came after.
+      arranged_hand = arrange_hand(md[0].sub(md[2], '') + ' ' +
           md.pre_match + ' ' + md[2] + ' ' + md.post_match)
       arranged_hand.match(/(?:\S\S ){4}(\S)/)
       [
         [
           3,
-          Card::face_value(md[1]),
-          Card::face_value(md[3]),
-          Card::face_value($1)
+          Card::face_value(md[1]),    # face value of the first pair
+          Card::face_value(md[3]),    # face value of the second pair
+          Card::face_value($1)        # face value of the kicker
         ],
         arranged_hand
       ]
@@ -240,8 +261,14 @@ class PokerHand
     }.find([0]) { |score| score }
   end
 
-  def arranged_hand
-    score[1] + " (#{hand_rating})"
+  # Returns a string of the hand arranged based on its rank. Usually this will be the
+  # same as `by_face` but there are some cases where it makes a difference.
+  #
+  #     ph = PokerHand.new("AS 3S 5S 2S 4S")
+  #     ph.sort_using_rank        # => "5s 4s 3s 2s As"
+  #     ph.by_face.just_cards       # => "As 5s 4s 3s 2s"   
+  def sort_using_rank
+    score[1]
   end
   
   # Returns string with a listing of the cards in the hand followed by the hand's rank.
@@ -274,6 +301,10 @@ class PokerHand
     end
     
     new_cards.each do |nc|
+      unless @@allow_duplicates
+        raise "A card with the value #{nc} already exists in this hand. Set PokerHand.allow_duplicates to true if you want to be able to add a card more than once." if self =~ /#{nc}/
+      end
+      
       @hand << Card.new(nc)
     end
   end
@@ -296,16 +327,18 @@ class PokerHand
     }
   end
   
-  protected
+  # protected
   
+  # if md is a string, arrange_hand will remove extra white space
+  # if md is a MatchData, arrange_hand returns the matched segment
+  # followed by the pre_match and the post_match
   def arrange_hand(md)
       hand = if (md.respond_to?(:to_str))
         md
       else
         md[0] + ' ' + md.pre_match + md.post_match
       end
-      hand.gsub!(/\s+/, ' ')
-      hand.gsub(/\s+$/,'')
+      hand.strip.squeeze(" ")   # remove extra whitespace
   end
   
   def delta_transform(use_suit = false)

data/test/test_card.rb

@@ -1,8 +1,4 @@
-# Code Generated by ZenTest v. 3.8.0
-#                 classname: asrt / meth =  ratio%
-#                      Card:    0 /    4 =   0.00%
-
-require 'test/unit' unless defined? $ZENTEST and $ZENTEST
+require 'test/unit'
 require 'card.rb'
 
 class TestCard < Test::Unit::TestCase
@@ -45,6 +41,15 @@ class TestCard < Test::Unit::TestCase
     assert_equal(37, @c3.value)
     assert_equal(52, @c4.value)
   end
-end
-
-# Number of errors detected: 9
+  
+  def test_comparison
+    assert(@c1 < @c2)
+    assert(@c3 > @c2)
+  end
+  
+  def test_equals
+    c = Card.new("9h")
+    assert_not_equal(@c1, c)
+    assert_equal(@c1, @c1)
+  end
+end

data/test/test_poker_hand.rb

@@ -1,8 +1,4 @@
-# Code Generated by ZenTest v. 3.8.0
-#                 classname: asrt / meth =  ratio%
-#                 PokerHand:    0 /   24 =   0.00%
-
-require 'test/unit' unless defined? $ZENTEST and $ZENTEST
+require 'test/unit'
 require 'ruby-poker.rb'
 
 class TestPokerHand < Test::Unit::TestCase
@@ -13,8 +9,16 @@ class TestPokerHand < Test::Unit::TestCase
     @straight = PokerHand.new("8H 9D TS JH QC AS")
   end
   
-  def test_arranged_hand
-    assert_equal("As Ah Ac 9c 2d (Three of a kind)", @trips.arranged_hand)
+  # there are a lot of combinations that should be tested here. I will add more
+  # troublesome cases as I think of them.
+  def test_sort_using_rank
+    assert_equal("As Ah Ac 9c 2d", @trips.sort_using_rank)
+    assert_equal("4s 4d 4c 2h 2d", @full_boat.sort_using_rank)
+    assert_equal("Qd Td 7d 6d 3d 2s 5h", @flush.sort_using_rank)
+    assert_equal("Qc Jh Ts 9d 8h As", @straight.sort_using_rank)
+    
+    assert_equal("As Ah 3d 3c Kd", PokerHand.new("AS AH KD 3D 3C").sort_using_rank)
+    assert_equal("As Ah 3d 3c 2d", PokerHand.new("2D AS AH 3D 3C").sort_using_rank)
   end
 
   def test_by_face
@@ -29,17 +33,17 @@ class TestPokerHand < Test::Unit::TestCase
     assert_equal([1, 8, 13, 13, 13], @trips.face_values)
   end
 
-  def test_flush_eh
+  def test_flush
     assert @flush.flush?
     assert !@trips.flush?
   end
 
-  def test_four_of_a_kind_eh
+  def test_four_of_a_kind
     assert !@trips.four_of_a_kind?
     assert PokerHand.new("AD 9C AS AH AC")
   end
 
-  def test_full_house_eh
+  def test_full_house
     assert !@trips.full_house?
     assert @full_boat.full_house?
   end
@@ -59,7 +63,7 @@ class TestPokerHand < Test::Unit::TestCase
     assert_not_nil @trips.rank
   end
 
-  def test_highest_card_eh
+  def test_highest_card
     # hard to test, make sure it does not return null
     assert PokerHand.new("2D 4S 6C 8C TH").highest_card?
   end
@@ -68,12 +72,12 @@ class TestPokerHand < Test::Unit::TestCase
     assert_equal("2d 9c As Ah Ac", @trips.just_cards)
   end
 
-  def test_pair_eh
+  def test_pair
     assert !PokerHand.new("5C JC 2H 7S 3D").pair?
     assert PokerHand.new("6D 7C 5D 5H 3S").pair?
   end
   
-  def test_royal_flush_eh
+  def test_royal_flush
     assert !@flush.royal_flush?
     assert PokerHand.new("AD KD QD JD TD").royal_flush?
   end
@@ -82,22 +86,22 @@ class TestPokerHand < Test::Unit::TestCase
     assert_equal([4, 13, 8, 1], @trips.score[0])
   end
 
-  def test_straight_eh
+  def test_straight
     assert @straight.straight?
     assert PokerHand.new("AH 2S 3D 4H 5D").straight?
   end
 
-  def test_straight_flush_eh
+  def test_straight_flush
     assert !@flush.straight_flush?
     assert !@straight.straight_flush?
     assert PokerHand.new("8H 9H TH JH QH AS").straight_flush?
   end
 
-  def test_three_of_a_kind_eh
+  def test_three_of_a_kind
     assert @trips.three_of_a_kind?
   end
 
-  def test_two_pair_eh
+  def test_two_pair
     assert PokerHand.new("2S 2D TH TD 4S").two_pair?
     assert !PokerHand.new("6D 7C 5D 5H 3S").two_pair?
   end
@@ -138,5 +142,24 @@ class TestPokerHand < Test::Unit::TestCase
     ph.delete("Ac")
     assert_equal(Array.new, ph.hand)
   end
+  
+  def test_five_of_a_kind
+    # there is no five of a kind. This just tests to make sure
+    # that ruby-poker doesn't crash if given 5 of the same card
+    ph = PokerHand.new("KS KS KS KS KS")
+    assert_equal("Four of a kind", ph.rank)
+  end
+  
+  def test_duplicates
+    ph = PokerHand.new("2d")
+    PokerHand.allow_duplicates = true
+    ph << "2d"
+    assert_equal("2d 2d", ph.just_cards)
+    
+    PokerHand.allow_duplicates = false
+    assert_raise RuntimeError do
+      ph << "2d"
+    end
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-poker
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors: 
 - Robert Olson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-20 00:00:00 -07:00
+date: 2008-05-26 00:00:00 -07:00
 default_executable: 
 dependencies: []