smartdown 0.11.2 → 0.11.3

data/README.md

@@ -1,444 +1,131 @@
 # Smartdown [![Build Status](https://travis-ci.org/alphagov/smartdown.svg?branch=master)](https://travis-ci.org/alphagov/smartdown)
 
-Smartdown is an [external
-DSL](http://www.martinfowler.com/bliki/DomainSpecificLanguage.html) for
-representing a series of questions and logical rules which determine the order
-in which the questions are asked, according to user input.
+Smartdown is a [custom formatting language](http://www.martinfowler.com/bliki/DomainSpecificLanguage.html) designed to generate HTML formatted questions. These questions can then be joined in a manner that articulates a full user journey.
 
-The language is designed to look like
-[Markdown](http://daringfireball.net/projects/markdown/), with some extensions
-to allow expression of logical rules, questions and conditional blocks of
-text.
+Implementation details for each kind of question can be found in the [documentation directory](doc).
 
-## Overview
-
-A single smartdown flow has a cover sheet, a set of questions, a set of
-outcomes and a set of test scenarios. Cover sheets, questions and outcomes are
-all types of node. A node represents a single user interaction (normally a web
-page, but in other media may be presented differently).
-
-Each question and outcome is held in a separate file. The name of the files
-are used to identify each question. Here's an example of the check-uk-visa
-flow:
-
-```
--- check-uk-visa
-   |-- outcomes
-   |   |-- general_y.txt
-   |   |-- joining_family_m.txt
-   |   |-- joining_family_y.txt
-   |   |-- marriage.txt
-   |   |-- medical_n.txt
-   |   |-- medical_y.txt
-   |   `-- ...
-   |-- scenarios
-   |   |-- 1.txt
-   |   |-- 2.txt
-   |   `-- 3.txt
-   |-- questions
-   |   |-- planning_to_leave_airport.txt
-   |   |-- purpose_of_visit.txt
-   |   |-- staying_for_how_long.txt
-   |   |-- what_passport_do_you_have.txt
-   `-- check-uk-visa.txt
-```
-
-## General node file syntax
-
-Each file has three parts: front-matter, a model definition, rules/logic. Only the model definition is required.
-
-* **front-matter** defines metadata in the form `property: value`. Note: this
-  does not support full YAML syntax.
-* the **model definition* is a markdown-like block which defines a flow,
-  question or outcome.
-* **rules/logic** defines 'next node' transition rules or other
-  logic/predicate definitions
-
-## Cover sheet node
-
-The cover sheet starts the flow off, its filename should match the flow name,
-e.g. 'check-uk-visa.txt'.
-
-It has initial 'front matter' which defines metadata for the flow. It then
-defines the copy for the cover sheet in markdown format. The h1 title is
-compulsory and used as the title for the smart answer.
-
-A start button determines which question node is presented first.
-
-```
-meta_description: You may need a visa to come to the UK to visit, study or work.
-satisfies_need: 100982
-
-# Check if you need a UK visa
-
-You may need a visa to come to the UK to visit, study or work.
-
-[start_button: what_passport_do_you_have]
-```
-
-## Question nodes
-
-Question nodes follow the same standard structure outlined above.
-
-Smartdown currently allows multiple questions to be defined per node, but this
-feature has only [recently been introduced](CHANGELOG.md#010) and may still change.
-
-The next sections define the various question types available.
-
-Note that at present only the 'choice' question type has been implemented.
-Unimplemented question types are marked with **(tbd)** in the heading. For
-these question types, consider this documentation to be a proposal of how they
-might work.
-
-### "Choice" questions (aka. radio buttons)
-
-A choice question allows the user to select a single option from a list of choices.
-
-```markdown
-## Will you pass through UK Border Control?
-
-You might pass through UK Border Control even if you don't leave the airport -
-eg your bags aren't checked through and you need to collect them before transferring
-to your outbound flight.
-
-[choice: uk_border_control]
-* yes: Yes
-* no: No
-```
-
-### 'Country' question
-
-A 'country' question allows the user to select a country from a drop-down list.
-
-```markdown
-## Where do you want to get married?
-
-[country: marriage_country, countries: all_countries]
-```
-
-Where `all_countries` is the name of a data-plugin method that will return a hash of
-country slugs/names.
-
-### Date
-
-```markdown
-## What is the baby’s due date?
-
-[date: baby_due_date]
-```
-
-To control the range of years selected you can supply 2 optional arguments to date questions: `from` and `to`.
-These can take the form of absolute values, eg.
-
-```markdown
-[date: baby_due_date, from: 2010, to: 2015]
-```
-
-Or relative values (from the current year), eg.
-
-```markdown
-[date: baby_due_date, from: -4, to: 1]
-```
-
-The default values for `from` and `to` are relative years: `-1` and `3` respectively.
-
-### Text
-
-```markdown
-[text: text_value]
-```
-
-Asks for an arbitrary text input.
-
-### Salary
-
-```markdown
-[salary: salary_value]
-```
-
-## Aliases
-
-An alias lets you referrer to any question identifier by its question intentifer or its alias.
-
-```markdown
-## Are you Clark Kent?
-
-[choice: clark_kent, alias: superman]
-* yes: Yes
-* no: No
-```
-
-## Next steps
-
-Markdown to be displayed as part of an outcome to direct the users to other information of potential interest to them.
-
-```markdown
-[next_steps]
-* Any kind of markdown
-[A link](https://gov.uk/somewhere)
-[end_next_steps]
-```
-
-## Next node rules
-
-Logical rules for transitioning to the next node are defined in 'Next node' section. This is declared using a markdown h1 'Next node'.
-
-There are two constructs for defining rules:
-
-```
-# Next node
-
-* predicate => outcome
-```
-
-defines a conditional transition
-
-```
-# Next node
-
-* reddish?
-  * yellowish? => orange
-  * blueish? => purple
-```
-
-defines nested rules.
-
-In the example above the node `orange` would be selected if both `reddish?` and `yellowish?` were true.
-
-## Predicates
-
-As well as 'named' predicates which might be defined by a plugin or other
-mechanism, there's also a basic expression language for predicates.
-
-The currently supported operations are:
-
-```
-variable_name is 'string'
-variable_name in {this that the-other}
-```
-
-### Date comparison predicates (tbd)
-
-```
-date_variable_name >= '14/07/2014'
-date_variable_name < '14/07/2014'
-```
-
-### Logical connectives
-
-There are operators that can be used to combine predicates, or invert
-their value. Namely NOT, OR and AND.
-
-eg.
-
-```
-variable_name is 'string' OR NOT variable name is 'date'
-```
-
-`OR` connectives join a sequence of predicates and will return true if
-any of them evaluate to true, otherwise false.
-
-`AND` connectives join a sequence of predicates and will return true if
-all of them evaluate to true, otherwise false.
-
-`NOT` connectives will invert the return value of a predicate. ie turn
-true to false and vice versa. They have high precedence so bind to a single
-predicate in chain eg in:
-
-```
-NOT variable_name is 'lovely name' OR variable_name is 'special name'
-```
-
-The implied parentheses around the experssion are:
-
-```
-(NOT variable_name is 'lovely name') OR variable_name is 'special name'
-```
-
-For more information on Logical Connectives see:
-
-http://en.wikipedia.org/wiki/Logical_connective
-
-
-## Processing model
-
-Each response to a question is assigned to a variable which corresponds to the
-question name (as determined by the filename).
-
-## Conditional blocks in outcomes
-
-The syntax is:
-
-```markdown
-
-$IF pred?
-
-Text if true
-
-more text if you like
-
-$ENDIF
-```
-
-You can also have an else clause:
-
-```markdown
-
-$IF pred?
-
-Text if true
-
-$ELSE
-
-Text if false
-
-$ENDIF
-```
-
-It's required to have a blank line between each if statement and the next paragraph of text, in other words this would be **invalid**:
-
-```markdown
-
-$IF pred?
-Text if true
-$ENDIF
-```
+For example:
 
-Similarly, it is also possible to specify an elseif clause. These can be
-chained together indefinitely. It is also possible to keep an else
-clause at the end like so:
 
 ```markdown
-$IF pred1?
-
-Text if pred1 true
-
-$ELSEIF pred2?
-
-Text if pred1 false and pred2 true
-
-$ELSEIF pred3?
-
-Text if pred1 and pred2 false, and pred3 true
-
-$ELSE
-
-Text if pred1, pred2, pred3 are false
-
-$ENDIF
-```
-
-It is also possible to nest if statements: like so.
+  # A Formatting and Logic Language
 
-```markdown
+  Smartdown helps GOV.UK users find the information they need without
+  having to search through daunting official documentation.
 
-$IF pred1?
+  ## Some extra information you need to know before you start
 
-$IF pred2?
+  * Like bullet points
+  * Can be used
+  * Throughout this journey
 
-Text if both true
+  [start: step_1]
 
-$ENDIF
+  ## Additional context after a start button
 
-$ENDIF
+  Any more information down here
 ```
 
-## Interpolation
+Will produce:
 
-It's possible to interpolate values from calculations, responses to questions, plugins etc.
+```html
+<div id="js-replaceable">
 
-Interpolations are currently supported into headings and paragraphs using the following syntax:
+  <header class="page-header group">
+    <div>
+      <h1>
+        A formatting and Logic Language
+      </h1>
+    </div>
+  </header>
 
-```markdown
+  <div class="article-container group">
+    <article role="article" class="group">
+      <div class="inner">
+        <div class="intro">
+          <p>Smartdown helps GOV.UK users find the information they need
+          without having to search through daunting official
+          documentation.</p>
 
-# State pension age calculation for %{name}
+          <h2 id="some-extra-information-you-need-to-know-before-you-start">
+            Some extra information you need to know before you start
+          </h2>
 
-Your state pension age is %{state_pension_age}.
-```
+          <ul>
+            <li>Like bullet points</li>
+            <li>Can be used</li>
+            <li>Throughout this journey</li>
+          </ul>
 
-## Snippets
+          <p class="get-started">
+            <a rel="nofollow" href="/step-1/y" class="big button">
+              Start now
+            </a>
+          </p>
+        </div>
 
-Snippets work like partials, to re-use common text. They can be block or inline,
-can be called recursivelty and can contain interpolation and conditional logic
+        <h2 id="additional-context-after-a-start-button">
+          Additional context after a start button
+        </h2>
+        <p>Any more information down here</p>
 
-They're called like so:
+      </div>
+    </article>
+  </div>
 
+</div>
 ```
-## My header
-
-Markdown copy..
 
-{{snippet: my_snippet}}
+Which on GOV.UK will look like:
 
-More copy...
-```
+![](http://cl.ly/image/1V3e042P0s0h/Screen%20Shot%202014-12-03%20at%2017.50.55.png)
 
-Where `snippet_name` is in a `snippets/` directory in the flow root with a `.txt`
-extension, eg `my-flow-name/snippets/my_snippet.txt`.
 
-The contents of `my_snippet` will be inserted into the outcome/question.
-
-###Snippet Organisation
-
-You can organise related snippets into a sub-directory of arbitrary depth
-
-For example:
-
-```
-## My header
+The language is designed to look like [Markdown](http://daringfireball.net/projects/markdown/), but it has been extended to allow you to write in logic rules, questions and conditional blocks of text.
 
-Markdown copy..
-
-{{snippet: my_sub_directory/my_snippet}}
-
-More copy...
-```
-Where `snippet_name` is in a `snippets/` directory in the flow root with a `.txt` extension, eg `my-flow-name/snippets/my_sub_directory/my_snippet.txt`.
-
-## Scenarios
+## Overview
 
-Scenarios are meant to be run as test to check that a Smartdown flow behaves
-in a certain way given some input data.
+A single smartdown flow has a [Start Page](doc/start-pages.md), a set of [Questions](doc/questions.md),
+[Outcomes](doc/outcomes.md) and a set of [Test Scenarios](doc/scenarios.md).
 
-###Scenario files
+Start Pages, Questions and Outcomes are all a type of 'node'.
+A node represents a single user interaction (normally a web page, but in other media may be presented differently).
 
-There can be as many scenario files as one wishes, with no restriction on name. Each
-scenario file should contain scenarios written as documented below.
+Each question and outcome is held in its own file. The name of the files are significant: they are used to identify each question.
 
-###Format
 
-Each scenario is made of:
-* a description (optional)
-* list of questions pages (each question page starts with a -), inside which questions to answers are defined
-* name of the outcome
+Here's an example of the check-uk-visa flow:
 
 ```
-# Description
-- name_of_q1_p1: answer_to_q1_p1
-- name_of_q1_p2: answer_to_q1_p2
-  name_of_q2_p2: answer_to_q2_p2
-outcome_the_result
-
-# Descriptions
-# can have several lines
-- name_of_q1_p1: answer_to_q1_p1_2
-- name_of_q1_p3: answer_to_q1_p3
-  name_of_q2_p3: answer_to_q2_p3
-outcome_the_other_result
+-- check-uk-visa
+   |-- outcomes
+   |   |-- general_y.txt
+   |   |-- joining_family_m.txt
+   |   |-- joining_family_y.txt
+   |   |-- marriage.txt
+   |   |-- medical_n.txt
+   |   |-- medical_y.txt
+   |   `-- ...
+   |-- scenarios
+   |   |-- 1.txt
+   |   |-- 2.txt
+   |   `-- 3.txt
+   |-- questions
+   |   |-- planning_to_leave_airport.txt
+   |   |-- purpose_of_visit.txt
+   |   |-- staying_for_how_long.txt
+   |   |-- what_passport_do_you_have.txt
+   `-- check-uk-visa.txt
 ```
 
-##Code terminology
-
-####Answers vs responses
+## Wiki
 
-The words 'answers' and 'responses' are used for various variable names and method names throughout the gem.
-Both are used to describe an answer to a question, but indicate two different formats:
-* ```response``` is used for raw string inputs
-* ```answer``` is used for Model::Answer objects
+Additional documentation and a [glossary of terms](https://github.com/alphagov/smartdown/wiki/Glossary) and concepts can be found in the [project wiki](https://github.com/alphagov/smartdown/wiki/) or in the [documentation folder](doc)
 
-## Software design
+### Dependencies
 
-The initial plan for software design can be seen in this diagram:
+Currently smartdown relies on the [Smart Answers](https://github.com/alphagov/smart-answers/) application to run.
 
-![Software design](https://raw.githubusercontent.com/alphagov/smartdown/master/doc/design.png)
+### Running
 
+For GOV.UK developers you can `bowl smartanswers` and navigate to an example flow such as http://smartanswers.dev.gov.uk/animal-example-multiple from within the GOV.UK VM.

data/lib/smartdown/api/postcode_question.rb

@@ -0,0 +1,8 @@
+require 'smartdown/api/question'
+
+module Smartdown
+  module Api
+    class PostcodeQuestion < Question
+    end
+  end
+end

data/lib/smartdown/api/previous_question.rb

@@ -18,6 +18,8 @@ module Smartdown
           @question = SalaryQuestion.new(elements)
         elsif element = elements.find{|element| element.is_a? Smartdown::Model::Element::Question::Text}
           @question = TextQuestion.new(elements)
+        elsif element = elements.find{|element| element.is_a? Smartdown::Model::Element::Question::Postcode}
+          @question = PostcodeQuestion.new(elements)
         end
         @answer = element.answer_type.new(response, element) if element
       end

data/lib/smartdown/api/question_page.rb

@@ -3,6 +3,7 @@ require 'smartdown/api/date_question'
 require 'smartdown/api/country_question'
 require 'smartdown/api/salary_question'
 require 'smartdown/api/text_question'
+require 'smartdown/api/postcode_question'
 
 module Smartdown
   module Api
@@ -21,6 +22,8 @@ module Smartdown
             Smartdown::Api::SalaryQuestion.new(question_element_group)
           elsif question_element_group.find{|element| element.is_a? Smartdown::Model::Element::Question::Text}
             Smartdown::Api::TextQuestion.new(question_element_group)
+          elsif question_element_group.find{|element| element.is_a? Smartdown::Model::Element::Question::Postcode}
+            Smartdown::Api::PostcodeQuestion.new(question_element_group)
           end
         end
       end

data/lib/smartdown/model/answer/postcode.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require_relative "base"
+require "uk_postcode"
+
+module Smartdown
+  module Model
+    module Answer
+      class Postcode < Base
+
+        def value_type
+          ::String
+        end
+
+        def humanize
+          value
+        end
+
+      private
+        def parse_value(value)
+          postcode = UKPostcode.new(value)
+          if !postcode.valid?
+            @error = "Invalid postcode"
+            return
+          elsif !postcode.full?
+            @error = "Please enter a full postcode"
+            return
+          end
+          value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require 'smartdown/model/answer/postcode'
+
+module Smartdown
+  module Model
+    module Element
+      module Question
+        class Postcode < Struct.new(:name, :alias)
+          def answer_type
+            Smartdown::Model::Answer::Postcode
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smartdown/parser/directory_input.rb

@@ -16,7 +16,7 @@ module Smartdown
       end
 
       def outcomes
-        read_dir("outcomes")
+        recursive_files_relatively_renamed("outcomes")
       end
 
       def scenario_sets

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

@@ -0,0 +1,20 @@
+require 'smartdown/parser/question'
+
+module Smartdown
+  module Parser
+    module Element
+      class PostcodeQuestion < Question
+
+        rule(:question_type) {
+          str("postcode")
+        }
+
+        rule(:postcode_question) {
+          question_tag.as(:postcode)
+        }
+
+        root(:postcode_question)
+      end
+    end
+  end
+end

data/lib/smartdown/parser/node_interpreter.rb

@@ -7,20 +7,21 @@ require 'smartdown/parser/node_transform'
 module Smartdown
   module Parser
     class NodeInterpreter
-      attr_reader :name, :source, :reporter
+      attr_reader :name, :source, :reporter, :data_module
 
       def initialize(name, source, options = {})
         @name = name
         @source = source
-        data_module = options.fetch(:data_module, {})
+        @data_module = options.fetch(:data_module, {})
         @parser = options.fetch(:parser, Smartdown::Parser::NodeParser.new)
-        @transform = options.fetch(:transform, Smartdown::Parser::NodeTransform.new(data_module))
+        @transform = options.fetch(:transform, Smartdown::Parser::NodeTransform.new)
         @reporter = options.fetch(:reporter, Parslet::ErrorReporter::Deepest.new)
       end
 
       def interpret
         transform.apply(parser.parse(source, reporter: reporter),
-          node_name: name
+          node_name: name,
+          data_module: data_module,
         )
       end
 

data/lib/smartdown/parser/node_parser.rb

@@ -7,6 +7,7 @@ require 'smartdown/parser/element/date_question'
 require 'smartdown/parser/element/salary_question'
 require 'smartdown/parser/element/text_question'
 require 'smartdown/parser/element/country_question'
+require 'smartdown/parser/element/postcode_question'
 require 'smartdown/parser/element/markdown_heading'
 require 'smartdown/parser/element/markdown_paragraph'
 require 'smartdown/parser/element/conditional'
@@ -23,6 +24,7 @@ module Smartdown
         Element::SalaryQuestion.new |
         Element::TextQuestion.new |
         Element::CountryQuestion.new |
+        Element::PostcodeQuestion.new |
         Rules.new |
         Element::StartButton.new |
         Element::NextSteps.new |

data/lib/smartdown/parser/node_transform.rb

@@ -10,6 +10,7 @@ require 'smartdown/model/element/question/country'
 require 'smartdown/model/element/question/date'
 require 'smartdown/model/element/question/salary'
 require 'smartdown/model/element/question/text'
+require 'smartdown/model/element/question/postcode'
 require 'smartdown/model/element/start_button'
 require 'smartdown/model/element/markdown_heading'
 require 'smartdown/model/element/markdown_paragraph'
@@ -31,46 +32,6 @@ module Smartdown
   module Parser
     class NodeTransform < Parslet::Transform
 
-      attr_reader :data_module
-
-      def initialize data_module=nil, &block
-        super(&block)
-
-        @data_module = data_module || {}
-      end
-
-      # !!ALERT!! MONKEY PATCHING !!ALERT!!
-      #
-      # This call_on_match method is used for executing all the rule blocks you see
-      # below. The only variables that are in scope for these blocks  are the contents
-      # of bindings - which consists of information about bits of the AST that the rule
-      # matched.
-      #
-      # In the country rule: there is a need for accessing an external variable/method
-      # as the information required to create a country question object is defined in
-      # the data_module - so cannot be inferred purely from the syntax fed to parselet.
-      #
-      # There are 2 options we could have chosen, the first would be to have another
-      # transformation layer. We would create intermediate elements that were lacking
-      # information and then recreate them outside of parselet.
-      #
-      # A far simpler option is to manually modify the set of bindings available to
-      # rule blocks, so we can inject our information from the data_module. Unfortunately
-      # the only way to do this is to Monkey patch the call_on_match method to do the
-      # to injecting. The drawbacks of this are if the method changes its name or function
-      # in a newer parselet version; or possibly accidentally overriding some default
-      # bindings with methods from a data module.
-      #
-      # Ideally we would like a way of injecting information into bindings without this
-      # patch so we have submitted a PR to parselet describing this problem:
-      #
-      # https://github.com/kschiess/parslet/pull/119
-      #
-      def call_on_match(bindings, block)
-        bindings.merge! data_module
-        super(bindings, block)
-      end
-
       rule(body: subtree(:body)) {
         Smartdown::Model::Node.new(
           node_name, body, Smartdown::Model::FrontMatter.new({})
@@ -120,7 +81,7 @@ module Smartdown
 
       rule(:country => {identifier: simple(:identifier), :option_pairs => subtree(:option_pairs)}) {
         country_data_method = Smartdown::Parser::OptionPairs.transform(option_pairs).fetch('countries', nil)
-        country_hash = (eval country_data_method).call
+        country_hash = data_module[country_data_method].call
         Smartdown::Model::Element::Question::Country.new(
           identifier.to_s,
           country_hash,
@@ -152,6 +113,13 @@ module Smartdown
         )
       }
 
+      rule(:postcode => {identifier: simple(:identifier), :option_pairs => subtree(:option_pairs)}) {
+        Smartdown::Model::Element::Question::Postcode.new(
+          identifier.to_s,
+          Smartdown::Parser::OptionPairs.transform(option_pairs).fetch('alias', nil)
+        )
+      }
+
       rule(:next_steps => { content: simple(:content) }) {
         Smartdown::Model::Element::NextSteps.new(content.to_s)
       }

data/lib/smartdown/version.rb

@@ -1,3 +1,3 @@
 module Smartdown
-  VERSION = "0.11.2"
+  VERSION = "0.11.3"
 end

data/spec/fixtures/directory_input/outcomes/nested/o1.txt

@@ -0,0 +1 @@
+nested outcome

data/spec/model/answer/postcode_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'smartdown/model/answer/postcode'
+
+describe Smartdown::Model::Answer::Postcode do
+
+  let(:answer_string) { "WC2B 6SE" }
+  subject(:answer) { described_class.new(answer_string) }
+
+  describe "#humanize" do
+    it "declares itself in the initial format provided" do
+      expect(answer.humanize).to eql("WC2B 6SE")
+    end
+  end
+
+  describe "errors" do
+    context "partial postcodes are not allowed" do
+      let(:answer_string) { "WC2B" }
+      specify { expect(answer.error).to eql "Please enter a full postcode" }
+    end
+
+    context "invalid postcode" do
+      let(:answer_string) { "invalid" }
+      specify { expect(answer.error).to eql "Invalid postcode" }
+    end
+
+    context "question not answered" do
+      let(:answer_string) { nil }
+      specify { expect(answer.error).to eql "Please answer this question" }
+    end
+  end
+end

data/spec/parser/directory_input_spec.rb

@@ -33,10 +33,17 @@ describe Smartdown::Parser::DirectoryInput do
   end
 
   describe "#outcomes" do
-    it "returns an InputFile for every file in the outcomes folder" do
-      expect(input.outcomes).to match([instance_of(Smartdown::Parser::InputFile)])
-      expect(input.outcomes.first.name).to eq("o1")
-      expect(input.outcomes.first.read).to eq("outcome one\n")
+    it "returns an InputFile for every file in the outcomes folder to arbitrary sub directory depth" do
+      expect(input.outcomes).to match([
+        instance_of(Smartdown::Parser::InputFile),
+        instance_of(Smartdown::Parser::InputFile),
+      ])
+
+      expect(input.outcomes.map(&:name)).
+        to match_array(["o1", "nested/o1",])
+
+      expect(input.outcomes.map(&:read)).
+      to match_array(["outcome one\n", "nested outcome\n"])
     end
   end
 
@@ -49,16 +56,17 @@ describe Smartdown::Parser::DirectoryInput do
   end
 
   describe "#snippets" do
-    it "returns an InputFile for every file, ending in .txt, in the snippets folder to arbitrary sub directory depth" do
+    it "returns an InputFile for every file in the snippets folder to arbitrary sub directory depth" do
       expect(input.snippets).to match([
         instance_of(Smartdown::Parser::InputFile),
         instance_of(Smartdown::Parser::InputFile),
       ])
-      expect(input.snippets.map(&:name)).to include("sn1")
-      expect(input.snippets.map(&:read)).to include("snippet one\n")
 
-      expect(input.snippets.map(&:name)).to include("nested/nested_again/nsn1")
-      expect(input.snippets.map(&:read)).to include("nested snippet\n")
+      expect(input.snippets.map(&:name)).
+        to match_array(["sn1", "nested/nested_again/nsn1"])
+
+      expect(input.snippets.map(&:read)).
+        to match_array(["snippet one\n", "nested snippet\n"])
     end
   end
 end

data/spec/parser/element/postcode_question_spec.rb

@@ -0,0 +1,57 @@
+require 'smartdown/parser/node_parser'
+require 'smartdown/parser/node_interpreter'
+require 'smartdown/parser/element/postcode_question'
+
+describe Smartdown::Parser::Element::PostcodeQuestion do
+  subject(:parser) { described_class.new }
+
+  context "with question tag" do
+    let(:source) { "[postcode: home]" }
+
+    it "parses" do
+      should parse(source).as(
+        postcode: {
+          identifier: "home",
+          option_pairs: [],
+        },
+      )
+    end
+
+    describe "transformed" do
+      let(:node_name) { "my_node" }
+      subject(:transformed) {
+        Smartdown::Parser::NodeInterpreter.new(node_name, source, parser: parser).interpret
+      }
+
+      it { should eq(Smartdown::Model::Element::Question::Postcode.new("home")) }
+    end
+  end
+
+  context "with question tag and alias" do
+    let(:source) { "[postcode: home, alias: sweet_home]" }
+
+    it "parses" do
+      should parse(source).as(
+        postcode: {
+          identifier: "home",
+          option_pairs:[
+            {
+              key: 'alias',
+              value: 'sweet_home',
+            }
+          ]
+        }
+      )
+    end
+
+    describe "transformed" do
+      let(:node_name) { "my_node" }
+      subject(:transformed) {
+        Smartdown::Parser::NodeInterpreter.new(node_name, source, parser: parser).interpret
+      }
+
+      it { should eq(Smartdown::Model::Element::Question::Postcode.new("home", "sweet_home")) }
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartdown
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
-  requirement: &22904640 !ruby/object:Gem::Requirement
+  requirement: &22331140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *22904640
+  version_requirements: *22331140
+- !ruby/object:Gem::Dependency
+  name: uk_postcode
+  requirement: &22330540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *22330540
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &22903900 !ruby/object:Gem::Requirement
+  requirement: &22330040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *22903900
+  version_requirements: *22330040
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &22903440 !ruby/object:Gem::Requirement
+  requirement: &22329660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22903440
+  version_requirements: *22329660
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &22902800 !ruby/object:Gem::Requirement
+  requirement: &22329160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22902800
+  version_requirements: *22329160
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &22902180 !ruby/object:Gem::Requirement
+  requirement: &22328660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22902180
+  version_requirements: *22328660
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &22901520 !ruby/object:Gem::Requirement
+  requirement: &22328220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22901520
+  version_requirements: *22328220
 description: 
 email: david.heath@digital.cabinet-office.gov.uk
 executables:
@@ -99,6 +110,7 @@ files:
 - lib/smartdown/parser/scenario_sets_interpreter.rb
 - lib/smartdown/parser/element/date_question.rb
 - lib/smartdown/parser/element/salary_question.rb
+- lib/smartdown/parser/element/postcode_question.rb
 - lib/smartdown/parser/element/conditional.rb
 - lib/smartdown/parser/element/markdown_paragraph.rb
 - lib/smartdown/parser/element/start_button.rb
@@ -114,6 +126,7 @@ files:
 - lib/smartdown/api/coversheet.rb
 - lib/smartdown/api/question.rb
 - lib/smartdown/api/salary_question.rb
+- lib/smartdown/api/postcode_question.rb
 - lib/smartdown/api/flow.rb
 - lib/smartdown/api/question_page.rb
 - lib/smartdown/api/state.rb
@@ -154,6 +167,7 @@ files:
 - lib/smartdown/model/answer/date.rb
 - lib/smartdown/model/answer/base.rb
 - lib/smartdown/model/answer/salary.rb
+- lib/smartdown/model/answer/postcode.rb
 - lib/smartdown/model/answer/country.rb
 - lib/smartdown/model/answer/money.rb
 - lib/smartdown/model/answer/multiple_choice.rb
@@ -165,6 +179,7 @@ files:
 - lib/smartdown/model/element/markdown_heading.rb
 - lib/smartdown/model/element/question/date.rb
 - lib/smartdown/model/element/question/salary.rb
+- lib/smartdown/model/element/question/postcode.rb
 - lib/smartdown/model/element/question/country.rb
 - lib/smartdown/model/element/question/multiple_choice.rb
 - lib/smartdown/model/element/question/text.rb
@@ -183,6 +198,7 @@ files:
 - spec/parser/input_set_spec.rb
 - spec/parser/rules_spec.rb
 - spec/parser/predicates_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
@@ -211,6 +227,7 @@ files:
 - spec/engine/transition_spec.rb
 - spec/engine/conditional_resolver_spec.rb
 - spec/fixtures/directory_input/scenarios/s1.txt
+- spec/fixtures/directory_input/outcomes/nested/o1.txt
 - spec/fixtures/directory_input/outcomes/o1.txt
 - spec/fixtures/directory_input/questions/q1.txt
 - spec/fixtures/directory_input/cover-sheet.txt
@@ -259,6 +276,7 @@ files:
 - spec/model/answer/base_spec.rb
 - spec/model/answer/salary_spec.rb
 - spec/model/answer/date_spec.rb
+- spec/model/answer/postcode_spec.rb
 - spec/model/answer/country_spec.rb
 - spec/model/predicates/not_operation_spec.rb
 - spec/model/predicates/set_membership_spec.rb
@@ -283,7 +301,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3333648473832850396
+      hash: -2697176231460023822
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -292,7 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3333648473832850396
+      hash: -2697176231460023822
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -309,6 +327,7 @@ test_files:
 - spec/parser/input_set_spec.rb
 - spec/parser/rules_spec.rb
 - spec/parser/predicates_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
@@ -337,6 +356,7 @@ test_files:
 - spec/engine/transition_spec.rb
 - spec/engine/conditional_resolver_spec.rb
 - spec/fixtures/directory_input/scenarios/s1.txt
+- spec/fixtures/directory_input/outcomes/nested/o1.txt
 - spec/fixtures/directory_input/outcomes/o1.txt
 - spec/fixtures/directory_input/questions/q1.txt
 - spec/fixtures/directory_input/cover-sheet.txt
@@ -385,6 +405,7 @@ test_files:
 - spec/model/answer/base_spec.rb
 - spec/model/answer/salary_spec.rb
 - spec/model/answer/date_spec.rb
+- spec/model/answer/postcode_spec.rb
 - spec/model/answer/country_spec.rb
 - spec/model/predicates/not_operation_spec.rb
 - spec/model/predicates/set_membership_spec.rb