smartdown 0.11.0 → 0.11.1

data/README.md

@@ -378,6 +378,23 @@ 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
+
+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
 
 Scenarios are meant to be run as test to check that a Smartdown flow behaves

data/lib/smartdown/api/outcome.rb

@@ -3,7 +3,8 @@ module Smartdown
     class Outcome < Node
 
       def next_steps
-        elements.find{|element| element.is_a? Smartdown::Model::Element::NextSteps}.content
+        next_steps = elements.find{ |element| element.is_a? Smartdown::Model::Element::NextSteps}
+        next_steps.content if next_steps && !next_steps.content.empty?
       end
 
     end

data/lib/smartdown/api/question.rb

@@ -48,7 +48,8 @@ module Smartdown
       end
 
       def build_govspeak(elements)
-        elements.select { |element| markdown_element?(element) }.markdown_elements.map(&:content).join("\n")
+        markdown_elements = elements.select { |element| markdown_element?(element) }
+        markdown_elements.map(&:content).join("\n") unless markdown_elements.empty?
       end
     end
   end

data/lib/smartdown/parser/directory_input.rb

@@ -24,7 +24,7 @@ module Smartdown
       end
 
       def snippets
-        read_dir("snippets")
+        recursive_files_relatively_renamed("snippets")
       end
 
       def filenames_hash
@@ -42,15 +42,35 @@ module Smartdown
           InputFile.new(filename)
         end
       end
+
+      def recursive_files_relatively_renamed(parent_dir, depth=nil)
+        parent_path = @coversheet_path.dirname + parent_dir
+        return [] unless File.exists?(parent_path)
+        
+        depth ||= parent_path.each_filename.count
+        parent_path.each_child.flat_map do |path| 
+          if path.directory?
+            recursive_files_relatively_renamed(path, depth)
+          else
+            InputFile.new(path, relatively_name(path, depth))
+          end
+        end
+      end
+
+      def relatively_name(path, depth)
+        path.each_filename.to_a[depth..-1].join('/')
+      end
+
     end
 
     class InputFile
-      def initialize(path)
+      def initialize(path, name=nil)
         @path = Pathname.new(path.to_s)
+        @name = name ||= @path.basename
       end
 
       def name
-        @path.basename.to_s.split(".").first
+        @name.to_s.split(".").first
       end
 
       def read

data/lib/smartdown/version.rb

@@ -1,3 +1,3 @@
 module Smartdown
-  VERSION = "0.11.0"
+  VERSION = "0.11.1"
 end

data/spec/fixtures/directory_input/snippets/nested/nested_again/nsn1.txt

@@ -0,0 +1 @@
+nested snippet

data/spec/parser/directory_input_spec.rb

@@ -49,10 +49,16 @@ describe Smartdown::Parser::DirectoryInput do
   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")
+    it "returns an InputFile for every file, ending in .txt, 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")
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartdown
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
-  requirement: &8759180 !ruby/object:Gem::Requirement
+  requirement: &10521380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *8759180
+  version_requirements: *10521380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &8758660 !ruby/object:Gem::Requirement
+  requirement: &10520820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *8758660
+  version_requirements: *10520820
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &8758220 !ruby/object:Gem::Requirement
+  requirement: &10520420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8758220
+  version_requirements: *10520420
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &8757720 !ruby/object:Gem::Requirement
+  requirement: &10519900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8757720
+  version_requirements: *10519900
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &8757300 !ruby/object:Gem::Requirement
+  requirement: &10519480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8757300
+  version_requirements: *10519480
 description: 
 email: david.heath@digital.cabinet-office.gov.uk
 executables:
@@ -200,6 +200,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/nested/nested_again/nsn1.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
@@ -268,7 +269,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3164786129793908873
+      hash: -3693296040115547194
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -277,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3164786129793908873
+      hash: -3693296040115547194
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -322,6 +323,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/nested/nested_again/nsn1.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