deck_of_cards_handler 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 429d1307ee681bdbe06c04a5b4232a106d2ad4a0f07cbe684eaab13254e9f402
-  data.tar.gz: 4d89bba0e091028380bb6481dacf2f48a97b3df1147a67a0f8c3bfbc67a3997b
+  metadata.gz: ada5266ea6fced842e0110cfb42413202aecd0344b6e50d7e03284b148a3de12
+  data.tar.gz: 69e43292eb8d3476afd899093ec29391e96dcc97cc52c0378c08830c5b35b47e
 SHA512:
-  metadata.gz: 971705372f4d56fc9d63d44f0d0c7b1a999209ff6f197084f8e951a58689ba45448c62ef3608eca4f97784dc9b6a4c8474aca0ce58de02e5811a3d9c654d47f4
-  data.tar.gz: bbe3e25a0fe903c1e687455225d64aeacd033d726d910f0516a7de7b83d626aa65e9d328234f654326a86f74c90a7f479c043aabe31a696f0259eaa99c400d7f
+  metadata.gz: b65f41b901b72be9ad9e8978b34cc2ada7f886ed5e6fe704d8fb630cd02cba94bbee162e9e09097b4496663e41cd50d251b653ed77ac9ff92bb7bb5f1458d19f
+  data.tar.gz: 62ce89b3c2cf352ad82a8fd3f8c2c86cfbe731cfe4c9f633b53dbd3ff6183d822d48916f6e1b5b66647c85e1e96a75038e1b00916f201119e51dc118e3cfc155

data/README.md

@@ -1,38 +1,154 @@
-# DeckOfCards
+# Deck of cards handler
 
-This is a gem that simulates the handling of a deck of cards.
-It provides all the moves one could do such as shuffling, cutting, dealing, culling, etc.
+A ruby gem for simulating real-world deck handling: shuffle, cut, deal, cull
+and more.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Run the following terminal command:
 
-Install the gem and add to the application's Gemfile by executing:
+```zsh
+gem install deck_of_cards_handler
+```
 
