smartdown 0.11.4 → 0.12.0

data/lib/smartdown/api/date_question.rb

@@ -4,21 +4,27 @@ module Smartdown
   module Api
     class DateQuestion < Question
       extend Forwardable
-      DEFAULT_START_YEAR = Time.now.year - 1
-      DEFAULT_END_YEAR = Time.now.year + 3
 
       def start_year
-        parse_date(from) || DEFAULT_START_YEAR
+        parse_date(from) || default_start_year
       end
 
       def end_year
-        parse_date(to) || DEFAULT_END_YEAR
+        parse_date(to) || default_end_year
       end
 
     private
 
       delegate [:to, :from] => :question_element
 
+      def default_start_year
+        Time.now.year - 1
+      end
+
+      def default_end_year
+        Time.now.year + 3
+      end
+
       def question_element
         @question_element ||= elements.find{|element| element.is_a? Smartdown::Model::Element::Question::Date}
       end

data/lib/smartdown/api/node.rb

@@ -45,7 +45,8 @@ module Smartdown
     private
 
       def markdown_element?(element)
-        (element.is_a? Smartdown::Model::Element::MarkdownParagraph) || (element.is_a? Smartdown::Model::Element::MarkdownHeading)
+        (element.is_a? Smartdown::Model::Element::MarkdownLine) || 
+        (element.is_a? Smartdown::Model::Element::MarkdownHeading)
       end
 
       def next_node_element?(element)

data/lib/smartdown/api/question.rb

@@ -36,7 +36,8 @@ module Smartdown
       attr_reader :elements
 
       def markdown_element?(element)
-        (element.is_a? Smartdown::Model::Element::MarkdownParagraph) || (element.is_a? Smartdown::Model::Element::MarkdownHeading)
+        (element.is_a? Smartdown::Model::Element::MarkdownLine) || 
+        (element.is_a? Smartdown::Model::Element::MarkdownHeading)
       end
 
       def smartdown_element?(element)

data/lib/smartdown/engine/interpolator.rb

@@ -63,7 +63,7 @@ module Smartdown
       end
 
       INTERPOLATOR_CONFIG = {
-        Smartdown::Model::Element::MarkdownParagraph => ElementContentInterpolator,
+        Smartdown::Model::Element::MarkdownLine => ElementContentInterpolator,
         Smartdown::Model::Element::MarkdownHeading => ElementContentInterpolator
       }
 

data/lib/smartdown/model/element/{markdown_paragraph.rb → markdown_line.rb}

@@ -1,7 +1,7 @@
 module Smartdown
   module Model
     module Element
-      MarkdownParagraph = Struct.new(:content)
+      MarkdownLine = Struct.new(:content)
     end
   end
 end

data/lib/smartdown/model/elements.rb

@@ -0,0 +1,51 @@
+module Smartdown
+  module Model
+=begin
+We had to create this Struct for storing multiple Smartdown::Model elements due
+to the syntax used in parsing. 
+
+In the parsing rule below:
+```
+rule(:markdown_elements) {
+  markdown_element.repeat(1, 1) >> 
+  (newline.repeat(1).as(:blank_line) >> markdown_element.as(:element)).repeat
+}
+```
+
+the `(newline.repeat(1).as(:blank_line) >> markdown_element.as(:element)).repeat` snippet creates
+a hash with two key/value pairs to transform.
+
+In order to avoid too much verbosity in the NodeTransform, using the markup "element" instead
+of relying on the naming given by the markdown element parsing itself means we can catch all those cases
+in one generic transform rule:
+
+``` 
+rule(blank_line: simple(:blank_line), element: subtree(:element)) {
+  Smartdown::Model::Elements.new(
+    [
+      Smartdown::Model::Element::MarkdownLine.new(blank_line.to_s),
+      element,
+    ]
+  )
+}
+```
+
+The other alternative would have been to have to add a new rule for every specific kind of markdown element. 
+This `Elements` Struct was created to avoid that much verbosity and brittleness in the transform (we would 
+have needed to add another `rule (blank_line...., xxxxx....)` every time we add a new type of markdown element)
+
+Last but not least, we couldn't just cast newlines as just any markdown element:
+
+```
+rule(:markdown_elements) {
+  markdown_element.repeat(1, 1) >> 
+  (markdown_element).repeat
+}
+```
+was not an option since we needed to differentiate between newlines that so happened to be inside broader blocks like
+frontmatter, rules or conditionals, and newlines that separated plain markdown text...
+
+=end 
+    Elements = Struct.new(:elements) 
+  end
+end

