smartdown 0.13.1 → 0.14.0

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (C) 2014 HM Government (Government Digital Service)
+Copyright (C) 2014 Crown Copyright (Government Digital Service)
 
 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

data/lib/smartdown/api/node.rb

@@ -2,13 +2,17 @@ module Smartdown
   module Api
     class Node
 
-      attr_reader :title ,:elements, :front_matter, :name
+      attr_reader :title ,:elements, :front_matter, :name, :markers
 
       def initialize(node)
         node_elements = node.elements.clone
         headings = node_elements.select { |element|
           element.is_a? Smartdown::Model::Element::MarkdownHeading
         }
+        markers = node_elements.select { |element|
+          element.is_a? Smartdown::Model::Element::Marker
+        }
+        markers.each { |marker| node_elements.delete(marker) }
         nb_questions = node_elements.select{ |element|
           element.class.to_s.include?("Smartdown::Model::Element::Question")
         }.count
@@ -16,6 +20,7 @@ module Smartdown
           node_elements.delete(headings.first) #Remove page title
           @title = headings.first.content.to_s
         end
+        @markers = markers
         @elements = node_elements
         @front_matter = node.front_matter
         @name = node.name
@@ -45,7 +50,7 @@ module Smartdown
     private
 
       def markdown_element?(element)
-        (element.is_a? Smartdown::Model::Element::MarkdownLine) || 
+        (element.is_a? Smartdown::Model::Element::MarkdownLine) ||
         (element.is_a? Smartdown::Model::Element::MarkdownHeading)
       end
 

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

@@ -0,0 +1,7 @@
+module Smartdown
+  module Model
+    module Element
+      Marker = Struct.new(:marker_name)
+    end
+  end
+end

data/lib/smartdown/model/scenarios/scenario.rb

@@ -1,7 +1,7 @@
 module Smartdown
   module Model
     module Scenarios
-      Scenario = Struct.new(:description, :question_groups, :outcome)
+      Scenario = Struct.new(:description, :question_groups, :outcome, :markers)
     end
   end
 end

data/lib/smartdown/parser/element/marker.rb

@@ -0,0 +1,18 @@
+require 'smartdown/parser/base'
+
+module Smartdown
+  module Parser
+    module Element
+      class Marker < Base
+        rule(:marker) {
+          str('{{marker: ') >>
+          identifier.as(:marker) >>
+          str('}}') >>
+          line_ending
+        }
+
+        root(:marker)
+      end
+    end
+  end
+end

data/lib/smartdown/parser/node_parser.rb

@@ -2,6 +2,7 @@ require 'smartdown/parser/base'
 require 'smartdown/parser/rules'
 require 'smartdown/parser/element/front_matter'
 require 'smartdown/parser/element/start_button'
+require 'smartdown/parser/element/marker'
 require 'smartdown/parser/element/multiple_choice_question'
 require 'smartdown/parser/element/date_question'
 require 'smartdown/parser/element/money_question'
@@ -30,6 +31,7 @@ module Smartdown
         Element::MoneyQuestion.new |
         Rules.new |
         Element::StartButton.new |
+        Element::Marker.new |
         Element::NextSteps.new |
         Element::MarkdownLine.new |
         Element::MarkdownBlankLine.new

data/lib/smartdown/parser/node_transform.rb

@@ -8,6 +8,7 @@ require 'smartdown/model/nested_rule'
 require 'smartdown/model/next_node_rules'
 require 'smartdown/model/element/question'
 require 'smartdown/model/element/start_button'
+require 'smartdown/model/element/marker'
 require 'smartdown/model/element/markdown_heading'
 require 'smartdown/model/element/markdown_line'
 require 'smartdown/model/element/conditional'
@@ -63,6 +64,10 @@ module Smartdown
         Smartdown::Model::Element::StartButton.new(start_node.to_s)
       }
 
