guard-markdown 0.1.2 → 0.1.3

data/README.md

@@ -37,14 +37,20 @@ The guard statement defines which guard your configuring and sets any optional p
 
 The watch statement - ok, it may look a little intimidating. You'll need to know your regular expressions. But this is what it's doing.
 
-	watch (/source_dir\/(.+\/)*(.+\.)(md|markdown)/i) { |m| "source_dir/#{m[1]}#{m[2]}#{m[3]}|output_dir/#{m[1]}#{m[2]}html"}
+	watch (/source_dir\/(.+\/)*(.+\.)(md|markdown)/i) { |m| "source_dir/#{m[1]}#{m[2]}#{m[3]}|output_dir/#{m[1]}#{m[2]}html|optional_template.html.erb"}
 			 
-			^ ------ input file pattern -----------  ^        ^ ---- input file path -------- ^|^ ----- output file path ---^
+			^ ------ input file pattern -----------  ^        ^ ---- input file path -------- ^|^ ----- output file path ---^|^ --- template path ---- ^
 	
 The "input file pattern" is a regular expression that is used to determine which files are watched by the guard. It'll be applied recursively to all files and folders starting in the current working directory. 
 
-Any matches are passed into the block and used to construct the conversion command. The conversion command is a string containing the path to the source file and the desired path to the output file separated by a "|" 
+Any matches are passed into the block and used to construct the conversion command. The conversion command is a string containing the path to the source file and the desired path to the output file separated by a "|". 
+You can also provide an optional template file. This file, if provided will be used by kramdown to wrap the converted output. 
+The template file is _typically_ an html file, and you define where the converted content will be placed by adding <%= @body %> in the desired location. e.g.
 
+ <div id = "main">
+	<%= @body %>
+ </div>
+	
 I hope that makes sense :)
 
 

data/lib/guard/markdown.rb

@@ -30,17 +30,23 @@ module Guard
     #       - for better testing
     def run_on_change(paths)
       paths.each do |path|
-        input, output = path.split("|") 
-        UI.info "#{input} >> #{output}" 
+        input, output, template = path.split("|")
+        info = "#{input} >> #{output}"
+        info = "#{info} via #{template}" unless template.nil? 
+        UI.info info 
         unless @options[:dry_run]
-          source = File.open(input,"rb").read 
+          source = File.open(input,"rb").read                        
                                             
           # make sure directory path exists
           reg = /(.+\/).+\.\w+/i
           target_path = output.gsub(reg,"\\1")
           FileUtils.mkpath target_path unless target_path.empty?
-        
-          doc = Kramdown::Document.new(source, :input => "markdown").to_html
+          
+          kram_ops = { :input => "markdown" }
+          kram_ops.update({ :template => template }) unless template.nil?
+          
+          doc = Kramdown::Document.new(source, kram_ops).to_html
+                   
         
           File.open(output, "w") do |f|
             f.write(doc)

data/lib/guard/markdown/templates/Guardfile

@@ -2,4 +2,5 @@ guard 'markdown', :convert_on_start => true, :dry_run => true do
 	# See README for info on the watch statement below
 	# Will not convert while :dry_run is true. Once you're happy with your watch statements remove it
 	watch (/source_dir\/(.+\/)*(.+\.)(md|markdown)/i) { |m| "source_dir/#{m[1]}#{m[2]}#{m[3]}|output_dir/#{m[1]}#{m[2]}html"}
+	watch (/source_dir\/(.+\/)*(.+\.)(md|markdown)/i) { |m| "source_dir/#{m[1]}#{m[2]}#{m[3]}|output_dir/#{m[1]}#{m[2]}html|optional_template.html.erb"}
 end

data/lib/guard/markdown/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module MarkdownVersion
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/spec/lib/guard/markdown_spec.rb

@@ -84,6 +84,25 @@ describe "Guard-Markdown" do
 				Guard::UI.should_receive(:info).exactly(3).times
 				@subject.run_on_change(@changed_paths)
 		  end
+		end
+		
+		describe "with a template file" do
+		  it "should use the template when converting the source file" do
+				file_double = double() 
+				file_double.should_receive(:read).and_return("#Title")
+				File.should_receive(:open).with("input.md","rb").and_return(file_double)
+				kram_doc = double() 
+				kram_doc.should_receive(:to_html)
+		  	Kramdown::Document.should_receive(:new).with("#Title", :input => "markdown", :template => "template.html.erb").and_return(kram_doc)
+		
+				file_out = double()   
+				FileUtils.should_receive(:mkpath)                                                      
+				File.should_receive(:open).with("output.html", "w").and_return(file_out) 
+				
+				Guard::UI.should_receive(:info).with("input.md >> output.html via template.html.erb")
+				
+				@subject.run_on_change(["input.md|output.html|template.html.erb"])
+		  end
 		end            
 	end 
 	

metadata

@@ -2,7 +2,7 @@
 name: guard-markdown
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Darren Wallace