smartdown 0.1.1 → 0.2.0

data/bin/smartdown

@@ -17,7 +17,6 @@ if ARGV.size == 0
 else
   coversheet_path, *responses = ARGV
   begin
-    #TODO: use same object as smartdown-frontend will be using here
     input = Smartdown::Parser::DirectoryInput.new(coversheet_path)
     flow = Smartdown::Parser::FlowInterpreter.new(input).interpret
     engine = Smartdown::Engine.new(flow)

data/lib/smartdown/api/flow.rb

@@ -75,10 +75,10 @@ module Smartdown
         if node.elements.any?{|element| element.is_a? Smartdown::Model::Element::StartButton}
           Smartdown::Api::Coversheet.new(node)
         elsif node.elements.any?{|element| element.is_a? Smartdown::Model::NextNodeRules}
-          if node.elements.any?{|element| element.is_a? Smartdown::Model::Element::MultipleChoice}
+          if node.elements.any?{|element| element.class.to_s.include?("Smartdown::Model::Element::Question")}
             Smartdown::Api::QuestionPage.new(node)
           else
-            #TODO: support other types of questions
+            raise("Unknown node type: #{node.elements.map(&:class)}")
           end
         else
           Smartdown::Api::Outcome.new(node)

data/lib/smartdown/api/multiple_choice.rb

@@ -4,22 +4,17 @@ module Smartdown
   module Api
     class MultipleChoice < Question
       def options
-        question = elements.find{|element| element.is_a? Smartdown::Model::Element::MultipleChoice}
+        question = elements.find{|element| element.is_a? Smartdown::Model::Element::Question::MultipleChoice}
         question.choices.map do |choice|
           OpenStruct.new(:label => choice[1], :value => choice[0])
         end
       end
 
       def name
-        question = elements.find{|element| element.is_a? Smartdown::Model::Element::MultipleChoice}
+        question = elements.find{|element| element.is_a? Smartdown::Model::Element::Question::MultipleChoice}
         question.name
       end
 
-      #TODO: move to presenters in smart-answer app
-      def partial_template_name
-        "multiple_choice_question"
-      end
-
     end
   end
 end

data/lib/smartdown/api/node.rb

@@ -6,33 +6,26 @@ module Smartdown
 
       def initialize(node)
         node_elements = node.elements.clone