-```bash
-bundle add deck_of_card_handler
+## Usage examples
+
+<details>
+<summary>Create the Mnemonica stack from Stay Stack</summary>
+
+```ruby
+  require "deck_of_cards_handler"
+
+  # create a deck in stay stack order
+  clubs = Card.values.map { Card.new(suit: "C", value: _1) }
+  hearts = Card.values.map { Card.new(suit: "H", value: _1) }
+  diamonds = Card.values.map { Card.new(suit: "D", value: _1) }
+  spades = Card.values.map { Card.new(suit: "S", value: _1) }
+  deck = Packet.new(cards: [clubs, hearts, diamonds.reverse, spades.reverse].flatten)
+
+  # make 4 faro shuffles
+  4.times do
+    top_half = deck.cut(number: 26)
+    deck.faro(other_packet: top_half)
+  end
+
+  # reverse the first 26 cards
+  top_half = deck.cut(number: 26)
+  top_half.reverse
+  deck.cards = [top_half.cards, deck.cards].flatten
+
+  # faro the 18 first cards
+  top_half = deck.cut(number: 18)
+  deck.faro(other_packet: top_half)
+
+  # cut the 9D to the bottom
+  deck.cut_and_complete(number: 9)
+  # assign a position value to the cards
+  deck.set_cards_positions
+
+  deck
+#  =>
+# <Packet:0x000000012ae2b848
+#  @cards=
+    [#<Card:0x000000012ae2bd20 @position=1, @suit="S", @value="4">,
+    #<Card:0x000000012ae2cae0 @position=2, @suit="H", @value="2">,
+    #<Card:0x000000012ae2c220 @position=3, @suit="D", @value="7">,
+    #<Card:0x000000012ae2bd98 @position=4, @suit="S", @value="3">,
+    #<Card:0x000000012ae2c9f0 @position=5, @suit="H", @value="4">,
+    #<Card:0x000000012ae2c298 @position=6, @suit="D", @value="6">,
+    #<Card:0x000000012ae2df08 @position=7, @suit="C", @value="A">,
+    #<Card:0x000000012ae2c978 @position=8, @suit="H", @value="5">,
+    #<Card:0x000000012ae2ce00 @position=9, @suit="C", @value="9">,
+    #<Card:0x000000012ae2d260 @position=10, @suit="C", @value="2">,
+    #<Card:0x000000012ae2c630 @position=11, @suit="H", @value="Q">,
+    #<Card:0x000000012ae2c400 @position=12, @suit="D", @value="3">,
+    #<Card:0x000000012ae2b960 @position=13, @suit="S", @value="Q">,
+    #<Card:0x000000012ae2c810 @position=14, @suit="H", @value="8">,
+    #<Card:0x000000012ae2cf68 @position=15, @suit="C", @value="6">,
+    #<Card:0x000000012ae2cfe0 @position=16, @suit="C", @value="5">,
+    #<Card:0x000000012ae2c798 @position=17, @suit="H", @value="9">,
+    #<Card:0x000000012ae2b8e8 @position=18, @suit="S", @value="K">,
+    #<Card:0x000000012ae2c478 @position=19, @suit="D", @value="2">,
+    #<Card:0x000000012ae2c6a8 @position=20, @suit="H", @value="J">,
+    #<Card:0x000000012ae2d0d0 @position=21, @suit="C", @value="3">,
+    #<Card:0x000000012ae2ce78 @position=22, @suit="C", @value="8">,
+    #<Card:0x000000012ae2c900 @position=23, @suit="H", @value="6">,
+    #<Card:0x000000012ae2ba50 @position=24, @suit="S", @value="10">,
+    #<Card:0x000000012ae2c310 @position=25, @suit="D", @value="5">,
+    #<Card:0x000000012ae2bf50 @position=26, @suit="D", @value="K">,
+    #<Card:0x000000012ae2be10 @position=27, @suit="S", @value="2">,
+    #<Card:0x000000012ae2ca68 @position=28, @suit="H", @value="3">,
+    #<Card:0x000000012ae2c1a8 @position=29, @suit="D", @value="8">,
+    #<Card:0x000000012ae2bca8 @position=30, @suit="S", @value="5">,
+    #<Card:0x000000012ae2cc20 @position=31, @suit="C", @value="K">,
+    #<Card:0x000000012ae2c040 @position=32, @suit="D", @value="J">,
+    #<Card:0x000000012ae2bb40 @position=33, @suit="S", @value="8">,
+    #<Card:0x000000012ae2cd88 @position=34, @suit="C", @value="10">,
+    #<Card:0x000000012ae2c5b8 @position=35, @suit="H", @value="K">,
+    #<Card:0x000000012ae2b9d8 @position=36, @suit="S", @value="J">,
+    #<Card:0x000000012ae2cef0 @position=37, @suit="C", @value="7">,
+    #<Card:0x000000012ae2c720 @position=38, @suit="H", @value="10">,
+    #<Card:0x000000012ae2c4f0 @position=39, @suit="D", @value="A">,
+    #<Card:0x000000012ae2d058 @position=40, @suit="C", @value="4">,
+    #<Card:0x000000012ae2c888 @position=41, @suit="H", @value="7">,
+    #<Card:0x000000012ae2c388 @position=42, @suit="D", @value="4">,
+    #<Card:0x000000012ae2be88 @position=43, @suit="S", @value="A">,
+    #<Card:0x000000012ae2bac8 @position=44, @suit="S", @value="9">,
+    #<Card:0x000000012ae2cd10 @position=45, @suit="C", @value="J">,
+    #<Card:0x000000012ae2bfc8 @position=46, @suit="D", @value="Q">,
+    #<Card:0x000000012ae2bbb8 @position=47, @suit="S", @value="7">,
+    #<Card:0x000000012ae2cc98 @position=48, @suit="C", @value="Q">,
+    #<Card:0x000000012ae2c0b8 @position=49, @suit="D", @value="10">,
+    #<Card:0x000000012ae2bc30 @position=50, @suit="S", @value="6">,
+    #<Card:0x000000012ae2cb58 @position=51, @suit="H", @value="A">,
+    #<Card:0x000000012ae2c130 @position=52, @suit="D", @value="9">]>
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+</details>
 
-```bash
-gem install deck_of_card_handler
-```
+<details>
+<summary>Distribute 5 hands of poker</summary>
+
+```ruby
+  require "deck_of_cards_handler"
 
-## Usage
+  # create a full deck of cards
+  cards = []
+  Card.suits.each do |suit|
+    Card.values.each do |value|
+      cards << Card.new(suit:, value:)
+    end
+  end
+  deck = Packet.new(cards:)
 
-TODO: Write usage instructions here
+  deck.shuffle
+
+  hands = deck.deal_into_piles(number_of_piles: 5, number_of_cards: 5)
+
+  hands.map(&:to_s)
+  # => [["5 of D", "8 of C", "6 of S", "10 of D", "5 of C"], ["7 of C", "5 of S", "4 of C", "2 of D", "Q of D"], ["3 of S", "8 of D", "A of D", "2 of C", "7 of D"], ["Q of H", "4 of S", "3 of D", "J of S", "9 of S"], ["6 of C", "6 of H", "10 of C", "4 of D", "A of H"]]
+```
+
+</details>
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```zsh
+bin/setup
+```
 
-## Contributing
+This installs dependencies.
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/simonbernard2/deck_of_cards>.
+Run the test suite:
 
-## License
+```zsh
+rake test
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+You can also open an interactive console for experimentation:
+
+```zsh
+bin/console
+```

data/lib/deck_of_cards_handler/card/card.rb

@@ -50,28 +50,20 @@ class Card
     other.suit == suit && other.value == value
   end
 
-  sig { returns(T::Array[Integer]) }
-  def rank
+  sig { params(low_ace: T::Boolean).returns(Integer) }
+  def rank(low_ace: false)
     case value
-    when "A" then [1, 14]
-    when "J" then [11]
-    when "Q" then [12]
-    when "K" then [13]
-    else [value.to_i]
+    when "A" then low_ace ? 1 : 14
+    when "J" then 11
+    when "Q" then 12
+    when "K" then 13
+    else value.to_i
     end
   end
 
   sig { params(other: Card).returns(Integer) }
   def <=>(other)
-    # compare by all possible ranks (Ace flexible)
-    my_ranks = rank
-    other_ranks = other.rank
-
-    # check if any ranks overlap (Ace == 1 or 14)
-    return 0 if (my_ranks & other_ranks).any?
-
-    # otherwise compare by highest possible
-    T.must(my_ranks.max) <=> T.must(other_ranks.max)
+    rank <=> other.rank
   end
 
   class << self

data/lib/deck_of_cards_handler/packet/packet.rb

@@ -47,14 +47,14 @@ class Packet
       end
 
       packet = Packet.new(cards:)
-      set_cards_positions(packet:)
+      packet.set_cards_positions
 
       packet
     end
 
-    sig { params(string: String).returns(Packet) }
+    sig { overridable.params(string: String).returns(Packet) }
     def build_from_string(string:) # rubocop:disable Metrics
-      content = string.split(",")
+      content = string.split(",").map(&:strip)
       cards = []
       cards_set = Set.new
 
@@ -71,19 +71,10 @@ class Packet
       end
 
       packet = Packet.new(cards:)
-      set_cards_positions(packet:)
+      packet.set_cards_positions
 
       packet
     end
-
-    private
-
-    sig { params(packet: Packet).void }
-    def set_cards_positions(packet:)
-      packet.cards.each_with_index do |card, index|
-        card.position = index + 1
-      end
-    end
   end
 
   sig { params(other_packet: Packet).void }
@@ -106,6 +97,13 @@ class Packet
     self.cards = cards.reverse
   end
 
+  sig { void }
+  def set_cards_positions
+    cards.each_with_index do |card, index|
+      card.position = index + 1
+    end
+  end
+
   sig { returns(T::Array[String]) }
   def to_s
     cards.map(&:to_s)

data/lib/deck_of_cards_handler/poker_hand.rb

@@ -0,0 +1,123 @@
+# typed: strict
+# frozen_string_literal: true
+
+# This represents a poker hands raking
+class PokerHand < Packet
+  extend T::Sig
+  extend T::Helpers
+
+  sig { params(cards: T::Array[Card]).void }
+  def initialize(cards:)
+    raise ArgumentError if cards.size != 5
+
+    super
+  end
+
+  class << self
+    sig { override.params(string: String).returns(PokerHand) }
+    def build_from_string(string:)
+      result = super
+      PokerHand.new(cards: result.cards)
+    end
+  end
+
+  HAND_RANKS = T.let(
+    {
+      nothing: 0,
+      pair: 1,
+      two_pairs: 2,
+      three_of_a_kind: 3,
+      straight: 4,
+      flush: 5,
+      full_house: 6,
+      four_of_a_kind: 7,
+      straight_flush: 8
+    }.freeze, T::Hash[Symbol, Integer]
+  )
+
+  sig { returns(Integer) }
+  def rank # rubocop:disable Metrics
+    return T.must(HAND_RANKS[:straight_flush]) if straight_flush?
+    return T.must(HAND_RANKS[:four_of_a_kind]) if four_of_a_kind?
+    return T.must(HAND_RANKS[:full_house]) if full_house?
+    return T.must(HAND_RANKS[:flush]) if flush?
+    return T.must(HAND_RANKS[:straight]) if straight?
+    return T.must(HAND_RANKS[:three_of_a_kind]) if three_of_a_kind?
+    return T.must(HAND_RANKS[:two_pairs]) if two_pairs?
+    return T.must(HAND_RANKS[:pair]) if pair?
+
+    T.must(HAND_RANKS[:nothing])
+  end
+
+  sig { returns(T::Boolean) }
+  def pair?
+    validate_hand_size
+
+    counts = cards.map(&:rank).flatten.tally
+    counts.values.count(2) == 1
+  end
+
+  sig { returns(T::Boolean) }
+  def two_pairs?
+    validate_hand_size
+
+    counts = cards.map(&:rank).flatten.tally
+    counts.values.count(2) == 2
+  end
+
+  sig { returns(T::Boolean) }
+  def three_of_a_kind?
+    validate_hand_size
+
+    counts = cards.map(&:rank).flatten.tally
+    counts.values.count(3) == 1
+  end
+
+  sig { returns(T::Boolean) }
+  def straight? # rubocop:disable Metrics/AbcSize
+    validate_hand_size
+
+    ranks = cards.map(&:rank).sort
+    return true if ranks.each_cons(2).all? { |a, b| b == T.must(a) + 1 }
+
+    ranks = cards.map { _1.rank(low_ace: true) }
+    ranks.each_cons(2).all? { |a, b| b == T.must(a) + 1 }
+  end
+
+  sig { returns(T::Boolean) }
+  def flush?
+    validate_hand_size
+
+    suit = T.must(cards.first).suit
+    cards.all? { _1.suit == suit }
+  end
+
+  sig { returns(T::Boolean) }
+  def full_house?
+    validate_hand_size
+
+    three_of_a_kind? && pair?
+  end
+
+  sig { returns(T::Boolean) }
+  def four_of_a_kind?
+    validate_hand_size
+
+    counts = cards.map(&:rank).flatten.tally
+    counts.values.count(4) == 1
+  end
+
+  sig { returns(T::Boolean) }
+  def straight_flush?
+    validate_hand_size
+
+    straight? && flush?
+  end
+
+  private
+
+  sig { void }
+  def validate_hand_size
+    raise StandardError unless size == 5
+  end
+end

data/lib/deck_of_cards_handler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeckOfCardsHandler
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/deck_of_cards_handler.rb

@@ -4,3 +4,4 @@ require "sorbet-runtime"
 require_relative "deck_of_cards_handler/version"
 require_relative "deck_of_cards_handler/card"
 require_relative "deck_of_cards_handler/packet"
+require_relative "deck_of_cards_handler/poker_hand"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deck_of_cards_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Simon Bernard
@@ -75,6 +75,7 @@ files:
 - lib/deck_of_cards_handler/packet/deals.rb
 - lib/deck_of_cards_handler/packet/packet.rb
 - lib/deck_of_cards_handler/packet/shuffles.rb
+- lib/deck_of_cards_handler/poker_hand.rb
 - lib/deck_of_cards_handler/version.rb
 - sig/deck_of_cards.rbs
 - sorbet/config