upwords 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d976dd35f79fb8bce46ee07868dff9b3e006307
-  data.tar.gz: a041750ee16726eb7120413b5e31556fa576dc76
+  metadata.gz: 6c9bd9e51484e62844a28edd893d75677898ca58
+  data.tar.gz: a6d853e3009e62f02d20b0bca25ea295d7e15e62
 SHA512:
-  metadata.gz: f77519cd05dbc45e243f3e36ca24a4f219b800b105dc1538313d71c342e60ca30434f217cb6ce7747ce1e8fa6b442c421c9ee89cc8931e58930c87634e2de169
-  data.tar.gz: 63e37dd7bd4f961bcd189121c51402e00d4bbd7b5d51c62315f09c755aca522e69a2191c8da60aa671d26343cc08246e991f7965ecd17b8f9add784224823fc4
+  metadata.gz: 8d9708d7e8b1910c0662defce90876449ec30f459ad1caf210e4e95dc0f89fa391c2a9e9c4fa54caf6f527d0f7b85c75ad85b2abce0bfb7e585f90033f43c48f
+  data.tar.gz: 696b89a6feaf45026c0a7b94046d93c6eb03063c1f01a3d7b9d2ae8b3e7e6431a374c9f49f8656d6ddd34ebf3f986c442a251b70ad2eba943100ba929e4ab4ce

data/README.md

@@ -1,4 +1,38 @@
-# UPWORDS - THE QUICK STACKING WORD GAME
+# Upwords - The Quick Stacking Word Game
+
+## Getting Started
+
+1. Install Upwords at the command prompt if you haven't yet:
+
+        $ gem install upwords
+
+2. At the command prompt, start a new Upwords game:
+
+        $ upwords
+
+3. Select the number of players:
+
+        How many players will play? (1-4)
+        3 
+
+4. Name each player and select if they are humans or computers:
+        
+        What is Player 1's name? (Press enter to submit...)
+        Bob 
+        Is Bob a computer? (y/n)
+        n   
+
+        What is Player 2's name? (Press enter to submit...)
+        Nina    
+        Is Nina a computer? (y/n)
+        n
+
+        What is Player 3's name? (Press enter to submit...)
+        Jack
+        Is Jack a computer? (y/n)
+        y
+
+## Rules
 
 Rules taken from: http://www.hasbro.com/common/instruct/04312.pdf
 
@@ -14,17 +48,11 @@ You score points for each letter in your word and every letter tile under
 each letter of your word.Letters can be stacked five tiles high so your score
 can really add up fast. Build words, stack letters, score high and have fun! 
 
-## OBJECT
+## Objective
 
 Build words to score the most points.
 
-## CONTENTS
-
-Plastic gameboard 100 plastic letter tiles 4 plastic tile racks
-
-4 rubber feet label sheet
-
-## LETTER DISTRIBUTION
+## Letter Distribution
 
 | Letters       | Amount    |
 | ------------- | --------- |
@@ -37,7 +65,7 @@ Plastic gameboard 100 plastic letter tiles 4 plastic tile racks
 | A I O         | 7 of each |
 | E             | 8 of each |
 
-## SETUP
+## Setup
 
 - Turn all of the tiles letter-side down and mix them up to create a draw pile.
 - Each player takes a rack.
@@ -46,7 +74,7 @@ Plastic gameboard 100 plastic letter tiles 4 plastic tile racks
   word. See Rule 8 on page 5 for more information. Use the dictionary
   to settle challenges only. 
 
-## GAMEPLAY
+## Gameplay
 
 ### 1. Deciding Who Goes First
 
@@ -68,7 +96,7 @@ let your opponents see 1 your letters.
 Whoever plays first must form a word of two letters or more that covers at least
 one of the four game squares in the center of the gameboard.
 
-### 4. BASIC TURN
+### 4. Basic Turn
 
 On your turn, play one or more letter tiles, either to form a new word that connects to
 a word already on the board, or to change a word already on the board to a different word. 
@@ -79,7 +107,7 @@ the ones you played.
 **IMPORTANT:** A word is legal and can be used in the game if it is in the dictionary and 
 it does not fall into any of the categories of illegal words listed in Rule 7 on page 5. 
 
-### 5. HOW TO FORM WORDS
+### 5. How To Form Words
 
 Figures 2 through 7 show a sequence of plays. Arrows point out the word or words 
 formed on each play. Point scores are given for each example. See Rule 6 on page
@@ -92,15 +120,40 @@ Build across using the letter "E" in DEAR to form the word NET as shown in Figur
 The word ON is also formed reading down.You score points for all of the words
 formed during your turn.
 