-        headings = node_elements.select {
-            |element| element.is_a? Smartdown::Model::Element::MarkdownHeading
+        headings = node_elements.select { |element|
+          element.is_a? Smartdown::Model::Element::MarkdownHeading
         }
         @title = headings.first.content.to_s if headings.first
-        node_elements.delete(headings.first) #Remove page title
+        nb_questions = node_elements.select{ |element|
+          element.is_a? Smartdown::Model::Element::Question::MultipleChoice
+        }.count
+        if headings.count > nb_questions
+          node_elements.delete(headings.first) #Remove page title
+        end
         @elements = node_elements
         @front_matter = node.front_matter
         @name = node.name
       end
 
-      def has_title?
-        !!title
-      end
-
       def body
         elements_before_smartdown = elements.take_while{|element| !smartdown_element?(element)}
         build_govspeak(elements_before_smartdown)
       end
 
-      def has_body?
-        !!body
-      end
-
-      def has_devolved_body?
-        !!devolved_body
-      end
-
       def devolved_body
         elements_after_smartdown = elements.drop_while{|element| !smartdown_element?(element)}
         build_govspeak(elements_after_smartdown)

data/lib/smartdown/api/outcome.rb

@@ -2,10 +2,6 @@ module Smartdown
   module Api
     class Outcome < Node
 
-      def has_next_steps?
-        !!next_steps
-      end
-
       def next_steps
         next_step_element = elements.find{|element| element.is_a? Smartdown::Model::Element::NextSteps}
         GovspeakPresenter.new(next_step_element.content).html if next_step_element

data/lib/smartdown/api/previous_question.rb

@@ -1,29 +1,17 @@
 module Smartdown
   module Api
     class PreviousQuestion
+      extend Forwardable
 
-      attr_reader :response, :title
+      def_delegators :@question, :title, :options
 
-      def initialize(title, question_element, response, modifiable)
-        @title = title
-        @question_element = question_element
-        @response = response
-        @modifiable = modifiable
-      end
-
-      #TODO: remove need for this method by impleemnting modification properly
-      def modifiable?
-        @modifiable
-      end
+      attr_reader :response
 
-      #TODO: to be moved to presenter
-      def multiple_responses?
-        false
-      end
-
-      #TODO: move to presenter, this object API should only expose question_element.choices
-      def response_label(value=response)
-        @question_element.choices.fetch(value)
+      def initialize(elements, response)
+        @response = response
+        if elements.find{|element| element.is_a? Smartdown::Model::Element::Question::MultipleChoice}
+          @question = MultipleChoice.new(elements)
+        end
       end
 
     end

data/lib/smartdown/api/previous_question_page.rb

@@ -0,0 +1,38 @@
+require 'smartdown/api/previous_question'
+
+module Smartdown
+  module Api
+    class PreviousQuestionPage
+
+      attr_reader :title
+
+      def initialize(node, responses)
+        node_elements = node.elements.clone
+        headings = node_elements.select {
+          |element| element.is_a? Smartdown::Model::Element::MarkdownHeading
+        }
+        @title = headings.first.content.to_s if headings.first
+        nb_questions = node_elements.select{ |element|
+          element.is_a? Smartdown::Model::Element::Question::MultipleChoice
+        }.count
+        if headings.count > nb_questions
+          node_elements.delete(headings.first) #Remove page title
+        end
+        @elements = node_elements
+        @responses = responses
+      end
+
+      def questions
+        elements.slice_before do |element|
+          element.is_a? Smartdown::Model::Element::MarkdownHeading
+        end.each_with_index.map do |question_element_group, index|
+          Smartdown::Api::PreviousQuestion.new(question_element_group, responses[index])
+        end
+      end
+
+      private
+
+      attr_reader :elements, :responses
+    end
+  end
+end

data/lib/smartdown/api/question.rb

@@ -2,57 +2,23 @@ module Smartdown
   module Api
     class Question
 
-      attr_reader :number
-
-      def initialize(elements, number=nil)
+      def initialize(elements)
         @elements = elements
-        @number = number
       end
 
-      #TODO: this assumes the title is the first element
       def title
         elements.first.content
       end
 
-      def has_body?
-        !!body
-      end
-
       def body
         elements_before_smartdown = elements[1..-1].take_while{|element| !smartdown_element?(element)}
         build_govspeak(elements_before_smartdown)
       end
 
-      def has_hint?
-        !!hint
-      end
-
-      #TODO: confirm we can delete this
-      # Usage TBC, most hints should actually be `body`s, semi-deprecated
-      # As we transition content we should better define it, or remove it
+      #TODO: deprecate
       def hint
       end
 
-      def prefix
-        "todo prefix"
-      end
-
-      def suffix
-        "todo suffix"
-      end
-
-      def subtitle
-        "todo subtitle"
-      end
-
-      #TODO
-      def error
-      end
-
-      #TODO: should not be needed
-      def responses
-      end
-
     private
 
       attr_reader :elements

data/lib/smartdown/api/question_page.rb

@@ -6,8 +6,10 @@ module Smartdown
       def questions
         elements.slice_before do |element|
           element.is_a? Smartdown::Model::Element::MarkdownHeading
-        end.each_with_index.map do |question_element_group, index|
-          Smartdown::Api::MultipleChoice.new(question_element_group, index+1)
+        end.map do |question_element_group|
+          if question_element_group.find{|element| element.is_a? Smartdown::Model::Element::Question::MultipleChoice}
+            Smartdown::Api::MultipleChoice.new(question_element_group)
+          end
         end
       end
     end

data/lib/smartdown/api/state.rb

@@ -1,4 +1,4 @@
-require 'smartdown/api/previous_question'
+require 'smartdown/api/previous_question_page'
 
 module Smartdown
   module Api
@@ -8,7 +8,7 @@ module Smartdown
 
       def initialize(current_node, previous_questionpage_smartdown_nodes, responses)
         @current_node = current_node
-        @previous_question_page_nodes = previous_questionpage_smartdown_nodes
+        @previous_questionpage_smartdown_nodes = previous_questionpage_smartdown_nodes
         @responses = responses
       end
 
@@ -20,29 +20,10 @@ module Smartdown
         current_node.is_a? Smartdown::Api::Outcome
       end
 
-      #TODO: refactor this :-O
-      def previous_questions
-        response_index = 0
-        previous_question_nodes.map.each_with_index do |previous_questions, node_index|
-          previous_questions.map.each_with_index do |previous_question, index|
-            previous_question = Smartdown::Api::PreviousQuestion.new(
-                previous_question_title_nodes[node_index][index].content,
-                previous_question,
-                responses[response_index],
-                index == 0
-            )
-            response_index+=1
-            previous_question
-          end
-        end.flatten
-      end
-
-      def previous_question_nodes
-        @previous_question_page_nodes.map(&:questions)
-      end
-
-      def previous_question_title_nodes
-        @previous_question_page_nodes.map(&:question_titles)
+      def previous_question_pages(responses)
+        previous_questionpage_smartdown_nodes.map do |smartdown_questionpage_node|
+          Smartdown::Api::PreviousQuestionPage.new(smartdown_questionpage_node, responses)
+        end
       end
 
       def current_question_number
@@ -51,7 +32,7 @@ module Smartdown
 
     private
 
-      attr_reader :smartdown_state, :previous_question_page_nodes
+      attr_reader :smartdown_state, :previous_questionpage_smartdown_nodes
 
     end
   end

data/lib/smartdown/engine/transition.rb

@@ -38,7 +38,7 @@ module Smartdown
       end
 
       def input_variable_names_from_question
-        questions = node.elements.select { |e| e.is_a?(Smartdown::Model::Element::MultipleChoice) }
+        questions = node.elements.select { |e| e.class.to_s.include?("Smartdown::Model::Element::Question") }
         questions.map(&:name)
       end
 

data/lib/smartdown/engine.rb

@@ -31,9 +31,8 @@ module Smartdown
         nb_questions = 0
         current_node = flow.node(state.get(:current_node))
         nb_questions += current_node.elements.select{|element|
-          element.is_a? Smartdown::Model::Element::MultipleChoice
+          element.class.to_s.include?("Smartdown::Model::Element::Question")
         }.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

data/lib/smartdown/model/element/question/multiple_choice.rb

@@ -0,0 +1,9 @@
+module Smartdown
+  module Model
+    module Element
+      module Question
+        MultipleChoice = Struct.new(:name, :choices)
+      end
+    end
+  end
+end

data/lib/smartdown/model/node.rb

@@ -8,15 +8,9 @@ module Smartdown
       end
 
       def questions
-        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)
+        elements.select do |element|
+          element.class.to_s.include?("Smartdown::Model::Element::Question")
+        end
       end
 
       def title

