rubywarrior 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+0.1.0 (Jan 2, 2010)
+
+* initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Ryan Bates
+ 
+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.rdoc

@@ -0,0 +1,170 @@
+= Ruby Warrior
+
+This is a game designed to teach the Ruby language and artificial intelligence in a fun, interactive way.
+
+You play as a warrior climbing a tall tower to reach the precious Ruby at the top level. On each floor you need to write a Ruby script to instruct the warrior to battle enemies, rescue captives, and reach the stairs. You have some idea of what each floor contains, but you never know for certain what will happen. You must give the Warrior enough artificial intelligence up-front to find his own way.
+
+NOTE: The player directory structure changed on July 18, 2009. If you have an old profile using the "level-00*" structure then move the contents of the last level into the parent directory.
+
+
+== Getting Started
+
+First install the gem.
+
+  gem install rubywarrior
+
+Then run the "rubywarrior" command to setup your profile. This will create a rubywarrior directory in your current location where you will find a player.rb file in your profile's directory containing this:
+
+  class Player
+    def play_turn(warrior)
+      # your code goes here
+    end
+  end
+
+Your objective is to fill this "play_turn" method with commands to instruct the warrior what to do. With each level your abilities will grow along with the difficulty. See the README in your profile's directory for details on what abilities your warrior has available on the current level.
+
+Here is a simple example which will instruct the warrior to attack if he feels an enemy, otherwise he will walk forward.
+
+  class Player
+    def play_turn(warrior)
+      if warrior.feel.enemy?
+        warrior.attack!
+      else
+        warrior.walk!
+      end
+    end
+  end
+
+Once you are done editing player.rb, save the file and run the "rubywarrior" command again to start playing the level. The play happens through a series of turns. On each one, your "play_turn" method is called along with any enemy's.
+
+You cannot change your code in the middle of a level. You must take into account everything that may happen on that level and give your warrior the proper instructions from the start.
+
+Losing all of your health will cause you to fail the level. You are not punished by this, you simply need to go back to your player.rb, improve your code, and try again.
+
+Once you pass a level (by reaching the stairs), the profile README will be updated for the next level. Alter the player.rb file and run rubywarrior again to play the next level.
+
+
+== Scoring
+
+Your objective is to not only reach the stairs, but to get the highest score you can. There are many ways you can earn points on a level.
+
+* defeat an enemy to add his max health to your score
+* rescue a captive to earn 20 points
+* pass the level within the bonus time to earn the amount of bonus time remaining
+* defeat all enemies and rescue all captives to receive a 20% overall bonus
+
+A total score is kept as you progress through the levels. When you pass a level, that score is added to your total.
+
+Don't be too concerned about scoring perfectly in the beginning. After you reach the top of the tower you will be able to re-run the tower and fine-tune your warrior to get the highest score. See the Epic Mode below for details.
+
+
+== Perspective
+
+Even though this is a text-based game, think of it as two-dimensional where you are viewing from overhead. Each level is always rectangular in shape and is made up of a number of squares. Only one unit can be on a given square at a time, and your objective is to find the square with the stairs. Here is an example level map and key.
+
+   ----
+  |C s>|
+  | S s|
+  |C @ |
+   ----
+  
+  > = Stairs
+  @ = Warrior (20 HP)
+  s = Sludge (12 HP)
+  S = Thick Sludge (24 HP)
+  C = Captive (1 HP)
+
+
+== Commanding the Warrior
+
+When you first start, your warrior will only have a few abilities, but with each level your abilities will grow. A warrior has two kinds of abilities: actions and senses.
+
+An action is something that effects the game in some way. You can easily tell an action because it ends in an exclamation mark. Only one action can be performed per turn, so choose wisely. Here are some examples of actions.
+
+  warrior.walk!
+    Move in given direction (forward by default).
+
+  warrior.attack!
+    Attack the unit in given direction (forward by default).
+
+  warrior.rest!
+    Gain 10% of max health back, but do nothing more.
+
+  warrior.bind!
+    Bind unit in given direction to keep him from moving (forward by default).
+
+  warrior.rescue!
+    Rescue a captive from his chains (earning 50 points) in given direction (forward by default).
+
+
+A sense is something which gathers information about the floor. You can perform senses as often as you want per turn to gather information about your surroundings and to aid you in choosing the proper action. Senses do NOT end in an exclamation mark.
+
+  warrior.feel
+    Returns a Space for the given direction (forward by default).
+
+  warrior.health
+    Returns an integer representing your health.
+
+  warrior.distance
+    Returns the number of spaces the stairs are away.
+
+  warrior.listen
+    Returns an array of all spaces which have units in them.
+
+
+Since what you sense will change each turn, you should record what information you gather for use on the next turn. For example, you can determine if you are being attacked if your health has gone down since the last turn.
+
+
+== Spaces
+
+Whenever you sense an area, often one or multiple spaces (in an array) will be returned. A space is an object representing a square in the level. You can call methods on a space to gather information about what is there. Here are the various methods you can call on a space.
+
+  space.empty?
+    If true, this means that nothing (except maybe stairs) is at this location and you can walk here.
+  
+  space.stairs?
+    Determine if stairs are at that location
+  
+  space.enemy?
+    Determine if an enemy unit is at this location.
+  
+  space.captive?
+    Determine if a captive is at this location.
+  
+  space.wall?
+    Returns true if this is the edge of the level. You can't walk here.
+  
+  space.ticking?
+    Returns true if this space contains a bomb which will explode in time.
+
+You will often call these methods directly after a sense. For example, the "feel" sense returns one space. You can call "captive?" on this to determine if a captive is in front of you.
+
+  warrior.feel.captive?
+
+
+== Epic Mode
+  
+Once you reach the top of the tower, you will enter epic mode. When running rubywarrior again it will run your current player.rb through all levels in the tower without stopping.
+
+Your warrior will most likely not succeed the first time around, so use the -l option on levels you are having difficulty or want to fine-tune the scoring.
+
+  rubywarrior -l 3
+
+Once your warrior reaches the top again you will receive an average grade, along with a grade for each level. The grades from best to worst are S, A, B, C, D and F. Try to get S on each level for the ultimate score.
+
+Note: I'm in the process of fine-tuning the grading system. If you find the "S" grade to be too easy or too difficult to achieve on a given level, please add an issue for this on GitHub.
+
+
+== Tips
+
+If you ever get stuck on a level, review the README documentation and be sure you're trying each ability out. If you can't keep your health up, be sure to "rest" when no enemy is around (while keeping an eye on your health). Also, try to use far-ranged weapons whenever possible (such as the bow).
+
+Remember, you're working in Ruby here. Don't simply fill up the "play_turn" method with a lot of code. Organize it with methods and classes. The player directory is set up as a load path so you can include other ruby files from your player.rb file.
+
+Senses are cheap, so use them liberally. Store the sensed information to help you better determine what actions to take in the future.
+
+Running "rubywarrior" while you are in your profile directory will auto-select that profile so you don't have to each time.
+
+If you're aiming for points, remember to sweep the area. Even if you're close to the stairs, don't go in until you've gotten everything (if you have the health). Use far-ranged senses (such as look and listen) to determine if there are any enemies left.
+
+Make sure to try the different options you can pass to the rubywarrior command. Run "rubywarrior --help" to see them all.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake'
+require 'spec'
+require 'cucumber'
+
+require 'cucumber/rake/task'
+require 'spec/rake/spectask'
+
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c"]
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format progress"
+end
+
+task :default => [:spec, :features]

