tuvi 0.0.8 → 0.0.12

data/README.md

@@ -15,31 +15,31 @@ 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
+      say "Welcome to KrazyMaze. Will you ever get out? BWAAHAAA! You have a choice to make: Go right or left"
+      response "right" => 2
+      response "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
+      say "You're in the middle of the maze. Go right or left or straight."
+      response "right" => 3
+      response "left" => 4
+      response "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
+      say "You've encountered a monster! You can either go straight, or punch the monster."
+      response "straight" => 2
+      response "punch" => 5
     end
 
     step 4 do
-      message "Drat. You've reached the end of the maze! I'll get you next time..."
+      say "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."
+      say "The monster was stronger than you! You died."
       stop
     end
 
@@ -48,15 +48,13 @@ Here is a basic example program followed by an explanation:
 
 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 needs a `say`, 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.
+Every step can establish one or more lines declaring an `response` which is followed first by a valid user response, a hashrocket arrow, 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.
+Some steps, instead of having responses, 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.
 
@@ -66,9 +64,9 @@ You can also add any custom Ruby code by placing it block passed to the `code` m
 
     step 1 do
       code {$steps = 1}
-      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
+      say "Welcome to KrazyMaze. Will you ever get out? BWAAHAAA! You have a choice to make: Go right or left"
+      response "right" => 2
+      response "left" => 3
     end
 
     step 2 do
@@ -76,10 +74,10 @@ You can also add any custom Ruby code by placing it block passed to the `code` m
         $steps += 1
         puts "You have taken #{$steps} steps."
       end
-      message "You're in the middle of the maze. Go right or left or straight."
-      answer "right", 3
-      answer "left", 4
-      answer "straight", 3
+      say "You're in the middle of the maze. Go right or left or straight."
+      response "right" => 3
+      response "left" => 4
+      response "straight" => 3
     end
 
 

data/bin/tuvi

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+puts <<-EOS
+#{'*'*50}
+  Tuvi!
+#{'*'*50}
+  EOS
+exit(1)

data/example_program.rb

@@ -2,20 +2,20 @@ require_relative 'lib/tuvi.rb'
 
 step 1 do
   code {$x = "hello"}
-  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
+  say "This is Step 1. Type yes to go to Step 2. Type no to go to Step 3."
+  response "Yes" => 2
+  response "No" => 3
 end
 
 step 2 do
   code {puts $x}
-  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
+  say "This is Step 2. Type hi to go to Step 3. Type bye to go to step 1."
+  response "Hi" => 3
+  response "Bye" => 1
 end
 
 step 3 do
-  message "You've reached the end!"
+  say "You've reached the end!"
   stop
 end
 

data/lib/tuvi/application_runner.rb

@@ -0,0 +1,41 @@
+class ApplicationRunner
+
+  def initialize(steps)
+    @steps = steps
+  end
+
+  def run
+    current_step_id = 1
+    while true do
+      current_step_id = execute_step(current_step_id)
+    end
+  end
+
+  def execute_step(step_id)
+    current_step = @steps[step_id]
+    current_step.code_blocks.each do |block|
+      block.call
+    end
+    puts
+    puts current_step.get_say
+    exit if current_step.exit_program
+    puts current_step.formatted_responses
+    input = gets.downcase.chomp
+    exit_program if input == "exit"
+    determine_next_step(current_step, input)
+  end
+
+  def determine_next_step(current_step, input)
+    if current_step.response_paths[input]
+      return current_step.response_paths[input]
+    end
+
+    puts "Sorry, I don't understand that response. Please try again:"
+    current_step.id
+  end
+
+  def exit_program
+    puts "Bye!"
+    exit
+  end
+end

data/lib/tuvi/step.rb

@@ -1,32 +1,34 @@
 class Step
 
-  attr_accessor :position, :answer_paths, :exit_program, :code_blocks
+  attr_accessor :id, :response_paths, :exit_program, :code_blocks
 
-  def initialize(position, &block)
-    @position = position
-    @answer_paths = {}
+  def initialize(id, &block)
+    @id = id
+    @response_paths = {}
     @code_blocks = []
     instance_eval(&block) if block_given?
   end
 
-  def message(text)
-    @message = text
+  def say(text)
+    @say = text
   end
 
-  def get_message
-    @message
+  def get_say
+    @say
   end
 
-  def answer(input, step_number)
-    @answer_paths[input.downcase] = step_number
+  def response(response_path)
+    response = response_path.first[0].downcase
+    next_step = response_path.first[1]
+    @response_paths[response] = next_step
   end
 
   def stop
     @exit_program = true
   end
 
-  def formatted_answers
-    "You can type one of the following: [#{@answer_paths.keys.join(", ")}] Enter 'exit' to quit."
+  def formatted_responses
+    "You can type one of the following: [#{@response_paths.keys.join(", ")}]. Enter 'exit' to quit."
   end
 
   def code(&block)

data/lib/tuvi/version.rb

@@ -1,3 +1,3 @@
 module Tuvi
-  VERSION = "0.0.8"
+  VERSION = "0.0.12"
 end

data/lib/tuvi.rb

@@ -1,46 +1,16 @@
 require_relative "tuvi/version"
 require_relative "tuvi/step"
-require 'ostruct'
+require_relative "tuvi/application_runner"
 
 module Tuvi
 
-  def step(position, &block)
+  def step(id, &block)
     @steps ||= {}
-    @steps[position] = Step.new(position, &block)
+    @steps[id] = Step.new(id, &block)
   end
 
   def run