data/lib/smartdown/model/node.rb

@@ -4,7 +4,14 @@ module Smartdown
   module Model
     Node = Struct.new(:name, :elements, :front_matter) do
       def initialize(name, elements, front_matter = nil)
-        super(name, elements, front_matter || Smartdown::Model::FrontMatter.new)
+        all_elements = elements.map do |element|
+          if element.is_a?(Smartdown::Model::Elements)
+            element.elements
+          else
+            element
+          end
+        end.flatten
+        super(name, all_elements, front_matter || Smartdown::Model::FrontMatter.new)
       end
 
       def title
@@ -12,11 +19,11 @@ module Smartdown
       end
 
       def body
-        markdown_blocks_before_question.map { |block| as_markdown(block) }.compact.join("\n")
+        markdown_blocks_before_question.map { |block| as_markdown(block) }.compact.join
       end
 
       def post_body
-        markdown_blocks_after_question.map { |block| as_markdown(block) }.compact.join("\n")
+        markdown_blocks_after_question.map { |block| as_markdown(block) }.compact.join
       end
 
       def questions
@@ -50,14 +57,14 @@ module Smartdown
       def markdown_blocks_before_question
         elements.take_while { |e|
           e.is_a?(Smartdown::Model::Element::MarkdownHeading) ||
-          e.is_a?(Smartdown::Model::Element::MarkdownParagraph)
+          e.is_a?(Smartdown::Model::Element::MarkdownLine)
         }[1..-1]
       end
 
       def markdown_blocks_after_question
         elements.reverse.take_while { |e|
           e.is_a?(Smartdown::Model::Element::MarkdownHeading) ||
-          e.is_a?(Smartdown::Model::Element::MarkdownParagraph)
+          e.is_a?(Smartdown::Model::Element::MarkdownLine)
         }.reverse
       end
 
@@ -73,8 +80,8 @@ module Smartdown
       def as_markdown(block)
         case block
         when Smartdown::Model::Element::MarkdownHeading
-          "# #{block.content}\n"
-        when Smartdown::Model::Element::MarkdownParagraph
+          "# #{block.content}"
+        when Smartdown::Model::Element::MarkdownLine
           block.content
         else
           raise "Unknown markdown block type '#{block.class.to_s}'"

data/lib/smartdown/parser/base.rb

@@ -7,7 +7,7 @@ module Smartdown
       rule(:ws_char) { space_char | str("\t") }
       rule(:space_char) { str(" ") }
       rule(:non_ws_char) { match('\S') }
-      rule(:carriage_return) { str("\r\n") | str("\n\r") | str("\n") | str("\r") }
+      rule(:carriage_return) { str("\n") | str("\r") }
       rule(:newline) { optional_space >> carriage_return }
       rule(:line_ending) { eof | newline }
 

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

