Oshuma-gambler 0.0.2

data/History.txt

@@ -0,0 +1,10 @@
+=== 0.0.2 / 2008-06-09
+
+* Basic gambling framework!
+
+=== 0.0.1 / 2008-06-05
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,31 @@
+History.txt
+Manifest.txt
+README
+README.rdoc
+README.txt
+Rakefile
+bin/gambler_client
+gambler.gemspec
+lib/gambler.rb
+lib/gambler/card.rb
+lib/gambler/deck.rb
+lib/gambler/exceptions.rb
+lib/gambler/game.rb
+lib/gambler/game/basic_game.rb
+lib/gambler/game/blackjack.rb
+lib/gambler/player.rb
+tasks/ditz.rake
+tasks/docs.rake
+tasks/git.rake
+tasks/override_rake_task.rb
+tasks/rcov.rake
+tasks/site.rake
+tasks/util.rb
+test/game/test_basic_game.rb
+test/game/test_blackjack.rb
+test/helper.rb
+test/suite.rb
+test/test_card.rb
+test/test_deck.rb
+test/test_gambler.rb
+test/test_player.rb

data/README

@@ -0,0 +1 @@
+README.txt

data/README.rdoc

@@ -0,0 +1 @@
+README.txt

data/README.txt

@@ -0,0 +1,46 @@
+= Gambler
+
+Github:: http://github.com/Oshuma/gambler/
+RubyForge:: http://gambler.rubyforge.org/
+
+== DESCRIPTION:
+
+Gambler is a Ruby library which can be included into other classes/modules.
+It provides an object oriented interface for common gambling games such as
+Blackjack, Poker, etc.
+
+== SYNOPSIS:
+
+Ruby library to satisfy yet another human addiction.
+
+
+== REQUIREMENTS:
+
+Pure Ruby, so far.
+
+== INSTALL:
+
+ # From RubyForge:
+ $ gem install gambler
+
+ # From Github:
+ $ gem sources -a http://gems.github.com/ (You only need to do this once.)
+ $ gem install Oshuma-gambler
+
+== LICENSE:
+
+     DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+             Version 2, December 2004
+ 	     http://sam.zoy.org/wtfpl/
+
+ Copyright (C) 2008 Dale Campbell <dale@save-state.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+     DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'hoe'
+require './lib/gambler'
+require './tasks/override_rake_task'
+require './tasks/util'
+
+GAMBLER_ROOT = File.dirname(__FILE__) unless defined? GAMBLER_ROOT
+
+Hoe.new('Gambler', Gambler::VERSION) do |g|
+  g.developer('Dale Campbell', 'dale@save-state.net')
+  g.name = 'gambler'
+  g.version = Gambler::VERSION
+  g.changes = g.paragraphs_of('History.txt', 0..1).join("\n\n")
+
+  url = g.paragraphs_of('README.txt', 1).first.split(/\n/)[1].split[1].strip
+  g.url = url
+
+  g.summary = 'Ruby library to satisfy yet another human addiction.'
+  g.description = g.paragraphs_of('README.txt', 3..3).join("\n\n")
+end
+
+# Remove un-needed tasks.
+remove_task 'audit'
+remove_task 'generate_key'
+remove_task 'multi'
+remove_task 'post_blog'
+
+Dir["#{GAMBLER_ROOT}/tasks/**/*.rake"].sort.each { |task| load task }
+
+task :default => [ :test, :rcov ]
+
+desc 'Clean up dynamically generated files'
+task :cleanup do
+  %w{
+    docs:clear
+    issues:report:clear
+    rcov:clear
+    site:clear_local
+  }.each do |clean|
+    Rake::Task[clean].invoke
+  end
+end
+
+desc 'Open a console with Gambler loaded'
+task :console do
+  sh "irb -rubygems -r ./lib/gambler.rb"
+end

data/bin/gambler_client

