guided_path 0.3.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.3 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'activemodel'
+gem 'activesupport'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem 'guard'
+gem 'json'
+gem 'ruby_gntp'
+gem 'rb-fsevent'
+gem "minitest"
+gem 'guard-minitest'
+gem "rdoc"
+gem "bundler"
+gem "jeweler"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    ffi (1.0.11)
+    git (1.2.5)
+    guard (1.0.2)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-minitest (0.5.0)
+      guard (>= 0.4)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.1)
+    minitest (2.12.1)
+    multi_json (1.3.2)
+    rake (0.9.2.2)
+    rb-fsevent (0.9.1)
+    rdoc (3.12)
+      json (~> 1.4)
+    ruby_gntp (0.3.4)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  activesupport
+  bundler
+  guard
+  guard-minitest
+  jeweler
+  json
+  minitest
+  rb-fsevent
+  rdoc
+  ruby_gntp

data/Guardfile

@@ -0,0 +1,12 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)\/?test_(.*)\.rb|) 
+  watch(%r|^lib/(.*)|) { "test"}
+  watch(%r|^test/helper\.rb|)    { "test" }
+
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 James
+
+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,19 @@
+= guided_path
+
+Description goes here.
+
+== Contributing to guided_path
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 James. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "guided_path"
+  gem.homepage = "http://github.com/statisticalfool/guided_path"
+  gem.license = "MIT"
+  gem.summary = %Q{Parser for making interactive exercises in a human readable DSL}
+  gem.description = %Q{Parser for making interactive exercises in a human readable DSL}
+  gem.email = "github@jamesstuart.org"
+  gem.authors = ["James"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "guided_path #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/guided_path.gemspec

@@ -0,0 +1,87 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "guided_path"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James"]
+  s.date = "2012-05-28"
+  s.description = "Parser for making interactive exercises in a human readable DSL"
+  s.email = "github@jamesstuart.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/guided_path.rb",
+    "lib/guided_path/node.rb",
+    "lib/guided_path/parser/spec1.rb",
+    "lib/guided_path/program.rb",
+    "lib/guided_path/script.rb",
+    "lib/guided_path/text_node.rb",
+    "test/fixtures/spec1/empty_file.yml",
+    "test/fixtures/spec1/sequences_three_textnodes.yml",
+    "test/fixtures/spec1/textnode_simple_attribute_list.yml",
+    "test/fixtures/spec1/textnode_simple_hash.yml",
+    "test/fixtures/spec1/textnode_simple_string.yml",
+    "test/fixtures/test/a_fixture.yml",
+    "test/guided_path/parser/spec1/test_sequences.rb",
+    "test/guided_path/parser/spec1/test_text_nodes.rb",
+    "test/guided_path/program/test_program_output.rb",
+    "test/guided_path/program/test_program_script_handling.rb",
+    "test/guided_path/test_helper_functions.rb",
+    "test/guided_path/test_text_node.rb",
+    "test/helper.rb"
+  ]
+  s.homepage = "http://github.com/statisticalfool/guided_path"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Parser for making interactive exercises in a human readable DSL"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<psych>, [">= 0"])
+      s.add_runtime_dependency(%q<activemodel>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<guard>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<rdoc>, [">= 0"])
+      s.add_runtime_dependency(%q<bundler>, [">= 0"])
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<psych>, [">= 0"])
+      s.add_dependency(%q<activemodel>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<psych>, [">= 0"])
+    s.add_dependency(%q<activemodel>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/lib/guided_path/goto_node.rb

@@ -0,0 +1,23 @@
+require "active_model"
+require "active_support/core_ext/hash"
+
+module GuidedPath
+  class GotoNode < Node
+    
+
+    def initialize(args = {})
+      super
+      args = args.symbolize_keys
+      raise("Must specify target for a goto node") if @next_node.empty?
+    end
+
+
+    def to_hash
+      output = {}
+      output = super
+      output[:type] = 'goto'
+      output
+    end
+    
+  end
+end

data/lib/guided_path/lead_in_node.rb

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

data/lib/guided_path/multimedia_node.rb

@@ -0,0 +1,38 @@
+require "active_model"
+require "active_support/core_ext/hash"
+
+module GuidedPath
+  class MultimediaNode < Node
+    
+    CATEGORIES = %w{image youtube} 
+    attr_reader :source, :url, :caption
+
+    def initialize(args = {})
+      super
+      args = args.symbolize_keys
+
+      raise(ArgumentError, "Must specify a value for the node") unless args[:url]
+      @url = args[:url].to_s
+
+      raise(ArgumentError, "Must specify a source") unless args[:url]
+      @source = args[:source].to_s
+      raise(ArgumentError, "Must specify a source in #{CATEGORIES.join(', ')}") unless CATEGORIES.include?(@source)
+      @caption = args[:caption]  
+      if @caption.kind_of?(String)
+        @caption = {text: @caption, position: 'bottom'}
+      elsif @caption.kind_of?(Hash)
+        @caption = {text: @caption['text'], position: @caption['position'] || 'top'}
+      end
+    end
+
+
+    def to_hash
+      output = super
+      output[:type] = @source 
+      output[:url] = @url
+      output[:caption] = @caption
+      output
+    end
+    
+  end
+end

data/lib/guided_path/node.rb

@@ -0,0 +1,33 @@
+require "active_model"
+
+module GuidedPath
+  class Node
+    attr_accessor :label
+    attr_reader :next_node
+
+    def initialize(args = {})
+
+      raise(ArgumentError, "Options must be a hash") unless args.kind_of?(Hash)
+      args = args.symbolize_keys
+      @label = args[:label]
+
+      @next_node = (args[:next_node] || args[:goto])
+      @next_node = @next_node.to_s.strip if @next_node
+
+    end
+
+    def next_node=(value)
+      @next_node = value
+    end
+
+    def to_hash
+      output = {}
+      if @next_node
+        output[:next_node] = @next_node.respond_to?(:label) ? @next_node.label : @next_node.to_s
+      end
+
+      output 
+    end
+
+  end
+end

data/lib/guided_path/parser/spec1.rb

@@ -0,0 +1,206 @@
+module GuidedPath
+  module Parser
+    class Spec1
+      def initialize(options = {})
+        @program = options[:program] || raise(ArgumentError, "Cannot run a parser without a program specified")
+        @script = preprocess_script(options[:script])
+        @script_name = options[:script_name] || raise(ArgumentError, 'Must specify a script name')
+        parse_script(@script)
+      end
+
+      private
+
+      def parse_script(script)
+        if (node = find_content_node(script))
+          return add_node(node:node)  
+        elsif script.kind_of?(Array)
+          parse_sequence_node(script)
+        end
+      end
+      
+      def parse_sequence_node(script)
+        last_node = nil
+        last_added_nodes = []
+        script.each do |node|
+          existing_nodes = @program.nodes.keys
+          new_node = parse_script(node)
+          added_nodes = @program.nodes.reject { |label, n| existing_nodes.include?(label) || n.next_node }
+          
+          last_added_nodes.each { |label, n| n.next_node = new_node }
+
+          last_node = new_node
+          last_added_nodes = added_nodes
+        end
+
+
+        return last_node
+      end
+
+      def find_content_node(script)
+
+        new_node = nil
+        new_node ||= find_goto_node(script)
+        new_node ||= find_lead_in_node(script)
+        new_node ||= find_question_node(script)
+        new_node ||= find_multimedia_node(script)
+        new_node ||= find_simple_textnode(script)
+        new_node ||= find_hash_textnode(script)
+        return new_node
+      end
+
+      def find_lead_in_node(script)
+
+        if script.kind_of?(Hash) && (next_node = (script["lead_in"]))
+          LeadInNode.new(next_node)
+        else
+          nil
+        end
+      end
+      
+      MULTIMEDIA_CATEGORIES = %w{image youtube}
+      def find_multimedia_node(script)
+
+        if script.kind_of?(Hash) 
+          if (multimedia_category = script.keys.detect { |k| MULTIMEDIA_CATEGORIES.include?(k) })
+            mm_params = script[multimedia_category]
+            mm_params['source'] = multimedia_category
+            new_node ||= MultimediaNode.new(mm_params)
+            return new_node
+          end
+        end
+      end
+
+      def find_goto_node(script)
+
+        if script.kind_of?(Hash) && (next_node = (script["goto"] || script["next_node"]))
+          GotoNode.new(next_node: next_node)
+        else
+          nil
+        end
+      end
+
+      def add_node(options = {})
+        @program.add_node({:script_name => @script_name}.merge(options))
+      end
+
+
+      def parse_question_textbox(script)
+
+        no_start = @program.starting_node.nil?
+        raise "Question formed invalidly. Did you indent the question enough?\n\n#{script.inspect}" unless script.values.length == 1
+        question_script = script.values.first
+        raise "Question node should be a hash underneath." unless question_script.kind_of?(Hash)
+
+        question_script['answers']['~not listed~'] ||=  "Sorry, the answer you gave was not listed."
+        question_script['answers']['~blank~'] ||=  "Sorry, you must provide an answer."
+        question_script['answers'].each do |name, subscript|
+          question_script['answers'][name] = parse_script(subscript)
+        end
+
+        new_node = QuestionTextBoxNode.new(question_script)
+
+        if no_start
+          @program.starting_node = new_node
+        end
+
+        return new_node
+      end
+      def parse_question_yes_no(script)
+        no_start = @program.starting_node.nil?
+
+        raise "Question formed invalidly. Did you indent the question enough?\n\n#{script.inspect}" unless script.values.length == 1
+        question_script = script.values.first
+        raise "Question node should be a hash underneath." unless question_script.kind_of?(Hash)
+
+        yes_label = ['yes', 'Yes', 'true', 'True', true].detect { |label| question_script.has_key?(label)} 
+        no_label = ['no','No','false','False', false].detect { |label| question_script.has_key?(label)} 
+
+        raise "No yes node found" if yes_label.nil?
+        raise "No no node found" if no_label.nil?
+
+        question_script['answers'] = {
+          'Yes' => parse_script(question_script[yes_label]),
+          'No' => parse_script(question_script[no_label])
+        }
+
+
+        new_node = QuestionMultipleChoiceNode.new(question_script)
+
+        if no_start
+          @program.starting_node = new_node
+        end
+
+        return new_node
+
+      end
+
+      def parse_question_multiple_choice(script)
+        no_start = @program.starting_node.nil?
+
+        raise "Question formed invalidly. Did you indent the question enough?\n\n#{script.inspect}" unless script.values.length == 1
+        question_script = script.values.first
+        raise "Question node should be a hash underneath." unless question_script.kind_of?(Hash)
+        raise "No answers node found in:\n\n#{script.inspect}" unless question_script.has_key?('answers')
+        question_script['answers'].each do |name, subscript| 
+          question_script['answers'][name] = parse_script(subscript)
+        end
+        new_node = QuestionMultipleChoiceNode.new(question_script)
+        if no_start
+          @program.starting_node = new_node
+        end
+
+        return new_node
+      end
+
+      def find_question_node(script)
+        return nil unless script.kind_of?(Hash) 
+
+        if (question_hash = (script['q'] || script['question']))
+          case question_hash['type']
+          when 'yes/no'
+            parse_question_yes_no(script)
+          when 'multiple choice' 
+            parse_question_multiple_choice(script)
+          when 'textbox'
+            parse_question_textbox(script)
+          else
+            parse_question_multiple_choice(script)
+          end
+        elsif script['multiple choice q'] || script['multiple choice question']
+          parse_question_multiple_choice(script)
+        elsif script['yes/no q'] || script['yes/no question']
+          parse_question_yes_no(script)
+        elsif script['textbox q'] || script['textbox question']
+          parse_question_textbox(script)
+        else
+          nil
+        end
+      end
+
+
+      def find_simple_textnode(script)
+        if script.kind_of?(String) || script.kind_of?(Symbol)
+          return TextNode.new(value: script)
+        end
+
+        return nil
+      end
+
+      def find_hash_textnode(script)
+        if script.kind_of?(Hash) && (text_node = script['text'])
+          new_node = find_simple_textnode(text_node)
+          new_node ||= TextNode.new(text_node) if text_node.kind_of?(Hash)
+          return new_node
+        end
+      end
+
+
+      def preprocess_script(raw_script)
+        raise "Must specify script" unless raw_script 
+        YAML.load(raw_script)
+      end
+  
+
+    end
+  end
+end