rubycards 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p385@rubycards"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.18.6 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubycards.gemspec
+gemspec
+gem 'colored'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jordan Scales
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Rubycards
+
+Rubycards is a library to emulate playing cards (cards, hands, decks). As an added bonus, you can display the cards as tiny pictures. I'm mainly doing this as an exercise to learn better Ruby organization, as well as documentation and testing. More importantly it's just fun.
+
+Feel free to peek around my code and point out anything I'm bad at.
+
+![rubycards](http://jordanscales.com/rubycards.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubycards'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubycards
+
+## Example
+
+Here's a trivial example of declaring a new deck, shuffling, and drawing 5 cards into a hand:
+
+    require 'rubycards'
+
+    hand = Hand.new
+    deck = Deck.new
+
+    deck.shuffle!
+
+    hand.draw(deck, 5)
+
+    puts hand
+
+Which produces the image at the top of this README.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/extensions/string.rb

@@ -0,0 +1,17 @@
+class String
+
+  # Places a string to the right of the current string
+  #
+  # Example:
+  #   ab        ef      abef
+  #   cd .next( gh ) => cdgh
+  def next(str)
+    # zip the two strings, split by line breaks
+    zipped = self.split("\n").zip(str.split("\n")).map
+
+    # map the zipped strings, by joining each pair and ending
+    #   with a new line, then joining the whole thing together
+    zipped.map { |e| "#{e.join}\n" }.join
+  end
+
+end

data/lib/rubycards.rb

@@ -0,0 +1,6 @@
+$: << File.dirname(__FILE__)
+
+require 'extensions/string'
+require 'rubycards/card'
+require 'rubycards/deck'
+require 'rubycards/hand'

data/lib/rubycards/card.rb

@@ -0,0 +1,131 @@
+# encoding: utf-8
+require 'colored'
+
+class Card
+
+  include Comparable
+
+  # constants for glyphs
+  CLUB    = '♣'
+  DIAMOND = '♦'
+  HEART   = '♥'
+  SPADE   = '♠'
+
+  def initialize(rank = 'Ace', suit = 'Spades')
+    @rank = rank_to_i(rank)
+    @suit = suit_to_i(suit)
+  end
+
+  # returns the rank of the card
+  # optional short parameter will limit face cards to one character
+  def rank(short = false)
+    if (2..10) === @rank
+      @rank.to_s
+    else
+      h = { 11 => 'Jack', 12 => 'Queen', 13 => 'King', 14 => 'Ace' }
+      h[@rank] && short ? h[@rank][0] : h[@rank]
+    end
+  end
+
+  # returns the suit of a card
+  # optional glyph parameter displays a colored unicode character
+  def suit(glyph = false)
+    case @suit
+      when 1
+        glyph ? CLUB.black.bold : 'Clubs'
+      when 2
+        glyph ? DIAMOND.red : 'Diamonds'
+      when 3
+        glyph ? HEART.red : 'Hearts'
+      when 4
+        glyph ? SPADE.black.bold : 'Spades'
+    end
+  end
+
+  # returns the short rank, followed by suit icon
+  def short
+    "#{rank(true)}#{suit(true)}"
+  end
+
+  # comparator
+  def <=>(c)
+    self.to_i <=> c.to_i
+  end
+
+  # returns the numerical representation of the rank
+  def to_i
+    @rank
+  end
+
+  # draws a card picture
+  def to_s
+    # A simple template with X's as placeholders
+    # YY represents the placement of the card's rank
+    template = <<-TPL.gsub(/^\s+/,'')
+      ╭───────╮
+      | X X X |
+      | X X X |
+      | X YYX |
+      | X X X |
+      ╰───────╯
+    TPL
+
+    # the patterns represent the configuration of glyphys
+    #   read from left to right, top to bottom
+    # X means place a glyph, _ means clear the space
+    case @rank
+      when 2;  pattern = '_X_______X_'
+      when 3;  pattern = '_X__X____X_'
+      when 4;  pattern = 'X_X_____X_X'
+      when 5;  pattern = 'X_X_X___X_X'
+      when 6;  pattern = 'X_XX_X__X_X'
+      when 7;  pattern = 'X_X_X_XXX_X'
+      when 8;  pattern = 'X_XX_XXXX_X'
+      when 9;  pattern = 'X_XXXXXXX_X'
+      when 10; pattern = 'XXXX_XXXXXX'
+      when 11..14;
+        pattern = 'X_________X'
+    end
+
+    pattern.each_char do |c|
+      # replace X's with glyphs
+      if c == 'X'
+        template.sub!(/X/, "#{suit(true)}")
+      # replace _'s with whitespace
+      else
+        template.sub!(/X/, " ")
+      end
+    end
+
+    # place the card rank (left-padded)
+    template.sub(/YY/, rank(true).ljust(2))
+  end
+
+  private
+
+  # converts the string representation of a rank to an integer
+  def rank_to_i(rank)
+    case rank.to_s
+      when /^(a|ace)/i;   14
+      when /^(k|king)/i;  13
+      when /^(q|queen)/i; 12
+      when /^(j|jack)/i;  11
+      when '10';          10
+      when '2'..'9';      rank
+      else 0
+    end
+  end
+
+  # converts the string representation of a suit to an integer
+  # suits are ordered alphabetically
+  def suit_to_i(suit)
+    case suit
+      when /^club/i;    1
+      when /^diamond/i; 2
+      when /^heart/i;   3
+      when /^spade/i;   4
+      else 0
+    end
+  end
+
+end

data/lib/rubycards/deck.rb

@@ -0,0 +1,45 @@
+class Deck
+
+  include Enumerable
+
+  attr_reader :cards
+
+  RANKS = [*2..10, 'Jack', 'Queen', 'King', 'Ace']
+  SUITS = %w{ Clubs Diamonds Hearts Spades }
+
+  # initialize a deck of cards using the RANKS and SUITS constants
+  def initialize
+    @cards = []
+
+    RANKS.product(SUITS).each do |rank, suit|
+      @cards << Card.new(rank, suit)
+    end
+  end
+
+  # shuffle the deck
+  def shuffle!
+    @cards.shuffle!
+  end
+
+  # draw a card from the deck
+  def draw
+    @cards.shift
+  end
+
+  # determines if the deck is empty
+  def empty?
+    @cards.empty?
+  end
+
+  # Enumerable#each
+  def each(&block)
+    @cards.each do |card|
+      if block_given?
+        block.call card
+      else
+        yield card
+      end
+    end
+  end
+
+end

data/lib/rubycards/hand.rb

@@ -0,0 +1,57 @@
+class Hand
+
+  include Enumerable
+
+  attr_reader :cards
+
+  # initialize with an array of cards
+  def initialize(cards = [])
+    @cards = []
+    cards.each do |card|
+      self << card
+    end
+  end
+
+  # add a card if it is valid
+  def add(card)
+    @cards << card if card.instance_of? Card
+  end
+
+  # alias array push (<<) to add method
+  alias_method :<<, :add
+
+  # indexing
+  def [](n)
+    @cards[n]
+  end
+
+  # sorting
+  def sort!
+    @cards.sort!
+  end
+
+  # draw n cards from a deck
+  def draw(deck, n = 1)
+    n.times do
+      @cards << deck.draw unless deck.empty?
+    end
+  end
+
+  # Enumerable#each
+  def each(&block)
+    @cards.each do |card|
+      if block_given?
+        block.call card
+      else
+        yield card
+      end
+    end
+  end
+
+  # displaying the card icons
+  # using extensions/string.rb for String#next
+  def to_s
+    @cards.map(&:to_s).inject(:next)
+  end
+
+end

data/lib/rubycards/version.rb

@@ -0,0 +1,3 @@
+module Rubycards
+  VERSION = "0.0.1"
+end

data/rubycards.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubycards/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rubycards"
+  gem.version       = Rubycards::VERSION
+  gem.authors       = ["Jordan Scales", "Joe Letizia"]
+  gem.email         = ["scalesjordan@gmail.com", "joe.letizia@gmail.com"]
+  gem.description   = "RubyCards"
+  gem.summary       = "A 52 card gem"
+  gem.homepage      = "https://github.com/prezjordan/rubycards"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('colored', '>= 1.2')
+end

data/spec/card_spec.rb

@@ -0,0 +1,73 @@
+require 'rubycards'
+
+describe Card do
+  describe '#initialize' do
+    context 'no params' do
+      it 'should return the ace of spades' do
+        subject.suit.should == 'Spades'
+        subject.rank.should == 'Ace'
+      end
+    end
+
+    context 'params' do
+      it 'should return the card specified in params' do
+        new_card = Card.new('Queen', 'Clubs')
+        new_card.rank.should == 'Queen'
+        new_card.suit.should == 'Clubs'
+
+        new_card = Card.new(3, 'Spades')
+        new_card.rank.should == 3.to_s
+        new_card.suit.should == 'Spades'
+      end
+    end
+  end
+
+  describe '#comparator' do
+      let(:king){Card.new('King','Clubs')}
+      let(:queen){Card.new('Queen','Clubs')}
+      let(:jack){Card.new('Jack','Clubs')}
+      let(:ace){Card.new('Ace','Clubs')}
+      let(:c2){Card.new(2,'Diamonds')}
+      let(:c2_heart){Card.new(2,'Hearts')}
+      let(:c4){Card.new(4,'Spades')}
+
+      it 'should reflect the correct rank when compared' do
+        king.should > queen
+        king.should > jack
+        king.should == king
+        king.should < ace
+
+        jack.should_not > queen
+        jack.should_not > ace
+        jack.should < queen
+
+        ace.should_not < queen
+        ace.should > c4
+
+        c2.should < c4
+        c2_heart.should == c2
+
+      end
+  end
+
+  describe '#rank' do
+    context 'face cards' do
+      let(:king){Card.new('King','Clubs')}
+
+      it 'should return a long rank' do
+        king.rank.should == 'King'
+      end
+      it 'should return a short rank' do
+        king.rank(true).should == 'K'
+      end
+    end
+
+    context 'numeric cards' do
+      let(:num){Card.new(10,'Diamonds')}
+
+      it 'should have the same long and short rank' do
+        num.rank.should == num.rank(true)
+      end
+    end
+  end
+end

data/spec/factory.rb

@@ -0,0 +1,10 @@
+FactoryGirl.define do
+  factory :card do
+  end
+
+  factory :deck do
+  end
+
+  factory :hand do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rubycards
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jordan Scales
+- Joe Letizia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: RubyCards
+email:
+- scalesjordan@gmail.com
+- joe.letizia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/extensions/string.rb
+- lib/rubycards.rb
+- lib/rubycards/card.rb
+- lib/rubycards/deck.rb
+- lib/rubycards/hand.rb
+- lib/rubycards/version.rb
+- rubycards.gemspec
+- spec/card_spec.rb
+- spec/factory.rb
+- spec/spec_helper.rb
+homepage: https://github.com/prezjordan/rubycards
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A 52 card gem
+test_files:
+- spec/card_spec.rb
+- spec/factory.rb
+- spec/spec_helper.rb
+has_rdoc: