smartdown 0.0.4 → 0.1.0

data/README.md

@@ -83,7 +83,7 @@ You may need a visa to come to the UK to visit, study or work.
 Question nodes follow the same standard structure outlined above.
 
 Smartdown currently allows multiple questions to be defined per node, but this
-feature is in development and the behaviour may change.
+feature has only [recently been introduced](CHANGELOG.md#010) and may still change.
 
 The next sections define the various question types available.
 

data/lib/smartdown/engine/transition.rb

@@ -4,26 +4,25 @@ require 'smartdown/engine/errors'
 module Smartdown
   class Engine
     class Transition
-      attr_reader :state, :node, :input
+      attr_reader :state, :node, :inputs
 
-      def initialize(state, node, input, options = {})
+      def initialize(state, node, input_array, options = {})
         @state = state
         @node = node
-        @input = input
+        @inputs = input_array
         @predicate_evaluator = options[:predicate_evaluator] || PredicateEvaluator.new
       end
 
       def next_node
         next_node_from_next_node_rules ||
-          next_node_from_start_button ||
-          raise(Smartdown::Engine::IndeterminateNextNode, "No next node rules defined for '#{node.name}'", caller)
+        next_node_from_start_button ||
+        raise(Smartdown::Engine::IndeterminateNextNode, "No next node rules defined for '#{node.name}'", caller)
       end
 
       def next_state
-        state_with_input
+        state_with_inputs
           .put(:path, state.get(:path) + [node.name])
-          .put(:responses, state.get(:responses) + [input])
-          .put(input_variable_name, input)
+          .put(:responses, state.get(:responses) + inputs)
           .put(:current_node, next_node)
       end
 
@@ -38,13 +37,9 @@ module Smartdown
         start_button && start_button.start_node
       end
 
-      def input_variable_name
-        input_variable_name_from_question || node.name
-      end
-
-      def input_variable_name_from_question
-        question = node.elements.find { |e| e.is_a?(Smartdown::Model::Element::MultipleChoice) }
-        question && question.name
+      def input_variable_names_from_question
+        questions = node.elements.select { |e| e.is_a?(Smartdown::Model::Element::MultipleChoice) }
+        questions.map(&:name)
       end
 
       def next_node_rules
@@ -65,11 +60,11 @@ module Smartdown
         rules.each do |rule|
           case rule
           when Smartdown::Model::Rule
-            if predicate_evaluator.evaluate(rule.predicate, state_with_input)
+            if predicate_evaluator.evaluate(rule.predicate, state_with_inputs)
               throw(:match, rule)
             end
           when Smartdown::Model::NestedRule
-            if predicate_evaluator.evaluate(rule.predicate, state_with_input)
+            if predicate_evaluator.evaluate(rule.predicate, state_with_inputs)
               throw_first_matching_rule_in(rule.children)
             end
           else
@@ -79,8 +74,12 @@ module Smartdown
         raise Smartdown::Engine::IndeterminateNextNode
       end
 
-      def state_with_input
-        state.put(node.name, input)
+      def state_with_inputs
+        result = state.put(node.name, inputs)
+        input_variable_names_from_question.each_with_index do |input_variable_name, index|
+          result = result.put(input_variable_name, inputs[index])
+        end
+        result
       end
     end
   end

data/lib/smartdown/engine.rb

@@ -25,10 +25,25 @@ module Smartdown
     end
 
     def process(responses, start_state = nil)
-      responses.inject(start_state || default_start_state) do |state, input|
+      state = start_state || default_start_state
+      unprocessed_responses = responses
+      while !unprocessed_responses.empty? do
+        nb_questions = 0
         current_node = flow.node(state.get(:current_node))
-        Transition.new(state, current_node, input).next_state
+        nb_questions += current_node.elements.select{|element|
+          element.is_a? Smartdown::Model::Element::MultipleChoice
+        }.count
+
+        #There is at least one relevant input per transition for now:
+        #Transition from start to first question relies on an input, regardless of its value
+        nb_relevant_inputs = [nb_questions, 1].max
+        input_array = unprocessed_responses.take(nb_relevant_inputs)
+        unprocessed_responses = unprocessed_responses.drop(nb_relevant_inputs)
+
+        transition = Transition.new(state, current_node, input_array)
+        state = transition.next_state
       end
+      state
     end
 
     def evaluate_node(state)

data/lib/smartdown/model/node.rb

@@ -11,10 +11,24 @@ module Smartdown
         elements_of_kind(Smartdown::Model::Element::MultipleChoice)
       end
 
+      #Because question titles and page titles use the same markdown,
+      #there are at least as many or more headings than questions on each page
+      #To get only the question titles, we are assuming that all the headings that
+      #are not question headings come first in the markdown, then question headings
+      def question_titles
+        h1s.drop(h1s.count - questions.count)
+      end
+
       def title
         h1s.first ? h1s.first.content : ""
       end
 
+      def body
+        markdown_blocks[1..-1].map { |block| as_markdown(block) }.compact.join("\n")
+      end
+
+      private
+
       def markdown_blocks
         elements_of_kind(Smartdown::Model::Element::MarkdownHeading, Smartdown::Model::Element::MarkdownParagraph)
       end
@@ -23,10 +37,6 @@ module Smartdown
         elements_of_kind(Smartdown::Model::Element::MarkdownHeading)
       end
 
-      def body
-        markdown_blocks[1..-1].map { |block| as_markdown(block) }.compact.join("\n")
-      end
-
     private
       def elements_of_kind(*kinds)
         elements.select {|e| kinds.any? {|k| e.is_a?(k)} }

data/lib/smartdown/version.rb

@@ -1,3 +1,3 @@
 module Smartdown
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/engine/interpolator_spec.rb

@@ -42,7 +42,7 @@ describe Smartdown::Engine::Interpolator do
             paragraph("False case")
           end
         end
-        multiple_choice({})
+        multiple_choice("example", {})
         next_node_rules
       end
     }

data/spec/engine/transition_spec.rb

@@ -7,10 +7,11 @@ describe Smartdown::Engine::Transition do
   let(:current_node_name) { "q1" }
   let(:start_state) { Smartdown::Engine::State.new(current_node: current_node_name) }
   let(:input) { "yes" }
-  subject(:transition) { described_class.new(start_state, current_node, input, predicate_evaluator: predicate_evaluator) }
+  let(:input_array) { [input] }
+  subject(:transition) { described_class.new(start_state, current_node, input_array, predicate_evaluator: predicate_evaluator) }
   let(:predicate_evaluator) { instance_double("Smartdown::Engine::PredicateEvaluator", evaluate: true) }
   let(:state_including_input) {
-    start_state.put(current_node.name, input)
+    start_state.put(current_node.name, input_array)
   }
 
   context "no next node rules" do
@@ -91,7 +92,7 @@ describe Smartdown::Engine::Transition do
           .put(:responses, [input])
           .put(:path, [current_node_name])
           .put(:current_node, outcome_name1)
-          .put(current_node.name, input)
+          .put(current_node.name, input_array)
 
         expect(transition.next_state).to eq(expected_state)
       end

data/spec/engine_spec.rb

@@ -1,20 +1,36 @@
 require 'smartdown/engine'
 
 describe Smartdown::Engine do
+
+  subject(:engine) { Smartdown::Engine.new(flow) }
+  let(:start_state) {
+    engine.default_start_state
+      .put(:eea_passport?, ->(state) {
+        %w{greek british}.include?(state.get(:what_passport_do_you_have?))
+      })
+      .put(:imaginary?, ->(state) {
+        %w{narnia}.include?(state.get(:what_country_are_you_going_to?))
+      })
+      .put(:otherwise, true)
+  }
+
   let(:flow) {
     build_flow("check-uk-visa") do
       node("check-uk-visa") do
         heading("Check uk visa")
         paragraph("This is the paragraph")
-        start_button("what_passport_do_you_have?")
+        start_button("passport_question")
       end
 
-      node("what_passport_do_you_have?") do
+      node("passport_question") do
         heading("What passport do you have?")
         multiple_choice(
-          greek: "Greek",
-          british: "British",
-          usa: "USA"
+            "what_passport_do_you_have?",
+            {
+                greek: "Greek",
+                british: "British",
+                usa: "USA"
+            }
         )
         next_node_rules do
           rule do
@@ -41,14 +57,64 @@ describe Smartdown::Engine do
       end
     end
   }
+  let(:two_questions_per_page_flow) {
+    build_flow("check-uk-visa") do
+      node("check-uk-visa") do
+        heading("Check uk visa")
+        paragraph("This is the paragraph")
+        start_button("passport_question")
+      end
 
-  subject(:engine) { Smartdown::Engine.new(flow) }
-  let(:start_state) {
-    engine.default_start_state
-      .put(:eea_passport?, ->(state) {
-        %w{greek british}.include?(state.get(:what_passport_do_you_have?))
-      })
-      .put(:otherwise, true)
+      node("passport_question") do
+        heading("What passport do you have?")
+        multiple_choice(
+            "what_passport_do_you_have?",
+            {
+                greek: "Greek",
+                british: "British",
+                usa: "USA"
+            }
+        )
+        heading("What country are you going to?")
+        multiple_choice(
+            "what_country_are_you_going_to?",
+            {
+                usa: "USA",
+                narnia: "Narnia"
+            }
+        )
+        next_node_rules do
+          rule do
+            named_predicate("imaginary?")
+            outcome("outcome_imaginary_country")
+          end
+          rule do
+            named_predicate("eea_passport?")
+            outcome("outcome_no_visa_needed")
+          end
+        end
+      end
+
+      node("outcome_no_visa_needed") do
+        conditional do
+          named_predicate "pred?"
+          true_case do
+            paragraph("True case")
+          end
+          false_case do
+            paragraph("False case")
+          end
+        end
+      end
+
+      node("outcome_imaginary_country") do
+        paragraph("Imaginary country")
+      end
+
+      node("outcome_with_interpolation") do
+        paragraph("The answer is %{interpolated_variable}")
+      end
+    end
   }
 
   describe "#process" do
@@ -60,31 +126,62 @@ describe Smartdown::Engine do
       it { should be_a(Smartdown::Engine::State) }
 
       it "current_node of 'what_passport_do_you_have?'" do
-        expect(subject.get(:current_node)).to eq("what_passport_do_you_have?")
+        expect(subject.get(:current_node)).to eq("passport_question")
       end
 
       it "input recorded in state variable corresponding to node name" do
-        expect(subject.get("check-uk-visa")).to eq("yes")
+        expect(subject.get("check-uk-visa")).to eq(["yes"])
       end
     end
 
-    context "greek passport" do
-      let(:responses) { %w{yes greek} }
+    context "one question per page" do
+      context "greek passport" do
+        let(:responses) { %w{yes greek} }
+
+        it "is on outcome_no_visa_needed" do
+          expect(subject.get(:current_node)).to eq("outcome_no_visa_needed")
+        end
 
-      it "is on outcome_no_visa_needed" do
-        expect(subject.get(:current_node)).to eq("outcome_no_visa_needed")
+        it "has recorded input" do
+          expect(subject.get("what_passport_do_you_have?")).to eq("greek")
+        end
       end
 
-      it "has recorded input" do
-        expect(subject.get("what_passport_do_you_have?")).to eq("greek")
+      context "USA passport" do
+        let(:responses) { %w{yes usa} }
+
+        it "raises IndeterminateNextNode error" do
+          expect { subject }.to raise_error(Smartdown::Engine::IndeterminateNextNode)
+        end
       end
     end
 
-    context "USA passport" do
-      let(:responses) { %w{yes usa} }
+    context "two questions per page" do
+      let(:flow) { two_questions_per_page_flow }
+      context "narnia" do
+        let(:responses) { %w{yes greek narnia} }
 
-      it "raises IndeterminateNextNode error" do
-        expect { subject }.to raise_error(Smartdown::Engine::IndeterminateNextNode)
+        it "is on outcome_no_visa_needed" do
+          expect(subject.get(:current_node)).to eq("outcome_imaginary_country")
+        end
+
+        it "has recorded inputs" do
+          expect(subject.get("what_passport_do_you_have?")).to eq("greek")
+          expect(subject.get("what_country_are_you_going_to?")).to eq("narnia")
+        end
+      end
+
+      context "usa" do
+        let(:responses) { %w{yes greek usa} }
+
+        it "is on outcome_no_visa_needed" do
+          expect(subject.get(:current_node)).to eq("outcome_no_visa_needed")
+        end
+
+        it "has recorded inputs" do
+          expect(subject.get("what_passport_do_you_have?")).to eq("greek")
+          expect(subject.get("what_country_are_you_going_to?")).to eq("usa")
+        end
       end
     end
   end

data/spec/support/model_builder.rb

@@ -45,10 +45,10 @@ class ModelBuilder
     @elements.last
   end
 
-  def multiple_choice(options)
+  def multiple_choice(name, options)
     @elements ||= []
     options_with_string_keys = ::Hash[options.map {|k,v| [k.to_s, v]}]
-    @elements << Smartdown::Model::Element::MultipleChoice.new(nil, options_with_string_keys)
+    @elements << Smartdown::Model::Element::MultipleChoice.new(name, options_with_string_keys)
     @elements.last
   end
 

data/spec/support_specs/model_builder_spec.rb

@@ -15,7 +15,7 @@ describe ModelBuilder do
     let(:node2) {
       Smartdown::Model::Node.new("what_passport_do_you_have?", [
         Smartdown::Model::Element::MarkdownHeading.new("What passport do you have?"),
-        Smartdown::Model::Element::MultipleChoice.new(nil, {"greek" => "Greek", "british" => "British"}),
+        Smartdown::Model::Element::MultipleChoice.new("what_passport_do_you_have?", {"greek" => "Greek", "british" => "British"}),
         Smartdown::Model::NextNodeRules.new([
           Smartdown::Model::Rule.new(
             Smartdown::Model::Predicate::Named.new("eea_passport?"),
@@ -40,8 +40,11 @@ describe ModelBuilder do
         node("what_passport_do_you_have?") do
           heading("What passport do you have?")
           multiple_choice(
-            greek: "Greek",
-            british: "British"
+            "what_passport_do_you_have?",
+            {
+              greek: "Greek",
+              british: "British"
+            }
           )
           next_node_rules do
             rule do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartdown
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &10785560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,15 +21,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.1
+  version_requirements: *10785560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &10784820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -37,15 +32,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.0.0
+  version_requirements: *10784820
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &10784240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,15 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *10784240
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &10783580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,12 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *10783580
 description: 
 email: david.heath@digital.cabinet-office.gov.uk
 executables:
@@ -177,7 +157,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3856298649637769047
+      hash: -476092451501996578
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -186,10 +166,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3856298649637769047
+      hash: -476092451501996578
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Interactive question-answer flows using markdown-like external DSL