Class: PokerHand

Inherits:
Object
  • Object
show all
Includes:
Comparable, Enumerable
Defined in:
lib/ruby-poker/poker_hand.rb

Constant Summary collapse

OPS = 
[
  ['Royal Flush',     :royal_flush? ],
  ['Straight Flush',  :straight_flush? ],
  ['Four of a kind',  :four_of_a_kind? ],
  ['Full house',      :full_house? ],
  ['Flush',           :flush? ],
  ['Straight',        :straight? ],
  ['Three of a kind', :three_of_a_kind?],
  ['Two pair',        :two_pair? ],
  ['Pair',            :pair? ],
  ['Highest Card',    :highest_card? ],
  ['Empty Hand',      :empty_hand? ],
]
RESOLVING_METHODS =

Resolving methods are just passed directly down to the @hand array

[:each, :size, :-]
@@allow_duplicates =

true by default

true

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cards = []) ⇒ PokerHand

Returns a new PokerHand object. Accepts the cards represented in a string or an array

PokerHand.new("3d 5c 8h Ks")   # => #<PokerHand:0x5c673c ...
PokerHand.new(["3d", "5c", "8h", "Ks"])  # => #<PokerHand:0x5c2d6c ...



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/ruby-poker/poker_hand.rb', line 15

def initialize(cards = [])
  @hand = case cards
  when Array
    cards.map do |card|
      if card.is_a? Card
        card
      else
        Card.new(card.to_s)
      end
    end
  when String
    cards.scan(/\S{2}/).map { |str| Card.new(str) }
  else
    cards
  end

  check_for_duplicates unless allow_duplicates
end

Instance Attribute Details

#hand ⇒ Object (readonly)

Returns the value of attribute hand.



4
5
6
 
# File 'lib/ruby-poker/poker_hand.rb', line 4

def hand
  @hand
end

Class Method Details

.allow_duplicates ⇒ Object 



7
 
# File 'lib/ruby-poker/poker_hand.rb', line 7

def self.allow_duplicates; @@allow_duplicates; end

.allow_duplicates=(v) ⇒ Object 



8
 
# File 'lib/ruby-poker/poker_hand.rb', line 8

def self.allow_duplicates=(v); @@allow_duplicates = v; end

Instance Method Details

#+(other) ⇒ Object 



415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/ruby-poker/poker_hand.rb', line 415

def +(other)
  cards = @hand.map { |card| Card.new(card) }
  case other
  when String
    cards << Card.new(other)
  when Card
    cards << other
  when PokerHand
    cards += other.hand
  else
    raise ArgumentError, "Invalid argument: #{other.inspect}"
  end
  PokerHand.new(cards)
end

#<<(new_cards) ⇒ Object

Add a card to the hand

hand = PokerHand.new("5d")
hand << "6s"          # => Add a six of spades to the hand by passing a string
hand << ["7h", "8d"]  # => Add multiple cards to the hand using an array



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/ruby-poker/poker_hand.rb', line 306

def << new_cards
  if new_cards.is_a?(Card) || new_cards.is_a?(String)
    new_cards = [new_cards]
  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

#<=>(other_hand) ⇒ Object 



297
298
299
 
# File 'lib/ruby-poker/poker_hand.rb', line 297

def <=> other_hand
  self.score[0].compact <=> other_hand.score[0].compact
end

#=~(re) ⇒ Object

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>



73
74
75
 
# File 'lib/ruby-poker/poker_hand.rb', line 73

def =~ (re)
  re.match(just_cards)
end

#allow_duplicates ⇒ Object 



344
345
346
 
# File 'lib/ruby-poker/poker_hand.rb', line 344

def allow_duplicates
  @@allow_duplicates
end

#by_face ⇒ Object

Returns a new PokerHand object with the cards sorted by face value with the highest value first.

PokerHand.new("3d 5c 8h Ks").by_face.just_cards   # => "Ks 8h 5c 3d"



46
47
48
 
# File 'lib/ruby-poker/poker_hand.rb', line 46

def by_face
  PokerHand.new(@hand.sort_by { |c| [c.face, c.suit] }.reverse)
end

#by_suit ⇒ Object

Returns a new PokerHand object with the cards sorted by suit The suit order is spades, hearts, diamonds, clubs

PokerHand.new("3d 5c 8h Ks").by_suit.just_cards   # => "Ks 8h 3d 5c"



38
39
40
 
# File 'lib/ruby-poker/poker_hand.rb', line 38

def by_suit
  PokerHand.new(@hand.sort_by { |c| [c.suit, c.face] }.reverse)
end

#delete(card) ⇒ Object

Remove a card from the hand.

hand = PokerHand.new("5d Jd")
hand.delete("Jd")           # => #<Card:0x5d0674 @value=23, @face=10, @suit=1>
hand.just_cards             # => "5d"



325
326
327
 
# File 'lib/ruby-poker/poker_hand.rb', line 325

def delete card
  @hand.delete(Card.new(card))
end

#empty_hand? ⇒ Boolean

Returns:

  • (Boolean) 


233
234
235
236
237
 
# File 'lib/ruby-poker/poker_hand.rb', line 233

def empty_hand?
  if size == 0
    [[0]]
  end
end

#face_values ⇒ Object

Returns an array of the card values in the hand. The values returned are 1 less than the value on the card. For example: 2’s will be shown as 1.

PokerHand.new(["3c", "Kh"]).face_values     # => [2, 12]



63
64
65
 
# File 'lib/ruby-poker/poker_hand.rb', line 63

def face_values
  @hand.map { |c| c.face }
end

#flush? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/ruby-poker/poker_hand.rb', line 126

def flush?
  if (md = (by_suit =~ /(.)(.) (.)\2 (.)\2 (.)\2 (.)\2/))
    [
      [
        6,
        Card::face_value(md[1]),
        *(md[3..6].map { |f| Card::face_value(f) })
      ],
      arrange_hand(md)
    ]
  else
    false
  end
end

#four_of_a_kind? ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
99
100
101
102
103
104
 
# File 'lib/ruby-poker/poker_hand.rb', line 96

def four_of_a_kind?
  if (md = (by_face =~ /(.). \1. \1. \1./))
    # get kicker
    result = [8, Card::face_value(md[1])]
    result << Card::face_value($1) if (md.pre_match + md.post_match).match(/(\S)/)
    return [result, arrange_hand(md)]
  end
  false
end

#full_house? ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/ruby-poker/poker_hand.rb', line 106

def full_house?
  if (md = (by_face =~ /(.). \1. \1. (.*)(.). \3./))
    arranged_hand = arrange_hand(md[0] + ' ' +
        md.pre_match + ' ' + md[2] + ' ' + md.post_match)
    [
      [7, Card::face_value(md[1]), Card::face_value(md[3])],
      arranged_hand
    ]
  elsif (md = (by_face =~ /((.). \2.) (.*)((.). \5. \5.)/))
    arranged_hand = arrange_hand(md[4] + ' '  + md[1] + ' ' +
        md.pre_match + ' ' + md[3] + ' ' + md.post_match)
    [
      [7, Card::face_value(md[5]), Card::face_value(md[2])],
      arranged_hand
    ]
  else
    false
  end
end

#hand_rating ⇒ Object Also known as: rank

Returns the verbose hand rating

PokerHand.new("4s 5h 6c 7d 8s").hand_rating     # => "Straight"



256
257
258
259
260
 
# File 'lib/ruby-poker/poker_hand.rb', line 256

def hand_rating
  OPS.map { |op|
    (method(op[1]).call()) ? op[0] : false
  }.find { |v| v }
end

#highest_card? ⇒ Boolean

Returns:

  • (Boolean) 


224
225
226
227
228
229
230
231
 
# File 'lib/ruby-poker/poker_hand.rb', line 224