-Figure 2 Score: 8 Points
-
-[FIGURE 2]
-
-Figure 3 Score: 10 Points 
-
-[FIGURE 3]
-
-**N0TE:** Any letter in your word that is adjacent to another letter or letters on
+    +----+----+----+----+----+----+
+    |    |    |    |    |    |    |
+    +----+----+----+----+----+----+
+    |    | M  | O  | O  |{D} |    |
+    +----+---1+---1+---1+---1+----+
+    |    |    |    |    |{E} |    |
+    +----+----+----+----+---1+----+
+    |    |    |    |    |{A} |    |
+    +----+----+----+----+---1+----+
+    |    |    |    |    |{R} |    |
+    +----+----+----+----+---1+----+
+    |    |    |    |    |    |    |
+    +----+----+----+----+----+----+
+
+*Figure 2 - Score: 8 Points*
+
+    +----+----+----+----+----+----+
+    |    |    |    |    |    |    |
+    +----+----+----+----+----+----+
+    |    | M  | O  |{O} | D  |    |
+    +----+---1+---1+---1+---1+----+
+    |    |    |    |{N} |{E} |{T} |
+    +----+----+----+---1+---1+---1+
+    |    |    |    |    | A  |    |
+    +----+----+----+----+---1+----+
+    |    |    |    |    | R  |    |
+    +----+----+----+----+---1+----+
+    |    |    |    |    |    |    |
+    +----+----+----+----+----+----+
+
+*Figure 3 - Score: 10 Points* 
+
+
+**NOTE:** Any letter in your word that is adjacent to another letter or letters on
 the board must form a word. For example, in Figure 3, the letter "N" in NET is adjacent to
 the letter "O" in MOOD, which forms the word ON.
 
@@ -147,7 +200,7 @@ makes it plural as shown in Figure 7. You score points for both words.
 
 [FIGURE 7 | Score: 16 Points]
 
