smartdown 0.1.0 → 0.1.1

data/lib/smartdown/api/coversheet.rb

@@ -0,0 +1,7 @@
+require 'smartdown/api/node'
+module Smartdown
+  module Api
+    class Coversheet < Node
+    end
+  end
+end

data/lib/smartdown/api/directory_input.rb

@@ -0,0 +1,11 @@
+require 'smartdown/parser/directory_input'
+
+module Smartdown
+  module Api
+    class DirectoryInput < Smartdown::Parser::DirectoryInput
+      def initialize(coversheet_path)
+        super(coversheet_path)
+      end
+    end
+  end
+end

data/lib/smartdown/api/flow.rb

@@ -0,0 +1,119 @@
+require 'smartdown'
+require 'smartdown/engine'
+require 'smartdown/api/state'
+require 'smartdown/api/coversheet'
+require 'smartdown/api/question_page'
+require 'smartdown/api/outcome'
+
+module Smartdown
+  module Api
+    class Flow
+
+      def initialize(smartdown_input)
+        @smartdown_flow = Smartdown::Parser::FlowInterpreter.new(smartdown_input).interpret
+        @engine = Smartdown::Engine.new(@smartdown_flow)
+      end
+
+      def state(started, responses)
+        state = smartdown_state(started, responses)
+        State.new(transform_node(node_by_name(state.get(:current_node))),
+                  previous_question_nodes_for(state),
+                  responses
+        )
+      end
+
+      def name
+        @smartdown_flow.name
+      end
+
+      def title
+        coversheet.title
+      end
+
+      def meta_description
+        front_matter.meta_description
+      end
+
+      def need_id
+        front_matter.satisfies_need
+      end
+
+      def status
+        front_matter.status
+      end
+
+      def draft?
+        status == 'draft'
+      end
+
+      def transition?
+        status == 'transition'
+      end
+
+      def published?
+        status == 'published'
+      end
+
+      def nodes
+        @smartdown_flow.nodes.map{ |node| transform_node(node) }
+          .select{ |node| (node.is_a? Smartdown::Api::QuestionPage) ||
+                          (node.is_a? Smartdown::Api::Outcome)
+        }
+      end
+
+      def question_pages
+        nodes.select{ |node| node.is_a? Smartdown::Api::QuestionPage }
+      end
+
+      def outcomes
+        nodes.select{ |node| node.is_a? Smartdown::Api::Outcome}
+      end
+
+    private
+
+      def transform_node(node)
+        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}
+            Smartdown::Api::QuestionPage.new(node)
+          else
+            #TODO: support other types of questions
+          end
+        else
+          Smartdown::Api::Outcome.new(node)
+        end
+      end
+
+      def coversheet
+        @coversheet ||= Smartdown::Api::Coversheet.new(@smartdown_flow.coversheet)
+      end
+
+      def front_matter
+        @front_matter ||= coversheet.front_matter
+      end
+
+      def smartdown_state(started, responses)
+        smartdown_responses = responses.clone
+        if started
+          smartdown_responses.unshift('y')
+        end
+        @engine.process(smartdown_responses)
+      end
+
+      def node_by_name(node_name)
+        @smartdown_flow.node(node_name)
+      end
+
+      def previous_question_nodes_for(state)
+        node_path = state.get('path')
+        return [] if node_path.empty?
+
+        node_path[1..-1].map do |node_name|
+          node_by_name(node_name)
+        end
+      end
+
+    end
+  end
+end

data/lib/smartdown/api/multiple_choice.rb

@@ -0,0 +1,25 @@
+require 'smartdown/api/question'
+
+module Smartdown
+  module Api
+    class MultipleChoice < Question
+      def options
+        question = elements.find{|element| element.is_a? Smartdown::Model::Element::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.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

@@ -0,0 +1,67 @@
+module Smartdown
+  module Api
+    class Node
+
+      attr_reader :title ,:elements, :front_matter, :name
+
+      def initialize(node)
+        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
+        node_elements.delete(headings.first) #Remove page title
+        @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)
+      end
+
+      def next_nodes
+        elements.select{ |element| element.is_a? Smartdown::Model::NextNodeRules }
+      end
+
+      def permitted_next_nodes
+        next_nodes
+      end
+
+    private
+
+      def markdown_element?(element)
+        (element.is_a? Smartdown::Model::Element::MarkdownParagraph) || (element.is_a? Smartdown::Model::Element::MarkdownHeading)
+      end
+
+      def smartdown_element?(element)
+        !markdown_element?(element)
+      end
+
+      def build_govspeak(elements)
+        markdown_elements = elements.select do |element|
+          markdown_element?(element)
+        end
+        GovspeakPresenter.new(markdown_elements.map(&:content).join("\n")).html
+      end
+    end
+  end
+end