@@ -0,0 +1,214 @@
+#!/usr/bin/env ruby -w
+
+GAMBLER_ROOT = File.join(File.dirname(__FILE__), '..')
+$LOAD_PATH.unshift File.join(GAMBLER_ROOT, 'lib')
+require 'gambler'
+
+module Gambler
+  # A simple Client which allows you to play around with Gambler.
+  # Most of this class can be ignored, as it just sets up the gaming
+  # environment.  The method to pay attention to is +play_blackjack+.
+  # This is the method that actually creates and deals a Blackjack game.
+  class Client
+    WIDTH = 50
+
+    $player_quits = false
+
+    attr_accessor :bots
+    attr_accessor :player
+
+    def initialize
+      @player = setup_player
+      @bots = Array.new
+    end
+
+    # This is the main client menu.
+    def menu
+      display_header
+      until $player_quits do
+        display_player_stats
+        display_game_menu
+        choice = STDIN.gets.chomp
+
+        case choice
+        when '1':
+          play_blackjack
+        when '2':
+          puts 'This game is not implemented yet.'
+        when '3':
+          puts 'This game is not implemented yet.'
+        when /a/i:
+          add_ai_player
+        when /p/i:
+          setup_player
+        when /d/i:
+          debug_console
+        when /q/i:
+          $player_quits = true
+          exit
+        else
+          puts 'Invalid choice, dumbass.'
+        end
+      end
+    end # of menu
+
+    private
+
+    # Add an AI Player as an opponent.
+    def add_ai_player
+      @bots << setup_player(:bot => true)
+    end
+
+    # Simple debugging console.
+    def debug_console
+      stop_debug = false
+      code = Array.new
+
+      puts # spacer
+      puts '== DEBUG CONSOLE =='
+      puts 'Commands:'
+      puts '  /run  - Quit debugger and run the code.'
+      puts '  /show - Show the code currently in the buffer.'
+      puts '  /quit - Quit debugger without running the code.'
+
+      until stop_debug do
+        print "eval:#{code.size + 1}> "
+        line = STDIN.gets.chomp
+
+        case line
+        when '/run':
+          run_code(code)
+          stop_debug = true
+        when '/show':
+          show_code_buffer(code)
+        when '/quit':
+          stop_debug = true
+        else # not a command, must be some Ruby code.
+          code << line
+        end
+      end
+    end # of debug_console
+
+    # Client header.
+    def display_header
+      puts # spacer
+      puts ''.center(WIDTH, '=')
+      puts " Gambler v#{Gambler::VERSION} ".center(WIDTH, '=')
+      puts ''.center(WIDTH, '=')
+      puts '----------------------------------------'.center(WIDTH)
+      puts '| Feeding yet another human addiction. |'.center(WIDTH)
+      puts '----------------------------------------'.center(WIDTH)
+    end # of display_header
+
+    # Pretty print the player's stats.
+    def display_player_stats
+      puts '- Players -'.center(WIDTH)
+      seperator = "\t"
+      stat_width = WIDTH - 5
+      stats     = String.new
+      bot_stats = String.new
+
+      stats << "Player: #{@player.name}".ljust(WIDTH/2)
+      stats << seperator
+      stats << "Chips: #{@player.chips}"
+      puts stats.center(stat_width)
+
+      if @bots.empty?
+        puts 'No AI opponents.'.center(WIDTH)
+      else
+        @bots.each do |bot|
+          bot_stats  = "AI: #{bot.name}".ljust(WIDTH/2)
+          bot_stats << seperator
+          bot_stats << "Chips: #{bot.chips}"
+          puts bot_stats.center(stat_width)
+        end
+      end
+    end # of display_player_stats
+
+    # Client game menu.
+    def display_game_menu
+      puts '-----------------------'.center(WIDTH)
+      puts '|  1) Blackjack       |'.center(WIDTH)
+      puts '|  2) Stud Poker      |'.center(WIDTH)
+      puts "|  3) Texas Hold 'em  |".center(WIDTH)
+      puts '|  A) Add AI Player   |'.center(WIDTH)
+      puts '|  D) Debug Console   |'.center(WIDTH)
+      puts '|  P) Setup Player    |'.center(WIDTH)
+      puts '|  Q) Quit            |'.center(WIDTH)
+      puts '-----------------------'.center(WIDTH)
+      puts
+      print 'Game: '
+    end # of display_menu
+
+    # Play a quick 1vs1 game of Blackjack.
+    def play_blackjack
+      begin
+        # Create an array and add the player and bots.
+        players = Array.new
+        players << @player
+        players << @bots
+        players.flatten!
+
+        @game = Gambler::Game::Blackjack.new(:players => players)
+      rescue Gambler::Exceptions::InvalidPlayerSize
+        puts 'Need at least 2 players for blackjack.'
+        until @bots.size >= 1
+          @bots << setup_player(:bot => true)
+        end
+        retry
+      end # of begin ZOMG!!1
+    end # of play_blackjack
+
+    # Takes an array of +code+ lines and <tt>eval</tt>'s them.
+    def run_code(code)
+      puts # spacer
+      begin
+        puts " BEGIN DEBUG ".center(WIDTH, '=')
+        eval(code.join("\n")) # Need to join, since +code+ is an Array.
+        puts " END DEBUG ".center(WIDTH, '=')
+      rescue Exception => error
+        puts " DEBUG FAILED ".center(WIDTH, '=')
+        puts error
+      end
+      puts # spacer
+    end
+
+    # Setup a new Player instance.
+    def setup_player(options = {})
+      default_chips = 100
+      if options[:bot]
+        who = 'AI player'
+        default_name = 'Kenny'
+      else
+        who = 'your player'
+        default_name = 'Human'
+      end
+
+      puts "Setting up #{who}."
+      print "Name [#{default_name}]: "
+      name = STDIN.gets.chomp
+      name = default_name if name.empty?
+
+      print "Chips [#{default_chips}]: "
+      chips = STDIN.gets.chomp.to_i
+      chips = default_chips if chips.zero?
+
+      return Gambler::Player.new(name, :chips => chips)
+    end # of setup_player
+
+    # Takes an array of +code+ lines and prints them.
+    def show_code_buffer(code)
+      return (puts "Buffer empty.") if code.size.zero?
+      puts "== BUFFER ==\n"
+      code.each_with_index do |buf, line_num|
+        print "#{line_num + 1}:  ".rjust(5)
+        puts buf
+      end
+    end
+
+  end # of Client
+
+end # of Gambler
+
+# Let's do this!
+Gambler::Client.new.menu

data/lib/gambler/card.rb

@@ -0,0 +1,163 @@
+module Gambler
+
+  # Object representing an individual Card.
+  #
+  # All of the following lines create a king of diamonds:
+  #   # Array
+  #   Card.new ['K', 'd']
+  #
+  #   # Hash
+  #   Card.new :face => 'K', :suit => 'd'
+  #
+  #   # String
+  #   Card.new 'Kd'
+  class Card
+    SUITS = %w(c d h s)
+    SUIT_NAMES = {
+      'c' => 'Clubs',
+      'd' => 'Diamonds',
+      'h' => 'Hearts',
+      's' => 'Spades'
+    }
+
+    FACES = %w(A K Q J T 9 8 7 6 5 4 3 2)
+    FACE_NAMES = {
+      'A' => 'Ace',
+      'K' => 'King',
+      'Q' => 'Queen',
+      'J' => 'Jack',
+      'T' => 'Ten',
+      '9' => 'Nine',
+      '8' => 'Eight',
+      '7' => 'Seven',
+      '6' => 'Six',
+      '5' => 'Five',
+      '4' => 'Four',
+      '3' => 'Three',
+      '2' => 'Two'
+    }
+    FACE_VALUES = {
+      'A' => 14,
+      'K' => 13,
+      'Q' => 12,
+      'J' => 11,
+      'T' => 10,
+      '9' => 9,
+      '8' => 8,
+      '7' => 7,
+      '6' => 6,
+      '5' => 5,
+      '4' => 4,
+      '3' => 3,
+      '2' => 2,
+      'L' => 1 # Magic low Ace.
+    }
+
+    attr_reader :face, :suit
+
+    # Creates a new Card object, based on the class of +args+.
+    def initialize(args)
+      face, suit = case args
+      when Array:
+        build_from_array(args)
+      when Hash:
+        build_from_hash(args)
+      when String:
+        build_from_string(args)
+      end
+      raise Exceptions::InvalidCardType unless SUITS.include?(suit) && FACES.include?(face)
+      @face, @suit = face, suit
+    end
+
+    # Class methods.
+    class << self
+      # Iterator for all Cards; yields one Card in +block+ or returns an Array of all Cards.
+      def all(&block)
+        cards = Array.new
+        each_suit do |suit|
+          each_face do |face|
+            card = self.new(:face => face, :suit => suit)
+            block_given? ? (yield card) : cards << card
+          end
+        end
+        return cards unless block_given?
+      end
+
+      # Iterator for the FACES.
+      def each_face(&block)
+        FACES.each { |face| yield face }
+      end # of each_face
+
+      # Iterator for the SUITS.
+      def each_suit(&block)
+        SUITS.each { |suit| yield suit }
+      end # of each_suit
+
+      # Build methods for each SUIT which will return an array of all Cards in that SUIT.
+      # This will allow for things like:
+      #   Card.diamonds.sort_by { |card| card.face_value }.each {|card| puts card}
+      class_eval do
+        Card.each_suit do |index|
+          suit_name = SUIT_NAMES[index].downcase
+          define_method(suit_name) do
+            cards = Array.new
+            all do |card|
+              cards << card if card.suit == index
+            end
+            return cards
+          end
+        end # of Card.each_suit
+      end # of class_eval
+    end # of class methods
+
+    # Return the numerical face value of a Card.
+    def face_value
+      FACE_VALUES[@face]
+    end
+
+    # Print a human readable description of a Card instance.
+    #   Card.new('Kd').to_s # => 'Kd'
+    def to_s
+      @face + @suit
+    end
+
+    # Print a (pretty) human readable description of a Card instance.
+    #   Card.new('Kd').to_pretty_s # => 'King of Diamonds'
+    def to_pretty_s
+      face = FACE_NAMES[@face]
+      suit = SUIT_NAMES[@suit]
+      return "#{face} of #{suit}"
+    end
+
+    private
+
+    # Build a Card object with the given +array+.
+    # Example:
+    #   build_from_array ['K', 'd']
+    def build_from_array(array)
+      raise Exceptions::InvalidCardType unless array.size == 2
+      face = array.shift
+      suit = array.shift
+      return face, suit
+    end
+
+    # Build a Card object with the given +hash+.
+    # Example:
+    #   build_from_hash(:face => 'K', :suit => 'd')
+    def build_from_hash(hash)
+      raise Exceptions::InvalidCardType unless hash.include?(:face) && hash.include?(:suit)
+      return hash[:face], hash[:suit]
+    end
+
+    # Build a Card object with the given +string+.
+    # Example:
+    #   build_from_string('Kd')
+    def build_from_string(string)
+      card = string.split('')
+      raise Exceptions::InvalidCardType unless card.size == 2
+      face = card.shift # First letter.
+      suit = card.shift # Second letter.
+      return face, suit
+    end
+  end # of Card
+end # of Gambler

data/lib/gambler/deck.rb

@@ -0,0 +1,46 @@
+module Gambler
+
+  # Handles a collection of Gambler::Card objects as a single Deck.
+  # +options+ can be:
+  # * <tt>cards</tt>: An array of Cards this Deck will contain.
+  #
+  # Examples:
+  #
+  #   @deck = Deck.new
+  class Deck
+    attr_reader :cards, :shuffled
+
+    def initialize(options = {})
+      options[:cards] ||= Card.all
+      options[:cards].each do |card|
+        raise Exceptions::InvalidDeck unless card.is_a? Card
+      end
+
+      @cards = options[:cards]
+      @shuffled = false
+    end
+
+    # Deals one Card to the given +player+.
+    # Example:
+    #   @deck.deal_to(@player)
+    def deal_to(player)
+      card = @cards.first
+      raise Exceptions::DeckEmpty if card.nil?
+      player.hand << card
+      @cards.delete(card)
+    end
+
+    # Shuffles the Deck; changes <tt>@cards</tt> to reflect the shuffle.
+    # Example:
+    #   @deck.shuffle!
+    def shuffle!
+      @cards.sort! {rand}
+      @shuffled = true
+    end
+
+    # Size of the current Deck (number of Cards remaining).
+    def size
+      @cards.size
+    end
+  end # of Deck
+end # of Gambler