@@ -14,7 +14,7 @@ module Smartdown
 
         rule(:markdown_block_inside_conditional) {
           dollar_keywords = [dollar_if, dollar_else, dollar_elseif, dollar_endif]
-          dollar_keywords.map(&:absent?).reduce(:>>) >> NodeParser.new.markdown_block
+          dollar_keywords.map(&:absent?).reduce(:>>) >> NodeParser.new.markdown_element
         }
 
         rule(:conditional_body_block) {
@@ -22,18 +22,19 @@ module Smartdown
         }
 
         rule(:blocks_inside_conditional) {
-          conditional_body_block.repeat(1,1) >> (newline.repeat(1) >> conditional_body_block).repeat
+          conditional_body_block.repeat(1,1) >> (conditional_body_block).repeat
         }
 
         rule(:else_clause) {
-          dollar_else >> optional_space >> newline.repeat(2) >>
-            (blocks_inside_conditional.as(:false_case) >> newline).maybe
+          dollar_else >>
+          optional_space >> newline.repeat(1) >>
+          (blocks_inside_conditional.as(:false_case)).maybe
         }
 
         rule(:elseif_clause) {
           dollar_elseif >> (Predicates.new.as(:predicate) >>
-          optional_space >> newline.repeat(2) >>
-          (blocks_inside_conditional.as(:true_case) >> newline).maybe >>
+          optional_space >> newline.repeat(1) >>
+          (blocks_inside_conditional.as(:true_case)).maybe >>
           ((elseif_clause | else_clause).maybe)).as(:conditional).repeat(1,1).as(:false_case)
         }
 
@@ -41,8 +42,8 @@ module Smartdown
           (
             dollar_if >>
               Predicates.new.as(:predicate) >>
-              optional_space >> newline.repeat(2) >>
-              (blocks_inside_conditional.as(:true_case) >> newline).maybe >>
+              optional_space >> newline.repeat(1) >>
+              (blocks_inside_conditional.as(:true_case)).maybe >>
               (else_clause | elseif_clause).maybe >>
               dollar_endif >> optional_space >> line_ending
           ).as(:conditional)

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

@@ -4,11 +4,17 @@ module Smartdown
   module Parser
     module Element
       class FrontMatter < Base
+        rule(:front_matter_delimiter) {
+          str("---") >> newline
+        }
         rule(:front_matter_line) {
           identifier.as(:name) >> str(":") >> ws >> whitespace_terminated_string.as(:value) >> line_ending
         }
         rule(:front_matter) {
-          front_matter_line.repeat(1).as(:front_matter)
+          front_matter_delimiter >>
+          front_matter_line.repeat(1).as(:front_matter) >>
+          front_matter_delimiter >>
+          newline.repeat
         }
         root(:front_matter)
       end

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

@@ -0,0 +1,14 @@
+require 'smartdown/parser/base'
+
+module Smartdown
+  module Parser
+    module Element
+      class MarkdownBlankLine < Base
+        rule(:markdown_blank_line) {
+          (line_ending).as(:blank)
+        }
+        root(:markdown_blank_line)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'smartdown/parser/base'
+
+module Smartdown
+  module Parser
+    module Element
+      class MarkdownLine < Base
+        rule(:markdown_line) {
+          (optional_space >> whitespace_terminated_string >> optional_space).as(:line)
+        }
+        root(:markdown_line)
+      end
+    end
+  end
+end

data/lib/smartdown/parser/node_parser.rb

@@ -9,14 +9,15 @@ 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/markdown_line'
+require 'smartdown/parser/element/markdown_blank_line'
 require 'smartdown/parser/element/conditional'
 require 'smartdown/parser/element/next_steps'
 
 module Smartdown
   module Parser
     class NodeParser < Base