data/lib/smartdown/api/outcome.rb

@@ -0,0 +1,16 @@
+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
+      end
+
+    end
+  end
+end

data/lib/smartdown/api/previous_question.rb

@@ -0,0 +1,31 @@
+module Smartdown
+  module Api
+    class PreviousQuestion
+
+      attr_reader :response, :title
+
+      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
+
+      #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)
+      end
+
+    end
+  end
+end

data/lib/smartdown/api/question.rb

@@ -0,0 +1,76 @@
+module Smartdown
+  module Api
+    class Question
+
+      attr_reader :number
+
+      def initialize(elements, number=nil)
+        @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
+      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
+
+      def markdown_element?(element)
+        (element.is_a? Smartdown::Model::Element::MarkdownParagraph) || (element.is_a? Smartdown::Model::Element::MarkdownHeading)
+      end
+
+      def smartdown_element?(element)
+        !markdown_element?(element)
+      end
+
+      def build_govspeak(elements)
+        markdown_elements = elements.select do |element|
+          markdown_element?(element)
+        end
+        GovspeakPresenter.new(markdown_elements.map(&:content).join("\n")).html
+      end
+    end
+  end
+end

data/lib/smartdown/api/question_page.rb

@@ -0,0 +1,15 @@
+require 'smartdown/api/multiple_choice'
+
+module Smartdown
+  module Api
+    class QuestionPage < Node
+      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
+      end
+    end
+  end
+end

data/lib/smartdown/api/state.rb

@@ -0,0 +1,58 @@
+require 'smartdown/api/previous_question'
+
+module Smartdown
+  module Api
+    class State
+
+      attr_reader :responses, :current_node
+
+      def initialize(current_node, previous_questionpage_smartdown_nodes, responses)
+        @current_node = current_node
+        @previous_question_page_nodes = previous_questionpage_smartdown_nodes
+        @responses = responses
+      end
+
+      def started?
+        !current_node.is_a? Smartdown::Api::Coversheet
+      end
+
+      def finished?
+        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)
+      end
+
+      def current_question_number
+        responses.count + 1
+      end
+
+    private
+
+      attr_reader :smartdown_state, :previous_question_page_nodes
+
+    end
+  end
+end

data/lib/smartdown/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   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: &10785560 !ruby/object:Gem::Requirement
+  requirement: &20994400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *10785560
+  version_requirements: *20994400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10784820 !ruby/object:Gem::Requirement
+  requirement: &20993600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *10784820
+  version_requirements: *20993600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10784240 !ruby/object:Gem::Requirement
+  requirement: &20993000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10784240
+  version_requirements: *20993000
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &10783580 !ruby/object:Gem::Requirement
+  requirement: &20992380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10783580
+  version_requirements: *20992380
 description: 
 email: david.heath@digital.cabinet-office.gov.uk
 executables:
@@ -79,6 +79,16 @@ files:
 - lib/smartdown/parser/element/next_steps.rb
 - lib/smartdown/parser/element/markdown_heading.rb
 - lib/smartdown/parser/flow_interpreter.rb
+- lib/smartdown/api/coversheet.rb
+- lib/smartdown/api/question.rb
+- lib/smartdown/api/flow.rb
+- lib/smartdown/api/question_page.rb
+- lib/smartdown/api/state.rb
+- lib/smartdown/api/node.rb
+- lib/smartdown/api/directory_input.rb
+- lib/smartdown/api/previous_question.rb
+- lib/smartdown/api/outcome.rb
+- lib/smartdown/api/multiple_choice.rb
 - lib/smartdown/version.rb
 - lib/smartdown/engine/node_presenter.rb
 - lib/smartdown/engine/state.rb
@@ -157,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -476092451501996578
+      hash: 3595553799676610551
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -166,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -476092451501996578
+      hash: 3595553799676610551
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11