ruby-poker 0.3.0 → 0.3.1

data/CHANGELOG

@@ -1,3 +1,11 @@
+2009-01-24 (0.3.1)
+    * Bug [#23623] undefined method <=> for nil:NilClass
+    
+2008-12-30 (0.3.1)
+    * Bug (#20407) Raise an exception when creating a new hand with duplicates
+    * Added PokerHand#uniq method
+    * Removed deprecated `Gem::manage_gems` from Rakefile
+
 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.

data/README.rdoc

@@ -0,0 +1,51 @@
+= Poker library in Ruby
+
+== Author
+
+Rob Olson (rko618 [at] gmail)
+
+== Description
+
+Ruby-Poker handles the logic for getting the rank of a poker hand. It can also be used to compare two or more hands to determine which hand has the highest poker value.
+
+Card representations can be passed to the PokerHand constructor as a string or an array. Face cards (cards ten, jack, queen, king, and ace) are created using their letter representation (T, J, Q, K, A).
+
+== Install
+
+    sudo gem install ruby-poker
+
+== Examples
+
+In this section some examples show what can be done with this class.
+
+    require 'rubygems'
+    require 'ruby-poker'
+    
+    hand1 = PokerHand.new("8H 9C TC JD QH")
+    hand2 = PokerHand.new(["3D", "3C", "3S", "KD", "AH"])
+    puts hand1                => 8h 9c Tc Jd Qh (Straight)
+    puts hand1.just_cards     => 8h 9c Tc Jd Qh
+    puts hand1.rank           => Straight
+    puts hand2                => 3d 3c 3s Kd Ah (Three of a kind)
+    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.
+
+== History
+
+In the 0.2.0 release Patrick Hurley's Texas Holdem code from http://rubyquiz.com/quiz24.html was merged into ruby-poker.
+
+== License
+
+This is free software; you can redistribute it and/or modify it under the terms of the BSD license. See LICENSE for more details.

data/Rakefile

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 
-Gem::manage_gems
 require 'rake/rdoctask'
 require "rake/testtask"
 require 'rake/gempackagetask'
@@ -11,32 +10,39 @@ rescue LoadError
   nil
 end
 
-RUBYPOKER_VERSION = "0.3.0"
+RUBYPOKER_VERSION = "0.3.1"
 
-task :default => [:test]
-
-spec = Gem::Specification::new do |s|
-  s.name = "ruby-poker"
-  s.summary = "Ruby library for comparing poker hands and determining the winner." 
-  s.version = RUBYPOKER_VERSION
-  
+spec = Gem::Specification.new do |s|
+  s.name     = "ruby-poker"
+  s.version  = RUBYPOKER_VERSION
+  s.date     = "2009-01-24"
   s.rubyforge_project = "rubypoker"
   s.platform = Gem::Platform::RUBY
+  s.summary = "Poker library in Ruby"
+  s.description = "Ruby library for comparing poker hands and determining the winner."
+  s.author  = "Rob Olson"
+  s.email    = "rko618@gmail.com"
+  s.homepage = "http://github.com/robolson/ruby-poker"
+  s.has_rdoc = true
+  s.files    = ["CHANGELOG", 
+		"examples/deck.rb", 
+		"examples/quick_example.rb", 
+		"lib/card.rb", 
+		"lib/ruby-poker.rb", 
+		"LICENSE", 
+		"Rakefile", 
+		"README.rdoc", 
+		"ruby-poker.gemspec"]
+  s.test_files = ["test/test_card.rb", 
+    "test/test_poker_hand.rb"]
+  s.require_paths << 'lib'
   
-  s.files =  Dir.glob("{examples,lib,test}/**/**/*") + ["Rakefile"]
-  s.require_path = "lib" 
-
-  s.has_rdoc = true 
-  s.extra_rdoc_files = ["README", "CHANGELOG", "LICENSE"]
+  s.extra_rdoc_files = ["README.rdoc", "CHANGELOG", "LICENSE"]
   s.rdoc_options << '--title' << 'Ruby Poker Documentation' <<
-                    '--main'  << 'README' <<
+                    '--main'  << 'README.rdoc' <<
                     '--inline-source' << '-q'
   
-  s.test_files = Dir.glob("test/*.rb")
-
-  s.author = "Robert Olson"
-  s.email = "rko618@gmail.com"
-  s.homepage = "http://rubyforge.org/projects/rubypoker/"
+  # s.add_dependency("thoughtbot-shoulda", ["> 2.0.0"])
 end
 
 Rake::GemPackageTask.new(spec) do |pkg| 
@@ -48,6 +54,7 @@ Rake::TestTask.new do |test|
   test.libs << "test"
   test.test_files = Dir[ "test/test_*.rb" ]
   test.verbose = true
+  test.warning = true
 end
 
 desc "Start autotest"
@@ -55,9 +62,9 @@ task :autotest do
   ruby "-I lib -w /usr/bin/autotest"
 end
 
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_files.include('README', 'CHANGELOG', 'LICENSE', 'lib/')
-  rdoc.main     = 'README'
+Rake::RDocTask.new(:docs) do |rdoc|
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG', 'LICENSE', 'lib/')
+  rdoc.main     = 'README.rdoc'
   rdoc.rdoc_dir = 'doc/html'
   rdoc.title    = 'Ruby Poker Documentation'
   rdoc.options << '--inline-source'

data/lib/card.rb

@@ -115,4 +115,11 @@ class Card
   def == card2
     @value == card2.value
   end
+  alias :eql? :==
+  
+  # Compute a hash-code for this Card. Two Cards with the same
+  # content will have the same hash code (and will compare using eql?). 
+  def hash
+    @value.hash
+  end
 end

data/lib/ruby-poker.rb

@@ -27,6 +27,8 @@ class PokerHand
     else
       @hand = cards
     end
+    
+    check_for_duplicates if !@@allow_duplicates
   end
 
   # Returns a new PokerHand object with the cards sorted by suit
@@ -262,7 +264,7 @@ class PokerHand
   end
 
   # 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.
+  # 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"
@@ -287,7 +289,7 @@ class PokerHand
   alias :to_ary :to_a
   
   def <=> other_hand
-    self.score[0] <=> other_hand.score[0]
+    self.score[0].compact <=> other_hand.score[0].compact
   end
   
   # Add a card to the hand
@@ -318,7 +320,13 @@ class PokerHand
     @hand.delete(Card.new(card))
   end
   
-  RESOLVING_METHODS = ['size', '+', '-']
+  # Same concept as Array#uniq
+  def uniq
+    PokerHand.new(@hand.uniq)
+  end
+  
+  # Resolving methods are just passed directly down to the @hand array
+  RESOLVING_METHODS = [:size, :+, :-]
   RESOLVING_METHODS.each do |method|
     class_eval %{
       def #{method}(*args, &block)
@@ -327,7 +335,13 @@ class PokerHand
     }
   end
   
-  # protected
+  protected
+  
+  def check_for_duplicates
+    if @hand.size != @hand.uniq.size && !@@allow_duplicates
+      raise "You are attempting to create a hand that contains duplicate cards. Set PokerHand.allow_duplicates to true if you do not want to ignore this error."
+    end
+  end
   
   # if md is a string, arrange_hand will remove extra white space
   # if md is a MatchData, arrange_hand returns the matched segment

data/ruby-poker.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  s.name     = "ruby-poker"
+  s.version  = "0.3.1"
+  s.date     = "2009-01-24"
+  s.rubyforge_project = "rubypoker"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Poker library in Ruby"
+  s.description = "Ruby library for comparing poker hands and determining the winner."
+  s.author  = "Rob Olson"
+  s.email    = "rko618@gmail.com"
+  s.homepage = "http://github.com/robolson/ruby-poker"
+  s.has_rdoc = true
+  s.files    = ["CHANGELOG", 
+		"examples/deck.rb", 
+		"examples/quick_example.rb", 
+		"lib/card.rb", 
+		"lib/ruby-poker.rb", 
+		"LICENSE", 
+		"Rakefile", 
+		"README.rdoc", 
+		"ruby-poker.gemspec"]
+  s.test_files = ["test/test_card.rb", 
+    "test/test_poker_hand.rb"]
+  s.require_paths << 'lib'
+  
+  s.extra_rdoc_files = ["README", "CHANGELOG", "LICENSE"]
+  s.rdoc_options << '--title' << 'Ruby Poker Documentation' <<
+                    '--main'  << 'README.rdoc' <<
+                    '--inline-source' << '-q'
+  
+  # s.add_dependency("thoughtbot-shoulda", ["> 2.0.0"])
+end

data/test/test_card.rb

@@ -52,4 +52,8 @@ class TestCard < Test::Unit::TestCase
     assert_not_equal(@c1, c)
     assert_equal(@c1, @c1)
   end
+  
+  def test_hash
+    assert_equal(15, @c1.hash)
+  end
 end

data/test/test_poker_hand.rb

@@ -1,165 +1,210 @@
-require 'test/unit'
 require 'ruby-poker.rb'
+require 'rubygems'
+require 'shoulda'
 
 class TestPokerHand < Test::Unit::TestCase
-  def setup
-    @trips = PokerHand.new("2D 9C AS AH AC")
-    @full_boat = PokerHand.new(["2H", "2D", "4C", "4D", "4S"])
-    @flush = PokerHand.new("3D 6D 7D TD QD 5H 2S")
-    @straight = PokerHand.new("8H 9D TS JH QC AS")
-  end
+  context "A PokerHand instance" do
+  
+    setup do
+      @trips = PokerHand.new("2D 9C AS AH AC")
+      @full_boat = PokerHand.new(["2H", "2D", "4C", "4D", "4S"])
+      @flush = PokerHand.new("3D 6D 7D TD QD 5H 2S")
+      @straight = PokerHand.new("8H 9D TS JH QC AS")
+    end
   
-  # 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)
+    # there are a lot of combinations that should be tested here. I will add more
+    # troublesome cases as I think of them.
+    should "sort using rank" do
+      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
-    assert_equal([13, 13, 13, 8, 1], @trips.by_face.hand.collect {|c| c.face})
-  end
-
-  def test_by_suit
-    assert_equal([3, 2, 1, 0, 0], @trips.by_suit.hand.collect {|c| c.suit})
-  end
-
-  def test_face_values
-    assert_equal([1, 8, 13, 13, 13], @trips.face_values)
-  end
+      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_flush
-    assert @flush.flush?
-    assert !@trips.flush?
-  end
+    should "return card sorted by face value" do
+      assert_equal([13, 13, 13, 8, 1], @trips.by_face.hand.collect {|c| c.face})
+    end
 
-  def test_four_of_a_kind
-    assert !@trips.four_of_a_kind?
-    assert PokerHand.new("AD 9C AS AH AC")
-  end
+    should "return cards sorted by suit" do
+      assert_equal([3, 2, 1, 0, 0], @trips.by_suit.hand.collect {|c| c.suit})
+    end
 
-  def test_full_house
-    assert !@trips.full_house?
-    assert @full_boat.full_house?
-  end
+    should "return just the face values of the cards" do
+      assert_equal([1, 8, 13, 13, 13], @trips.face_values)
+    end
+    
+    should "recognize a straight flush" do
+      assert !@flush.straight_flush?
+      assert !@straight.straight_flush?
+      assert PokerHand.new("8H 9H TH JH QH AS").straight_flush?
+    end
+  
+    should "recognize a royal flush" do
+      assert !@flush.royal_flush?
+      assert PokerHand.new("AD KD QD JD TD").royal_flush?
+    end
 
-  def test_hand
-    assert_equal 5, @trips.hand.size
-    assert_instance_of Card, @trips.hand[0]
-  end
+    should "recognize a flush" do
+      assert @flush.flush?
+      assert !@trips.flush?
+    end
 
-  def test_hand_rating
-    assert_equal "Three of a kind", @trips.hand_rating
-    assert_equal "Full house", @full_boat.hand_rating
-  end
+    should "recognize a four of a kind" do
+      assert !@trips.four_of_a_kind?
+      assert PokerHand.new("AD 9C AS AH AC")
+    end
 
-  def test_rank
-    # rank is an alias for hand_rating
-    assert_not_nil @trips.rank
-  end
+    should "recognize a full house" do
+      assert !@trips.full_house?
+      assert @full_boat.full_house?
+    end
+    
+    should "recognize a straight" do
+      assert @straight.straight?
+      assert PokerHand.new("AH 2S 3D 4H 5D").straight?
+    end
 
-  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
+    should "recognize a three of a kind" do
+      assert @trips.three_of_a_kind?
+    end
 
-  def test_just_cards
-    assert_equal("2d 9c As Ah Ac", @trips.just_cards)
-  end
+    should "recognize a two pair" do
+      assert PokerHand.new("2S 2D TH TD 4S").two_pair?
+      assert !PokerHand.new("6D 7C 5D 5H 3S").two_pair?
+    end
+    
+    should "recognize a pair" do
+      assert !PokerHand.new("5C JC 2H 7S 3D").pair?
+      assert PokerHand.new("6D 7C 5D 5H 3S").pair?
+    end
+    
+    should "recognize a hand with the rank highest_card" do
+      # hard to test, make sure it does not return null
+      assert PokerHand.new("2D 4S 6C 8C TH").highest_card?
+    end
 
-  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
-    assert !@flush.royal_flush?
-    assert PokerHand.new("AD KD QD JD TD").royal_flush?
-  end
+    should "have an instance variable hand that is an array of Cards" do
+      assert_instance_of Card, @trips.hand[0]
+    end
 
-  def test_score
-    assert_equal([4, 13, 8, 1], @trips.score[0])
-  end
+    should "return the hand's rating as a string" do
+      assert_equal "Three of a kind", @trips.hand_rating
+      assert_equal "Full house", @full_boat.hand_rating
+    end
 
-  def test_straight
-    assert @straight.straight?
-    assert PokerHand.new("AH 2S 3D 4H 5D").straight?
-  end
+    should "respond to rank" do
+      # rank is an alias for hand_rating
+      assert_respond_to @trips, :rank
+    end
 
-  def test_straight_flush
-    assert !@flush.straight_flush?
-    assert !@straight.straight_flush?
-    assert PokerHand.new("8H 9H TH JH QH AS").straight_flush?
-  end
+    should "return the hand as a string" do
+      assert_equal("2d 9c As Ah Ac", @trips.just_cards)
+    end
 
-  def test_three_of_a_kind
-    assert @trips.three_of_a_kind?
-  end
+    should "return the hand's score" do
+      assert_equal([4, 13, 8, 1], @trips.score[0])
+    end
 
-  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
-  
-  def test_matching
-    assert_match(/9c/, @trips)
-  end
+    should "be able to match regular expressions" do
+      assert_match(/9c/, @trips.to_s)
+      assert_no_match(/AD/, @trips.to_s)
+    end
   
-  def test_size
-    assert_equal(2, PokerHand.new("2c 3d").size)
-  end
+    should "return the correct number of cards in the hand" do
+      assert_equal(2, PokerHand.new("2c 3d").size)
+    end
   
-  def test_comparisons
-    hand1 = PokerHand.new("5C JC 2H 5S 3D")
-    hand2 = PokerHand.new("6D 7C 5D 5H 3S")
-    assert_equal(1, hand1 <=> hand2)
-    assert_equal(-1, hand2 <=> hand1)
-  end
+    should "be comparable to other PokerHands" do
+      hand1 = PokerHand.new("5C JC 2H 5S 3D")
+      hand2 = PokerHand.new("6D 7C 5D 5H 3S")
+      assert_equal(1, hand1 <=> hand2)
+      assert_equal(-1, hand2 <=> hand1)
+    end
   
-  def test_equality
-    assert_equal(0, @trips <=> @trips)
+    should "be considered equal to other poker hands that contain the same cards" do
+      assert_equal(0, @trips <=> @trips)
     
-    hand1 = PokerHand.new("Ac Qc Ks Kd 9d 3c")
-    hand2 = PokerHand.new("Ah Qs 9h Kh Kc 3s")
-    assert_equal(0, hand1 <=> hand2)
-  end
+      hand1 = PokerHand.new("Ac Qc Ks Kd 9d 3c")
+      hand2 = PokerHand.new("Ah Qs 9h Kh Kc 3s")
+      assert_equal(0, hand1 <=> hand2)
+    end
   
-  def test_appending
-    ph = PokerHand.new()
-    ph << "Qd"
-    ph << Card.new("2D")
-    ph << ["3d", "4d"]
-    assert_equal("Qd 2d 3d 4d", ph.just_cards)
-  end
+    should "be able to add a Card to itself" do
+      ph = PokerHand.new()
+      ph << "Qd"
+      ph << Card.new("2D")
+      ph << ["3d", "4d"]
+      assert_equal("Qd 2d 3d 4d", ph.just_cards)
+    end
   
-  def test_delete
-    ph = PokerHand.new("Ac")
-    ph.delete("Ac")
-    assert_equal(Array.new, ph.hand)
-  end
+    should "be able to delete a card" do
+      ph = PokerHand.new("Ac")
+      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
+    context "when duplicates are allowed" do
+      setup do
+        PokerHand.allow_duplicates = true
+      end
+    
+      should "create a PokerHand of unique cards" do
+        uniq_ph = PokerHand.new("3s 4s 3s").uniq
+        assert_instance_of(PokerHand, uniq_ph)  # want to be sure uniq hands back a PokerHand
+        assert_contains(uniq_ph.hand, Card.new('3s'))
+        assert_contains(uniq_ph.hand, Card.new('4s'))
+      end
+    
+      should "allow five of a kind" do
+        # 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)
+      should "allow duplicates on initialize" do
+        assert_nothing_raised RuntimeError do
+          PokerHand.new("3s 3s")
+        end
+      end
     
-    PokerHand.allow_duplicates = false
-    assert_raise RuntimeError do
-      ph << "2d"
+      should "allow duplicate card to be added after initialize" do
+        ph = PokerHand.new("2d")
+        ph << "2d"
+        assert_equal("2d 2d", ph.just_cards)
+      end
     end
+  
+    context "when duplicates are not allowed" do
+      setup do
+        PokerHand.allow_duplicates = false
+      end
+  
+      should "not allow duplicates on initialize" do
+        PokerHand.allow_duplicates = false
+    
+        assert_raise RuntimeError do
+          PokerHand.new("3s 3s")
+        end
+    
+        PokerHand.allow_duplicates = true
+      end
+    
+      should "not allow duplicates after initialize" do
+        PokerHand.allow_duplicates = false
+    
+        ph = PokerHand.new("2d")    
+        assert_raise RuntimeError do
+          ph << "2d"
+        end
+    
+        PokerHand.allow_duplicates = true
+      end
+    end
+    
   end
 end
 

metadata

@@ -1,51 +1,51 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-poker
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
-- Robert Olson
+- Rob Olson
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-05-26 00:00:00 -07:00
+date: 2009-01-24 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: 
+description: Ruby library for comparing poker hands and determining the winner.
 email: rko618@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 - CHANGELOG
 - LICENSE
 files: 
+- CHANGELOG
 - examples/deck.rb
 - examples/quick_example.rb
 - lib/card.rb
 - lib/ruby-poker.rb
-- test/test_card.rb
-- test/test_poker_hand.rb
-- Rakefile
-- README
-- CHANGELOG
 - LICENSE
+- Rakefile
+- README.rdoc
+- ruby-poker.gemspec
 has_rdoc: true
-homepage: http://rubyforge.org/projects/rubypoker/
+homepage: http://github.com/robolson/ruby-poker
 post_install_message: 
 rdoc_options: 
 - --title
 - Ruby Poker Documentation
 - --main
-- README
+- README.rdoc
 - --inline-source
 - -q
 require_paths: 
 - lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
@@ -61,10 +61,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rubypoker
-rubygems_version: 1.1.1
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Ruby library for comparing poker hands and determining the winner.
+summary: Poker library in Ruby
 test_files: 
 - test/test_card.rb
 - test/test_poker_hand.rb

data/README

@@ -1,63 +0,0 @@
-= Poker hand evaluator for Ruby
-
-== Author
-
-Robert Olson (rko618 [at] gmail [dot] com)
-
-== License
-
-This is free software; you can redistribute it and/or modify it under the
-terms of the BSD license. See LICENSE for more details.
-
-== Download
-
-The latest version of <b>ruby poker</b> can be found at
-
-http://rubyforge.org/frs/?group_id=5257
-
-The homepage of this project is located at
-
-http://rubyforge.org/projects/rubypoker
-
-== Description
-
-Ruby-Poker handles the logic for getting the rank of a poker hand. It can also be used
-to compare two or more hands to determine which hand has the highest poker value.
-
-Card representations can be passed to the PokerHand constructor as a string or an array.
-Face cards (cards ten, jack, queen, king, and ace) are created using their 
-letter representation (T, J, Q, K, A).
-
-== Examples
-
-In this section some examples show what can be done with this class.
-
-    hand1 = PokerHand.new("8H 9C TC JD QH")
-    hand2 = PokerHand.new(["3D", "3C", "3S", "KD", "AH"])
-    puts hand1                => 8h 9c Tc Jd Qh (Straight)
-    puts hand1.just_cards     => 8h 9c Tc Jd Qh
-    puts hand1.rank           => Straight
-    puts hand2                => 3d 3c 3s Kd Ah (Three of a kind)
-    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).
-As of the 0.2.0 release ruby-poker incorporates Patrick Hurley's Texas 
-Holdem code from http://rubyquiz.com/quiz24.html which I merged into ruby-poker.