gates_of_moria 0.0.3 → 0.0.4

data/gates_of_moria.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('rspec', '~> 2.11.0')
   gem.add_development_dependency('turnip')
   gem.add_development_dependency('pry')
+  gem.add_development_dependency('greenletters')
 
 end

data/lib/gates_of_moria/data/door.rb

@@ -0,0 +1,13 @@
+class Door
+  def self.read
+    "fcrnx sevraq naq ragre"
+  end
+
+  def self.tell text
+    if text == 'sevraq'
+      "The door opens!"
+    else
+      "The door remains firmly shut."
+    end
+  end
+end

data/lib/gates_of_moria/{motd.txt → data/motd.txt}

@@ -33,3 +33,7 @@
                       ;____:   `._        `'           _,'   ;____:
                      {______}     \___________________/     {______}
                  SSt |______|_______________________________|______|
+
+Welcome to the Gates of Moria! After many adventures, you and your companions have come upon a door to the Dwarven kingdom of Moria. But you cannot open the door by brute strength, so you will have to use your wits.
+
+You can leave the game at any time by typing 'exit'

data/lib/gates_of_moria/data/questions.json

@@ -0,0 +1,81 @@
+{
+  "questions": [
+    {
+      "help_texts": [ "Are you ready to begin your adventure? Answer in Ruby.",
+                      "In Ruby, we say things are correct, or 'truthy', when they are true.",
+                      "We often use true to say yes, as well",
+                      "Try telling Ruby that it is 'true' that you want to begin your adventure.",
+                      "Try reading http://www.ruby-lang.org/en/documentation/quickstart/ to get started!"
+                    ],
+      "expected_response": "result == true"
+    },
+    {
+      "title": "\nPart 1: Strings\n===============\n",
+      "help_texts": [ "Now give me the name Gandalf as a String.",
+                      "Strings are typically wrapped in either single quotes or double quotes.",
+                      "Try putting Gandalf's name in quotes."
+                    ],
+      "expected_response": "result == 'Gandalf'"
+    },
+    {
+      "title": "\nPart 2: Variables\n=================\n",
+      "help_texts": [ "Let me know your name by assigning it to a variable called @name",
+                      "Variables hold information. We use the equal sign to assign an object to a variable.",
+                      "Here's how I would tell Ruby my name:\n  @name = \"Matt\"",
+                      "In this case, we want to assign the value of your name, as a String, to the variable @name.",
+                      "I think you might like reading about variables:\n  http://mislav.uniqpath.com/poignant-guide/book/chapter-3.html#section2"
+                    ],
+      "expected_response": "@name.class == String && @name.length > 0"
+    },
+    {
+      "title": "\nPart 3: Methods\n===============\n",
+      "help_texts": [ "Now send the String 'sevraq' to the translate method.",
+                      "We say that we are sending a message to an object when we invoke a method.",
+                      "In this case, the object we are sending the translate message to is the global object. But don't worry too much about that yet!",
+                      "You can send a message to Ruby like this:\n  method(parameters)",
+                      "I think you would like this part of the book Programming Ruby:\n  http://www.ruby-doc.org/docs/ProgrammingRuby/html/tut_methods.html"
+                    ],
+      "expected_response": "result == 'friend'",
+      "setup_code": "def translate(s); s.tr!('A-Za-z', 'N-ZA-Mn-za-m'); end",
+      "_comments": [ "So now we know that the strange word 'sevraq' is really the word 'friend' when we run it through the translator!"]
+    },
+    {
+      "title": "\nPart 4: Objects\n===============\n",
+      "help_texts": [ "The great big door is before you.\n\nSend the message 'read' to the Door object to read what it says.",
+                      "When we send a message to an object, we're invoking a method with that name on the object.",
+                      "The Door class has a method called 'read'.",
+                      "If I wanted to blow the Horn of Gondor, I might write in Ruby:\n  HornOfGondor.blow!",
+                      "If you've got time, you might want to watch this video to get a deep dive into what these object things are:\n\nhttp://confreaks.com/videos/1133-scrc2012-thinking-in-objects\n\n(it is roughly 26 minutes long)"
+      ],
+      "expected_response": "result == 'fcrnx sevraq naq ragre'",
+      "setup_code": "load 'lib/gates_of_moria/data/door.rb'"
+    },
+    {
+      "title": "\nPart 5: Putting it all together\n===============================\n",
+      "help_texts": [ "So now we've got this weird text from the Door, and it appears to be the same strange language that we translated before.\n\nLet's use our translate method again on the String returned by reading the Door.",
+                      "Remember how we sent the String 'sevraq' as a parameter to translate() before?\n\nWe can do the same thing with Door.read, because Door.read will return the strange text as a String and send it as a parameter to translate().",
+                      "If I wanted to translate some text from the first page of a book, I might do this:\n\n  translate(OldBook.first_page)"
+                    ],
+      "expected_response": "result = 'speak friend and enter'"
+    },
+    {
+      "title": "\nPart 6: Solving the Riddle\n==========================\n",
+      "help_texts": [ "Huh, the secret message on the door is the text 'speak friend and enter'\n\nNow that we know that the text on the door is a riddle, and we know how to speak in it's secret language, try sending the Door the message 'tell' with the parameter of the answer to the riddle.",
+                      "Remember that we need to speak in the Door's language.\n\n  You can use the translate() method to turn the word 'friend' back into its strange language.",
+                      "The tell() method on the Door class tries to answer the riddle. Give it another try!",
+                      "The Door expects the tell method to receive the string 'sevraq', which is its secret word for 'friend'!"
+      ],
+      "expected_response": "result == 'The door opens!'",
+      "setup_code": ""
+    }
+  ],
+
+  "question_template":
+    {
+      "title": "\nPart N: Foo\n===============\n",
+      "help_texts": [ ""
+      ],
+      "expected_response": "",
+      "setup_code": ""
+  }
+}