-    current_step_position = 1
-    while true do
-      current_step_position = execute_step(current_step_position)
-    end
-  end
-
-  def execute_step(step_position)
-    current_step = @steps[step_position]
-    current_step.code_blocks.each do |block|
-      block.call
-    end
-    puts current_step.get_message
-    exit if current_step.exit_program
-    puts current_step.formatted_answers
-    input = gets.downcase.chomp
-    exit_program if input == "exit"
-    determine_next_step(current_step, input)
-  end
-
-  def determine_next_step(current_step, input)
-    if current_step.answer_paths[input]
-      return current_step.answer_paths[input]
-    end
-
-    puts "Sorry, I don't understand that answer. Please try again:"
-    current_step.position
-  end
-
-  def exit_program
-    puts "Bye!"
-    exit
+    ApplicationRunner.new(@steps).run
   end
 
 end

data/spec/tuvi/application_runner_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe ApplicationRunner do
+
+  before(:each) do
+    @step = Step.new(1) do
+      @response_paths = {"yes" => 2}
+    end
+    @application_runner = ApplicationRunner.new([@step])
+  end
+
+  describe "Running the Tuvi program" do
+
+    describe "determine_next_step" do
+
+      it "should determine the next step based on response paths" do
+        @application_runner.determine_next_step(@step, "yes").should == 2
+      end
+
+      it "should set the next step to be the current step if input is invalid" do
+        @application_runner.determine_next_step(@step, "blah").should == 1
+      end
+
+    end
+
+  end
+end

data/spec/tuvi/step_spec.rb

@@ -4,12 +4,6 @@ describe Step do
 
   describe "class methods" do
 
-    # it "should initialize new Step" do
-    #   Step.new.should respond_to :message
-    # end
-
   end
 
-
-
 end

data/spec/tuvi_spec.rb

@@ -10,7 +10,7 @@ describe Tuvi do
     @program = Program.new
   end
 
-  describe "The Tuvi language helper methods" do
+  describe "Step syntax" do
 
     describe "step" do
 
@@ -19,50 +19,47 @@ describe Tuvi do
         @program.instance_eval{@steps[1]}.class.should == Step
       end
 
-      it "should assign number parameter to step's position" do
+      it "should assign number parameter to step's id" do
         @program.step(1)
-        @program.instance_eval{@steps[1]}.position.should == 1
+        @program.instance_eval{@steps[1]}.id.should == 1
       end
 
-      it "should assign a message based on message passed in block" do
-        @program.step(1){message "Hello!"}
-        @program.instance_eval{@steps[1]}.get_message.should == "Hello!"
-      end
+    end
 
-      it "should assign answer paths based on answers passed in block" do
-        @program.step(1){answer "yes", 2}
-        @program.instance_eval{@steps[1]}.answer_paths["yes"].should == 2
-      end
+    describe "say" do
 
-      it "should mark a step as exit_program if 'stop' is passed in block" do
-        @program.step(1){stop}
-        @program.instance_eval{@steps[1]}.exit_program.should be_true
+      it "should assign a say based on say passed in block" do
+        @program.step(1){say "Hello!"}
+        @program.instance_eval{@steps[1]}.get_say.should == "Hello!"
       end
+
     end
 
-    describe "determine_next_step" do
+    describe "response" do
 
-      it "should determine the next step based on answer paths" do
-        @program.step(1){answer "yes", 2}
-        current_step = @program.instance_eval{@steps[1]}
-        @program.determine_next_step(current_step, "yes").should == 2
+      it "should create an response path with the key and the key should be downcased" do
+        @program.step(1){response "Yes" => 2}
+        @program.instance_eval{@steps[1]}.response_paths["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}
-        current_step = @program.instance_eval{@steps[1]}
-        @program.determine_next_step(current_step, "blah").should == 1
+    end
+
+    describe "stop" do
+
+      it "should mark a step as exit_program if 'stop' is passed in block" do
+        @program.step(1){stop}
+        @program.instance_eval{@steps[1]}.exit_program.should be_true
       end
 
     end
 
-  end
+    describe "code" do
 
-  describe "#code" do
+      it "should add blocks to the step's code_blocks" do
+        @program.step(1){code {puts "Hello"} }
+        @program.instance_eval{@steps[1]}.code_blocks[0].should be_a Proc
+      end
 
-    it "should add blocks to the step's code_blocks" do
-      @program.step(1){code {puts "Hello"} }
-      @program.instance_eval{@steps[1]}.code_blocks[0].should be_a Proc
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tuvi
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.12
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-22 00:00:00.000000000 Z
+date: 2014-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,7 +62,8 @@ dependencies:
 description: Tuvi is a computer language for kids to create text-based games and applications.
 email:
 - jaywngrw@gmail.com
-executables: []
+executables:
+- tuvi
 extensions: []
 extra_rdoc_files: []
 files:
@@ -72,12 +73,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/tuvi
 - example_program.rb
 - lib/.DS_Store
 - lib/tuvi.rb
+- lib/tuvi/application_runner.rb
 - lib/tuvi/step.rb
 - lib/tuvi/version.rb
 - spec/spec_helper.rb
+- spec/tuvi/application_runner_spec.rb
 - spec/tuvi/step_spec.rb
 - spec/tuvi_spec.rb
 - tuvi.gemspec
@@ -96,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4086389073629585186
+      hash: -2205103365390497425
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -105,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4086389073629585186
+      hash: -2205103365390497425
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -115,5 +119,6 @@ summary: Tuvi is a Ruby DSL which supplies a declarative format which dictates t
   flow of the program as a series of steps.
 test_files:
 - spec/spec_helper.rb
+- spec/tuvi/application_runner_spec.rb
 - spec/tuvi/step_spec.rb
 - spec/tuvi_spec.rb