data/bin/rubywarrior

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../lib/ruby_warrior'
+
+runner = RubyWarrior::Runner.new(ARGV, STDIN, STDOUT)
+runner.run

data/features/command_options.feature

@@ -0,0 +1,46 @@
+Feature: Command Options
+  In order to play the game the way I want
+  As a player
+  I want to customize rubywarrior with options
+  
+  Background:
+    Given no profile at "tmp"
+  
+  Scenario: Run ruby warrior in specified directory with -d option
+    Given a profile named "Joe" on "beginner"
+    When I copy fixture "walking_player.rb" to "tmp/rubywarrior/joe-beginner/player.rb"
+    And I run rubywarrior with options "-d tmp/rubywarrior/joe-beginner -t 0"
+    And I answer "y" to "next level"
+    Then I should see "the updated README in the rubywarrior/joe-beginner directory"
+  
+  Scenario: Skip user input with -s option
+    Given a profile named "Joe" on "beginner"
+    When I copy fixture "walking_player.rb" to "tmp/rubywarrior/joe-beginner/player.rb"
+    And I run rubywarrior with options "-d tmp/rubywarrior/joe-beginner -t 0 -s"
+    Then I should see "current level"
+    When I run rubywarrior with options "-d tmp/rubywarrior/joe-beginner -t 0"
+    And I answer "y" to "next level"
+    Then I should see "the updated README in the rubywarrior/joe-beginner directory"
+    When I run rubywarrior with options "-d tmp/rubywarrior/joe-beginner -t 0 -s"
+    Then I should see "failed level 2"
+  
+  Scenario: Unable to practice level if not epic
+    Given a profile named "Joe" on "beginner"
+    When I copy fixture "walking_player.rb" to "tmp/rubywarrior/joe-beginner/player.rb"
+    And I run rubywarrior with options "-d tmp/rubywarrior/joe-beginner -l 2"
+    Then I should see "Unable"
+  
+  Scenario: Practice specific level when epic
+    When I copy fixture "short-tower" to "towers/short"
+    Given a profile named "Bill" on "short"
+    When I copy fixture "walking_player.rb" to "tmp/rubywarrior/bill-short/player.rb"
+    And I run rubywarrior
+    And I choose "Bill - short - level 1" for "profile"
+    Then I answer "y" to "next level"
+    And I should see "the updated README in the rubywarrior/bill-short directory"
+    When I run rubywarrior
+    And I choose "Bill - short - level 2" for "profile"
+    Then I answer "y" to "epic"
+    And I should see "epic mode"
+    When I run rubywarrior with options "-d tmp/rubywarrior/bill-short -l 2"
+    Then I should not see "Level 1" before "Total Score: 17"

