Cardistry

Cardistry provides a few basic classes that model the behavior of a real deck of cards – and a (mostly!) complete test suite.

• Easily extendable classes so that you can model your favorite decks and games, from poker to tarot, or even MTG or UNO.
• Realistic, simulated (not random!) riffle shuffling
• Common actions like cutting the deck, dealing individual cards to other locations, and more.

• Card - Represents a single card, to be contained by other Classes
• Deck - An enumerable collection of cards.
• Spread (not yet added) – A sequence of positions, each with a name (ie "The River").
• Hand (not yet added) - A sortable collection of cards.

Add this line to your application's Gemfile:

gem 'cardistry'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cardistry

require 'cardistry'

deck = Cardistry::Deck.new
deck.load 'cards.json'

puts deck.size    # 52
puts deck.info    # "cards: 52, suits: [:spades, :hearts, :clubs, :diamonds]
puts deck.first   # "Ace of Spades"

puts deck[0].suit # :spades

require 'cardistry'

class CoolerCard < Cardistry::Card
  
  def to_s
    "Cooler than #{super}"
  end
  
end

Eventually a standard poker style deck will be included. You can find something close in spec/test_deck.json for now.

Note that currently, all fields except rank are optional, kind will default to :pip

[
  {
    "name": "Ace of Spades",
    "kind": "pip",
    "suit": "spades",
    "rank": 1
  },
  
  // ...
  
  {
    "suit": "clubs",
    "rank": 7
  },
  
  // ...
  
  {
    "name": "Queen of Hearts",
    "kind": "court",
    "suit": "hearts",
    "rank": 12
  },
  
  // ...etc
]

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Bug reports and pull requests are welcome on GitHub at https://github.com/nickisnoble/cardistry.

The gem is available as open source under the terms of the MIT License.

Be nice or leave!