fiftytwo 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c00da0e98ce49dd9546e2936caf0f8b19dea1353ff953e35edf0fa4e8856e97
-  data.tar.gz: bd0ec3c7c3b7bb0305c3b9b8ed534865eee21dd47a9b0e61e69655d9a7d3c8ff
+  metadata.gz: bf4943f0c945d56876c500510e5b3d484aad7a10b3957372d34ce5802e1cb712
+  data.tar.gz: dd70bde751e33a47750c1b80174a89cc70dd3a6d94aeee084ccf8f8cec2bf9fd
 SHA512:
-  metadata.gz: c2dbb21639b82fe689c8de2ef7033783e9a5ade2fd35372f7e763b09464cec1bc46bac943cd9274499621143922fe7eb7c0d34426b9430f698ea8dcc120b3216
-  data.tar.gz: cebde92a30ff69c21a3244e29588eef325431c0d684cddbb2b7a66c4bf34846a397b8529edc87397862512fbde75bd9a0960ff61c0f83d86e569211aecef6d83
+  metadata.gz: 1e5d0e2f89d862a920f3660915a713ea2750f4380777cb464bf200727c8e8077901ab418869c58d1f37eda99ce33fd0a4339190b2ee323a54be310d6bd958c83
+  data.tar.gz: cad05b3559ac84e6cf7bced0a9dcc97ba2b5126bc5bd8ecc9b631f399865f21e84b86ea9c1e11c39fbaf9663e563408e4f97ea93089cfeff9cba5f36ce1c557b

data/README.md

@@ -111,41 +111,94 @@ my_hand = FiftyTwo::Hand.new
 your_hand = FiftyTwo::Hand.new
 # => #<FiftyTwo::Hand:0x00007fb3d21c68c0 @cards=[]>
 
-deck.deal([my_hand, your_hand], hand_size: 5)
+deck.deal([my_hand, your_hand], 5)
 "Deck has #{deck.count} cards, I have #{my_hand.count} cards, you have #{your_hand.count} cards"
 # => "Deck has 42 cards, I have 5 cards, you have 5 cards"
 
 puts my_hand.render, your_hand.render # by the way renderings are colored red/black in your terminal, just like the suit!
- 3♦  4♠  5♦  7♥  2♣
- 6♠  A♦  5♠ 10♦  Q♣
+# 3♦  4♠  5♦  7♥  2♣
+# 6♠  A♦  5♠ 10♦  Q♣
 ```
 
 Hands, just like the deck, can be shuffled, sorted, searched, etc:
 ```ruby
 your_hand.sort!
 puts your_hand.render
- 5♠  6♠ 10♦  Q♣  A♦
+# 5♠  6♠ 10♦  Q♣  A♦
 
 your_hand.aces.count
 # => 1
 ```
 
+Examine the overall composition of a hand:
+```ruby
+your_hand.suits.map(&:name) # values are ordered ascending. try ranks too!
+# => ["clubs", "diamonds", "spades"]
+```
+
 Pass your cards around:
 ```ruby
-my_hand.transfer("4S", your_hand)
+my_hand.transfer("4S", your_hand) # try an array of card identifiers and/or indexes, too!
 puts my_hand.render, your_hand.render
- 3♦  5♦  7♥  2♣
- 5♠  6♠ 10♦  Q♣  A♦  4♠
+# 3♦  5♦  7♥  2♣
+# 5♠  6♠ 10♦  Q♣  A♦  4♠
 
 your_hand.transfer("QC") # goes back to the deck
 puts my_hand.render, your_hand.render