-      rule(:markdown_block) {
+      rule(:markdown_element) {
         Element::Conditional.new |
         Element::MarkdownHeading.new |
         Element::MultipleChoiceQuestion.new |
@@ -28,19 +29,21 @@ module Smartdown
         Rules.new |
         Element::StartButton.new |
         Element::NextSteps.new |
-        Element::MarkdownParagraph.new
+        Element::MarkdownLine.new |
+        Element::MarkdownBlankLine.new
       }
 
-      rule(:markdown_blocks) {
-        markdown_block.repeat(1, 1) >> (newline.repeat(1) >> markdown_block).repeat
+      rule(:markdown_elements) {
+        markdown_element.repeat(1, 1) >> 
+        (newline.repeat(1).as(:blank_line) >> markdown_element.as(:element)).repeat
       }
 
       rule(:body) {
-        markdown_blocks.as(:body) >> newline.repeat
+        markdown_elements.as(:body)
       }
 
       rule(:flow) {
-        Element::FrontMatter.new >> newline.repeat(1) >> body |
+        Element::FrontMatter.new >> body |
         Element::FrontMatter.new |
         ws >> body
       }

data/lib/smartdown/parser/node_transform.rb

@@ -2,6 +2,7 @@ require 'parslet/transform'
 require 'smartdown/parser/option_pairs_transform'
 require 'smartdown/model/node'
 require 'smartdown/model/front_matter'
+require 'smartdown/model/elements'
 require 'smartdown/model/rule'
 require 'smartdown/model/nested_rule'
 require 'smartdown/model/next_node_rules'
@@ -13,7 +14,7 @@ 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'
+require 'smartdown/model/element/markdown_line'
 require 'smartdown/model/element/conditional'
 require 'smartdown/model/element/next_steps'
 require 'smartdown/model/predicate/equality'
@@ -38,12 +39,29 @@ module Smartdown
         )
       }
 
+      rule(blank_line: simple(:blank_line), element: subtree(:element)) {
+        Smartdown::Model::Elements.new(
+          [
+            Smartdown::Model::Element::MarkdownLine.new(blank_line.to_s),
+            element,
+          ]
+        )
+      }
+
       rule(h1: simple(:content)) {
         Smartdown::Model::Element::MarkdownHeading.new(content.to_s)
       }
 
