Oshuma-gambler 0.0.2

data/lib/gambler.rb

@@ -0,0 +1,24 @@
+# Add the Gambler library path to the front of the Ruby load path.
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+# Third party libraries.
+require 'rubygems'
+
+# Gambler libraries.
+require 'gambler/card'
+require 'gambler/deck'
+require 'gambler/exceptions'
+require 'gambler/game'
+require 'gambler/player'
+
+module Gambler
+  include Exceptions
+
+  class << self
+    attr_accessor :debug
+  end
+
+  self.debug = false
+
+  VERSION = '0.0.2'
+end

data/tasks/ditz.rake

@@ -0,0 +1,43 @@
+# Tasks that make it easier to deal with ditz.
+
+DOC_ROOT  = File.join(GAMBLER_ROOT, 'doc') unless defined? DOC_ROOT
+ISSUE_DIR = "#{DOC_ROOT}/issues"
+
+# 'rake issues' will just list them.
+desc 'List current issues'
+task :issues do
+  Rake::Task['issues:list'].invoke
+end
+
+# Rake tasks for dealing with ditz issues.
+namespace :issues do
+  desc 'Add an issue'
+  task :add do
+    sh 'ditz add'
+  end
+
+  task :list do
+    # Use back-tick execution to prevent output of command being run.
+    # Returns a string of the command output.
+    puts `ditz todo`
+  end
+
+  # 'rake issues:report' will just generate the report.
+  desc 'Generate issue report'
+  task :report do
+    Rake::Task['issues:report:generate'].invoke
+  end
+
+  namespace :report do
+    task :generate => [ 'issues:report:clear' ] do
+      header "Generating issue report in #{ISSUE_DIR}"
+      sh "ditz html #{ISSUE_DIR}"
+    end
+
+    desc 'Clear the issue report'
+    task :clear do
+      header "Removing issue report from #{ISSUE_DIR}"
+      sh "rm -rf #{ISSUE_DIR}"
+    end
+  end
+end

data/tasks/docs.rake

