badcards 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e65c8a32d66371c3b2b62a05d6305df0ea9446c9
-  data.tar.gz: c8dd7c3580ed698e6ab35b62255813e776596764
+  metadata.gz: 89fc14a4fc5e0a46a7f8be3555bee622dd5d84df
+  data.tar.gz: 5e225d4f3469c8d8b26c3009d4bc8db24c20da80
 SHA512:
-  metadata.gz: f8fd2516fb581527bafcf2c06db13472f23e0076643863eee66becc532b5f02eb6c25d9df7b33ae771ce7dc6ab30607df81ec7c00835159354e89d43a84c1a66
-  data.tar.gz: 7757e906f56989b83827adcc9127ffdf8913f21cf8c409fb8a03eaebbdb290c06e398e009553257d427cc29b7e66804b7389375547e9f2ce7194ddd5bf298bb6
+  metadata.gz: da6eb1534c4bf7a28623de6303f77f7ee17925ee0843f1793e7a8f88f89e17b237285eae1ac4da5bf9da47a6d09ca36dccffd44d8220e2ab6488a23e54a70cee
+  data.tar.gz: 3002e00a023841691af2903c7f4275ea4009e3f5520353875a7e920866e93d0dd7e4ac0bd38cab6a5cae931b6732f84594a0c06bd6e7b7679cb750f9a001c3ed

data/README.md

@@ -4,6 +4,8 @@
 [![Coverage Status](https://coveralls.io/repos/BensPotatoes/BaDCards/badge.png?branch=master)](https://coveralls.io/r/BensPotatoes/BaDCards?branch=master)
 
 Ruby library of playing cards.
+I needed a card library for an app so I decided to make one.
+Why "badcards"? Because the images are bad (check them out, you'll see what I mean).
 
 ## Installation
 
@@ -27,6 +29,56 @@ hand = Hand.new # create a hand that can hold onto cards
 deck = Deck.new(6) # create a deck consisting of six mini-decks of 52 cards
 ```
 
+## Properties
+
+### Card
+A card has a value, suit, and image.
+Images are hosted by myself on S3 and (for the moment) are publicly available.
+
+```
+card = Card.new("Ace", "Spades")
+card.img
+# => "https://s3-us-west-2.amazonaws.com/badcards/cards/spade/ace.png"
+```
+
+Acceptable values (as strings):
+
+* Ace (A)
+* 2
+* 3
+* 4
+* 5
+* 6
+* 7
+* 8
+* 9
+* 10
+* Jack (J)
+* Queen (Q)
+* King (K)
+
+Acceptable suits (as strings):
+
+* Diamond (D)
+* Club (C)
+* Heart (H)
+* Spade (S)
+
+### Hand
+A simple container to hold cards, currently no limit on the number of cards in each
+
+### Deck
+A deck is comprised of a minimum of 52 cards, currently no limit on the number of base decks in each (defaults to 1).
+Has a shuffle method to shuffle cards randomly, shuffles 12 times by default.
+Also has a peek method to see what the n top-most cards are.
+
+```
+deck = Deck.new(6)
+deck.shuffle(3)
+deck.peek(5)
+# => [Card, Card, Card, Card, Card]
+```
+
 ## Contributing
 
 1. Fork it ( http://github.com/benspotatoes/badcards/fork )

data/lib/badcards/card.rb

@@ -101,8 +101,8 @@ class Card
   end
 
   def self.all_cards
-    VALUES.each do |value|
-      SUITS.each do |suit|
+    SUITS.each do |suit|
+      VALUES.each do |value|
         yield value, suit
       end
     end

data/lib/badcards/deck.rb

@@ -16,8 +16,12 @@ class Deck
     @cards.count
   end
 
-  def peek
-    @cards.first
+  def peek(num_to_peek = 1)
+    if num_to_peek == 1
+      @cards.first
+    else
+      @cards[0..num_to_peek-1]
+    end
   end
 
   def shuffle(num_times = 12)

data/lib/badcards/version.rb

@@ -1,3 +1,3 @@
 module Badcards
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: badcards
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Benjamin Hsieh, Ben's Potatoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler