guided_path 0.3.0

data/lib/guided_path/program.rb

@@ -0,0 +1,84 @@
+module GuidedPath
+  class Program
+
+    attr_reader :parser, :nodes
+    attr_accessor :starting_node
+    
+    def initialize(options = {})
+      @parser = options[:parser] || GuidedPath::Parser::Spec1
+      
+      @scripts = options[:scripts] || raise(ArgumentError, "Must specify scripts.")
+      raise(ArgumentError, "Scripts must be an hash") unless @scripts.kind_of?(Hash)
+      raise(ArgumentError, "Must pass along at least one script") if @scripts.empty?
+
+      @starting_script = options[:starting_script] || raise(ArgumentError, "Must specify starting script.")
+      raise(ArgumentError, "Starting script not present in script hash") unless @scripts.has_key?(@starting_script)
+
+      parse_scripts
+      postprocess_scripts
+    end
+
+
+    def add_node(options)
+      script_name = options[:script_name] || raise(ArgumentError, "Script name missing")
+      node = options[:node] || raise(ArgumentError, "Script node")
+      full_label = nil
+
+      if node.next_node.kind_of?(String)
+        node.next_node = "#{script_name}#~##{node.next_node}".strip unless node.next_node.include?("#~#")
+      end
+      if node.label
+        full_label = "#{script_name}#~##{node.label}"
+        raise "Manually specified label #{full_label} already exists!" if nodes.has_key?(full_label)
+      else
+        begin
+          full_label = "#{script_name}#~##{node.class.to_s.gsub("GuidedPath::","")}~#{rand(1000000)}"
+        end while nodes.has_key?(full_label)
+      end
+
+      node.label = full_label
+      @nodes[full_label] = node
+
+      if @starting_node.nil? && @starting_script == script_name
+        @starting_node = node
+      end
+
+      return node
+    end
+
+    def to_hash
+      node_hash = {}
+      @nodes.each_pair { |label, node| node_hash[label] = node.to_hash }
+
+      output = {:starting_node => nil }
+      output[:starting_node] = @starting_node.label if @starting_node
+      output[:nodes] = node_hash
+
+      return output
+    end
+
+    private
+
+    def postprocess_scripts
+      # check for label based gotos and change to full nodes.
+      @nodes.each do |label, node|
+        if node.next_node.kind_of?(String)
+          next_node = @nodes[node.next_node]
+          
+          
+          node.next_node = next_node
+        end
+      end
+    end
+
+    def parse_scripts
+      @nodes = {}
+      @starting_node = nil
+
+      # parse the starting script first
+      @scripts.each do |script_name, script|
+        @parser.new(program: self, script_name: script_name, script: script)
+      end
+    end
+  end
+end

data/lib/guided_path/question_multiple_choice_node.rb

@@ -0,0 +1,28 @@
+require "active_model"
+require "active_support/core_ext/hash"
+
+module GuidedPath
+  class QuestionMultipleChoiceNode < Node
+    
+    attr_reader :text, :answers
+
+    def initialize(args = {})
+      super
+      args = args.symbolize_keys
+      
+      @answers = args[:answers] 
+      raise(ArgumentError, "Must specify answers in an Hash") unless args[:answers] && args[:answers].kind_of?(Hash)
+      @text = args[:text]
+    end
+
+
+    def to_hash
+      output = super
+      output[:type] = 'question_multiple_choice'
+      output[:answers] = Hash[@answers.collect { |answer,node| [answer, node.label] }]
+      output[:text] = @text
+      return output
+    end
+    
+  end
+end

data/lib/guided_path/question_textbox_node.rb

@@ -0,0 +1,31 @@
+require "active_model"
+require "active_support/core_ext/hash"
+
+module GuidedPath
+  class QuestionTextBoxNode < Node
+    
+    attr_reader :text, :answers, :otherwise, :blank
+
+    def initialize(args = {})
+      super
+      args = args.symbolize_keys
+      
+      @answers = args[:answers] 
+      raise(ArgumentError, "Must specify answers in an Hash") unless args[:answers] && args[:answers].kind_of?(Hash)
+      @text = args[:text]
+
+    end
+
+
+    def to_hash
+      output = super
+      output[:type] = 'question_text_box'
+      output[:answers] = Hash[@answers.collect { |answer,node| [answer, node.label] }]
+      output[:text] = @text
+      return output
+    end
+    
+
+
+  end
+end

data/lib/guided_path/script.rb

@@ -0,0 +1,14 @@
+require 'active_model'
+
+module GuidedPath
+  class Script
+    
+    attr_accessor :start_nodes
+
+    def initialize(raw_data)
+      @raw_yaml = YAML.parse(raw_data)
+      @parse_errors = []
+    end
+
+  end
+end

data/lib/guided_path/text_node.rb

@@ -0,0 +1,26 @@
+require "active_model"
+require "active_support/core_ext/hash"
+
+module GuidedPath
+  class TextNode < Node
+    
+    attr_reader :value
+
+    def initialize(args = {})
+      super
+      args = args.symbolize_keys
+
+      raise(ArgumentError, "Must specify a value for the node") unless args[:value]
+      @value = args[:value].to_s
+    end
+
+
+    def to_hash
+      output = super
+      output[:type] = 'text'
+      output[:value] = @value
+      output
+    end
+    
+  end
+end

data/lib/guided_path.rb

@@ -0,0 +1,10 @@
+require 'active_support/core_ext/hash'
+require 'guided_path/parser/spec1'
+require 'guided_path/program'
+require 'guided_path/node'
+require 'guided_path/text_node'
+require 'guided_path/goto_node'
+require 'guided_path/lead_in_node'
+require 'guided_path/multimedia_node'
+require 'guided_path/question_textbox_node'
+require 'guided_path/question_multiple_choice_node'

data/test/fixtures/spec1/goto_jump_script_a.yml

@@ -0,0 +1,7 @@
+- text: 
+    value: Hey there!
+    label: start
+    next_node: scriptb#~#target
+- text: 
+    value: Doesn't display.
+    label: target

data/test/fixtures/spec1/goto_jump_script_b.yml

@@ -0,0 +1,6 @@
+- text: Also doesn't display.
+- text:
+    value: On target!
+    label: target
+- next_node: scripta#~#start
+

data/test/fixtures/spec1/goto_node_jumps.yml

@@ -0,0 +1,10 @@
+- text:
+    value: Let's start here.
+    label: the start
+    next_node: the end
+- This never gets displayed.
+- text:
+    value: Let's loop some!
+    label: the end
+    next_node: the start
+

data/test/fixtures/spec1/goto_simple_jumps.yml

@@ -0,0 +1,10 @@
+
+- text:
+    value: Let's start here.
+    label: the start
+- next_node: the end
+- This never gets displayed.
+- text:
+    value: Let's loop some!
+    label: the end
+- next_node: the start

data/test/fixtures/spec1/image_captions.yml

@@ -0,0 +1,10 @@
+- image:
+    caption: Some text
+    
+    url: http://businessnetworking.com/wp-content/uploads/2012/04/happy-face.jpg
+- image:
+    caption: 
+      position: top
+      text: Some text on top
+      
+    url: http://businessnetworking.com/wp-content/uploads/2012/04/happy-face.jpg

data/test/fixtures/spec1/image_simple.yml

@@ -0,0 +1,3 @@
+- image:
+    url: http://businessnetworking.com/wp-content/uploads/2012/04/happy-face.jpg
+

data/test/fixtures/spec1/leadin_multiple.yml

@@ -0,0 +1,8 @@
+- lead_in:
+    text: Close your eyes, think of the happiest thing that happened today.
+    pause: 5
+- q:
+    text: How are you feeling?
+    answers:
+      Unhappy: Boo.
+      Happy: Yay.

data/test/fixtures/spec1/multiple_simple.yml

@@ -0,0 +1,5 @@
+- question:
+    text: How are you feeling?
+    answers:
+      Unhappy: Boo.
+      Happy: Yay.

data/test/fixtures/spec1/multiple_with_loops.yml

@@ -0,0 +1,19 @@
+- q:
+    label: question
+    text: Choose the banana!
+    answers:
+      Banana: Yay!
+      Mango:
+        text:
+          value: Not acceptable.
+          next_node: question
+- q:
+    label: question_mango
+    text: Choose the mango!
+    answers:
+      Banana: 
+        text:
+          value: Not acceptable.
+          next_node: question_mango
+      Mango: Yay!
+- Question done!

data/test/fixtures/spec1/multiple_with_sub_questions.yml

@@ -0,0 +1,10 @@
+- q:
+    text: How are you feeling?
+    answers:
+      Happy: Yay!
+      Elastic:
+        q: 
+          text: Are you limbs turning into taffy?
+          answers:
+            yes: Please avoid cotton candy machines.
+            no: Whew. Close call.

data/test/fixtures/spec1/sequences_three_textnodes.yml

@@ -0,0 +1,7 @@
+# this file tests that we can go between three simple text nodes.
+# also testing that normal text node parsing works in sequences
+#
+- The beginning
+- text: The middle
+- text:
+    value: The end

data/test/fixtures/spec1/textbox_simple.yml

@@ -0,0 +1,10 @@
+- q:
+    type: textbox
+    text: Say yes?
+    answers:
+      Yes: :)
+      No: I said yes.
+      Yes?: Smart aleck
+      ~not listed~: Sorry, didn't understand.
+      ~blank~: Please enter something.
+

data/test/fixtures/spec1/textnode_simple_attribute_list.yml

@@ -0,0 +1,3 @@
+text: 
+  value: Welcome back!
+  section_title: Quiz 2 of 4.

data/test/fixtures/spec1/textnode_simple_hash.yml

@@ -0,0 +1 @@
+text: Welcome back!

data/test/fixtures/spec1/textnode_simple_string.yml

@@ -0,0 +1,2 @@
+Welcome back!
+

data/test/fixtures/spec1/yes_no_simple.yml

@@ -0,0 +1,11 @@
+- q:
+    type: yes/no
+    text: Say yes?
+    yes: happy
+    no: sad
+- yes/no q:
+    text: Say yes?
+    yes: happy happy 
+    no: sad sad
+
+

data/test/fixtures/spec1/youtube_captions.yml

@@ -0,0 +1,10 @@
+- youtube:
+    url: http://www.youtube.com/watch?v=aHrn3-Cb3iM
+    caption: Inspiring skateboarding!
+- youtube:
+    url: http://www.youtube.com/watch?v=aHrn3-Cb3iM
+    caption: 
+      text: Inspiring skateboarding!
+      position: top
+  
+

data/test/fixtures/spec1/youtube_simple.yml

@@ -0,0 +1,6 @@
+- youtube:
+    url: http://www.youtube.com/watch?v=aHrn3-Cb3iM
+ 
+- video:
+    service: youtube
+    url: http://www.youtube.com/watch?v=aHrn3-Cb3iM

data/test/fixtures/test/a_fixture.yml

@@ -0,0 +1 @@
+test: nodes

data/test/guided_path/parser/spec1/test_goto.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+class TestSpec1Goto < MiniTest::Unit::TestCase
+  def load_program_with_scripts(scripts, starting_script)
+    Program.new(version: GuidedPath::Parser::Spec1, scripts: Hash[scripts.collect { |name, filename| [name, load_fixture("spec1/#{filename}")]}] , starting_script: starting_script) 
+  end
+
+  def load_program_fixture(spec_name)
+    load_program_with_scripts({'test' => spec_name}, 'test')
+
+  end
+
+  def test_simple_goto_nodes
+    @program = load_program_fixture("goto_simple_jumps.yml")
+    assert_nodes_equal @program, {TextNode => 3, GotoNode => 2}
+
+    assert_equal "Let's start here.", @program.starting_node.value
+    assert_kind_of GotoNode, @program.starting_node.next_node
+    assert_equal "Let's loop some!", @program.starting_node.next_node.next_node.value
+    assert_kind_of GotoNode, @program.starting_node.next_node.next_node.next_node
+    assert_equal "Let's start here.", @program.starting_node.next_node.next_node.next_node.next_node.value
+  end
+
+  def test_simple_node_jumps
+    @program = load_program_fixture("goto_node_jumps.yml")
+    assert_nodes_equal @program, {TextNode => 3}
+
+    assert_equal "Let's start here.", @program.starting_node.value
+    assert_equal "Let's loop some!", @program.starting_node.next_node.value
+    assert_equal "Let's start here.", @program.starting_node.next_node.next_node.value
+  end
+
+  def test_cross_script_jumps
+    @program = load_program_with_scripts({'scripta' => 'goto_jump_script_a.yml', 'scriptb' => 'goto_jump_script_b.yml'}, 'scripta')
+
+    assert_equal "Hey there!", @program.starting_node.value
+    assert_equal "On target!", @program.starting_node.next_node.value
+    assert_equal "Hey there!", @program.starting_node.next_node.next_node.next_node.value
+  end
+end
+
+
+
+

data/test/guided_path/parser/spec1/test_lead_in_nodes.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+class TestSpec1LeadInNodes < MiniTest::Unit::TestCase
+  def load_program_fixture(spec_name)
+    Program.new(version: GuidedPath::Parser::Spec1, scripts: {'test' => load_fixture("spec1/#{spec_name}")}, starting_script: 'test')
+
+  end
+
+  def test_lead_in_node
+    @program = load_program_fixture("leadin_multiple.yml")
+    assert_nodes_equal @program, {LeadInNode => 1, QuestionMultipleChoiceNode => 1, TextNode => 2}
+
+    assert_kind_of LeadInNode, @program.starting_node
+    assert_equal "5", @program.starting_node.pause
+  end
+end
+
+
+

data/test/guided_path/parser/spec1/test_multimedia_nodes.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class TestSpec1MultimediaNodes < MiniTest::Unit::TestCase
+  def load_program_fixture(spec_name)
+    Program.new(version: GuidedPath::Parser::Spec1, scripts: {'test' => load_fixture("spec1/#{spec_name}")}, starting_script: 'test')
+
+  end
+
+  def test_image_node
+    @program = load_program_fixture("image_simple.yml")
+    assert_nodes_equal @program, {MultimediaNode => 1}
+    assert_equal "http://businessnetworking.com/wp-content/uploads/2012/04/happy-face.jpg", @program.starting_node.url
+    assert_equal "image", @program.starting_node.source
+
+    @program = load_program_fixture("image_captions.yml")
+    assert_nodes_equal @program, {MultimediaNode => 2}
+    assert_equal @program.starting_node.caption, {text: "Some text", position: "bottom"}
+
+
+    assert_equal @program.starting_node.next_node.caption, {text: "Some text on top", position: "top"}
+
+  end
+
+  def test_youtube_node
+    @program = load_program_fixture("youtube_simple.yml")
+    assert_nodes_equal @program, {MultimediaNode => 1}
+    assert_equal "http://www.youtube.com/watch?v=aHrn3-Cb3iM", @program.starting_node.url
+    assert_equal "youtube", @program.starting_node.source
+
+    @program = load_program_fixture("youtube_captions.yml")
+    assert_nodes_equal @program, {MultimediaNode => 2}
+    assert_equal @program.starting_node.caption, {text: "Inspiring skateboarding!", position: "bottom"}
+
+
+    assert_equal @program.starting_node.next_node.caption, {text: "Inspiring skateboarding!", position: "top"}
+
+  end
+end
+
+
+

data/test/guided_path/parser/spec1/test_question_multiple.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+class TestSpec1QuestionMultiple < MiniTest::Unit::TestCase
+  def load_program_fixture(spec_name)
+    Program.new(version: GuidedPath::Parser::Spec1, scripts: {'test' => load_fixture("spec1/#{spec_name}")}, starting_script: 'test')
+
+  end
+
+  def test_simple_question_node
+    program = load_program_fixture("multiple_simple.yml")
+    assert_nodes_equal program, {QuestionMultipleChoiceNode => 1, TextNode => 2}
+    question = program.starting_node
+    assert_kind_of QuestionMultipleChoiceNode,  question
+    assert_equal question.text, "How are you feeling?"
+    assert_equal question.to_hash[:text], "How are you feeling?"
+
+    assert_kind_of TextNode,  question.answers['Unhappy']
+  end
+
+  def test_multiple_with_sub_questions
+
+    program = load_program_fixture("multiple_with_sub_questions.yml")
+    assert_nodes_equal program, {QuestionMultipleChoiceNode => 2, TextNode => 3}
+  end
+
+
+  def test_multiple_with_loops
+
+    program = load_program_fixture("multiple_with_loops.yml")
+    assert_kind_of QuestionMultipleChoiceNode, program.starting_node.answers['Banana'].next_node
+
+    assert_equal program.starting_node.answers['Mango'].next_node, program.starting_node
+  end
+end
+
+
+

data/test/guided_path/parser/spec1/test_question_textbox.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class TestSpec1QuestionTextBox < MiniTest::Unit::TestCase
+  def load_program_fixture(spec_name)
+    Program.new(version: GuidedPath::Parser::Spec1, scripts: {'test' => load_fixture("spec1/#{spec_name}")}, starting_script: 'test')
+
+  end
+
+  def test_simple_textbox_node
+    program = load_program_fixture("textbox_simple.yml")
+    assert_nodes_equal program, {QuestionTextBoxNode => 1, TextNode => 5}
+    assert_equal "Sorry, didn't understand.", program.starting_node.answers['~not listed~'].value
+   end
+end
+
+
+

data/test/guided_path/parser/spec1/test_question_yes_no.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+class TestSpec1QuestionYesNo < MiniTest::Unit::TestCase
+  def load_program_fixture(spec_name)
+    Program.new(version: GuidedPath::Parser::Spec1, scripts: {'test' => load_fixture("spec1/#{spec_name}")}, starting_script: 'test')
+
+  end
+
+  def test_simple_yes_no
+    program = load_program_fixture("yes_no_simple.yml")
+    assert_nodes_equal program, {QuestionMultipleChoiceNode => 2, TextNode => 4}
+    question = program.starting_node
+    assert_kind_of QuestionMultipleChoiceNode,  question
+    assert_equal question.text, "Say yes?"
+    assert_kind_of TextNode, question.answers['Yes']
+    assert_kind_of QuestionMultipleChoiceNode, question.answers['Yes'].next_node
+
+  end
+
+end
+
+
+

data/test/guided_path/parser/spec1/test_sequences.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+class TestSpec1Sequences < MiniTest::Unit::TestCase
+  def load_program_fixture(spec_name)
+    Program.new(version: GuidedPath::Parser::Spec1, scripts: {'test' => load_fixture("spec1/#{spec_name}")}, starting_script: 'test')
+
+  end
+
+  def test_simple_text_node
+    @program = load_program_fixture("sequences_three_textnodes.yml")
+    assert_nodes_equal @program, {TextNode => 3}
+
+    assert_equal "The beginning", @program.starting_node.value
+    assert_equal "The middle", @program.starting_node.next_node.value
+    assert_equal "The end", @program.starting_node.next_node.next_node.value
+    assert_equal nil, @program.starting_node.next_node.next_node.next_node
+  end
+end
+
+
+
+

data/test/guided_path/parser/spec1/test_text_nodes.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+class TestSpec1TextNodes < MiniTest::Unit::TestCase
+  def load_program_fixture(spec_name)
+    Program.new(version: GuidedPath::Parser::Spec1, scripts: {'test' => load_fixture("spec1/#{spec_name}")}, starting_script: 'test')
+
+  end
+
+  def test_simple_text_node
+    @program = load_program_fixture("textnode_simple_string.yml")
+    assert_nodes_equal @program, {TextNode => 1}
+
+    @program = load_program_fixture("textnode_simple_hash.yml")
+    assert_nodes_equal @program, {TextNode => 1}
+
+    @program = load_program_fixture("textnode_simple_attribute_list.yml")
+    assert_nodes_equal @program, {TextNode => 1}
+    assert_equal "Welcome back!", @program.nodes.values.first.value
+  end
+end
+
+
+

data/test/guided_path/program/test_program_output.rb

@@ -0,0 +1,52 @@
+require 'helper'
+
+class TestProgramOuput< MiniTest::Unit::TestCase
+  def load_program_fixture(spec_name)
+    Program.new(version: GuidedPath::Parser::Spec1, scripts: {'test' => load_fixture("spec1/#{spec_name}")}, starting_script: 'test')
+
+  end
+
+  def find_next_node(output, current_node = nil)
+    if current_node == nil
+      return output[:nodes][output[:starting_node]]
+    else
+      return output[:nodes][current_node[:next_node]]
+    end
+  end
+
+  def test_empty_program
+    @program = load_program_fixture("empty_file.yml")
+
+    assert_equal @program.to_hash, {:starting_node => nil, :nodes => {}}
+  end
+
+  def test_single_node
+    @program = load_program_fixture("textnode_simple_string.yml")
+    output = @program.to_hash
+
+    node = find_next_node(output)
+    assert_equal node[:type], 'text'
+    assert_equal node[:value], 'Welcome back!'
+  end
+
+  def test_multiple_nodes
+
+    @program = load_program_fixture("sequences_three_textnodes.yml")
+    output = @program.to_hash
+
+    node = find_next_node(output)
+    assert_equal node[:type], 'text'
+    assert_equal node[:value], 'The beginning'
+
+    node = find_next_node(output, node)
+    assert_equal node[:type], 'text'
+    assert_equal node[:value], 'The middle'
+
+    node = find_next_node(output, node)
+    assert_equal node[:type], 'text'
+    assert_equal node[:value], 'The end'
+
+  end
+end
+
+