@@ -0,0 +1,70 @@
+# Tasks to handle application docs.
+DOC_TITLE = "Gambler v#{Gambler::VERSION} Documentation"
+DOC_ROOT  = File.join(GAMBLER_ROOT, 'doc') unless defined? DOC_ROOT
+API_DOCS  = File.join(DOC_ROOT, 'api')
+
+# Remove the default Hoe documentation tasks.
+remove_task 'clobber_docs'
+remove_task 'docs'
+remove_task 'docs/index.html'
+remove_task 'publish_docs'
+remove_task 'redocs'
+remove_task 'ridocs'
+
+# Override the default clobber_docs task.
+task :clobber_docs do
+  Rake::Task['docs:clear'].invoke
+end
+
+desc 'Generate the Gambler API docs'
+task :docs do
+  Rake::Task['docs:api'].invoke
+end
+
+namespace :docs do
+  task :setup_rdoc do
+    @file_list = FileList[ "#{GAMBLER_ROOT}/README",
+                           "#{GAMBLER_ROOT}/lib/**/*.rb",
+                           "#{GAMBLER_ROOT}/bin/gambler_client" ]
+    @file_list.add "#{GAMBLER_ROOT}/test/**/*.rb" if ENV['TESTS']
+    # Substitute GAMBLER_ROOT with a dot.  Makes for a better index in the generated docs.
+    @files = @file_list.collect  {|f| f.gsub(/#{GAMBLER_ROOT}/, '.')}
+    @options = %W[
+      --all
+      --inline-source
+      --line-numbers
+      --main README
+      --op #{API_DOCS}
+      --title '#{DOC_TITLE}'
+    ]
+    # Generate a diagram, yes/no?
+    @options << '-d' if RUBY_PLATFORM !~ /win32/ && `which dot` =~ /\/dot/ && !ENV['NODOT']
+  end
+
+  # desc 'Generate the Gambler API docs'
+  task :api => [ :setup_rdoc ] do
+    run_rdoc(@options, @files)
+    system("open #{API_DOCS}/index.html") if RUBY_PLATFORM =~ /darwin/ && ENV['OPEN']
+  end
+
+  desc 'Remove the Gambler API docs'
+  task :clear do
+    system("rm -rf #{API_DOCS}")
+  end
+
+  desc 'Remove and rebuild the Gambler API docs'
+  task :rebuild do
+    Rake::Task['docs:clear'].invoke
+    Rake::Task['docs:api'].invoke
+  end
+end
+
+private
+
+# Runs rdoc with the given +options+ and +files+.
+# Both arguments should be an Array, which is joined with a space.
+def run_rdoc(options, files)
+  options = options.join(' ') if options.is_a? Array
+  files   = files.join(' ')   if files.is_a? Array
+  system("rdoc #{options} #{files}")
+end

data/tasks/git.rake

@@ -0,0 +1,27 @@
+# A few helpful tasks for dealing with git.
+
+# Some defaults.
+REPOS  = ENV['REPOS']  || 'github,rubyforge'
+BRANCH = ENV['BRANCH'] || 'master'
+
+namespace :git do
+  desc 'Mirror the local repo on REPOS (comma delimited)'
+  task :mirror do
+    repos.each do |repo|
+      sh "git push --mirror #{repo}"
+    end
+  end
+
+  desc 'Push BRANCH to REPOS (comma delimited)'
+  task :push do
+    repos.each do |repo|
+      sh "git push #{repo} #{BRANCH}"
+    end
+  end
+end
+
+private
+
+def repos
+  REPOS.split(',')
+end

data/tasks/override_rake_task.rb

@@ -0,0 +1,16 @@
+# OverrideRakeTask - http://tools.assembla.com/svn/rails_plugins/override_rake_task/
+Rake::TaskManager.class_eval do
+  def remove_task(task_name)
+    @tasks.delete(task_name.to_s)
+  end
+end
+
+def remove_task(task_name)
+  Rake.application.remove_task(task_name)
+end
+
+def override_task(args, &block)
+  name, deps = Rake.application.resolve_args(args)
+  remove_task Rake.application[name].name
+  task(args, &block)
+end

data/tasks/rcov.rake

@@ -0,0 +1,48 @@
+# Tasks to handle rcov usage.
+
+DOC_ROOT     = File.join(GAMBLER_ROOT, 'doc') unless defined? DOC_ROOT
+COVERAGE_DIR = File.join(DOC_ROOT, 'coverage')
+
+desc 'Display coverage stats'
+task :rcov do
+  Rake::Task['rcov:stats'].invoke
+end
+
+namespace :rcov do
+  task :setup_rcov do
+    @file_list = FileList["#{GAMBLER_ROOT}/test/**/test_*.rb"]
+    @test_files = @file_list.collect { |f| f.gsub(/#{GAMBLER_ROOT}/, '.')}
+    @options = [
+      # Remove rcov.rb from report. Escape the slash, because we need it in the string.
+      "-x 'rcov\\.rb'",
+      "-o #{COVERAGE_DIR}"
+    ]
+  end
+
+  desc 'Remove the generated coverage report'
+  task :clear do
+    system("rm -rf #{COVERAGE_DIR}")
+  end
+
+  desc 'Generate coverage report'
+  task :html => [ :clear, :setup_rcov ] do
+    @options << '--text-summary'
+    run_rcov(@options, @test_files)
+    system("open #{COVERAGE_DIR}/index.html") if RUBY_PLATFORM =~ /darwin/ && ENV['OPEN']
+  end
+
+  task :stats => [ :setup_rcov ] do
+    @options << '--text-report --no-html'
+    run_rcov(@options, @test_files)
+  end
+end
+
+private
+
+# Runs rcov with the given +options+ and +test_files+.
+# Both arguments should be an Array, which is joined with a space.
+def run_rcov(options, test_files)
+  options    = options.join(' ')    if options.is_a?    Array
+  test_files = test_files.join(' ') if test_files.is_a? Array
+  system("rcov #{options} #{test_files}")
+end

data/tasks/site.rake

@@ -0,0 +1,51 @@
+# Tasks for dealing with the RubyForge site.
+
+# The local directories to store the website files.
+DOC_ROOT      = File.join(GAMBLER_ROOT, 'doc') unless defined? DOC_ROOT
+LOCAL_SITE    = File.join(DOC_ROOT, 'rubyforge.site')
+SITE_API      = File.join(LOCAL_SITE, 'api')
+SITE_COVERAGE = File.join(LOCAL_SITE, 'coverage')
+SITE_ISSUES   = File.join(LOCAL_SITE, 'issues')
+
+# The remote directory the files will be scp'ed to.
+REMOTE_SITE = 'gambler.rubyforge.org:/var/www/gforge-projects/gambler'
+
+# A list of static pages to upload.
+PAGES = %w{
+  index.html
+  robots.txt
+}
+
+namespace :site do
+  desc 'Clear the local site directory of dynamic files'
+  task :clear_local do
+    header("Clearing local site directory: #{LOCAL_SITE}")
+    sh "rm -rf #{SITE_API}"      if File.exists? SITE_API
+    sh "rm -rf #{SITE_COVERAGE}" if File.exists? SITE_COVERAGE
+    sh "rm -rf #{SITE_ISSUES}"   if File.exists? SITE_ISSUES
+  end
+
+  # Copies the issue and docs to the site directory.
+  task :setup_dir => [ :clear_local, :run_external_tasks ] do
+    header('Copying coverage and API docs to the site directory.')
+    FileUtils.cp_r(COVERAGE_DIR, LOCAL_SITE)
+    FileUtils.cp_r(API_DOCS, LOCAL_SITE)
+    FileUtils.cp_r(ISSUE_DIR, LOCAL_SITE)
+  end
+
+  desc 'Upload the issues and docs to the website'
+  task :upload => :setup_dir do
+    header('Uploading local site to remote site.')
+    sh "cd #{LOCAL_SITE} && scp -r ./* #{REMOTE_SITE}"
+  end
+
+  private
+
+  # Used to shorten the setup_site_dir task definition.
+  task :run_external_tasks do
+    ENV['NODOT'] = 'TRUE' # Don't generate dot diagrams for the site docs.
+    Rake::Task['docs:rebuild'].invoke
+    Rake::Task['issues:report'].invoke
+    Rake::Task['rcov:html'].invoke
+  end
+end

data/tasks/util.rb

@@ -0,0 +1,32 @@
+# Utility methods.
+
+# Ask for confirmation.  Returns true/false
+def confirm(message, options = {})
+  confirm_message = options[:confirm_message] || 'Are you sure?'
+  banner = options[:banner] || false
+  if banner
+    header(message) # print with header
+    print "#{confirm_message} (yes/no) "
+    choice = STDIN.gets.chomp
+  else
+    puts message
+    print "#{confirm_message} (yes/no) "
+    choice = STDIN.gets.chomp
+  end
+
+  case choice
+  when 'yes'
+    return true
+  else
+    puts 'Aborted'
+  end
+end
+
+# Displays +message+ inside a formatted header.
+def header(message = nil)
+  raise ArgumentError, 'No message passed to header.' unless message
+  puts "\n"
+  puts '+---'
+  puts "| #{message}"
+  puts '+---'
+end

data/test/game/test_basic_game.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/../helper'
+
+# Test the BasicGame class.
+class TestBasicGame < Test::Unit::TestCase
+  include Game
+
+  def setup
+    @dale  = Player.new('Dale')
+    @kenny = Player.new('Kenny')
+    @game  = BasicGame.new(:players => [@dale, @kenny])
+  end
+
+  def test_basic_game_defaults
+    assert_kind_of(BasicGame, @game)
+    assert_equal(10, @game.ante)
+    assert_equal(0, @game.pot)
+    assert_kind_of(Deck, @game.deck)
+    assert(@game.deck.shuffled, "#{@game.deck} is not shuffled!")
+  end
+
+  def test_no_players
+    assert_raise(NoPlayers) do
+      BasicGame.new(:players => []) # empty array
+    end
+  end
+
+  def test_invalid_players
+    assert_raise(InvalidPlayers) do
+      BasicGame.new(:players => [@dale, 'WTF'])
+    end
+  end
+end

data/test/game/test_blackjack.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../helper'
+
+# Test the Blackjack class.
+class TestBlackjack < Test::Unit::TestCase
+  include Game
+
+  def setup
+    @dale  = Player.new('Dale')
+    @kenny = Player.new('Kenny')
+    @game = Blackjack.new(:players => [@dale, @kenny])
+  end
+
+  def test_new_blackjack_game
+    assert_kind_of(Blackjack, @game)
+    assert_equal(10, @game.ante)
+    assert_equal(0, @game.pot)
+    assert_kind_of(Deck, @game.deck)
+  end
+
+  def test_invalid_player_size
+    assert_raise(InvalidPlayerSize) do
+      Blackjack.new(:players => [])
+      Blackjack.new(:players => [@dale])
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+
+unless defined? Gambler
+  require File.join(File.dirname(__FILE__), *%w[ .. lib gambler ])
+  include Gambler
+end

data/test/suite.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+
+Dir["#{File.dirname(__FILE__)}/**/test_*.rb"].each do |test|
+  require test
+end

data/test/test_card.rb

@@ -0,0 +1,113 @@
+require File.dirname(__FILE__) + '/helper'
+
+# Tests the Card class.
+class TestCard < Test::Unit::TestCase
+  def test_all_cards
+    assert_equal(52, Card.all.size)
+    assert_kind_of(Array, Card.all)
+  end
+
+  def test_all_iterator
+    Card.all do |card|
+      assert_kind_of(Card, card)
+      assert(Card::FACES.include?(card.face), "#{card.face} was not found in FACES.")
+      assert(Card::SUITS.include?(card.suit), "#{card.suit} was not found in SUITS.")
+    end
+  end
+
+  def test_order_of_all_cards
+    cards = Card.all
+    assert_equal('Ace of Clubs', cards.first.to_pretty_s)
+    assert_equal('Two of Spades', cards.last.to_pretty_s)
+  end
+
+  def test_each_face
+    Card.each_face do |face|
+      assert(Card::FACES.include?(face), "#{face} was not found in FACES.")
+    end
+  end
+
+  def test_each_suit
+    Card.each_suit do |suit|
+      assert(Card::SUITS.include?(suit), "#{suit} was not found in SUITS.")
+    end
+  end
+
+  def test_clubs_class_method
+    clubs = Card.clubs
+    assert_kind_of(Array, clubs)
+    clubs.each do |card|
+      assert_kind_of(Card, card)
+      assert_equal('c', card.suit)
+    end
+  end
+
+  def test_diamonds_class_method
+    diamonds = Card.diamonds
+    assert_kind_of(Array, diamonds)
+    diamonds.each do |card|
+      assert_kind_of(Card, card)
+      assert_equal('d', card.suit)
+    end
+  end
+
+  def test_hearts_class_method
+    hearts = Card.hearts
+    assert_kind_of(Array, hearts)
+    hearts.each do |card|
+      assert_kind_of(Card, card)
+      assert_equal('h', card.suit)
+    end
+  end
+
+  def test_spades_class_method
+    spades = Card.spades
+    assert_kind_of(Array, spades)
+    spades.each do |card|
+      assert_kind_of(Card, card)
+      assert_equal('s', card.suit)
+    end
+  end
+
+  def test_face_value
+    card = Card.new(:face => 'K', :suit => 'd')
+    assert_equal(13, card.face_value)
+  end
+
+  def test_to_s
+    card = Card.new(:face => 'K', :suit => 'd')
+    assert_equal('Kd', card.to_s)
+  end
+
+  def test_to_pretty_s
+    card = Card.new(:face => 'K', :suit => 'd')
+    assert_equal('King of Diamonds', card.to_pretty_s)
+  end
+
+  def test_new_card_from_array
+    card = %w{ K d }
+    assert_kind_of(Card, Card.new(card))
+  end
+
+  def test_new_card_from_hash
+    card = { :face => 'K', :suit => 'd' }
+    assert_kind_of(Card, Card.new(card))
+  end
+
+  def test_new_card_from_string
+    card = 'Kd'
+    assert_kind_of(Card, Card.new(card))
+  end
+
+  def test_invalid_card_initializer
+    assert_raise(InvalidCardType) { Card.new(420) }
+  end
+
+  def test_invalid_card_from_hash
+    assert_raise(InvalidCardType) { Card.new(:wtf => 'ZOMG') }
+  end
+
+  def test_invalid_card_from_string
+    assert_raise(InvalidCardType) { Card.new('WTF') }
+  end
+end

data/test/test_deck.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/helper'
+
+# Tests the Deck class.
+class TestDeck < Test::Unit::TestCase
+  def setup
+    @deck = Deck.new
+    @dale  = Player.new('Dale')
+    @kenny = Player.new('Kenny')
+  end
+
+  def test_new_deck
+    new_deck = Deck.new
+    assert_kind_of(Deck, new_deck)
+    assert_equal(false, new_deck.shuffled)
+    assert_equal(52, new_deck.size)
+    assert_kind_of(Array, new_deck.cards)
+    new_deck.cards.each do |card|
+      assert_kind_of(Card, card)
+    end
+  end
+
+  def test_cards_option
+    new_deck = Deck.new(:cards => Card.diamonds)
+    assert_kind_of(Deck, new_deck)
+    assert_equal(Card.diamonds.size, new_deck.size)
+    new_deck.cards.each do |card|
+      assert_equal('d', card.suit)
+    end
+  end
+
+  def test_invalid_cards
+    assert_raise(InvalidDeck) do
+      Deck.new(:cards => 'WTF')
+    end
+  end
+
+  def test_shuffle!
+    first_card = @deck.cards.first
+    last_card  = @deck.cards.last
+    @deck.shuffle!
+    assert(@deck.shuffled, "#{@deck} not shuffled!")
+    assert_not_equal(first_card, @deck.cards.first)
+    assert_not_equal(last_card,  @deck.cards.last)
+  end
+
+  def test_deal_to
+    assert_equal(52, @deck.size)
+    assert(@dale.hand.empty?, "#{@dale}'s hand is not empty!")
+    assert(@kenny.hand.empty?, "#{@kenny}'s hand is not empty!")
+    2.times do
+      @deck.deal_to @dale
+      @deck.deal_to @kenny
+    end
+    assert_equal(48, @deck.size)
+  end
+
+  def test_deck_empty
+    # Deal out all the Cards first.
+    @deck.size.times do
+      @deck.deal_to(@dale)
+    end
+
+    assert_raise(DeckEmpty) do
+      @deck.deal_to(@kenny)
+    end
+  end
+end

data/test/test_gambler.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/helper'
+
+# Tests the Gambler module.
+class TestGambler < Test::Unit::TestCase
+  def test_version_string
+    assert_equal(Gambler::VERSION, '0.0.2')
+  end
+  
+  def test_debug
+    assert_equal(Gambler.debug, false)
+    Gambler.debug = true
+    assert_equal(Gambler.debug, true)
+  end
+end

data/test/test_player.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/helper'
+
+# Tests the Player class.
+class TestPlayer < Test::Unit::TestCase
+  def setup
+    @player = Player.new('Dale')
+  end
+
+  def test_pretty_inspect
+    assert_equal("#<Gambler::Player 'Dale'>", @player.inspect)
+  end
+
+  def test_to_s
+    assert_equal('Dale ($100)', @player.to_s)
+  end
+
+  def test_new_player
+    dale = Player.new('Dale', :chips => 10) # broke :(
+    assert_kind_of(Player, dale)
+    assert_equal('Dale', dale.name)
+    assert_equal(10, dale.chips)
+    assert(dale.hand.empty?)
+  end
+
+  def test_player_name
+    @player = Player.new('Dale')
+    assert_equal('Dale', @player.name)
+  end
+
+  def test_no_player_name
+    assert_raise(ArgumentError) { Player.new }
+  end
+
+  def test_change_name
+    @player.name = 'Not Dale'
+    assert_equal('Not Dale', @player.name)
+  end
+
+  def test_player_hand
+    assert(@player.hand.empty?)
+    @player = Player.new( 'Cheaty McGee', # has blackjack from the start!
+                          :hand => [Card.new('Ad'), Card.new('Kd')] )
+    assert_equal(2, @player.hand.size)
+  end
+
+  def test_empty_hand!
+    @player = Player.new('Dale', :hand => [Card.new('Ad'), Card.new('Kd')])
+    assert_equal(2, @player.hand.size)
+    @player.empty_hand!
+    assert_equal(0, @player.hand.size)
+  end
+
+  def test_view_hand_as_array
+    @player = Player.new('Dale', :hand => [Card.new('Ad'), Card.new('Kd')])
+    assert_equal(['Ad', 'Kd'], @player.view_hand) # defaults to non-pretty array.
+  end
+
+  def test_view_hand_as_pretty_array
+    @player = Player.new('Dale', :hand => [Card.new('Ad'), Card.new('Kd')])
+    pretty_hand = ['Ace of Diamonds', 'King of Diamonds']
+    assert_equal(pretty_hand, @player.view_hand(:format => :array, :pretty => true))
+  end
+
+  def test_view_hand_as_string
+    @player = Player.new('Dale', :hand => [Card.new('Ad'), Card.new('Kd')])
+    assert_equal('Ad Kd', @player.view_hand(:format => :string))
+  end
+
+  def test_view_hand_as_pretty_string
+    @player = Player.new('Dale', :hand => [Card.new('Ad'), Card.new('Kd')])
+    pretty_hand = 'Ace of Diamonds, King of Diamonds'
+    assert_equal(pretty_hand, @player.view_hand(:format => :string, :pretty => true))
+  end
+
+  def test_default_chip_stack
+    assert_equal(100, @player.chips)
+  end
+
+  def test_player_chips
+    @player = Player.new('Dale', :chips => 500)
+    assert_equal(500, @player.chips)
+  end
+
+  def test_invalid_chip_count
+    assert_raise(InvalidChipCount) do
+      Player.new('Dale', :chips => 'WTF')
+    end
+  end
+
+  def test_change_chip_count
+    pot = 1_000_000_000
+    chips = @player.chips
+    @player.chips += pot # You win!
+    assert_equal(pot + chips, @player.chips)
+  end
+end