- 3♦  5♦  7♥  2♣
- 5♠  6♠ 10♦  A♦  4♠
+# 3♦  5♦  7♥  2♣
+# 5♠  6♠ 10♦  A♦  4♠
 
 deck.count
 # => 43
 ```
 
+And finally, release your hand back to the dealer:
+```ruby
+my_hand.release
+your_hand.release
+
+"Deck has #{deck.count} cards, I have #{my_hand.count} cards, you have #{your_hand.count} cards"
+# => "Deck has 52 cards, I have 0 cards, you have 0 cards"
+```
+
+## Example: 5 card draw poker
+_Reminder, we are implementing a deck of cards, and the operations you can perform with that deck. Evaluation of hands is dependent upon some
+particular game, and is outside the scope of this gem!_
+
+```ruby
+require "fiftytwo"
+
+deck = FiftyTwo::Deck.standard
+deck.shuffle!
+
+my_hand = FiftyTwo::Hand.new
+your_hand = FiftyTwo::Hand.new
+discard = FiftyTwo::Hand.new
+
+deck.deal([your_hand, my_hand], 5)
+
+[my_hand, your_hand].each(&:sort!)
+puts "you: #{your_hand.render}", "me:  #{my_hand.render}"
+# you:  6♦  6♠  7♠  K♣  A♦
+# me:   2♦  5♥  8♠  9♥ 10♦
+
+your_hand.transfer(%w[7s kc], discard)
+deck.deal(your_hand, 2)
+
+my_hand.transfer(%w[2D 5H], discard)
+deck.deal(my_hand, 2)
+
+[my_hand, your_hand].each(&:sort!)
+puts "you: #{your_hand.render}", "me:  #{my_hand.render}"
+# you:  4♠  6♦  6♠  K♦  A♦
+# me:   2♣  4♣  8♠  9♥ 10♦
+
+puts "Congratulations, you win!"
+
+[my_hand, your_hand, discard].each(&:release)
+deck.shuffle!
+```
+
 # Problems?
 Please submit an [issue](https://github.com/kevinstuffandthings/fiftytwo/issues).
 We'll figure out how to get you up and running with FiftyTwo as smoothly as possible.

data/lib/fiftytwo/deck.rb

@@ -22,9 +22,9 @@ module FiftyTwo
       end
     end
 
-    def deal(hands, hand_size: 1)
-      hand_size.times.each do |card_idx|
-        hands.each { |h| h << draw }
+    def deal(hands, num_cards = 1)
+      num_cards.times.each do |card_idx|
+        Array(hands).each { |h| h << draw }
       end
 
       hands

data/lib/fiftytwo/hand.rb

@@ -5,5 +5,9 @@ require_relative "./has_cards"
 module FiftyTwo
   class Hand
     include HasCards
+
+    def release
+      cards.reverse_each { |c| transfer(c) }
+    end
   end
 end

data/lib/fiftytwo/has_cards.rb

@@ -21,14 +21,16 @@ module FiftyTwo
     end
 
     def locate(identifier)
+      return cards[identifier] if identifier.is_a?(Integer)
       cards.find { |c| c.identifier == identifier.upcase }
     end
 
-    def transfer(card, destination = nil)
-      card = locate(card) unless card.is_a?(FiftyTwo::Card)
-      raise CardUnavailableError if card.nil?
-      raise CardUnavailableError unless cards.include?(card)
-      (destination || card.deck) << cards.delete(card)
+    def transfer(cards, destination = nil)
+      gather(cards).map { |c| (destination || c.deck) << self.cards.delete(c) }
+    end
+
+    %i[rank suit].each do |attribute|
+      define_method(attribute.to_s.pluralize) { cards.map { |c| c.send(attribute) }.uniq.sort }
     end
 
     FiftyTwo::Suit::ALL.each do |suit|
@@ -48,5 +50,14 @@ module FiftyTwo
     def select(identifier)
       self.class.new(cards.select { |c| c.send("#{identifier}?") })
     end
+
+    def gather(cards)
+      Array(cards).map do |card|
+        card = locate(card) unless card.is_a?(FiftyTwo::Card)
+        raise CardUnavailableError if card.nil?
+        raise CardUnavailableError unless self.cards.include?(card)
+        card
+      end
+    end
   end
 end

data/lib/fiftytwo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FiftyTwo
-  VERSION = "0.0.1"
+  VERSION = "0.0.5"
 end

data/spec/lib/fiftytwo/deck_spec.rb

@@ -7,6 +7,7 @@ module FiftyTwo
     before(:each) do
       minideck << FiftyTwo::Card.new(minideck, FiftyTwo::Rank::THREE, FiftyTwo::Suit::CLUBS)
       minideck << FiftyTwo::Card.new(minideck, FiftyTwo::Rank::NINE, FiftyTwo::Suit::DIAMONDS)
+      minideck << FiftyTwo::Card.new(minideck, FiftyTwo::Rank::TEN, FiftyTwo::Suit::DIAMONDS)
     end
 
     it "is a deck, made up of cards" do
@@ -55,8 +56,23 @@ module FiftyTwo
       end
     end
 
+    context "ranks/suits" do
+      let(:subject) { minideck }
+
+      it "can pull the unique ranks from a deck" do
+        items = subject.ranks
+        items.each { |i| expect(i).to be_a FiftyTwo::Rank }
+        expect(items.map(&:value)).to eq [3, 9, 10]
+      end
+
+      it "can pull the unique suits from a deck" do
+        items = subject.suits
+        items.each { |i| expect(i).to be_a FiftyTwo::Suit }
+        expect(items.map(&:name)).to eq %w[clubs diamonds]
+      end
+    end
+
     context "filtering" do
-      require "pry"
       it "can find diamonds" do
         cards = subject.diamonds
         expect(cards.count).to eq 13
@@ -117,17 +133,22 @@ module FiftyTwo
       let(:subject) { minideck }
 
       it "takes cards in order from the deck" do
+        expect(subject.count).to eq 3
+
+        card = subject.draw
         expect(subject.count).to eq 2
+        expect(card).to be_a FiftyTwo::Card
+        expect(card.identifier).to eq "3C"
 
         card = subject.draw
         expect(subject.count).to eq 1
         expect(card).to be_a FiftyTwo::Card
-        expect(card.identifier).to eq "3C"
+        expect(card.identifier).to eq "9D"
 
         card = subject.draw
         expect(subject.count).to eq 0
         expect(card).to be_a FiftyTwo::Card
-        expect(card.identifier).to eq "9D"
+        expect(card.identifier).to eq "10D"
 
         card = subject.draw
         expect(subject.count).to eq 0
@@ -174,20 +195,44 @@ module FiftyTwo
       let(:hand) { FiftyTwo::Hand.new }
 
       it "has a deck with 2 cards, and a hand with none" do
-        expect(subject.count).to eq 2
+        expect(subject.count).to eq 3
         expect(hand.count).to eq 0
       end
 
       it "can transfer a card by object" do
         subject.transfer(subject[1], hand)
-        expect(subject.count).to eq 1
-        expect(hand.count).to eq 1
+        expect(subject.map(&:identifier)).to match_array ["3C", "10D"]
+        expect(hand.map(&:identifier)).to match_array ["9D"]
       end
 
       it "can transfer a card by identifier" do
         subject.transfer("3C", hand)
-        expect(subject.count).to eq 1
-        expect(hand.count).to eq 1
+        expect(subject.map(&:identifier)).to match_array ["9D", "10D"]
+        expect(hand.map(&:identifier)).to match_array ["3C"]
+      end
+
+      it "can transfer a card by index" do
+        subject.transfer(0, hand)
+        expect(subject.map(&:identifier)).to match_array ["9D", "10D"]
+        expect(hand.map(&:identifier)).to match_array ["3C"]
+      end
+
+      it "can transfer multiple cards" do
+        subject.transfer(%w[3C 10D], hand)
+        expect(subject.map(&:identifier)).to match_array ["9D"]
+        expect(hand.map(&:identifier)).to match_array ["3C", "10D"]
+      end
+
+      it "can transfer multiple cards by a variety of identification methods" do
+        subject.transfer(["3C", 1], hand)
+        expect(subject.map(&:identifier)).to match_array ["10D"]
+        expect(hand.map(&:identifier)).to match_array ["3C", "9D"]
+      end
+
+      it "will not transfer any and raise an error if any one card reference is invalid" do
+        expect { subject.transfer(%w[3C 10K], hand) }.to raise_error FiftyTwo::HasCards::CardUnavailableError
+        expect(subject.count).to eq 3
+        expect(hand.count).to eq 0
       end
 
       context "missing card" do
@@ -206,14 +251,14 @@ module FiftyTwo
         let(:card) { subject[1] }
         before(:each) { subject.transfer(card, hand) }
 
-        it "starts with a card in the hand and a card in the deck" do
-          expect(subject.count).to eq 1
+        it "starts with a card in the hand and 2 in the deck" do
+          expect(subject.count).to eq 2
           expect(hand.count).to eq 1
         end
 
         it "can transfer a card from a hand back to the bottom of its originating deck" do
           hand.transfer(card)
-          expect(subject.count).to eq 2
+          expect(subject.count).to eq 3
           expect(hand.count).to eq 0
           expect(subject.last).to eq card
         end
@@ -230,7 +275,7 @@ module FiftyTwo
       end
 
       it "renders the set of cards in this deck" do
-        expect(subject.render).to eq "CARD0 CARD1"
+        expect(subject.render).to eq "CARD0 CARD1 CARD2"
       end
     end
 
@@ -269,7 +314,7 @@ module FiftyTwo
         card8 = subject[7]
         card9 = subject[8]
 
-        subject.deal(hands, hand_size: 3)
+        subject.deal(hands, 3)
         expect(subject.count).to eq 43
         expect(hand1.cards).to match_array [card1, card4, card7]
         expect(hand2.cards).to match_array [card2, card5, card8]

data/spec/lib/fiftytwo/hand_spec.rb

@@ -2,6 +2,36 @@
 
 module FiftyTwo
   describe Hand do
-    # covered by tests for FiftyTwo::Deck
+    # majority covered by tests for FiftyTwo::Deck
+
+    let(:deck) { FiftyTwo::Deck.standard }
+    let(:hand) { described_class.new }
+    before(:each) { deck.shuffle! }
+
+    describe "#release" do
+      it "does nothing with an empty hand" do
+        expect(deck.count).to eq 52
+        expect(hand.count).to eq 0
+
+        hand.release
+
+        expect(deck.count).to eq 52
+        expect(hand.count).to eq 0
+      end
+
+      context "with cards" do
+        before(:each) { deck.deal(hand, 5) }
+
+        it "can return the entirety of the hand back to the deck from whence it came" do
+          expect(deck.count).to eq 47
+          expect(hand.count).to eq 5
+
+          hand.release
+
+          expect(deck.count).to eq 52
+          expect(hand.count).to eq 0
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fiftytwo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Kevin McDonald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport