doop 0.0.1

data/lib/generators/doopgovuk/templates/app/views/demo/_preamble.html.erb

@@ -0,0 +1,33 @@
+<%=question_form doop, res do %>
+  <%=question "/page/preamble" do |root, answer| %>
+
+    <%=question "/page/preamble/debug_on" do |root,answer| %>
+      <button name="b_answer" value="Yes">Yes, turn debugging on</button><br/>
+      <button name="b_answer" value="No">No, turn debugging off</button>
+    <% end %>
+
+    <%=question "/page/preamble/enrolled_before" do |root,answer| %>
+      <button name="b_answer" value="Yes">Yes, I've applied before</button><br/>
+      <button name="b_answer" value="No">No, I haven't applied before</button>
+    <% end %>
+
+    <%=question "/page/preamble/year_last_applied" do |root,answer| %>
+      <%=select_tag( "b_answer", "<option>2013</option><option>2012</option>".html_safe ) %>
+      <br/>
+      <button>Continue</button>
+    <% end %>
+
+    <%=question "/page/preamble/reason_for_applying" do |root,answer| %>
+      <p>Why are you applying this year?  Please be as specific as possible, and give examples</p>
+      <%=error res, :reason_for_applying_error  %>
+      <%=text_area_tag "b_answer", answer, rows: 10, cols: 100 %>
+      <br/>
+      <button>Continue</button>
+    <% end %>
+
+    <% when_answered "/page/preamble" do %>
+      <button>Continue and Save</button>
+    <% end %>
+  <% end %>
+
+<% end %>

data/lib/generators/doopgovuk/templates/app/views/demo/_summary.html.erb

@@ -0,0 +1,10 @@
+
+<%=question_form doop, res do %>
+  <%=question "/page/summary" do |root, answer| %>
+    <%=question "/page/summary/terms_and_conditions" do |root, answer| %>
+      <p>I have answered the questions to the best of my knowledge and agree to abide by the terms and conditions of this service.</p>
+      <button>I have read and understood the terms and conditions</button>
+    <% end %>
+
+  <% end %>
+<% end %>

data/lib/generators/doopgovuk/templates/app/views/demo/_your_details.html.erb

@@ -0,0 +1,55 @@
+<%=question_form doop, res do %>
+  <%=question "/page/your_details" do |root, answer| %>
+
+    <%=question "/page/your_details/your_name" do |root,answer| %>
+      <div class="textfield">
+        <label for="firstname">First names</label>
+        <input id="firstname" name="b_firstname" type="text" value="<%=answer["firstname"]%>"/>
+      </div>
+      <div class="textfield">
+        <label for="surname">Surname</label>
+        <input id="surname" name="b_surname" type="text" value="<%=answer["surname"]%>"/>
+      <br/>
+      <button>Continue</button><br/>
+    <% end %>
+
+    <%=question "/page/your_details/address_history" do |root,answer| %>
+
+      <p>We need to know where you have lived for the past 6 years</p>
+
+      <% list "/page/your_details/address_history/address__(\\d+)" do |path,index| %>
+        <%=question path, :title => "Address #{index}" do |root,answer| %>
+          <div class="textfield">
+            <label for="address1">Address</label>
+            <input id="address1" type="text" name="b_address1" value="<%=answer['address1']%>"/>
+          </div>
+          <div class="textfield">
+            <input id="address2" type="text" name="b_address2" value="<%=answer['address2']%>"/>
+          </div>
+
+          <div class="textfield">
+            <input id="address3" type="text" name="b_address3" value="<%=answer['address3']%>"/>
+          </div>
+          <div class="textfield">
+            <label for="postcode">Postcode</label>
+            <input id="postcode" type="text" name="b_postcode" value="<%=answer['postcode']%>"/>
+          </div>
+          <% if index > 1 %>
+            <button class="button-secondary" name="remove_address">Remove</button><br/>
+          <% end %>
+          <button>Continue</button>
+        <% end %>
+      <% end %>
+      <% when_answered "/page/your_details/address_history" do %>
+        <button name="add_address" class="button-secondary">Add another address</button><br/>
+        <button>Continue</button>
+      <% end %>
+
+    <% end %>
+
+    <% when_answered "/page/your_details" do %>
+      <button>Continue and Save</button>
+    <% end %>
+  <% end %>
+
+<% end %>

data/lib/generators/doopgovuk/templates/app/views/demo/index.html.erb

@@ -0,0 +1,3 @@
+<div id="question_section">
+  <%= render res[:page], :doop => doop, :res => res %>
+</div>

data/lib/generators/doopgovuk/templates/app/views/demo/index.js.erb

@@ -0,0 +1,4 @@
+$("#question_section").html( "<%= escape_javascript( render res[:page], :doop => doop, :res => res  ) %>" )
+$("#nav_path").val("")
+$("#back_a_page").val("")
+$("#change_answer").val("")

data/lib/generators/doopgovuk/templates/app/views/doop/_error.html.erb

@@ -0,0 +1,3 @@
+<div class="error">
+  <span><%= msg %></span>
+</div>

data/lib/generators/doopgovuk/templates/app/views/doop/_info_box.html.erb

@@ -0,0 +1,4 @@
+<div class="info_box">
+  <%=image_tag "info-icon.png", :class => "info_img" %>
+  <% content.call %>
+</div>

data/lib/generators/doopgovuk/templates/app/views/doop/_navbar.html.erb

@@ -0,0 +1,23 @@
+<div class="navbar">
+  <ol>
+  <%
+    i = 1
+    pages = res[:all_pages]
+    page_path = res[:page_path]
+    pages.each do |p|
+      nav_name = doop[p]["_nav_name"]
+
+      if p == page_path %>
+        <li class="doing"><%="#{i}. #{nav_name}"%></li>
+      <% elsif doop[p]["_answered"] %>
+        <li class="done"><a href="#" onclick="$('#nav_path').val('<%=p %>').click(); return false"><%="#{i}. #{nav_name}" %></a></li>
+      <% else %>
+        <li class="todo"><%="#{i}. #{nav_name}"%></li>
+     <%
+      end
+      i +=1
+    end %>
+  </ol>
+
+</div>
+

data/lib/generators/doopgovuk/templates/app/views/doop/_question.html.erb

@@ -0,0 +1,19 @@
+<% if root["_open"] %>
+  <% if indent %><div class="indent"><% end %>
+    <div class="question-open">
+      <h2><%=title != nil ? title : root["_question"]%></h2>
+      <% content.call(root, answer) %>
+    </div>
+  <% if indent %> </div"><% end %>
+<% end %>
+
+<% if !root["_open"] && root["_answered"] %>
+  <% if indent %><div class="indent"><% end %>
+    <div class="question-closed">
+      <div class="title"><%=title != nil ? title : root["_question"]%></div>
+      <div class="answer">
+        <a href="#" class="button" onclick="$('#change_answer_path').val('<%=path %>').click(); return false"><%=root['_summary']%></a>
+      </div>
+    </div>
+  <% if indent %> </div"><% end %>
+<% end %>

data/lib/generators/doopgovuk/templates/app/views/doop/_question_form.html.erb

@@ -0,0 +1,15 @@
+<%=form_tag( {action: "answer"}, :authenticity_token => true, :remote => true ) do %>
+  <div class="question_form">
+    <%=render "doop/navbar", :res => res, :doop => doop %> 
+    <h1><%=res[:page_title]%></h1>
+    <% content.call %>
+  </div>
+
+  <% if res[:debug_on] %>
+    <br/><br/><textarea cols="115" rows="20"><%= h(doop.dump)%></textarea>
+  <% end %>
+  <button id="nav_path" style="display: none;" name="nav_path"></button>
+  <button id="back_a_page" name="back_a_page" style="display: none;"></button>
+  <button id="change_answer_path" style="display: none;" name="change_answer_path"></button>
+  <input type="hidden" name="doop_data" value="<%=request["doop_data"]%>"/>
+<% end %>