data/lib/gates_of_moria/quiz.rb

@@ -5,15 +5,22 @@ module GatesOfMoria
     def initialize(output_buffer, input_buffer, motd = nil)
       @output_buffer = output_buffer
       @input_buffer = input_buffer
-      @motd = motd || File.read(File.expand_path("../motd.txt", __FILE__))
-      @questions = File.read(File.expand_path("../questions.json", __FILE__))
+      @motd = motd || File.read(File.expand_path("../data/motd.txt", __FILE__))
+      @questions = File.read(File.expand_path("../data/questions.json", __FILE__))
     end
 
     def start
       @output_buffer.puts @motd
+
       @repl = GatesOfMoria::REPL.new(@output_buffer, @input_buffer, @questions)
 
-      @repl.start
+      player_won = @repl.start
+
+      if player_won
+        @output_buffer.puts "Congratulations! You've opened the door to the mines.\n\nGood luck on your future adventures.\n\nMight I suggest trying RubyWarrior next?\n"
+      else
+        @output_buffer.puts "\n\nYour adventures with Ruby are not over yet!\n\nMay I suggest trying the game again, or going to read up on how Ruby works at:\n\n  http://www.ruby-lang.org/en/documentation/quickstart/\n"
+      end
     end
 
   end

data/lib/gates_of_moria/repl.rb

@@ -5,28 +5,37 @@ module GatesOfMoria
       @input_buffer = input_buffer
 
       @questions = JSON.parse(questions)['questions']
+      @last_question = @questions.pop
     end
 
     def start
       ask_the_questions
+      ask_last_question
     end
 
     def answer_question(expected_answer, user_input)
       begin
         result = eval(user_input)
+      rescue SystemExit
+        display_leaving_game
+        exit 0
       rescue SyntaxError, Exception
         politely_say_their_ruby_is_invalid
         return false
       end
-      @output_buffer.puts "\n=> #{result}\n"
+      @output_buffer.puts "\n=> #{result}\n\n"
       eval(expected_answer)
     end
 
     private
+
+    def ask_last_question
+      return prompt_with_help_texts @last_question
+    end
+
     def ask_the_questions
       @questions.each do |question|
         if prompt_with_help_texts question
-          display_you_are_correct
           next
         end
       end
@@ -35,6 +44,7 @@ module GatesOfMoria
 
     def prompt_with_help_texts question
       eval(question['setup_code']) if question.has_key?('setup_code')
+      @output_buffer.puts(question['title']) if question.has_key?('title')
       question['help_texts'].each do |ht|
         prompt_question ht
 
@@ -61,8 +71,8 @@ module GatesOfMoria
       @output_buffer.puts("Sorry, that's not it.")
     end
 
-    def display_you_are_correct
-      @output_buffer.puts("Correct! Next up...")
+    def display_leaving_game
+      @output_buffer.puts("\nYou are leaving the game. Play again soon!\n")
     end
   end
 end

data/lib/gates_of_moria/version.rb

@@ -1,3 +1,3 @@
 module GatesOfMoria
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/acceptance/answering_last_question_wrong.feature

@@ -0,0 +1,8 @@
+Feature: Answering Last Question Wrong
+
+  Scenario: User answers last question wrong
+    Given I am not playing
+    When I start a new quiz
+    And I answer all questions up to the last one
+    And I answer the last question incorrectly
+    Then I should see encouraging text to keep trying

data/spec/acceptance/{player_starts_the_quiz.feature → answering_questions.feature}

@@ -1,20 +1,10 @@
-Feature: Player Starts the Quiz
-  As a player
-  I want to start the quiz
-  So that I can proceed to Ruby Warrior
-
-  Scenario: start quiz
-    Given I am not playing
-    When I start a new quiz
-    Then I should see the Gates of Moria
-    And I should be prompted for the answer to the first question
+Feature: Answering questions
 
   Scenario: user answers first question correctly
     Given I am not playing
     When I start a new quiz
     When I answer the first question correctly
     Then I should not see the first help text
-    And I should see that I was correct
     And I should be prompted for the answer to the second question
 
   Scenario: user answers first question incorrectly

data/spec/acceptance/starting_and_quitting.feature

@@ -0,0 +1,13 @@
+Feature: Starting and Quitting
+  As a player
+  I want to start the quiz
+  So that I can proceed to Ruby Warrior
+
+  Scenario: starting and quitting the game
+    Given I am not playing
+    When I start a new quiz
+    Then I should see the Gates of Moria
+    And I should be prompted for the answer to the first question
+
+    When I quit
+    Then the game should end

data/spec/acceptance/steps/player_steps.rb

@@ -1,46 +1,109 @@
-step 'I am not playing' do 
+step 'I am not playing' do
 end
 
-step 'I start a new quiz' do 
-  # simulate a game playing input/output session:
-  @output = StringIO.new
-  @input = StringIO.new
-  @motd = 'gates'
+step 'I start a new quiz' do
+  @game = Greenletters::Process.new('bin/gates_of_moria')
+  @game.start!
+end
+
+step 'I quit' do
+  @game << prepare_input("exit")
+end
 
-  @quiz = GatesOfMoria::Quiz.new(@output, @input, @motd)
-  @quiz.start
+step 'the game should end' do
+  @game.kill!
 end
 
 step 'I should see the Gates of Moria' do
-  @output.string.should include(@motd)
+  expected_pattern = massage_pattern("DOORS OF DURIN")
+  @game.wait_for(:output, expected_pattern)
 end
 
 step 'I should be prompted for the answer to the first question' do
-  @output.string.should include("Let me know your name by assigning it to a variable called '@name'!")
+  expected_pattern = massage_pattern "Are you ready to begin your adventure"
+  @game.wait_for(:output, expected_pattern)
 end
 
 step 'I should be prompted for the answer to the second question' do
-  @output.string.should include("Now send the string 'sevraq' to the translate method.")
+  expected_pattern = massage_pattern "Now give me the name Gandalf as a String"
+  @game.wait_for(:output, expected_pattern)
 end
 
 step 'I answer the first question correctly' do
   step 'I should be prompted for the answer to the first question'
-  @input.gets "name = 'Matt'"
+  @game << prepare_input("true")
 end
 
 step 'I answer the first question incorrectly' do
   step 'I should be prompted for the answer to the first question'
-  @input.gets "moo = 'baz'"
+  @game << prepare_input("moo")
 end
 
 step "I should see the first help text" do
-  @output.string.should include("Variables hold information. We use the equal sign to assign information into a variable:\n@name = \"Matt\"")
+  expected_pattern = massage_pattern('In Ruby, we say things are')
+  @game.wait_for(:output, expected_pattern)
 end
 
 step "I should not see the first help text" do
-  @output.string.should_not include("Variables hold information. We use the equal sign to assign information into a variable:\n@name = \"Matt\"")
+  pattern = massage_pattern('In Ruby, we say things are')
+  @game.check_until(pattern).should be_nil
+end
+
+step "I answer all the questions correctly" do
+  step "I answer all questions up to the last one"
+
+  # Part 6:
+  @game << prepare_input("Door.tell('sevraq')")
+  @game.wait_for(:output, massage_pattern('The door opens'))
+end
+
+step "I should see that I've won the game" do
+  @game.wait_for(:output, massage_pattern('Congratulations'))
+end
+
+step "I answer all questions up to the last one" do
+  step "I answer the first question correctly"
+  # Part 1:
+  @game << prepare_input('"Gandalf"')
+  @game.wait_for(:output, massage_pattern('Part 2'))
+
+  # Part 2:
+  @game << prepare_input("@name = 'Matt'")
+  @game.wait_for(:output, massage_pattern('Part 3'))
+
+  # Part 3:
+  @game << prepare_input("translate('sevraq')")
+  @game.wait_for(:output, massage_pattern('Part 4'))
+
+  # Part 4:
+  @game << prepare_input("Door.read")
+  @game.wait_for(:output, massage_pattern('Part 5'))
+
+  # Part 5:
+  @game << prepare_input("translate(Door.read)")
+  @game.wait_for(:output, massage_pattern('speak friend and enter'))
+  @game.wait_for(:output, massage_pattern('Part 6'))
+end
+
+step "I answer the last question incorrectly" do
+  # Part 6:
+  @game.wait_for(:output, massage_pattern('try sending the Door the message'))
+  @game << prepare_input("Door.tell('moo')")
+  @game.wait_for(:output, massage_pattern("=> The door remains firmly shut."))
+
+  #answer second help text wrong:
+  @game << prepare_input("Door.tell('moo')")
+  @game.wait_for(:output, massage_pattern("=> The door remains firmly shut."))
+
+  #answer third help text wrong:
+  @game << prepare_input("Door.tell('moo')")
+  @game.wait_for(:output, massage_pattern("=> The door remains firmly shut."))
+
+  #answer fourth help text wrong:
+  @game << prepare_input("Door.tell('moo')")
+  @game.wait_for(:output, massage_pattern("=> The door remains firmly shut."))
 end
 