-      rule(p: simple(:content)) {
-        Smartdown::Model::Element::MarkdownParagraph.new(content.to_s)
+      rule(:line => simple(:content)) {
+        Smartdown::Model::Element::MarkdownLine.new(content.to_s)
+      }
+
+      rule(:blank => simple(:content)) {
+        Smartdown::Model::Element::MarkdownLine.new(content.to_s)
+      }
+
+      rule(:blank_line => simple(:content)) {
+        Smartdown::Model::Element::MarkdownLine.new(content.to_s)
       }
 
       rule(:start_button => simple(:start_node)) {
@@ -70,7 +88,6 @@ module Smartdown
         [url.to_s, label.to_s]
       }
 
-
       rule(:multiple_choice => {identifier: simple(:identifier), :option_pairs => subtree(:option_pairs), options: subtree(:choices)}) {
         Smartdown::Model::Element::Question::MultipleChoice.new(
           identifier.to_s,

data/lib/smartdown/version.rb

@@ -1,3 +1,3 @@
 module Smartdown
-  VERSION = "0.11.4"
+  VERSION = "0.12.0"
 end

data/spec/acceptance/parsing_spec.rb

@@ -48,6 +48,7 @@ describe "Smartdown.parse" do
 
       it "has a body" do
         expect(coversheet.body).to eq(<<-EXPECTED)
+
 This is the body markdown.
 
 It has many paragraphs
@@ -57,6 +58,9 @@ of text.
 * can
 * have
 * lists
+
+
+And handles multiple new lines
 EXPECTED
       end
     end
@@ -80,15 +84,18 @@ EXPECTED
 
       it "has two body paras" do
         expect(question_node.body).to eq(<<-EXPECTED)
+
 Body text line 1.
 
 Body text
 para 2.
+
 EXPECTED
       end
 
       it "has a post body" do
         expect(question_node.post_body).to eq(<<-EXPECTED)
+
 Text after the question.
 EXPECTED
       end

data/spec/api/node_spec.rb

@@ -6,7 +6,7 @@ require 'smartdown/model/front_matter'
 require 'smartdown/model/next_node_rules'
 require 'smartdown/model/element/question/date'
 require 'smartdown/model/element/markdown_heading'
-require 'smartdown/model/element/markdown_paragraph'
+require 'smartdown/model/element/markdown_line'
 
 describe Smartdown::Api::Node do
 
@@ -44,17 +44,17 @@ describe Smartdown::Api::Node do
 
   let(:body_content) { "I <3 bodyshopping" }
   let(:body_element) {
-    Smartdown::Model::Element::MarkdownParagraph.new(body_content)
+    Smartdown::Model::Element::MarkdownLine.new(body_content)
   }
 
   let(:post_body_content) { "hur hur such content" }
   let(:post_body_element) {
-    Smartdown::Model::Element::MarkdownParagraph.new(post_body_content)
+    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_element) {
-    Smartdown::Model::Element::MarkdownParagraph.new(other_post_body_content)
+    Smartdown::Model::Element::MarkdownLine.new(other_post_body_content)
   }
 
 

data/spec/api/question_spec.rb

@@ -2,7 +2,7 @@ require 'smartdown/api/question'
 require 'smartdown/api/date_question'
 require 'smartdown/model/element/question/date'
 require 'smartdown/model/element/markdown_heading'
-require 'smartdown/model/element/markdown_paragraph'
+require 'smartdown/model/element/markdown_line'
 
 describe Smartdown::Api::Question do
 
@@ -22,12 +22,12 @@ describe Smartdown::Api::Question do
 
   let(:body_content) { 'I <3 bodyshopping' }
   let(:body_element) {
-    Smartdown::Model::Element::MarkdownParagraph.new(body_content)
+    Smartdown::Model::Element::MarkdownLine.new(body_content)
   }
 
   let(:post_body_content) { 'hur hur such content' }
   let(:post_body_element) {
-    Smartdown::Model::Element::MarkdownParagraph.new(post_body_content)
+    Smartdown::Model::Element::MarkdownLine.new(post_body_content)
   }
 
 

data/spec/engine/conditional_resolver_spec.rb

@@ -10,10 +10,10 @@ describe Smartdown::Engine::ConditionalResolver do
         conditional do
           named_predicate "pred?"
           true_case do
-            paragraph("True case")
+            line("True case")
           end
           false_case do
-            paragraph("False case")
+            line("False case")
           end
         end
       end
@@ -29,7 +29,7 @@ describe Smartdown::Engine::ConditionalResolver do
 
       let(:expected_node_after_presentation) {
         model_builder.node("outcome_no_visa_needed") do
-          paragraph("True case")
+          line("True case")
         end
       }
 
@@ -48,7 +48,7 @@ describe Smartdown::Engine::ConditionalResolver do
 
       let(:expected_node_after_presentation) {
         model_builder.node("outcome_no_visa_needed") do
-          paragraph("False case")
+          line("False case")
         end
       }
 
@@ -63,13 +63,13 @@ describe Smartdown::Engine::ConditionalResolver do
         conditional do
           named_predicate "pred1?"
           true_case do
-            paragraph("True case")
+            line("True case")
           end
           false_case do
             conditional do
               named_predicate "pred2?"
               true_case do
-                paragraph("False True case")
+                line("False True case")
               end
             end
           end
@@ -88,7 +88,7 @@ describe Smartdown::Engine::ConditionalResolver do
 
       let(:expected_node_after_presentation) {
         model_builder.node("outcome_no_visa_needed") do
-          paragraph("True case")
+          line("True case")
         end
       }
 
@@ -110,7 +110,7 @@ describe Smartdown::Engine::ConditionalResolver do
 
         let(:expected_node_after_presentation) {
           model_builder.node("outcome_no_visa_needed") do
-            paragraph("False True case")
+            line("False True case")
           end
         }
 

data/spec/engine/interpolator_spec.rb

@@ -37,14 +37,14 @@ describe Smartdown::Engine::Interpolator do
     let(:node) {
       model_builder.node("example") do
         heading("a heading")
-        paragraph("some_stuff")
+        line("some_stuff")
         conditional do
           named_predicate "pred?"
           true_case do
-            paragraph("True case")
+            line("True case")
           end
           false_case do
-            paragraph("False case")
+            line("False case")
           end
         end
         multiple_choice("example", {})
@@ -58,7 +58,7 @@ describe Smartdown::Engine::Interpolator do
   end
 
   context "a node with a paragraph containing an interpolation" do
-    let(:elements) { [Smartdown::Model::Element::MarkdownParagraph.new('Hello %{name}')] }
+    let(:elements) { [Smartdown::Model::Element::MarkdownLine.new('Hello %{name}')] }
 
     it "interpolates the name into the paragraph content" do
       expect(interpolated_node.elements.first.content).to eq("Hello #{example_name}")
@@ -74,7 +74,7 @@ describe Smartdown::Engine::Interpolator do
   end
 
   context "a paragraph containing function call" do
-    let(:elements) { [Smartdown::Model::Element::MarkdownParagraph.new('%{double(number)}')] }
+    let(:elements) { [Smartdown::Model::Element::MarkdownLine.new('%{double(number)}')] }
     let(:state) {
       Smartdown::Engine::State.new(
         current_node: node.name,
@@ -88,7 +88,7 @@ describe Smartdown::Engine::Interpolator do
   end
 
   context "a paragraph containing function call with two arguments" do
-    let(:elements) { [Smartdown::Model::Element::MarkdownParagraph.new('%{multiply(number other_number)}')] }
+    let(:elements) { [Smartdown::Model::Element::MarkdownLine.new('%{multiply(number other_number)}')] }
     let(:state) {
       Smartdown::Engine::State.new(
           current_node: node.name,
@@ -103,7 +103,7 @@ describe Smartdown::Engine::Interpolator do
   end
 
   context "a paragraph containing a date answer" do
-    let(:elements) { [Smartdown::Model::Element::MarkdownParagraph.new('%{date_answer}')] }
+    let(:elements) { [Smartdown::Model::Element::MarkdownLine.new('%{date_answer}')] }
     let(:state) {
       Smartdown::Engine::State.new(
           current_node: node.name,
@@ -116,7 +116,7 @@ describe Smartdown::Engine::Interpolator do
   end
 
   context "a paragraph containing a money answer" do
-    let(:elements) { [Smartdown::Model::Element::MarkdownParagraph.new('%{money_answer}')] }
+    let(:elements) { [Smartdown::Model::Element::MarkdownLine.new('%{money_answer}')] }
     let(:state) {
       Smartdown::Engine::State.new(
           current_node: node.name,
@@ -129,7 +129,7 @@ describe Smartdown::Engine::Interpolator do
   end
 
   context "a paragraph containing a text answer" do
-    let(:elements) { [Smartdown::Model::Element::MarkdownParagraph.new('%{text_answer}')] }
+    let(:elements) { [Smartdown::Model::Element::MarkdownLine.new('%{text_answer}')] }
     let(:state) {
       Smartdown::Engine::State.new(
           current_node: node.name,
@@ -142,7 +142,7 @@ describe Smartdown::Engine::Interpolator do
   end
 
   context "a paragraph containing a multuple-choice answer" do
-    let(:elements) { [Smartdown::Model::Element::MarkdownParagraph.new('%{multiple_choice_answer}')] }
+    let(:elements) { [Smartdown::Model::Element::MarkdownLine.new('%{multiple_choice_answer}')] }
     let(:choices) { { 'dog' => 'Dog', 'growlithe' => 'Growlithe', 'arcanine' => 'Arcanine' } }
     let(:question) { Smartdown::Model::Element::Question::MultipleChoice.new('arcanine', choices) }
     let(:state) {
@@ -157,7 +157,7 @@ describe Smartdown::Engine::Interpolator do
   end
 
   context "a paragraph containing a country answer" do
-    let(:elements) { [Smartdown::Model::Element::MarkdownParagraph.new('%{country_answer}')] }
+    let(:elements) { [Smartdown::Model::Element::MarkdownLine.new('%{country_answer}')] }
     let(:country_hash) { { 'united-kingdom' => 'United Kingdom' } }
     let(:question) { Smartdown::Model::Element::Question::Country.new('united-kingdom', country_hash) }
     let(:state) {