data/lib/gambler/exceptions.rb

@@ -0,0 +1,26 @@
+module Gambler
+
+  module Exceptions
+
+    # Gambler
+    class MustOverrideMethod < Exception; end
+
+    # Card
+    class InvalidCardType < Exception; end
+
+    # Deck
+    class DeckEmpty   < Exception; end
+    class InvalidDeck < Exception; end
+
+    # Game
+    class InvalidPlayers     < Exception; end
+    class InvalidPlayerSize  < Exception; end
+    class NoPlayers          < Exception; end
+
+    # Player
+    class NoPlayerName     < Exception; end
+    class InvalidChipCount < Exception; end
+
+  end # of Exceptions
+
+end # of Gambler

data/lib/gambler/game/blackjack.rb

@@ -0,0 +1,31 @@
+module Gambler
+
+  module Game
+
+    # The Game of Blackjack.
+    class Blackjack < Gambler::Game::BasicGame
+      INITIAL_CARDS = 2
+
+      def initialize(options = {})
+        raise Exceptions::InvalidPlayerSize unless options[:players].size >= 2
+        super(options)
+        @players.each { |player| player.empty_hand! }
+        deal_initial_hands
+      end
+
+      private
+
+      # Deal out the initial cards to each Player.
+      def deal_initial_hands
+        INITIAL_CARDS.times do
+          @players.each do |player|
+            @deck.deal_to player
+          end
+        end
+      end
+
+    end # of Blackjack
+
+  end # of Game
+
+end # of Gambler

data/lib/gambler/game.rb

@@ -0,0 +1,9 @@
+require 'gambler/game/basic_game'
+require 'gambler/game/blackjack'
+
+module Gambler
+
+  module Game
+  end # of Game
+
+end # of Gambler

data/lib/gambler/player.rb

@@ -0,0 +1,64 @@
+module Gambler
+
+  # Main Player class in which all others should inherit (if neccessary).
+  # The Player's +name+ is required.
+  #
+  # +options+ can contain:
+  # * <tt>chips</tt>: Amount of chips the new Player will have.  Defaults to 100.
+  # * <tt>hand</tt>: An array of Cards the new Player will be holding.  Defaults to +nil+.
+  #
+  # Example:
+  #   Player.new('Dale')
+  #   Player.new('Kenny', :chips => 1_000_000)
+  #   Player.new( 'Cheaty McGee', # has blackjack from the start!
+  #               :hand => [Card.new('Ad'), Card.new('Kd')] )
+  class Player
+    # Initial chip count if none is specified.
+    CHIP_STACK = 100
+
+    attr_accessor :name, :chips, :hand
+
+    def initialize(name, options = {})
+      raise Exceptions::NoPlayerName unless name
+      @name  = name
+      @hand  = options[:hand] || Array.new
+
+      @chips = options[:chips] || CHIP_STACK
+      raise Exceptions::InvalidChipCount unless @chips.is_a? Fixnum
+    end
+
+    # Removes all the Cards from the Player's hand.
+    def empty_hand!
+      @hand = Array.new
+    end
+
+    # Pretty object inspection.
+    def inspect
+      %Q{#<Gambler::Player '#{@name}'>}
+    end
+
+    # Pretty printing of a Player.
+    def to_s
+      "#{@name} ($#{@chips})"
+    end
+
+    # Allows a Player to view their +hand+ in various formats.
+    def view_hand(options = {})
+      format    = options[:format]    || :array
+      pretty    = options[:pretty]    || false
+      seperator = options[:seperator] || (pretty ? ', ' : ' ')
+
+      method = (pretty ? :to_pretty_s : :to_s)
+
+      case format
+      when :array
+        cards = Array.new
+        @hand.each { |card| cards << card.send(method) }
+      when :string
+        cards = @hand.collect { |card| card.send(method) }.join(seperator)
+      end
+      return cards
+    end # of view_hand
+
+  end # of Player
+end # of Gambler