smartdown 0.4.0 → 0.5.0

data/README.md

@@ -285,6 +285,28 @@ Interpolations are currently supported into headings and paragraphs using the fo
 Your state pension age is %{state_pension_age}.
 ```
 
+## Snippets
+
+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
+
+They're called like so:
+
+```
+## My header
+
+Markdown copy..
+
+{{snippet: 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_snippet.txt`.
+
+The contents of `my_snippet` will be inseted into the outcome/question.
+
 ## Named predicates (tbd)
 
 Named predicates

data/lib/smartdown/parser/directory_input.rb

@@ -23,6 +23,10 @@ module Smartdown
         read_dir("scenarios")
       end
 
+      def snippets
+        read_dir("snippets")
+      end
+
       def filenames_hash
         {
           coversheet: coversheet.to_s,

data/lib/smartdown/parser/flow_interpreter.rb

@@ -1,5 +1,6 @@
 require 'smartdown/model/flow'
 require 'smartdown/parser/node_interpreter'
+require 'smartdown/parser/snippet_pre_parser'
 
 module Smartdown
   module Parser
@@ -20,7 +21,7 @@ module Smartdown
       attr_reader :flow_input
 
       def initialize(flow_input)
-        @flow_input = flow_input
+        @flow_input = pre_parse(flow_input)
       end
 
       def interpret
@@ -33,11 +34,11 @@ module Smartdown
       end
 
       def questions
-        flow_input.questions.map { |i| interpret_node(i) }
+        flow_input.questions.map { |question_data| interpret_node(question_data) }
       end
 
       def outcomes
-        flow_input.outcomes.map { |i| interpret_node(i) }
+        flow_input.outcomes.map { |outcome_data| interpret_node(outcome_data) }
       end
 
       def interpret_node(input_data)
@@ -45,6 +46,10 @@ module Smartdown
       rescue Parslet::ParseFailed => error
         raise ParseError.new(input_data.to_s, error)
       end
+
+      def pre_parse(flow_input)
+        SnippetPreParser.parse(flow_input)
+      end
     end
   end
 end

data/lib/smartdown/parser/input_set.rb

@@ -0,0 +1,28 @@
+module Smartdown
+  module Parser
+    class InputSet
+      attr_reader :coversheet, :questions, :outcomes, :snippets, :scenarios
+
+      def initialize(params = {})
+        @coversheet = params[:coversheet]
+        @questions = params[:questions]
+        @outcomes = params[:outcomes]
+        @snippets = params[:snippets]
+        @scenarios = params[:scenarios]
+      end
+    end
+
+    class InputData
+      attr_reader :name, :content
+
+      def initialize(name, content)
+        @name = name
+        @content = content
+      end
+
+      def read
+        content
+      end
+    end
+  end
+end

data/lib/smartdown/parser/node_parser.rb

@@ -30,7 +30,7 @@ module Smartdown
       }
 
       rule(:body) {
-        markdown_blocks.as(:body)
+        markdown_blocks.as(:body) >> newline.repeat
       }
 
       rule(:flow) {

data/lib/smartdown/parser/snippet_pre_parser.rb

@@ -0,0 +1,44 @@
+require 'smartdown/parser/input_set'
+
+module Smartdown
+  module Parser
+    class SnippetPreParser
+      class SnippetNotFound < StandardError; end
+
+      attr_reader :input_data
+
+      def initialize(input_data)
+        @input_data = input_data
+      end
+
+      def parse
+        InputSet.new({
+          coversheet: parse_node_input(input_data.coversheet),
+          questions: input_data.questions.map { |question_data| parse_node_input(question_data) },
+          outcomes: input_data.outcomes.map { |outcome_data| parse_node_input(outcome_data) },
+          snippets: input_data.snippets,
+          scenarios: input_data.scenarios,
+        })
+      end
+
+      def self.parse(input_data)
+        self.new(input_data).parse
+      end
+
+    private
+      def parse_node_input(node_input)
+        InputData.new(node_input.name, parse_content(node_input.read))
+      end
+
+      def parse_content(content)
+        content.gsub(/\{\{snippet:\W?(.*)\}\}/i) { |_|
+          parse_content(get_snippet($1).read.strip)
+        }
+      end
+
+      def get_snippet(snippet_name)
+        input_data.snippets.find { |snippet| snippet.name == snippet_name } or raise SnippetNotFound.new(snippet_name)
+      end
+    end
+  end
+end

data/lib/smartdown/version.rb

@@ -1,3 +1,3 @@
 module Smartdown
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/acceptance/parsing_spec.rb

@@ -112,6 +112,14 @@ EXPECTED
       expect(flow.instance_of? Smartdown::Model::Flow).to eq(true)
     end
   end
+
+  context "snippets" do
+    subject(:flow) { Smartdown.parse(fixture("snippet")) }
+
+    it "has replaced the snippet tag with the snippet contents" do
+      expect(flow.nodes.first.elements.any? { |element| element.content.to_s.include? "snippet body" })
+    end
+  end
 end
 
 

data/spec/fixtures/acceptance/snippet/snippet.txt

@@ -0,0 +1,7 @@
+meta_description: Snippets
+satisfies_need: 999999
+status: draft
+
+# A snippet in use
+
+{{snippet: the_snippet}}

data/spec/fixtures/acceptance/snippet/snippets/the_snippet.txt

@@ -0,0 +1 @@
+snippet body

data/spec/fixtures/directory_input/snippets/sn1.txt

@@ -0,0 +1 @@
+snippet one

data/spec/parser/directory_input_spec.rb

@@ -1,11 +1,5 @@
 require 'smartdown/parser/directory_input'
-
-shared_examples "flow input interface" do
-  it { should respond_to(:coversheet) }
-  it { should respond_to(:questions) }
-  it { should respond_to(:outcomes) }
-  it { should respond_to(:scenarios) }
-end
+require 'support/flow_input_interface'
 
 describe Smartdown::Parser::DirectoryInput do
   it_should_behave_like "flow input interface"
@@ -53,4 +47,12 @@ describe Smartdown::Parser::DirectoryInput do
       expect(input.scenarios.first.read).to eq("scenario one\n")
     end
   end
+
+  describe "#snippets" do
+    it "returns an InputFile for every file in the snippets folder" do
+      expect(input.snippets).to match([instance_of(Smartdown::Parser::InputFile)])
+      expect(input.snippets.first.name).to eq("sn1")
+      expect(input.snippets.first.read).to eq("snippet one\n")
+    end
+  end
 end

data/spec/parser/input_set_spec.rb

@@ -0,0 +1,15 @@
+require 'smartdown/parser/input_set'
+require 'support/flow_input_interface'
+
+describe Smartdown::Parser::InputSet do
+  it_should_behave_like "flow input interface"
+end
+
+describe Smartdown::Parser::InputData do
+  let(:name) { 'a name' }
+  let(:data) { 'some smartdown' }
+  subject { Smartdown::Parser::InputData.new(name, data) }
+
+  specify { expect(subject.name).to eql name }
+  specify { expect(subject.read).to eql data }
+end

data/spec/parser/node_parser_spec.rb

@@ -166,4 +166,30 @@ SOURCE
       })
     }
   end
+
+  context "body with extra trailing newlines" do
+    let(:source) {
+<<SOURCE
+# This is my title
+
+This is a paragraph of text with stuff
+that flows along
+
+Another paragraph of text
+
+
+SOURCE
+     }
+
+    it {
+      should parse(source).as({
+        body: [
+          {h1: "This is my title"},
+          {p: "This is a paragraph of text with stuff\nthat flows along\n"},
+          {p: "Another paragraph of text\n"}
+        ]
+      })
+    }
+  end
+
 end

data/spec/parser/snippet_pre_parser_spec.rb

@@ -0,0 +1,116 @@
+require 'smartdown/parser/snippet_pre_parser'
+require 'smartdown/parser/directory_input'
+require 'ostruct'
+
+describe Smartdown::Parser::SnippetPreParser do
+  let(:input_data) {
+    Smartdown::Parser::InputSet.new({
+      coversheet: Smartdown::Parser::InputData.new("coversheet_1", "some smartdown {{snippet: coversheet_snippet}}"),
+      questions: [
+        Smartdown::Parser::InputData.new("question_1", "some {{snippet: question_snippet}} smartdown"),
+      ],
+      outcomes: [
+        Smartdown::Parser::InputData.new("outcome_1", "some smartdown\n\n{{snippet: outcome_snippet}}\n\nmore smartdown"),
+      ],
+      snippets: [
+        Smartdown::Parser::InputData.new("question_snippet", "question snippet"),
+        Smartdown::Parser::InputData.new("outcome_snippet", "outcome snippet"),
+        Smartdown::Parser::InputData.new("coversheet_snippet", "coversheet snippet"),
+      ],
+      scenarios: [:some_scenario]
+    })
+  }
+
+  subject(:parsed_output) {
+    described_class.parse(input_data)
+  }
+
+  it "should replace the snippet tag with the snippet content for questions" do
+    expect(parsed_output.questions[0].read).to eql "some question snippet smartdown"
+  end
+
+  it "should replace the snippet tag with the snippet content for outcomes" do
+    expect(parsed_output.outcomes[0].read).to eql "some smartdown\n\noutcome snippet\n\nmore smartdown"
+  end
+
+  it "should replace the snippet tag with the snippet content for the coversheet" do
+    expect(parsed_output.coversheet.read).to eql "some smartdown coversheet snippet"
+  end
+
+  context "with nested snippets" do
+    let(:input_data) {
+      Smartdown::Parser::InputSet.new({
+        coversheet: Smartdown::Parser::InputData.new("coversheet_1", "some smartdown {{snippet: top_level_snippet}}"),
+        questions: [],
+        outcomes: [],
+        snippets: [
+          Smartdown::Parser::InputData.new("top_level_snippet", "top level snippet {{snippet: nested_snippet}}"),
+          Smartdown::Parser::InputData.new("nested_snippet", "nested snippet"),
+        ],
+        scenarios: []
+      })
+    }
+
+    it "shoud recursively process nested snippets" do
+      expect(parsed_output.coversheet.read).to eql "some smartdown top level snippet nested snippet"
+    end
+  end
+
+  context "when referencing a non-existent snippet" do
+    let(:input_data) {
+      Smartdown::Parser::InputSet.new({
+        coversheet: Smartdown::Parser::InputData.new("coversheet_1", "some smartdown {{snippet: non_existent_snippet}}"),
+        questions: [],
+        outcomes: [],
+        snippets: [],
+        scenarios: []
+      })
+    }
+
+    specify { expect { parsed_output }.to raise_exception(Smartdown::Parser::SnippetPreParser::SnippetNotFound) }
+  end
+
+  describe "whitespace handling" do
+    let(:snippet_smartdown) { "A snippet" }
+    let(:input_data) {
+      Smartdown::Parser::InputSet.new({
+        coversheet: Smartdown::Parser::InputData.new("coversheet_1",  "Smartdown {{snippet: snippet}} more smartdown"),
+        questions: [],
+        outcomes: [],
+        snippets: [ Smartdown::Parser::InputData.new("snippet", snippet_smartdown) ],
+        scenarios: []
+      })
+    }
+
+    context "when snippet smartdown has leading / trailing whitespace" do
+      let(:snippet_smartdown) { "\n\n  Snippet text\n\n with whitespace  \n\n" }
+
+      it "should strip off the snippet content's leading and trailing whitespace" do
+        expect(parsed_output.coversheet.read).to eql "Smartdown Snippet text\n\n with whitespace more smartdown"
+      end
+    end
+  end
+
+  describe "alternative tag definitions" do
+    let(:snippet_tag) { "{{snippet: snippet_name}}" }
+    let(:input_data) {
+      Smartdown::Parser::InputSet.new({
+        coversheet: Smartdown::Parser::InputData.new("coversheet_1",  snippet_tag),
+        questions: [],
+        outcomes: [],
+        snippets: [ Smartdown::Parser::InputData.new("snippet_name", "the snippet") ],
+        scenarios: []
+      })
+    }
+
+    context "with {{SNIPPET: snippet_name}}" do
+      let(:snippet_tag) { "{{SNIPPET: snippet_name}}" }
+      specify { expect(parsed_output.coversheet.read).to eql "the snippet" }
+    end
+
+    context "with {{snippet:snippet_name}}" do
+      let(:snippet_tag) { "{{snippet:snippet_name}}" }
+      specify { expect(parsed_output.coversheet.read).to eql "the snippet" }
+    end
+  end
+end

data/spec/support/flow_input_interface.rb

@@ -0,0 +1,7 @@
+shared_examples "flow input interface" do
+  it { should respond_to(:coversheet) }
+  it { should respond_to(:questions) }
+  it { should respond_to(:outcomes) }
+  it { should respond_to(:scenarios) }
+  it { should respond_to(:snippets) }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartdown
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.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: &10821840 !ruby/object:Gem::Requirement
+  requirement: &7733220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *10821840
+  version_requirements: *7733220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10820700 !ruby/object:Gem::Requirement
+  requirement: &7731020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *10820700
+  version_requirements: *7731020
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10818660 !ruby/object:Gem::Requirement
+  requirement: &7744660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10818660
+  version_requirements: *7744660
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &10832280 !ruby/object:Gem::Requirement
+  requirement: &7742640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10832280
+  version_requirements: *7742640
 description: 
 email: david.heath@digital.cabinet-office.gov.uk
 executables:
@@ -67,7 +67,9 @@ files:
 - lib/smartdown/parser/predicates.rb
 - lib/smartdown/parser/node_transform.rb
 - lib/smartdown/parser/node_interpreter.rb
+- lib/smartdown/parser/snippet_pre_parser.rb
 - lib/smartdown/parser/base.rb
+- lib/smartdown/parser/input_set.rb
 - lib/smartdown/parser/directory_input.rb
 - lib/smartdown/parser/rules.rb
 - lib/smartdown/parser/node_parser.rb
@@ -134,6 +136,7 @@ files:
 - spec/parser/directory_input_spec.rb
 - spec/parser/integration/cover_sheet_spec.rb
 - spec/parser/base_spec.rb
+- spec/parser/input_set_spec.rb
 - spec/parser/rules_spec.rb
 - spec/parser/predicates_spec.rb
 - spec/parser/element/next_steps_spec.rb
@@ -146,6 +149,8 @@ files:
 - spec/parser/element/front_matter_spec.rb
 - spec/parser/element/salary_question_spec.rb
 - spec/parser/node_parser_spec.rb
+- spec/parser/snippet_pre_parser_spec.rb
+- spec/support/flow_input_interface.rb
 - spec/support/model_builder.rb
 - spec/spec_helper.rb
 - spec/engine/state_spec.rb
@@ -156,6 +161,7 @@ files:
 - spec/fixtures/directory_input/outcomes/o1.txt
 - spec/fixtures/directory_input/questions/q1.txt
 - spec/fixtures/directory_input/cover-sheet.txt
+- spec/fixtures/directory_input/snippets/sn1.txt
 - spec/fixtures/acceptance/question-and-outcome/question-and-outcome.txt
 - spec/fixtures/acceptance/question-and-outcome/outcomes/o1.txt
 - spec/fixtures/acceptance/question-and-outcome/questions/q1.txt
@@ -169,6 +175,8 @@ files:
 - spec/fixtures/acceptance/cover-sheet/cover-sheet.txt
 - spec/fixtures/acceptance/one-question/one-question.txt
 - spec/fixtures/acceptance/one-question/questions/q1.txt
+- spec/fixtures/acceptance/snippet/snippet.txt
+- spec/fixtures/acceptance/snippet/snippets/the_snippet.txt
 - spec/fixtures/example.sd
 - spec/support_specs/model_builder_spec.rb
 - spec/engine_spec.rb
@@ -195,7 +203,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1672361924519016433
+      hash: 2695022002413728177
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -204,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1672361924519016433
+      hash: 2695022002413728177
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -217,6 +225,7 @@ test_files:
 - spec/parser/directory_input_spec.rb
 - spec/parser/integration/cover_sheet_spec.rb
 - spec/parser/base_spec.rb
+- spec/parser/input_set_spec.rb
 - spec/parser/rules_spec.rb
 - spec/parser/predicates_spec.rb
 - spec/parser/element/next_steps_spec.rb
@@ -229,6 +238,8 @@ test_files:
 - spec/parser/element/front_matter_spec.rb
 - spec/parser/element/salary_question_spec.rb
 - spec/parser/node_parser_spec.rb
+- spec/parser/snippet_pre_parser_spec.rb
+- spec/support/flow_input_interface.rb
 - spec/support/model_builder.rb
 - spec/spec_helper.rb
 - spec/engine/state_spec.rb
@@ -239,6 +250,7 @@ test_files:
 - spec/fixtures/directory_input/outcomes/o1.txt
 - spec/fixtures/directory_input/questions/q1.txt
 - spec/fixtures/directory_input/cover-sheet.txt
+- spec/fixtures/directory_input/snippets/sn1.txt
 - spec/fixtures/acceptance/question-and-outcome/question-and-outcome.txt
 - spec/fixtures/acceptance/question-and-outcome/outcomes/o1.txt
 - spec/fixtures/acceptance/question-and-outcome/questions/q1.txt
@@ -252,6 +264,8 @@ test_files:
 - spec/fixtures/acceptance/cover-sheet/cover-sheet.txt
 - spec/fixtures/acceptance/one-question/one-question.txt
 - spec/fixtures/acceptance/one-question/questions/q1.txt
+- spec/fixtures/acceptance/snippet/snippet.txt
+- spec/fixtures/acceptance/snippet/snippets/the_snippet.txt
 - spec/fixtures/example.sd
 - spec/support_specs/model_builder_spec.rb
 - spec/engine_spec.rb