deck_of_cards_handler 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 429d1307ee681bdbe06c04a5b4232a106d2ad4a0f07cbe684eaab13254e9f402
-  data.tar.gz: 4d89bba0e091028380bb6481dacf2f48a97b3df1147a67a0f8c3bfbc67a3997b
+  metadata.gz: 9bb4b9ad9eeda85ab0251a2d2a0d1030ad1713956582d204726402254d1b423b
+  data.tar.gz: 61b9a15a482800bc77b55f3e81402314ad1668fdfb0d8d1076bec4388ab05cb6
 SHA512:
-  metadata.gz: 971705372f4d56fc9d63d44f0d0c7b1a999209ff6f197084f8e951a58689ba45448c62ef3608eca4f97784dc9b6a4c8474aca0ce58de02e5811a3d9c654d47f4
-  data.tar.gz: bbe3e25a0fe903c1e687455225d64aeacd033d726d910f0516a7de7b83d626aa65e9d328234f654326a86f74c90a7f479c043aabe31a696f0259eaa99c400d7f
+  metadata.gz: f10d2d29dabdd04098c987d992e06c303cb3a142097973aceb4f0e11cbfaf52feeea8d23418f488167fa645742accfb44ac6841efc71b84cada89b5362275865
+  data.tar.gz: aa06d832d4e713cade2a60cd8a06fc7d7da776e3f86b9b1ce62c6101448c91c930f4248efd7a82c84587add52de9d3d08c05205a623eca53dde2d7c5f4fcb95a

data/README.md

@@ -1,38 +1,95 @@
-# 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:
-
-```bash
-bundle add deck_of_card_handler
+```zsh
+gem install deck_of_cards_handler
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## 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
 
-```bash
-gem install deck_of_card_handler
 ```
 
-## Usage
+</details>
+
+<details>
+<summary>Distribute 5 hands of poker</summary>
 
-TODO: Write usage instructions here
+```ruby
+  require "deck_of_cards_handler"
+
+  # 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:)
+
+  deck.shuffle
+
+  hands = deck.deal_into_piles(number_of_piles: 5, number_of_cards: 5)
+```
+
+</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
+```
+
+This installs dependencies.
 
-## Contributing
+Run the test suite:
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/simonbernard2/deck_of_cards>.
+```zsh
+rake test
+```
 
-## License
+You can also open an interactive console for experimentation:
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```zsh
+bin/console
+```

data/lib/deck_of_cards_handler/packet/packet.rb

@@ -47,7 +47,7 @@ class Packet
       end
 
       packet = Packet.new(cards:)
-      set_cards_positions(packet:)
+      packet.set_cards_positions
 
       packet
     end
@@ -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/version.rb

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

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.4
 platform: ruby
 authors:
 - Simon Bernard