def highest_card?
  if size > 0
    result = by_face
    [[1, *result.face_values[0..result.face_values.length]], result.hand.join(' ')]
  else
    false
  end
end

#just_cards ⇒ Object Also known as: cards

Returns string representation of the hand without the rank

PokerHand.new(["3c", "Kh"]).just_cards     # => "3c Kh"



53
54
55
 
# File 'lib/ruby-poker/poker_hand.rb', line 53

def just_cards
  @hand.join(" ")
end

#match?(expression) ⇒ Boolean

Checks whether the hand matches usual expressions like AA, AK, AJ+, 66+, AQs, AQo…

Valid expressions:

  • “AJ”: Matches exact faces (in this case an Ace and a Jack), suited or not

  • “AJs”: Same but suited only

  • “AJo”: Same but offsuit only

  • “AJ+”: Matches an Ace with any card >= Jack, suited or not

  • “AJs+”: Same but suited only

  • “AJo+”: Same but offsuit only

  • “JJ+”: Matches any pair >= “JJ”.

  • “8T+”: Matches connectors (in this case with 1 gap : 8T, 9J, TQ, JK, QA)

  • “8Ts+”: Same but suited only

  • “8To+”: Same but offsuit only

The order of the cards in the expression is important (8T+ is not the same as T8+), but the order of the cards in the hand is not (“AK” will match “Ad Kc” and “Kc Ad”).

The expression can be an array of expressions. In this case the method returns true if any expression matches.

This method only works on hands with 2 cards.

PokerHand.new('Ah Ad').match? 'AA' # => true
PokerHand.new('Ah Kd').match? 'AQ+' # => true
PokerHand.new('Jc Qc').match? '89s+' # => true
PokerHand.new('Ah Jd').match? %w( 22+ A6s+ AJ+ ) # => true
PokerHand.new('Ah Td').match? %w( 22+ A6s+ AJ+ ) # => false

Returns:

  • (Boolean) 


374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/ruby-poker/poker_hand.rb', line 374

def match? expression
  raise "Hands with #{@hand.size} cards is not supported" unless @hand.size == 2

  if expression.is_a? Array
    return expression.any? { |e| match?(e) }
  end

  faces = @hand.map { |card| card.face }.sort.reverse
  suited = @hand.map { |card| card.suit }.uniq.size == 1
  if expression =~ /^(.)(.)(s|o|)(\+|)$/
    face1 = Card.face_value($1)
    face2 = Card.face_value($2)
    raise ArgumentError, "Invalid expression: #{expression.inspect}" unless face1 and face2
    suit_match = $3
    plus = ($4 != "")

    if plus
      if face1 == face2
        face_match = (faces.first == faces.last and faces.first >= face1)
      elsif face1 > face2
        face_match = (faces.first == face1 and faces.last >= face2)
      else
        face_match = ((faces.first - faces.last) == (face2 - face1) and faces.last >= face1)
      end
    else
      expression_faces = [face1, face2].sort.reverse
      face_match = (expression_faces == faces)
    end
    case suit_match
    when ''
      face_match
    when 's'
      face_match and suited
    when 'o'
      face_match and !suited
    end
  else
    raise ArgumentError, "Invalid expression: #{expression.inspect}"
  end
end

#pair? ⇒ Boolean

Returns:

  • (Boolean) 


205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/ruby-poker/poker_hand.rb', line 205

def pair?
  if (md = (by_face =~ /(.). \1./))
    arranged_hand_str = arrange_hand(md)
    arranged_hand = PokerHand.new(arranged_hand_str)

    if arranged_hand.hand[0].face == arranged_hand.hand[1].face &&
        arranged_hand.hand[0].suit != arranged_hand.hand[1].suit
      result = [2, arranged_hand.hand[0].face]
      result << arranged_hand.hand[2].face if arranged_hand.size > 2
      result << arranged_hand.hand[3].face if arranged_hand.size > 3
      result << arranged_hand.hand[4].face if arranged_hand.size > 4

      return [result, arranged_hand_str]
    end
  else
    false
  end