data/features/levels.feature

@@ -0,0 +1,51 @@
+Feature: Play levels
+  In order to play ruby warrior
+  As a player
+  I want to advance through levels or retry them
+  
+  Background:
+    Given no profile at "tmp"
+  
+  Scenario: Pass first level, fail second level
+    Given a profile named "Joe" on "beginner"
+    When I copy fixture "walking_player.rb" to "tmp/rubywarrior/joe-beginner/player.rb"
+    And I run rubywarrior
+    And I choose "Joe - beginner - level 1" for "profile"
+    And I answer "y" to "next level"
+    Then I should see "the updated README in the rubywarrior/joe-beginner directory"
+    When I run rubywarrior
+    And I choose "Joe - beginner - level 2" for "profile"
+    And I answer "y" to "clues"
+    Then I should see "warrior.feel.empty?"
+  
+  Scenario: Retry first level
+    Given a profile named "Joe" on "beginner"
+    When I copy fixture "walking_player.rb" to "tmp/rubywarrior/joe-beginner/player.rb"
+    And I run rubywarrior
+    And I choose "Joe - beginner - level 1" for "profile"
+    And I answer "n" to "next level"
+    Then I should see "current level"
+    When I run rubywarrior
+    Then I should see "Joe - beginner - level 1"
+  
+  @focus
+  Scenario: Replay levels as epic when finishing last level with grades
+    When I copy fixture "short-tower" to "towers/short"
+    Given a profile named "Bill" on "short"
+    When I copy fixture "walking_player.rb" to "tmp/rubywarrior/bill-short/player.rb"
+    And I run rubywarrior
+    And I choose "Bill - short - level 1" for "profile"
+    Then I answer "y" to "next level"
+    And I should see "the updated README in the rubywarrior/bill-short directory"
+    When I run rubywarrior
+    And I choose "Bill - short - level 2" for "profile"
+    Then I answer "y" to "epic"
+    And I should see "epic mode"
+    When I run rubywarrior
+    And I choose "Bill - short - first score 34 - epic score 0" for "profile"
+    Then I should see "Level Grade: S"
+    When I run rubywarrior
+    And I choose "Bill - short - first score 34 - epic score 34" for "profile"
+    Then I should see "grade for this tower"
+    When I run rubywarrior
+    Then I should see "Bill - short - first score 34 - epic score 34"

data/features/profiles.feature