-### 6. HOW TO SCORE WORDS
+### 6. How To Score Words
 
 - You score 2 points per letter tile for any word formed with all letters
   only one tile high (no letter in the word is stacked on top of another
@@ -178,7 +231,7 @@ makes it plural as shown in Figure 7. You score points for both words.
 - At the end of the game, 5 points are subtracted from your score for
   each letter tile you cannot play. 
 
-### 7. ILLEGAL WORDS
+### 7. Illegal Words
 
 Any word that falls into any category listed below, is an illegal
 word and cannot be used in the game:
@@ -190,7 +243,7 @@ word and cannot be used in the game:
 - Foreign words are illegal unless they appear in the dictionary.
 - Words that are only one letter long are illegal. *(Note: Not Standard)*
 
-### 8. CHALLENGING A WORD
+### 8. Challenging A Word
 
 You can challenge an opponent's word if you think it's misspelled or
 an illegal word. The word must be challenged before another word is
@@ -198,13 +251,13 @@ played. Use a dictionary to decide if the challenged word is legal or
 illegal. lf the challenged word is illegal, the player who played it removes
 the letter tiles from the board and either plays another word or passes.
 
-### 9. PASSING
+### 9. Passing
 
 You may pass your turn at any time during the game. Sometimes it is to
 your advantage to pass, especially toward the end of the game, to allow
 a better scoring opportunity to open up for you. 
 
-### 10. EXCHANGING YOUR LETTERS
+### 10. Exchanging Your Letters
 
 On your turn, you may exchange one of your letter tiles for a new one.
 Just turn the tile you want to exchange letter-side down and draw a
@@ -214,7 +267,7 @@ it is a good strategy to give up a turn in order to exchange a letter. For
 example, you may want to exchange a "J" or a "Z" if you draw them late
 in the game.
 
-### 11. HOW TO END THE GAME
+### 11. How To End The Game
 
 The game is over as soon as any of the following situations occur:
 - When one player uses all of his or her letter tiles, and no tiles remain in
@@ -227,11 +280,11 @@ The game is over as soon as any of the following situations occur:
 When the game is over, total each player's final score. Subtract 5 points
 from a player's score for each letter tile he/she has not played.
 
-### HOW TO WIN
+### How To Win
 
 The player who scores the most points wins. 
 
-### SOLO PLAY RULES
+### Solo Play Rules
 
 Follow setup and gameplay rules as explained above. Make words, one at
 a time, and score points for every word you make. **NOTE:** During the game,

data/exe/upwords

@@ -2,4 +2,4 @@
 
 require 'upwords'
 
-Upwords::Game.new.run
+Upwords::UI::new(Upwords::Game.new, row_height=1, col_width=4)

data/lib/upwords.rb

@@ -7,17 +7,17 @@ require 'upwords/board'
 require 'upwords/letter_bank'
 require 'upwords/letter_rack'
 require 'upwords/dictionary'
+require 'upwords/word'
 
 require 'upwords/shape'
 require 'upwords/move'
-require 'upwords/move_manager'
 
 require 'upwords/cursor'
-
-require 'upwords/word'
 require 'upwords/player'
-require 'upwords/graphics'
+
+require 'upwords/move_manager'
 require 'upwords/game'
+require 'upwords/ui'
 
 module Upwords
   # Raised when player makes an illegal move
@@ -42,6 +42,10 @@ module Upwords
   DELETE = 127
   ENTER = 10
 
+  # Curses Color Constants
+  RED = 1
+  YELLOW = 2
+
   # Official Scrabble Player Dictionary file
   OSPD_FILE = File.join(File.dirname(__FILE__), "../data/ospd.txt")
   

data/lib/upwords/board.rb

@@ -1,7 +1,7 @@
 module Upwords
   class Board
     
-    attr_accessor :max_height, :size
+    attr_accessor :max_height, :min_word_length, :size
 
     # creates a 10 x 10 board
     def initialize(size=10, max_height=5)
@@ -10,6 +10,7 @@ module Upwords
       else
         @size = size
         @max_height = max_height
+        @min_word_length = 2
         @grid = Hash.new do |h, (row, col)|
           if row < 0 || col < 0 || num_rows <= row || num_columns <= col
             raise IllegalMove, "#{row}, #{col} is out of bounds!"
@@ -28,11 +29,6 @@ module Upwords
       @grid.key?([row, col]) && stack_height(row, col) > 0
     end
 
-    # maximum letters than can be stacked in one space
-    def min_word_length
-      2
-    end
-
     def num_rows
       @size
     end
@@ -70,6 +66,7 @@ module Upwords
       else 
         return true
       end
+
       return false
     end
 
@@ -84,13 +81,8 @@ module Upwords
       @grid[[row, col]].pop
     end
     
-    # show top letter in board space
     def top_letter(row, col)
-      get_letter(row, col, 1)
-    end
-
-    def get_letter(row, col, depth=1)
-      @grid[[row, col]][-depth]
+      @grid[[row, col]].last
     end
 
     def word_positions

data/lib/upwords/cursor.rb

@@ -6,9 +6,9 @@ module Upwords
       @max_y = max_y
       @max_x = max_x
 
-      # TODO: Handle case where init_y, x are outside bounds
-      @y = init_y 
-      @x = init_x
+      # HACK: Force init_y, init_x to be in bounds
+      @y = init_y % @max_y
+      @x = init_x % @max_x 
     end
 
     def up
@@ -32,7 +32,7 @@ module Upwords
       @x = (x + dx) % @max_x 
     end 
 
-    def posn
+    def pos
       [y, x]
     end
   end

data/lib/upwords/game.rb

@@ -2,19 +2,15 @@ module Upwords
   class Game
     attr_reader :board, :cursor, :players
     
-    def initialize(display_on = true, max_players = 4)
+    def initialize(max_players = 4)
       @max_players = max_players
-      @display_on = display_on
       @board = Board.new(10, 5)
       @letter_bank = LetterBank.new(ALL_LETTERS.dup)
-      @cursor = Cursor.new(@board.num_rows,
-                           @board.num_columns,
-                           *@board.middle_square[0])
+      @cursor = Cursor.new(@board.num_rows, @board.num_columns, *@board.middle_square[0])
       @dict = Dictionary.import(OSPD_FILE)
       @moves = MoveManager.new(@board, @dict)
       @players = []
-      @running = false
-      @submitted = false
+      @running = true
     end
     
     # =========================================
@@ -33,80 +29,39 @@ module Upwords
       player_count = @players.size
     end
 
-    def add_player(name = nil, cpu = false)
-      if player_count >= max_players
-        raise StandardError, "No more players can join"
-      else
-        if name.nil? || name.size == 0
-          name = "Player #{player_count + 1}" 
-        end
-        @players << Player.new(name, rack_capacity=7, cpu)
-      end
-      @players.each {|p| p.refill_rack(@letter_bank) }
+    def add_player(name = nil, letter_capacity = 7, cpu = false)
+      raise ArgumentError, "No more players can join" if player_count >= max_players
+      
+      # Automatically name player if no name is provided
+      name = "Player #{player_count + 1}" if name.nil? || name.length == 0
+        
+      @players << Player.new(name, letter_capacity, cpu)
     end
 
-    def add_players(player_names = nil)
-      print "\n"
-      num_players = 0
-
-      # Select how many players will be in the game
-      # TODO: Add a command-line flag to allow players to skip this step
-      until (1..@max_players).include?(num_players) do
-        print "How many players will play? (1-#{@max_players})\n"
-        num_players = gets.chomp.to_i
-        print "\n"
-        if !(1..@max_players).include?(num_players)
-          print "Invalid selection: #{num_players}\n\n"
-        end
-      end
-
-      # Name each player and choose if they are humans or computers
-      # TODO: Add a command-line flag to set this
-      (1..num_players).each do |idx|
-        print "What is Player #{idx}'s name?\n"
-        name = gets.chomp
-        print "Is Player #{idx} or a computer? (y/n)\n"
-        cpu = gets.chomp
-        add_player(name, cpu.upcase == "Y")
-        print "\n"
-      end
+    def all_refill_racks
+      @players.each {|p| p.refill_rack(@letter_bank) }
     end
 
     # =========================================
-    # Graphics Methods
+    # Move Manager Methods
     # =========================================
-
-    def init_window
-      Curses.noecho
-      Curses.curs_set(0) 
-      Curses.init_screen
-      # Curses.start_color
-
-      @win = Graphics.new(self)
-      @win.keypad(true)
-    end
     
-    def display_on?
-      @display_on
-    end
-    
-    def refresh_graphics
-      if display_on? && running?
-        @win.refresh
-      end
+    def play_letter(letter, y = @cursor.y, x = @cursor.x)
+      @moves.add(current_player, modify_letter_input(letter), y, x)
     end
 
-    def update_message msg
-      if display_on?
-        @win.message = msg
-        refresh_graphics
-      end
+    def undo_last
+      @moves.undo_last(current_player)
     end
 
-    def clear_message
-      update_message standard_message
+    def pending_position?(row, col)
+      @moves.include?(row, col)
     end
 
+    # =========================================
+    # Output messages that rely on MoveManager
+    # =========================================
+
     def standard_message
       "#{current_player.name}'s pending words: #{pending_result}"
     end
@@ -116,7 +71,7 @@ module Upwords
 
       unless new_words.empty?
         new_words.map do |w|
-          "#{w} (#{w.score})"
+          "#{w} (#{w.score})".upcase
         end.join(", ") + " (Total = #{@moves.pending_score(current_player)})"
       end
     end
@@ -129,196 +84,79 @@ module Upwords
       @running
     end
 
-    def run
-      @running = true
-      
-      # Add players
-      add_players
-
-      # Start graphics
-      init_window if @display_on
-      clear_message
-
-      # Start main loop
-      while running? do
-        begin
-          # ------ CPU MOVE --------
-          if current_player.cpu?
-            update_message "#{current_player.name} is thinking..."
-            cpu_move = current_player.cpu_move(@board, @dict, 50, 10)
-            
-            if !cpu_move.nil?
-              cpu_move.each do |posn, letter|
-                @moves.add(current_player, letter, *posn)
-              end
-              submit_moves(need_confirm=false)
-            else
-              skip_turn(need_confirm=false)
-            end
-          else
-            read_input(@win.getch)
-          end
-
-          if @submitted
-            # TODO: remove magic string from last move message
-            if @players.all? {|p| p.last_turn == "skipped turn"} || @letter_bank.empty? && current_player.rack_empty?
-              game_over
-              @running = false
-            else    
-              next_turn
-            end
-          end
-          
-          refresh_graphics
-          
-        rescue IllegalMove => exception
-          update_message "#{exception.message} (press any key to continue...)"
-          @win.getch if display_on?
-          clear_message
-        end
-      end
-      
-    end
-
-    def read_input(key)
-      case key
-      when 'Q'
-        exit_game
-      when SPACE
-        toggle_rack_visibility
-      when DELETE
-        undo_moves
-      when ENTER
+    def cpu_move
+      move = current_player.cpu_move(@board, @dict, batch_size=50, min_score=10)      
+      if !move.nil?
+        move.each { |pos, letter| play_letter(letter, *pos) }
         submit_moves
-      when Curses::KEY_UP
-        @cursor.up
-      when Curses::KEY_DOWN
-        @cursor.down
-      when Curses::KEY_LEFT
-        @cursor.left
-      when Curses::KEY_RIGHT
-        @cursor.right
-      when '+'
-        swap_letter
-      when '-'
+      else
         skip_turn
-      when /[[:alpha:]]/
-        @moves.add(current_player, modify_letter_input(key), @cursor.y, @cursor.x)
-        clear_message
       end
     end
     
-    def next_turn
-      @players.rotate!
-      @win.hide_rack if display_on?
-      clear_message
-      @submitted = false
-    end
-
-    # =========================================
-    # Methods Related to Key Inputs
-    # =========================================
-
-    # Capitalize letters, and convert 'Q' and 'q' to 'Qu'
-    def modify_letter_input(letter)
-      if letter =~ /[Qq]/
-        'Qu'
-      else
-        letter.capitalize
-      end
-    end
-
-    def confirm_action?(question_text)
-      if display_on?
-        update_message "#{question_text} (y/n)"
-        inp = @win.getch
-        clear_message
-        inp == 'y' || inp == 'Y'
-      else
-        true # Never ask for confirm if the display_on is off
-      end
-    end
-
     # =========================================
     # Game Procedures Bound to some Key Input
     # =========================================
 
-    def undo_moves
-      @moves.undo_last(current_player)
-      clear_message
+    def submit_moves
+      @moves.submit(current_player)
+      current_player.refill_rack(@letter_bank)     
+      current_player.last_turn = "played word"      # TODO: remove magic string from last move message
+      next_turn
     end
 
-    def submit_moves(need_confirm=true)
-      if !need_confirm || (confirm_action? "Are you sure you want to submit?")
-        @moves.submit(current_player)
-        current_player.refill_rack(@letter_bank)
-        @submitted = true
-        clear_message
-
-        # TODO: remove magic string from last move message
-        current_player.last_turn = "played word"
-      end
+    def swap_letter(letter)
+      letter = modify_letter_input(letter)
+      @moves.undo_all(current_player)
+      current_player.swap_letter(letter, @letter_bank) 
+      current_player.last_turn = "swapped letter"        # TODO: remove magic string from last move message
+      next_turn
     end
 
-    # TODO: Test this method...
-    def swap_letter(need_confirm=true)
-      update_message "Pick a letter to swap... "
-      letter = @win.getch
-
-      if letter =~ /[[:alpha:]]/
-        letter = modify_letter_input(letter)
-        if !need_confirm || (confirm_action? "Swap '#{letter}' for another?")
-          @moves.undo_all(current_player)
-          current_player.swap_letter(letter, @letter_bank)
-          @submitted = true
-
-          # TODO: remove magic string from last move message
-          current_player.last_turn = "swapped letter"
-        end
-      end
+    def skip_turn
+      @moves.undo_all(current_player)
+      current_player.last_turn = "skipped turn"    # TODO: remove magic string from last move message
+      next_turn
     end
 
-    def skip_turn(need_confirm=true)
-      if !need_confirm || (confirm_action? "Are you sure you want to skip your turn?")
-        @moves.undo_all(current_player)
-        @submitted = true
+    def exit_game
+      @running = false
+    end
 
-        # TODO: remove magic string from last move message
-        current_player.last_turn = "skipped turn"
-      end
+    # =================
+    # Game over methods
+    # =================
+    
+    def game_over?
+      @players.all? {|p| p.last_turn == "skipped turn"} || (@letter_bank.empty? && current_player.rack_empty?)
     end
 
-    def exit_game(need_confirm=true)
-      if !need_confirm || (confirm_action? "Are you sure you want to exit the game?")
-        @running = false
-        @win.close if display_on?
-      end
+    def get_top_score
+      @players.map {|p| p.score}.max
     end
 
-    def toggle_rack_visibility 
-      @win.toggle_rack_visibility
+    def get_winners
+      @players.select{|p| p.score == get_top_score}.map{|p| p.name}
     end
 
-    def game_over
-      update_message "The game is over. Press any key to continue to see who won..."
-      @win.getch if display_on?
+    private 
 
-      # Subtract 5 points for each tile remaining
-      @players.each do |p|
-        p.score -= p.letters.size * 5
+    def next_turn
+      if game_over?
+        # Subtract 5 points for each tile remaining
+        @players.each { |p| p.score -= p.letters.size * 5 }
+      else    
+        @players.rotate!
       end
+    end
 
-      top_score = @players.map {|p| p.score}.max
-      winners = @players.select{|p| p.score == top_score}.map{|p| p.name}
-
-      if winners.size == 1 
-        update_message "And the winner is... #{winners[0]} with #{top_score} points!"
+    # Capitalize letters, and convert 'Q' and 'q' to 'Qu'
+    def modify_letter_input(letter)
+      if letter =~ /[Qq]/
+        'Qu'
       else
-        update_message "We have a tie! #{winners.join(', ')} all win with #{top_score} points!"
+        letter.capitalize
       end
-
-      @win.getch if display_on?
-      exit_game(need_confirm=false)
     end
 
   end