+      rule(:marker => simple(:marker)) {
+        Smartdown::Model::Element::Marker.new(marker.to_s)
+      }
+
       rule(:front_matter => subtree(:attrs), body: subtree(:body)) {
         Smartdown::Model::Node.new(
           node_name, body, Smartdown::Model::FrontMatter.new(Hash[attrs])
@@ -226,12 +231,15 @@ module Smartdown
       rule(:rule => {predicate: subtree(:predicate), outcome: simple(:outcome_name) } ) {
         Smartdown::Model::Rule.new(predicate, outcome_name.to_s)
       }
+
       rule(:nested_rule => {predicate: subtree(:predicate), child_rules: subtree(:child_rules) } ) {
         Smartdown::Model::NestedRule.new(predicate, child_rules)
       }
+
       rule(:next_node_rules => subtree(:rules)) {
         Smartdown::Model::NextNodeRules.new(rules)
       }
+
     end
   end
 end

data/lib/smartdown/parser/scenario_set_interpreter.rb

@@ -0,0 +1,93 @@
+require "json"
+require "smartdown/model/scenarios/scenario_set"
+require "smartdown/model/scenarios/scenario"
+require "smartdown/model/scenarios/question"
+
+module Smartdown
+  module Parser
+    class ScenarioSetInterpreter
+      def initialize(scenario_string)
+        @scenario_lines = scenario_string.split("\n")
+      end
+
+      def scenario
+        Smartdown::Model::Scenarios::Scenario.new(
+          description,
+          question_groups,
+          outcome,
+          markers
+        )
+      end
+
+      def description_lines
+        @scenario_lines.select{ |line| line.start_with?("#") }
+      end
+
+      def description
+        description_lines.map do |description_line|
+          description_line[1..-1].strip
+        end.join(";")
+      end
+
+      def question_groups
+        lines = @scenario_lines - description_lines
+        if has_markers?
+          question_pages = group_questions_by_page(lines[0..-3])
+        else
+          question_pages = group_questions_by_page(lines[0..-2])
+        end
+        question_groups = question_pages.map { |question_page| interpret_question_page(question_page) }
+      end
+
+      def outcome
+        if has_markers?
+          @scenario_lines[@scenario_lines.size - 2]
+        else
+          @scenario_lines.last
+        end
+      end
+
+      def has_markers?
+        @scenario_lines.last.match(/(has markers:|has marker:)/)
+      end
+
+      def markers
+        if has_markers?
+          last_line = @scenario_lines.last
+          comma_sperated_markers = last_line.slice(last_line.index(":") + 1, last_line.size)
+          comma_sperated_markers.split(',').map(&:strip)
+        else
+          []
+        end
+      end
+
+    private
+
+      def group_questions_by_page(lines)
+        result = []
+        lines.each do |scenario_line|
+          if scenario_line.start_with?("-")
+            result << [scenario_line[1..-1]]
+          else
+            result.last << scenario_line
+          end
+        end
+        result
+      end
+
+      def interpret_question_page(question_page)
+        question_page.map { |question|
+          interpret_question(question)
+        }
+      end
+
+      def interpret_question(question_string)
+        name, answer = question_string.split(":").map(&:strip)
+        Smartdown::Model::Scenarios::Question.new(
+          name,
+          answer,
+        )
+      end
+    end
+  end
+end

data/lib/smartdown/parser/scenario_sets_interpreter.rb

@@ -1,6 +1,5 @@
 require "smartdown/model/scenarios/scenario_set"
-require "smartdown/model/scenarios/scenario"
-require "smartdown/model/scenarios/question"
+require "smartdown/parser/scenario_set_interpreter"
 
 module Smartdown
   module Parser
@@ -18,50 +17,9 @@ module Smartdown
       def interpret_scenario_set(scenario_set)
         Smartdown::Model::Scenarios::ScenarioSet.new(
           scenario_set.name,
-          scenario_set.read.split("\n\n").map { |scenario_string| interpret_scenario(scenario_string) }
-        )
-      end
-
-      def interpret_scenario(scenario_string)
-        scenario_lines = scenario_string.split("\n")
-        description_lines = scenario_lines.select{ |line| line.start_with?("#") }
-        description = description_lines.map { |description_line|
-          description_line[1..-1].strip
-        }.join(";")
-        scenario_lines = scenario_lines - description_lines
-        outcome = scenario_lines.last
-        question_pages = group_questions_by_page(scenario_lines[0..-2])
-        question_groups = question_pages.map { |question_page| interpret_question_page(question_page) }
-        Smartdown::Model::Scenarios::Scenario.new(
-          description,
-          question_groups,
-          outcome,
-        )
-      end
-
-      def group_questions_by_page(scenario_lines)
-        result = []
-        scenario_lines.each do |scenario_line|
-          if scenario_line.start_with?("-")
-            result << [scenario_line[1..-1]]
-          else
-            result.last << scenario_line
+          scenario_set.read.split("\n\n").map do |scenario_string|
+            ScenarioSetInterpreter.new(scenario_string).scenario
           end
-        end
-        result
-      end
-
-      def interpret_question_page(question_page)
-        question_page.map { |question|
-          interpret_question(question)
-        }
-      end
-
-      def interpret_question(question_string)
-        name, answer = question_string.split(":").map(&:strip)
-        Smartdown::Model::Scenarios::Question.new(
-          name,
-          answer,
         )
       end
     end

data/lib/smartdown/version.rb

@@ -1,3 +1,3 @@
 module Smartdown
-  VERSION = "0.13.1"
+  VERSION = "0.14.0"
 end

data/spec/api/node_spec.rb

@@ -16,15 +16,11 @@ describe Smartdown::Api::Node do
   let(:front_matter) { Smartdown::Model::FrontMatter.new({}) }
   let(:node_model) { Smartdown::Model::Node.new(node_name, elements, front_matter) }
 
-  let(:next_node_rules_content) { 
-    %{ Rule 1: Do not talk about Fight Club.
-       Rule 2: Do not talk about Fight Club.
-       Rule 3: If someone says "stop" or goes limp, taps out the fight is over.
-       Rule 4: Only two guys to a fight.
-       Rule 5: One fight at a time.
-       Rule 6: No shirts, no shoes.
-       Rule 7: Fights will go on as long as they have to.
-       Rule 8: If this is your first night at Fight Club, you have to fight.} }
+  let(:next_node_rules_content) {
+    %{ Rule 1: Is a rule
+       Rule 2: Is another rule }
+  }
+
   let(:next_node_rules) { Smartdown::Model::NextNodeRules.new(next_node_rules_content) }
 
   let(:question_element) {
@@ -39,10 +35,10 @@ describe Smartdown::Api::Node do
   let(:node_heading_content) { "hehehe" }
   let(:node_heading) { Smartdown::Model::Element::MarkdownHeading.new(node_heading_content) }
 
-  let(:question_heading_content) { "Do you feel lucky?" }
+  let(:question_heading_content) { "Is this a question?" }
   let(:question_heading) { Smartdown::Model::Element::MarkdownHeading.new(question_heading_content) }
 
-  let(:body_content) { "I <3 bodyshopping" }
+  let(:body_content) { "Body" }
   let(:body_elements) {
     Smartdown::Model::Elements.new(
       [
@@ -52,14 +48,14 @@ describe Smartdown::Api::Node do
     )
   }
 
-  let(:post_body_content) { "hur hur such content" }
+  let(:post_body_content) { "content" }
   let(:post_body_elements) {
     Smartdown::Model::Elements.new(
       [Smartdown::Model::Element::MarkdownLine.new(post_body_content)]
     )
   }
 
-  let(:other_post_body_content) { "Postman Pat and his black and white cat" }
+  let(:other_post_body_content) { "Post Body Content" }
   let(:other_post_body_elements) {
     Smartdown::Model::Elements.new(
       [
@@ -69,6 +65,7 @@ describe Smartdown::Api::Node do
     )
   }
 
+  let(:marker) { Smartdown::Model::Element::Marker.new("Content Marker") }
 
   context "with a body and post_body (and next node rules)" do
     let(:elements) { [node_heading, body_elements, question_heading, question_element, post_body_elements, other_post_body_elements, next_node_rules] }
@@ -157,4 +154,14 @@ describe Smartdown::Api::Node do
     end
   end
 
+  context "with a marker" do
+    let(:elements) { [node_heading, question_heading, question_element, marker] }
+
+    describe "#markers" do
+      it 'returns the markers' do
+        expect(node.markers).to eq([Smartdown::Model::Element::Marker.new("Content Marker")])
+      end
+    end
+  end
+
 end

data/spec/fixtures/acceptance/animal-example-simple/outcomes/outcome_safe_pet.txt

@@ -1,11 +1,19 @@
 # You picked a safe pet
 
-Good call.
+{{marker: is_a_safe_pet}}
 
 # Markdown/Govspeak examples
 
+$IF question_1 is 'cat'
+
+{{marker: safe_pets_are_cool}}
+
+$ENDIF
+
+Good call.
 ## H2 example
 
+
 With answers, that are smart. Down with that?
 
 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod

data/spec/fixtures/acceptance/animal-example-simple/scenarios/tigers_and_cats.txt

@@ -2,3 +2,4 @@
 # And cats are amazing
 - question_1: cat
 outcome_safe_pet
+has markers: is_a_safe_pet, safe_pets_are_cool

data/spec/parser/element/marker_spec.rb

@@ -0,0 +1,30 @@
+require 'smartdown/parser/element/marker'
+require 'smartdown/parser/node_parser'
+require 'smartdown/parser/node_interpreter'
+
+describe Smartdown::Parser::Element::Marker do
+  subject(:parser) { described_class.new }
+
+  it "parses a marker with a marker name" do
+    should parse("{{marker: hello_there}}").as({marker: "hello_there"})
+    should parse("{{marker: hello_there}}\n").as({marker: "hello_there"})
+  end
+
+  it "requires a name" do
+    should_not parse("{{marker:}}")
+  end
+
+  it "does not allow spaces in name" do
+    should_not parse("{{marker: hello there}}")
+  end
+
+  describe "transformed" do
+    let(:node_name) { "my_node" }
+    let(:source) { "{{marker: hello_there}}\n" }
+    subject(:transformed) {
+      Smartdown::Parser::NodeInterpreter.new(node_name, source, parser: parser).interpret
+    }
+
+    it { should eq(Smartdown::Model::Element::Marker.new("hello_there")) }
+  end
+end

data/spec/parser/scenario_set_interpreter_spec.rb

@@ -0,0 +1,24 @@
+require 'smartdown/parser/scenario_set_interpreter'
+
+describe Smartdown::Parser::ScenarioSetInterpreter do
+  let(:outcome) { File.open(File.dirname(__FILE__) + "/../fixtures/acceptance/animal-example-simple/scenarios/tigers_and_cats.txt", "rb").read }
+  subject { described_class.new(outcome) }
+
+  describe "#description" do
+    it { expect(subject.description).to eq("User has a cat;And cats are amazing") }
+  end
+
+  describe "#question_groups" do
+    it { expect(subject.question_groups).to eq([ [ Smartdown::Model::Scenarios::Question.new("question_1", "cat") ] ]) }
+  end
+
+  describe "#outcome" do
+    it { expect(subject.outcome).to eq("outcome_safe_pet") }
+  end
+
+  describe "#markers" do
+    it { expect(subject.markers).to eq(["is_a_safe_pet", "safe_pets_are_cool"]) }
+  end
+
+
+end

data/spec/parser/scenario_sets_interpreter_spec.rb

@@ -0,0 +1,38 @@
+require 'smartdown'
+require 'smartdown/parser/scenario_sets_interpreter'
+
+describe Smartdown::Parser::ScenarioSetsInterpreter do
+  def fixture(name)
+    File.dirname(__FILE__) + "/../fixtures/acceptance/#{name}/#{name}.txt"
+  end
+
+  let(:input) { Smartdown::Parser::DirectoryInput.new(fixture("animal-example-simple")) }
+  subject(:scenario_sets) { described_class.new(input).interpret }
+
+
+  context "flow with one question per page" do
+    it "has two scenario_sets" do
+      expect(scenario_sets.size).to eq(2)
+    end
+
+    it "has scenario_set names" do
+      expect(scenario_sets.map(&:name)).to match_array(["lions", "tigers_and_cats"])
+    end
+
+    it "has scenarios with description, questions, markers and outcome" do
+      tigers_and_cats_scenario_set = scenario_sets.find { |scenario_set| scenario_set.name == "tigers_and_cats" }
+      expect(tigers_and_cats_scenario_set.scenarios.size).to eq(1)
+      expect(tigers_and_cats_scenario_set.scenarios.first.description).to eq("User has a cat;And cats are amazing")
+      expect(tigers_and_cats_scenario_set.scenarios.first.question_groups.size).to eq(1)
+      expect(tigers_and_cats_scenario_set.scenarios.first.outcome).to eq("outcome_safe_pet")
+      expect(tigers_and_cats_scenario_set.scenarios.first.markers).to eq(['is_a_safe_pet', 'safe_pets_are_cool'])
+    end
+
+    it "has scenario questions with name and answer" do
+      tigers_and_cats_scenario_set = scenario_sets.find { |scenario_set| scenario_set.name == "tigers_and_cats" }
+      tigers_and_cats_scenario = tigers_and_cats_scenario_set.scenarios.first
+      expect(tigers_and_cats_scenario.question_groups.first.first.name).to eq("question_1")
+      expect(tigers_and_cats_scenario.question_groups.first.first.answer).to eq("cat")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartdown
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-19 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
-  requirement: &12661260 !ruby/object:Gem::Requirement
+  requirement: &23997380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.2
   type: :runtime
   prerelease: false
-  version_requirements: *12661260
+  version_requirements: *23997380
 - !ruby/object:Gem::Dependency
   name: uk_postcode
-  requirement: &12660740 !ruby/object:Gem::Requirement
+  requirement: &23996560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *12660740
+  version_requirements: *23996560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &12660200 !ruby/object:Gem::Requirement
+  requirement: &24022840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *12660200
+  version_requirements: *24022840
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &12659780 !ruby/object:Gem::Requirement
+  requirement: &24022300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12659780
+  version_requirements: *24022300
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &12659200 !ruby/object:Gem::Requirement
+  requirement: &24021740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12659200
+  version_requirements: *24021740
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &12658640 !ruby/object:Gem::Requirement
+  requirement: &24021220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12658640
+  version_requirements: *24021220
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &12658200 !ruby/object:Gem::Requirement
+  requirement: &24020020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12658200
+  version_requirements: *24020020
 description: 
 email: david.heath@digital.cabinet-office.gov.uk
 executables:
@@ -101,6 +101,7 @@ files:
 - lib/smartdown/parser/node_transform.rb
 - lib/smartdown/parser/question.rb
 - lib/smartdown/parser/node_interpreter.rb
+- lib/smartdown/parser/scenario_set_interpreter.rb
 - lib/smartdown/parser/snippet_pre_parser.rb
 - lib/smartdown/parser/base.rb
 - lib/smartdown/parser/input_set.rb
@@ -114,6 +115,7 @@ files:
 - lib/smartdown/parser/element/postcode_question.rb
 - lib/smartdown/parser/element/money_question.rb
 - lib/smartdown/parser/element/conditional.rb
+- lib/smartdown/parser/element/marker.rb
 - lib/smartdown/parser/element/start_button.rb
 - lib/smartdown/parser/element/front_matter.rb
 - lib/smartdown/parser/element/country_question.rb
@@ -178,6 +180,7 @@ files:
 - lib/smartdown/model/answer/text.rb
 - lib/smartdown/model/element/question.rb
 - lib/smartdown/model/element/conditional.rb
+- lib/smartdown/model/element/marker.rb
 - lib/smartdown/model/element/start_button.rb
 - lib/smartdown/model/element/markdown_line.rb
 - lib/smartdown/model/element/next_steps.rb
@@ -203,13 +206,16 @@ files:
 - spec/parser/base_spec.rb
 - spec/parser/input_set_spec.rb
 - spec/parser/rules_spec.rb
+- spec/parser/scenario_set_interpreter_spec.rb
 - spec/parser/predicates_spec.rb
+- spec/parser/scenario_sets_interpreter_spec.rb
 - spec/parser/element/postcode_question_spec.rb
 - spec/parser/element/next_steps_spec.rb
 - spec/parser/element/multiple_choice_question_spec.rb
 - spec/parser/element/country_question_spec.rb
 - spec/parser/element/conditional_spec.rb
 - spec/parser/element/start_button_parser_spec.rb
+- spec/parser/element/marker_spec.rb
 - spec/parser/element/date_question_spec.rb
 - spec/parser/element/markdown_heading_spec.rb
 - spec/parser/element/front_matter_spec.rb
@@ -309,7 +315,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1413061790039635549
+      hash: -4151966028766809979
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -318,7 +324,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1413061790039635549
+      hash: -4151966028766809979
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -334,13 +340,16 @@ test_files:
 - spec/parser/base_spec.rb
 - spec/parser/input_set_spec.rb
 - spec/parser/rules_spec.rb
+- spec/parser/scenario_set_interpreter_spec.rb
 - spec/parser/predicates_spec.rb
+- spec/parser/scenario_sets_interpreter_spec.rb
 - spec/parser/element/postcode_question_spec.rb
 - spec/parser/element/next_steps_spec.rb
 - spec/parser/element/multiple_choice_question_spec.rb
 - spec/parser/element/country_question_spec.rb
 - spec/parser/element/conditional_spec.rb
 - spec/parser/element/start_button_parser_spec.rb
+- spec/parser/element/marker_spec.rb
 - spec/parser/element/date_question_spec.rb
 - spec/parser/element/markdown_heading_spec.rb
 - spec/parser/element/front_matter_spec.rb