@@ -0,0 +1,56 @@
+Feature: Manage Profiles
+  In order to play ruby warrior
+  As a player
+  I want to create and choose profiles
+  
+  Background:
+    Given no profile at "tmp"
+
+  Scenario: New profile
+    When I run rubywarrior
+    And I answer "y" to "create one?"
+    And I choose "beginner" for "tower"
+    And I answer "Joe" to "name"
+    Then I should see "generated"
+    And I should find file at "tmp/rubywarrior"
+    When I run rubywarrior
+    Then I should see "Joe - beginner - level 1 - score 0"
+
+  Scenario: Another new profile on same tower
+    Given a profile named "Joe" on "beginner"
+    When I run rubywarrior
+    And I choose "New" for "profile"
+    And I choose "beginner" for "tower"
+    And I answer "Bob" to "name"
+    Then I should see "generated"
+    When I run rubywarrior
+    Then I should see "Bob - beginner - level 1 - score 0"
+
+  Scenario: Replace profile in same tower with same name
+    Given a profile named "Joe" on "beginner"
+    When I run rubywarrior
+    And I choose "New" for "profile"
+    And I choose "beginner" for "tower"
+    And I answer "Joe" to "name"
+    And I answer "y" to "replace"
+    Then I should see "generated"
+    When I run rubywarrior
+    Then I should see "Joe - beginner - level 1 - score 0"
+  
+  Scenario: Auto select profile at given path
+    Given a profile named "Joe" on "beginner"
+    And current directory is "tmp/rubywarrior/joe-beginner"
+    When I copy fixture "walking_player.rb" to "tmp/rubywarrior/joe-beginner/player.rb"
+    And I run rubywarrior
+    And I answer "y" to "next level"
+    Then I should see "the updated README in the rubywarrior/joe-beginner directory"
+
+  Scenario: Move legacy ruby-warrior profile
+    Given a directory at "tmp/ruby-warrior"
+    And no directory at "tmp/rubywarrior"
+    When I run rubywarrior
+    And I choose "beginner" for "tower"
+    And I answer "Joe" to "name"
+    Then I should see "generated"
+    And I should find file at "tmp/rubywarrior"
+    And I should find no file at "tmp/ruby-warrior"

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,19 @@
+Given /^a directory at "([^\"]*)"$/ do |path|
+  Dir.mkdir(path) unless File.exist? path
+end
+
+Given /^no directory at "([^\"]*)"$/ do |path|
+  Dir.rmdir(path) if File.exist? path
+end
+
+When /^I copy fixture "([^\"]*)" to "([^\"]*)"$/ do |from, to|
+  FileUtils.cp_r("spec/fixtures/" + from, to)
+end
+
+Then /^I should find file at "([^\"]*)"$/ do |path|
+  File.exist?(path).should be_true
+end
+
+Then /^I should find no file at "([^\"]*)"$/ do |path|
+  File.exist?(path).should be_false
+end

data/features/step_definitions/interaction_steps.rb

@@ -0,0 +1,65 @@
+Given /^a profile named "([^\"]*)" on "([^\"]*)"$/ do |name, tower|
+  When 'I run rubywarrior'
+  And 'I answer "y" to "create one?"'
+  And 'I choose "' + tower + '" for "tower"'
+  And 'I answer "' + name + '" to "name"'
+  Then 'I should see "generated"'
+end
+
+Given /^no profile at "([^\"]*)"$/ do |path|
+  RubyWarrior::Config.path_prefix = path
+  FileUtils.rm_rf("#{path}/rubywarrior")
+end
+
+Given /^current directory is "([^\"]*)"$/ do |path|
+  RubyWarrior::Config.path_prefix = path
+end
+
+When /^I run rubywarrior$/ do
+  @io = MockIO.new
+  @io.start do |io|
+    RubyWarrior::Config.out_stream = io
+    RubyWarrior::Config.in_stream = io
+    RubyWarrior::Game.new.start
+  end
+end
+
+When /^I run rubywarrior with options "([^\"]*)"$/ do |options|
+  RubyWarrior::Config.reset
+  @io = MockIO.new
+  @io.start do |io|
+    RubyWarrior::Runner.new(options.split, io, io).run
+  end
+end
+
+When /^I answer "([^\"]*)" to "([^\"]*)"$/ do |answer, question|
+  @io.gets_until_include(question)
+  @io.puts(answer)
+end
+
+When /^I choose "([^\"]*)" for "([^\"]*)"$/ do |choice, phrase|
+  answer = nil
+  content = @io.gets_until_include(phrase)
+  content.split("\n").each do |line|
+    if line.include?(choice) && line =~ /\[(\d)\]/
+      answer = $1
+    end
+  end
+  if answer
+    @io.puts(answer)
+  else
+    raise "Unable to find choice #{choice} in #{content}"
+  end
+end
+
+When /^I wait until it says "([^\"]*)"$/ do |phrase|
+  @io.gets_until_include(phrase)
+end
+
+Then /^I should see "([^\"]*)"$/ do |phrase|
+  @io.gets_until_include(phrase).should include(phrase)
+end
+
+Then /^I should not see "([^\"]*)" before "([^\"]*)"$/ do |first_phrase, second_phrase|
+  @io.gets_until_include(second_phrase).should_not include(first_phrase)
+end