data/lib/generators/doopgovuk/templates/app/views/layouts/application.html.erb

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+
+<% content_for :head do %>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+<% end %>
+
+<% content_for :content do %>
+  <div class="outer-block">
+    <div class="inner-block">
+      <div class="phase-banner">
+        <strong class="phase-tag">BETA</strong>
+        <span>This is a new service – your <a href="#">feedback</a> will help us to improve it.</span>
+      </div>
+
+      <%= yield  %>
+    </div>
+  </div>
+<% end %>
+
+<%= render template: "layouts/govuk_template" %>

data/spec/doop_spec.rb

@@ -0,0 +1,448 @@
+require "spec_helper"
+
+describe "Doop" do
+
+  describe "automatic binding" do
+
+    let(:question) {
+      q = Doop::Doop.new
+      q.yaml = ( 
+        <<-EOS
+    
+        root: {
+          age: {},
+          address: { 
+            address_line_1: { _answer: "21 The Grove" },
+            address_line_2: { _answer: "Telford" },
+            address_line_3: {}
+          },
+
+          pets: {
+            pet__8: { _answer: "Claude" },
+            pet__3: { _answer: "Lucy" }
+          }
+
+        }
+
+        EOS
+      )
+      q.init
+      q.ask_next
+      q
+    }
+
+
+    it "attempts to bind anything starting with b_ to the answer" do
+      expect(question.currently_asked).to eq( "/root/age" )
+      question.answer( { "b_age"=>10 } )
+      expect( question["/root/age/_answer"]["age"] ).to eq(10)
+
+    end
+
+  end
+
+  describe "structure management" do
+
+    let(:question) {
+      q = Doop::Doop.new
+      q.yaml = 
+        <<-EOS
+    
+        root: {
+          age: {_answer: 25, _answered: true},
+          address: { 
+            address_line_1: { _answer: "21 The Grove" },
+            address_line_2: { _answer: "Telford" },
+            address_line_3: {}
+          },
+
+          pets: {
+            pet__8: { _answer: "Claude" },
+            pet__3: { _answer: "Lucy" }
+          }
+
+        }
+
+        EOS
+      q.init
+      q.ask_next
+      q
+    }
+
+    it "is initialized with a YAML data structure" do
+    end
+
+    it "can be serialized" do
+      dump = question.dump
+      expect(dump).to include( "root" )
+      expect(dump).to eq( Doop::Doop.new(dump).dump )
+    end
+
+    it "allows questions to be accessed like a file system" do
+      expect(question["/root/age/_answer"] ).to eq(25)
+      expect(question["/root/age"] ).not_to be_nil
+      expect(question["/root/address/address_line_1/_answer"] ).to eq("21 The Grove")
+      expect(question["/root/address/address_line_3/_answer"] ).to eq(nil)
+    end
+
+    it "allows questions to be answered" do
+      question["/root/address/address_line_3/_answer"] = "Shropshire" 
+      expect(question["/root/address/address_line_3/_answer"] ).to eq("Shropshire")
+
+      yaml = <<-EOS
+
+        address_line_1: { _answer: "AAA" }
+        address_line_2: { _answer: "BBB" }
+
+      EOS
+
+      question["/root/address"] = YAML.load(yaml)
+      expect(question["/root/address/address_line_1/_answer"] ).to eq("AAA")
+
+    end
+
+    it "allows questions to be added" do
+      question.add( "/root/address/address_line_4" )
+      question["/root/address/address_line_4/_answer"] = "XXX"
+      expect(question["/root/address/address_line_4/_answer"] ).to eq("XXX")
+    end
+
+    it "allows questions to be removed" do
+      question.remove( "/root/address/address_line_1" )
+      expect(question["/root/address/address_line_1"] ).to eq(nil)
+    end
+
+    it "allows questions to be moved" do
+      question.move( "/root/address/address_line_1", "/root/address/address_line_6" )
+      expect(question["/root/address/address_line_1"] ).to eq(nil)
+      expect(question["/root/address/address_line_6/_answer"] ).to eq("21 The Grove")
+    end
+
+    it "allows question to be renumbered in sequence" do
+      question.renumber( "/root/pets" )
+      expect(question["/root/pets/pet__1/_answer"] ).to eq("Lucy")
+      expect(question["/root/pets/pet__2/_answer"] ).to eq("Claude")
+    end
+
+    it "automatically adds meta data. Meta data starts with _" do
+
+      expect(question["/root/pets/_answered"] ).not_to be_nil
+      expect(question["/root/pets/_open"] ).not_to be_nil
+      expect(question["/root/pets/_enabled"] ).not_to be_nil
+      expect(question["/root/pets/_answer"] ).to be_nil
+
+    end
+
+  end
+
+
+  describe "navigation and answering" do
+
+
+    let(:question) {
+      q = Doop::Doop.new 
+      q.yaml=
+        <<-EOS
+    
+        root: {
+          age: { _question: "How old are you?"},
+          address: { 
+            _question: "What is your address",
+            address_line__1: { _question: "Address Line 1"},
+            address_line__2: { _question: "Address Line 2"},
+            address_line__3: { _question: "Address Line 3"}
+          }
+        }
+
+        EOS
+      q.init
+      q.ask_next
+      q
+    }
+
+    it "gets the next unaswered question" do
+      expect(question.currently_asked).to eq( "/root/age" )
+    end
+
+
+    it "allows question to be answered in order" do
+      expect(question.currently_asked).to eq( "/root/age" )
+      question.answer( { "answer" => 36 } )
+      expect(question["/root/age/_answer"]).to eq( 36 )
+      expect(question["/root/address/_open"]).to eq( true )
+      expect(question.currently_asked).to eq( "/root/address/address_line__1" )
+      question.answer( { "answer" => "address1" } )
+      expect(question.currently_asked).to eq( "/root/address/address_line__2" )
+      question.answer( {"answer" => "address2" } )
+      expect(question.currently_asked).to eq( "/root/address/address_line__3" )
+      question.answer( {"answer" => "address3" } )
+      expect(question.currently_asked).to eq( "/root/address" )
+      question.answer( { "answer" => "#{question['/root/address/address_line__1']},  #{question['/root/address/address_line__2']},  #{question['/root/address/address_line__3']}" } )
+      expect(question.currently_asked).to eq( "/root" )
+      question.answer( { "answer" => "done" } )
+      expect(question.currently_asked).to be_nil
+    end
+
+    it "allows questions to be disabled" do
+      question.disable("/root/address")
+      expect(question.currently_asked).to eq( "/root/age" )
+      question.answer( {"answer" => 36 } )
+      expect(question.currently_asked).to eq( "/root" )
+    end
+
+    it "allows earlier questions to be changed" do
+      expect(question.currently_asked).to eq( "/root/age" )
+      question.answer( {"answer" => 36} )
+      expect(question["/root/age/_answer"]).to eq( 36 )
+      expect(question.currently_asked).to eq( "/root/address/address_line__1" )
+      question.answer( {"answer" => "address1" } )
+      expect(question.currently_asked).to eq( "/root/address/address_line__2" )
+      question.answer( {"answer" => "address2"} )
+      expect(question.currently_asked).to eq( "/root/address/address_line__3" )
+      question.change( "/root/address/address_line__1" )
+      dump = question.dump
+      expect( question.dump ).to eq( Doop::Doop.new(dump).dump )
+
+
+      expect(question.currently_asked).to eq( "/root/address/address_line__1" )
+      question.answer( {"answer" => "address1"} )
+      expect(question.currently_asked).to eq( "/root/address/address_line__3" )
+
+      question.change( "/root/age" )
+      expect(question.currently_asked).to eq( "/root/age" )
+      question.answer({ "answer" => 35} )
+      expect(question.currently_asked).to eq( "/root/address/address_line__3" )
+    end
+
+    it "provides a mechanism to see if all questions are answered under a given path" do
+
+      expect(question.currently_asked).to eq( "/root/age" )
+      question.answer( {"answer" => 36} )
+      expect(question["/root/age/_answer"]).to eq( 36 )
+      expect(question.currently_asked).to eq( "/root/address/address_line__1" )
+      question.answer( {"answer" => "address1" } )
+      expect(question.currently_asked).to eq( "/root/address/address_line__2" )
+      question.answer( {"answer" => "address2"} )
+      expect(question.currently_asked).to eq( "/root/address/address_line__3" )
+      question.answer({ "answer" => "address3"} )
+      expect(question.all_answered("/root/address")).to eq(true)
+      expect(question.all_answered("/root")).to eq(false)
+      question.answer({ "answer" => "provided"} )
+      expect(question.all_answered("/root")).to eq(true)
+      question.answer({ "answer" => "provided"} )
+      expect(question.all_answered("/")).to eq(true)
+    end
+
+  end
+
+  describe "on question answered callbacks" do
+
+    let(:question) {
+      q = Doop::Doop.new 
+      q.yaml=
+        <<-EOS
+    
+        root: {
+          address: { 
+            _question: "What is your address",
+            address_line__1: { _question: "Address Line 1"},
+            address_line__2: { _question: "Address Line 2"},
+            address_line__3: { _question: "Address Line 3"}
+          },
+          age: {
+            _question: "How old are you?",
+            _on_answer_handler: "how_old_are_you"
+          }
+
+        }
+
+        EOS
+      q.init
+      q.ask_next
+      q
+
+    }
+
+    it "allows a callback when a question is answered.  This allows flows to be changed based on the answer" do
+
+      question.on_answer "/root/address/address_line__1" do |root, path, context, answer|
+        question.enable( "/root/address/address_line__2", context[:button] == :ok )
+        root["_answer"] = "answered!"
+        root["_summary"] = "my summary"
+        root["_answered"] = true
+
+      end
+
+      expect(question.currently_asked).to eq( "/root/address/address_line__1" )
+      question.answer( {:button => :skip} )
+      expect(question.currently_asked).to eq( "/root/address/address_line__3" )
+      question.change( "/root/address/address_line__1" )
+      expect(question.currently_asked).to eq( "/root/address/address_line__1" )
+      question.answer( {:button => :ok} )
+      expect(question.currently_asked).to eq( "/root/address/address_line__2" )
+    end
+
+    it "allows callbacks based on a regex expression" do
+      question.on_answer "/root/address/address_line__(.*)" do |root, path, context|
+        root["_answer"] = "answered!"
+        root["_answered"] = true
+      end
+      expect(question.currently_asked).to eq( "/root/address/address_line__1" )
+      question.answer( {} )
+      expect(question["/root/address/address_line__1/_answer"]).to eq( "answered!" )
+      question.answer( {} )
+      expect(question["/root/address/address_line__2/_answer"]).to eq( "answered!" )
+    end
+
+    it "allows named handlers to be used" do
+      question.on_answer "how_old_are_you" do |root,path,context,answer|
+        root["_answered"] = true
+      end
+      question.answer( {} )
+      question.answer( {} )
+      expect(question.currently_asked).to eq( "/root/address/address_line__3" )
+      question.answer( {"b_answer" => "test"} )
+      expect( question[ "/root/address/address_line__3/_answer" ] ).to eq( "test" )
+      question.answer( {} )
+      expect(question.currently_asked).to eq( "/root/age" )
+      question.answer( {"b_age" => 30 } )
+      expect(question["/root/age/_answer/age"]).to eq( 30 )
+    end
+
+  end
+
+  describe "on child question answered callbacks" do
+
+    let(:nested_question) {
+      q = Doop::Doop.new 
+
+      q.yaml=
+        <<-EOS
+        root: {
+          a: {
+            b: {
+              c1: {},
+              c2: {}
+            }
+          }
+        }
+        EOS
+      q.init
+      q.ask_next
+      q
+
+    }
+
+    let(:question) {
+      q = Doop::Doop.new 
+      q.yaml =
+        <<-EOS
+    
+        root: {
+          address: { 
+            _question: "What is your address",
+            address_line__1: { _question: "Address Line 1"},
+            address_line__2: { _question: "Address Line 2"},
+            address_line__3: { _question: "Address Line 3"}
+          },
+          age: {
+            _question: "How old are you?",
+            _on_answer_handler: "how_old_are_you"
+          }
+
+        }
+
+        EOS
+      q.init
+      q.ask_next
+      q
+
+    }
+
+    it "allows a callback when all nested questions have been answered" do
+      question.on_all_nested_answer "/root/address" do |root,path,context|
+        root["_answer"] = "answered!"
+        root["_answered"] = true
+      end
+
+      expect(question.currently_asked).to eq( "/root/address/address_line__1" )
+      question.answer( {} )
+      expect(question.currently_asked).to eq( "/root/address/address_line__2" )
+      question.answer( {} )
+      expect(question.currently_asked).to eq( "/root/address/address_line__3" )
+      question.answer( {} )
+      # /root/address should be answered by the callback
+      expect(question.currently_asked).to eq( "/root/age" )
+    end
+
+    it "recursively descends the question tree, making call backs" do
+      nested_question.on_all_nested_answer "/root/a/b" do |root,path,context|
+        root["_answer"] = "answered!"
+        root["_answered"] = true
+      end
+      nested_question.on_all_nested_answer "/root/a" do |root,path,context|
+        root["_answer"] = "answered!"
+        root["_answered"] = true
+      end
+
+      expect(nested_question.currently_asked).to eq( "/root/a/b/c1" )
+      nested_question.answer( {} )
+      expect(nested_question.currently_asked).to eq( "/root/a/b/c2" )
+      nested_question.answer( {} )
+      expect(nested_question.currently_asked).to eq( "/root" )
+    end
+
+  end
+
+  describe "on the fly structure manipulation" do
+
+    let(:question) {
+      q = Doop::Doop.new 
+      q.yaml = 
+        <<-EOS
+    
+        root: {
+          address: { 
+            _question: "What is your address",
+            address_line__1: { _question: "Address Line 1"},
+            address_line__2: { _question: "Address Line 2"},
+            address_line__3: { _question: "Address Line 3"}
+          },
+          age: {
+            _question: "How old are you?",
+            _on_answer_handler: "how_old_are_you"
+          }
+
+        }
+
+        EOS
+      q.init
+      q.ask_next
+      q
+
+    }
+
+    it "allows questions to be removed and added in flight" do
+
+      expect(question.currently_asked).to eq( "/root/address/address_line__1" )
+      question.answer( {"answer"=>"address1"} )
+      question.answer( {"answer"=>"address2"} )
+      question.answer( {"answer"=>"address3"} )
+      expect(question.currently_asked).to eq( "/root/address" )
+
+      expect( question["/root/address/address_line__1/_answer"] ).to eq( "address1" ) 
+
+      question.remove( "/root/address/address_line__1" )
+      question.renumber( "/root/address" )
+      question.ask_next
+      expect( question["/root/address/address_line__1/_answer"] ).to eq( "address2" ) 
+
+      question.add( "/root/address/address_line__3" )
+      question.ask_next
+      expect(question.currently_asked).to eq( "/root/address/address_line__3" )
+
+    end
+  end
+
+end
+