end

#royal_flush? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
80
81
82
83
 
# File 'lib/ruby-poker/poker_hand.rb', line 77

def royal_flush?
  if (md = (by_suit =~ /A(.) K\1 Q\1 J\1 T\1/))
    [[10], arrange_hand(md)]
  else
    false
  end
end

#score ⇒ Object 



264
265
266
267
268
269
270
271
 
# File 'lib/ruby-poker/poker_hand.rb', line 264

def score
  # OPS.map returns an array containing the result of calling each OPS method against
  # the poker hand. The truthy cell closest to the front of the array represents
  # the highest ranking.
  OPS.map { |op|
    method(op[1]).call()
  }.find { |score| score }
end

#sort_using_rank ⇒ Object

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"



279
280
281
 
# File 'lib/ruby-poker/poker_hand.rb', line 279

def sort_using_rank
  score[1]
end

#straight? ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/ruby-poker/poker_hand.rb', line 141

def straight?
  result = false
  if hand.size >= 5
    transform = delta_transform
    # note we can have more than one delta 0 that we
    # need to shuffle to the back of the hand
    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)
      result = [[5, high_card], arranged_hand]
    end
  end
end

#straight_flush? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ruby-poker/poker_hand.rb', line 85

def straight_flush?
  if (md = (/.(.)(.)(?: 1.\2){4}/.match(delta_transform(true))))
    high_card = Card::face_value(md[1])
    arranged_hand = fix_low_ace_display(md[0] + ' ' +
        md.pre_match + ' ' + md.post_match)
    [[9, high_card], arranged_hand]
  else
    false
  end
end

#three_of_a_kind? ⇒ Boolean

Returns:

  • (Boolean) 


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/ruby-poker/poker_hand.rb', line 162

def three_of_a_kind?
  if (md = (by_face =~ /(.). \1. \1./))
    # get kicker
    arranged_hand = arrange_hand(md)
    matches = arranged_hand.match(/(?:\S\S ){2}(\S\S)/)
    if matches
      result = [4, Card::face_value(md[1])]
      matches = arranged_hand.match(/(?:\S\S ){3}(\S)/)
      result << Card::face_value($1) if matches
      matches = arranged_hand.match(/(?:\S\S ){3}(\S)\S (\S)/)
      result << Card::face_value($2) if matches
      return [result, arranged_hand]
    end
  end
  false
end

#to_a ⇒ Object Also known as: to_ary

Returns an array of ‘Card` objects that make up the `PokerHand`.



292
293
294
 
# File 'lib/ruby-poker/poker_hand.rb', line 292

def to_a
  @hand
end

#to_s ⇒ Object

Returns string with a listing of the cards in the hand followed by the hand’s rank.

h = PokerHand.new("8c 8s")
h.to_s                      # => "8c 8s (Pair)"



287
288
289
 
# File 'lib/ruby-poker/poker_hand.rb', line 287

def to_s
  just_cards + " (" + hand_rating + ")"
end

#two_pair? ⇒ Boolean

Returns:

  • (Boolean) 


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/ruby-poker/poker_hand.rb', line 179

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./))
    # 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 were 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)
    matches = arranged_hand.match(/(?:\S\S ){3}(\S\S)/)
    if matches
      result = []
      result << 3
      result << Card::face_value(md[1])    # face value of the first pair
      result << Card::face_value(md[3])    # face value of the second pair
      matches = arranged_hand.match(/(?:\S\S ){4}(\S)/)
      result << Card::face_value($1) if matches    # face value of the kicker
    return [result, arranged_hand]
    end
  end
  false
end

#uniq ⇒ Object

Same concept as Array#uniq



330
331
332
 
# File 'lib/ruby-poker/poker_hand.rb', line 330

def uniq
  PokerHand.new(@hand.uniq)
end