-step "I should see that I was correct" do
-  @output.string.should include("Correct!")
+step "I should see encouraging text to keep trying" do
+  @game.wait_for(:output, massage_pattern('Your adventures with Ruby are not over yet'))
 end

data/spec/acceptance/winning_the_game.feature

@@ -0,0 +1,10 @@
+Feature: Winning the game
+  In order to continue on to Ruby Warrior
+  As a player
+  I want to be told that I've won the game
+
+  Scenario: winning the game
+    Given I am not playing
+    When I start a new quiz
+    And I answer all the questions correctly
+    Then I should see that I've won the game

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'rubygems'
 require 'gates_of_moria'
+require 'greenletters'
+require 'shellwords'
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 Dir.glob("spec/acceptance/steps/**/*steps.rb") { |f| load f, true }

data/spec/support/ending_processes.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+  config.after(:each) do
+    if @game && @game.alive?
+      @game.kill!
+    end
+  end
+end

data/spec/support/greenletters.rb

@@ -0,0 +1,7 @@
+def prepare_input(text)
+  text.chomp + "\n"
+end
+
+def massage_pattern(text)
+  Regexp.new(Regexp.escape(text.strip.tr_s(" \r\n\t", " ")).gsub('\ ', '\s+'))
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gates_of_moria
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-25 00:00:00.000000000 Z
+date: 2013-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -60,6 +60,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: greenletters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple quiz to test Ruby knowledge
 email:
 - matt@bendyworks.com
@@ -78,17 +94,23 @@ files:
 - bin/gates_of_moria
 - gates_of_moria.gemspec
 - lib/gates_of_moria.rb
-- lib/gates_of_moria/motd.txt
-- lib/gates_of_moria/questions.json
+- lib/gates_of_moria/data/door.rb
+- lib/gates_of_moria/data/motd.txt
+- lib/gates_of_moria/data/questions.json
 - lib/gates_of_moria/quiz.rb
 - lib/gates_of_moria/repl.rb
 - lib/gates_of_moria/version.rb
-- spec/acceptance/player_starts_the_quiz.feature
+- spec/acceptance/answering_last_question_wrong.feature
+- spec/acceptance/answering_questions.feature
+- spec/acceptance/starting_and_quitting.feature
 - spec/acceptance/steps/player_steps.rb
+- spec/acceptance/winning_the_game.feature
 - spec/fixtures/one_question.json
 - spec/gates_of_moria/quiz_spec.rb
 - spec/gates_of_moria/repl_spec.rb
 - spec/spec_helper.rb
+- spec/support/ending_processes.rb
+- spec/support/greenletters.rb
 homepage: https://github.com/mathias/gates_of_moria
 licenses: []
 post_install_message: 
@@ -114,9 +136,14 @@ signing_key:
 specification_version: 3
 summary: A simple quiz to test Ruby knowledge
 test_files:
-- spec/acceptance/player_starts_the_quiz.feature
+- spec/acceptance/answering_last_question_wrong.feature
+- spec/acceptance/answering_questions.feature
+- spec/acceptance/starting_and_quitting.feature
 - spec/acceptance/steps/player_steps.rb
+- spec/acceptance/winning_the_game.feature
 - spec/fixtures/one_question.json
 - spec/gates_of_moria/quiz_spec.rb
 - spec/gates_of_moria/repl_spec.rb
 - spec/spec_helper.rb
+- spec/support/ending_processes.rb
+- spec/support/greenletters.rb

data/lib/gates_of_moria/questions.json

@@ -1,13 +0,0 @@
-{
-  "questions": [
-    {
-      "initial_prompt": "Let me know your name by assigning it to a variable called '@name'!",
-      "expected_response": "@name.class == String && @name.length > 0",
-      "help_texts": [ "Let me know your name by assigning it to a variable called '@name'!", "Variables hold information. We use the equal sign to assign information into a variable:\n@name = \"Matt\"", "bar", "baz" ]
-    }, {
-      "expected_response": "result == 'friend'",
-      "help_texts": ["Now send the string 'sevraq' to the translate method."],
-      "setup_code": "def translate(s); s.tr!('A-Za-z', 'N-ZA-Mn-za-m'); end"
-    }
-  ]
-}