data/lib/smartdown/parser/node_transform.rb

@@ -4,7 +4,7 @@ require 'smartdown/model/front_matter'
 require 'smartdown/model/rule'
 require 'smartdown/model/nested_rule'
 require 'smartdown/model/next_node_rules'
-require 'smartdown/model/element/multiple_choice'
+require 'smartdown/model/element/question/multiple_choice'
 require 'smartdown/model/element/start_button'
 require 'smartdown/model/element/markdown_heading'
 require 'smartdown/model/element/markdown_paragraph'
@@ -56,7 +56,7 @@ module Smartdown
       }
 
       rule(:multiple_choice => {identifier: simple(:identifier), options: subtree(:choices)}) {
-        Smartdown::Model::Element::MultipleChoice.new(
+        Smartdown::Model::Element::Question::MultipleChoice.new(
           identifier, Hash[choices]
         )
       }

data/lib/smartdown/version.rb

@@ -1,3 +1,3 @@
 module Smartdown
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/acceptance/parsing_spec.rb

@@ -88,7 +88,7 @@ EXPECTED
       end
 
       it "has a multiple choice question" do
-        expect(question_node.questions).to match([instance_of(Smartdown::Model::Element::MultipleChoice)])
+        expect(question_node.questions).to match([instance_of(Smartdown::Model::Element::Question::MultipleChoice)])
       end
     end
   end

data/spec/engine/transition_spec.rb

@@ -165,7 +165,7 @@ describe Smartdown::Engine::Transition do
       Smartdown::Model::Node.new(
         current_node_name,
         [
-          Smartdown::Model::Element::MultipleChoice.new(question_name, {"a" => "Apple"}),
+          Smartdown::Model::Element::Question::MultipleChoice.new(question_name, {"a" => "Apple"}),
           Smartdown::Model::NextNodeRules.new(
             [Smartdown::Model::Rule.new(double("predicate1"), "o1")]
           )

data/spec/parser/element/multiple_choice_question_spec.rb

@@ -32,7 +32,7 @@ describe Smartdown::Parser::Element::MultipleChoiceQuestion do
         Smartdown::Parser::NodeInterpreter.new(node_name, source, parser: parser).interpret
       }
 
-      it { should eq(Smartdown::Model::Element::MultipleChoice.new("yes_or_no", {"yes"=>"Yes", "no"=>"No"})) }
+      it { should eq(Smartdown::Model::Element::Question::MultipleChoice.new("yes_or_no", {"yes"=>"Yes", "no"=>"No"})) }
     end
   end
 

data/spec/parser/node_parser_spec.rb

@@ -123,7 +123,7 @@ SOURCE
       let(:expected_elements) {
         [
           Smartdown::Model::Element::MarkdownHeading.new("This is my title"),
-          Smartdown::Model::Element::MultipleChoice.new("my_question", "yes"=>"Yes", "no"=>"No"),
+          Smartdown::Model::Element::Question::MultipleChoice.new("my_question", "yes"=>"Yes", "no"=>"No"),
           Smartdown::Model::Element::MarkdownHeading.new("Next node rules"),
           Smartdown::Model::NextNodeRules.new([
             Smartdown::Model::Rule.new(Smartdown::Model::Predicate::Named.new("pred1?"), "outcome")

data/spec/support/model_builder.rb

@@ -3,7 +3,7 @@ require 'smartdown/model/node'
 require 'smartdown/model/element/markdown_heading'
 require 'smartdown/model/element/markdown_paragraph'
 require 'smartdown/model/element/start_button'
-require 'smartdown/model/element/multiple_choice'
+require 'smartdown/model/element/question/multiple_choice'
 require 'smartdown/model/element/conditional'
 require 'smartdown/model/next_node_rules'
 require 'smartdown/model/rule'
@@ -48,7 +48,7 @@ class ModelBuilder
   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(name, options_with_string_keys)
+    @elements << Smartdown::Model::Element::Question::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("what_passport_do_you_have?", {"greek" => "Greek", "british" => "British"}),
+        Smartdown::Model::Element::Question::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?"),

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartdown
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.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: &20994400 !ruby/object:Gem::Requirement
+  requirement: &18315460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *20994400
+  version_requirements: *18315460
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20993600 !ruby/object:Gem::Requirement
+  requirement: &18314660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *20993600
+  version_requirements: *18314660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &20993000 !ruby/object:Gem::Requirement
+  requirement: &18314100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20993000
+  version_requirements: *18314100
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &20992380 !ruby/object:Gem::Requirement
+  requirement: &18313460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20992380
+  version_requirements: *18313460
 description: 
 email: david.heath@digital.cabinet-office.gov.uk
 executables:
@@ -89,6 +89,7 @@ files:
 - lib/smartdown/api/previous_question.rb
 - lib/smartdown/api/outcome.rb
 - lib/smartdown/api/multiple_choice.rb
+- lib/smartdown/api/previous_question_page.rb
 - lib/smartdown/version.rb
 - lib/smartdown/engine/node_presenter.rb
 - lib/smartdown/engine/state.rb
@@ -108,7 +109,7 @@ files:
 - lib/smartdown/model/element/start_button.rb
 - lib/smartdown/model/element/next_steps.rb
 - lib/smartdown/model/element/markdown_heading.rb
-- lib/smartdown/model/element/multiple_choice.rb
+- lib/smartdown/model/element/question/multiple_choice.rb
 - lib/smartdown/model/next_node_rules.rb
 - lib/smartdown/model/nested_rule.rb
 - lib/smartdown/model/rule.rb
@@ -167,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3595553799676610551
+      hash: -3191894024105276380
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -176,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3595553799676610551
+      hash: -3191894024105276380
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11

data/lib/smartdown/model/element/multiple_choice.rb

@@ -1,7 +0,0 @@
-module Smartdown
-  module Model
-    module Element
-      MultipleChoice = Struct.new(:name, :choices)
-    end
-  end
-end