tuvi 0.0.3 → 0.0.4

data/.gitignore

@@ -1 +1,2 @@
-/pkg
+/pkg
+Gemfile.lock

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tuvi (0.0.3)
+    tuvi (0.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # Tuvi
 
-Tuvi is a computer language for kids to create text-based games and applications. It is a Ruby DSL which supplies a declarative format which dictates the flow of the program as a series of steps.
+Tuvi is a computer language for kids to create text-based games and applications. It is a Ruby DSL which provides a simple way to declare the flow of the program as a series of steps. Although the below example demonstrates the use of Tuvi in creating a Choose-Your-Own-Adventure type game, it can be used for any text game or application. Tuvi was written in order to introduce programming to my son, Tuvi!
 
 ## Installation
 
@@ -10,7 +10,57 @@ Install Tuvi simply with:
 
 ## Usage
 
-Coming Soon!
+Here is a basic example program followed by an explanation:
+
+    require 'tuvi'
+
+    step 1 do
+      message "Welcome to KrazyMaze. Will you ever get out? BWAAHAAA! You have a choice to make: Go right or left"
+      answer "right", 2
+      answer "left", 3
+    end
+
+    step 2 do
+      message "You're in the middle of the maze. Go right or left or straight."
+      answer "right", 3
+      answer "left", 4
+      answer "straight", 3
+    end
+
+    step 3 do
+      message "You've encountered a monster! You can either go straight, or punch the monster."
+      answer "straight", 2
+      answer "punch", 5
+    end
+
+    step 4 do
+      message "Drat. You've reached the end of the maze! I'll get you next time..."
+      stop
+    end
+
+    step 5 do
+      message "The monster was stronger than you! You died."
+      stop
+    end
+
+    run
+
+
+First, create a ruby file and on the first line require the Tuvi library with `require 'tuvi'`
+
+Then, create a class with any name you desire. The first thing to do inside this class is: `extend Tuvi`.
+
+From here on in, the Tuvi language is used. As you can see, the program is divided into steps, which represent a step in the program where the program provides some instructions, and either prompts the user for input or simply exits.
+
+Every step needs a `message`, which sets the computer's instructions for that step.
+
+Every step can establish one or more lines declaring an `answer` which is followed first by a valid user response, a comma, and then by the step number that that particular user response should lead to.
+
+Some steps, instead of having answers, can simply end the program using the `stop` keyword.
+
+Finally, after all the steps have been declared (but still within the class), the `run` keyword actually runs the steps.
+
+You can run this file like any other Ruby file, using `ruby filename.rb`.
 
 ## Contributing
 

data/example_program.rb

@@ -1,26 +1,20 @@
 require_relative 'lib/tuvi.rb'
 
-class ExampleProgram
+step 1 do
+  message "This is Step 1. Type yes to go to Step 2. Type no to go to Step 3."
+  answer "Yes", 2
+  answer "No", 3
+end
 
-  extend Tuvi
+step 2 do
+  message "This is Step 2. Type hi to go to Step 3. Type bye to go to step 1."
+  answer "Hi", 3
+  answer "Bye", 1
+end
 
-  step 1 do
-    message "This is Step 1. Type yes to go to Step 2. Type no to go to Step 3."
-    answer "Yes", 2
-    answer "No", 3
-  end
+step 3 do
+  message "You've reached the end!"
+  stop
+end
 
-  step 2 do
-    message "This is Step 2. Type hi to go to Step 3. Type bye to go to step 1."
-    answer "Hi", 3
-    answer "Bye", 1
-  end
-
-  step 3 do
-    message "You've reached the end!"
-    stop
-  end
-
-  run
-
-end
+run

data/lib/tuvi/version.rb

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

data/lib/tuvi.rb

@@ -11,16 +11,28 @@ module Tuvi
   def run
     current_step = 1
     while true do
-      puts @steps[current_step].get_message
-      exit if @steps[current_step].exit_program
-      puts @steps[current_step].formatted_answers
-      input = gets.downcase.chomp
-      if @steps[current_step].answer_paths[input]
-        current_step = @steps[current_step].answer_paths[input]
-      else
-        puts "Sorry, I don't understand that answer. Please try again:"
-      end
+      current_step = execute_step(current_step)
     end
   end
 
+  def execute_step(current_step)
+    puts @steps[current_step].get_message
+    exit if @steps[current_step].exit_program
+    puts @steps[current_step].formatted_answers
+    input = gets.downcase.chomp
+    determine_next_step(current_step, input)
+  end
+
+  def determine_next_step(current_step, input)
+    if @steps[current_step].answer_paths[input]
+      next_step = @steps[current_step].answer_paths[input]
+    else
+      puts "Sorry, I don't understand that answer. Please try again:"
+      next_step = current_step
+    end
+    next_step
+  end
+
 end
+
+extend Tuvi

data/spec/tuvi_spec.rb

@@ -40,7 +40,17 @@ describe Tuvi do
       end
     end
 
-    describe "run" do
+    describe "determine_next_step" do
+
+      it "should determine the next step based on answer paths" do
+        @program.step(1){answer "yes", 2}
+        @program.determine_next_step(1, "yes").should == 2
+      end
+
+      it "should set the next step to be the current step if input is invalid" do
+        @program.step(1){answer "yes", 2}
+        @program.determine_next_step(1, "blah").should == 1
+      end
 
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tuvi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4344284518542191746
+      hash: -202346767343120134
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4344284518542191746
+      hash: -202346767343120134
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25