guard-markdown 0.1.4 → 0.2.0

data/README.md

@@ -35,6 +35,17 @@ The guard statement defines which guard your configuring and sets any optional p
 *	:convert_on_start - if true will run all conversions when you start the guard. Defaults to true
 *	:dry_run - if true won't actually run the conversion process, but it will output the files being watched and the file it would write to. Use it to tweak your watch statements and when you're happy set it to false.
 
+If you want to pass additional options directly to kramdown add them as an additional options hash to `kram_ops`.
+
+For example to generate a table of contents consisting of headers 2 through 6 first make sure that something like the following is in your markdown source file. This serves as a placeholder which will be replaced with the table of contents. See: [Automatic Table of Contents Generation](http://kramdown.rubyforge.org/converter/html.html#toc).
+
+    * table of contents
+    {:toc}
+
+Then include the following in the start of your guard markdown block:
+
+    :kram_ops_ => { :toc_levels =>  [2, 3, 4, 5, 6]}
+
 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|optional_template.html.erb"}
@@ -65,6 +76,5 @@ Oh yeah, I'm using [Kramdown](http://kramdown.rubyforge.org/) for the conversion
 
 *	Simplify the required watch statement
 	* Seems a little wasteful to have to recreate the input path in the regexp. Must find a way around it.
-*	Allow the passing of Kramdown options into the guard
 *  Allow the conversion of more doc types using Kramdown
 

data/guard-markdown.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec',   '~> 2.6'
 	s.add_development_dependency 'guard-rspec' 
 	s.add_development_dependency 'growl' 
+	s.add_development_dependency 'rake' 
 end

data/lib/guard/markdown.rb

@@ -1,17 +1,20 @@
 require 'guard'
 require 'guard/guard'
 require 'guard/watcher'
-require 'Kramdown'
+require 'kramdown'
 
 module Guard  
   class Markdown < Guard
     # Your code goes here...
+    attr_reader :kram_ops
     def initialize(watchers=[], options={})
       super              
       @options = {
         :convert_on_start => true,
         :dry_run          => false
       }.update(options)
+      @kram_ops = { :input => "kramdown", :output => "html" }
+      @kram_ops.update(@options[:kram_ops]) if @options[:kram_ops]
     end         
     
     def start
@@ -42,10 +45,9 @@ module Guard
           target_path = output.gsub(reg,"\\1")
           FileUtils.mkpath target_path unless target_path.empty?
           
-          kram_ops = { :input => "kramdown", :output => "html" }
-          kram_ops.update({ :template => template }) unless template.nil?
+          @kram_ops.update({ :template => template }) unless template.nil?
           
-          doc = Kramdown::Document.new(source, kram_ops).to_html
+          doc = Kramdown::Document.new(source, @kram_ops).to_html
                    
         
           File.open(output, "w") do |f|

data/lib/guard/markdown/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module MarkdownVersion
-    VERSION = "0.1.4"
+    VERSION = "0.2.0"
   end
 end

data/spec/lib/guard/markdown_spec.rb

@@ -28,6 +28,18 @@ describe "Guard-Markdown" do
 				@subject.options[:convert_on_start].should be false
 	      @subject.options[:dry_run].should be true
 		end
+		it "should also start with default kramdown options" do
+      @subject.kram_ops[:input].should match "kramdown"
+      @subject.kram_ops[:output].should match "html"
+      @subject.kram_ops[:toc_levels].should be nil
+    end
+		it "should accept additional kramdown options" do
+			@subject = Guard::Markdown.new([],{ 
+				:kram_ops => { :toc_levels => [2, 3, 4, 5, 6] } })
+      @subject.kram_ops[:input].should match "kramdown"
+      @subject.kram_ops[:output].should match "html"
+      @subject.kram_ops[:toc_levels].should =~ [2, 3, 4, 5, 6]
+    end
 	end 
 	
 	describe "start" do
@@ -106,6 +118,28 @@ describe "Guard-Markdown" do
 		end            
 	end 
 	
+  describe "with a template file and additional kramdown options" do
+    it "should use the additional kramdown options and 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 => "kramdown", :output => "html",
+          :toc_levels => [2, 3, 4, 5, 6], :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 = Guard::Markdown.new([],{ :kram_ops => { :toc_levels => [2, 3, 4, 5, 6] } })
+      @subject.run_on_change(["input.md|output.html|template.html.erb"])
+    end
+  end
+
 	describe "run_all" do
 	  it "should call run_on_change for all matching paths" do
 			#mock Guard.watcher
@@ -133,4 +167,4 @@ def mock_kramdown text
  	kram_doc = double()
 	Kramdown::Document.should_receive(:new).with(text, :input => "kramdown", :output=> "html").and_return(kram_doc)
 	kram_doc
-end
+end

metadata

@@ -1,93 +1,101 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: guard-markdown
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  version: 0.1.4
 platform: ruby
-authors: 
+authors:
 - Darren Wallace
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: guard
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70223889876720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.2.2
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: kramdown
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70223889876720
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: &70223889875280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.13.3
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70223889875280
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70223889873940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70223889873940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70223889871280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.6'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: guard-rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70223889871280
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70223889870540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *70223889870540
+- !ruby/object:Gem::Dependency
   name: growl
+  requirement: &70223889869540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70223889869540
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70223889868320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-description: Watches a source folder and converts markdown docs to html docs in a target folder
-email: 
+  prerelease: false
+  version_requirements: *70223889868320
+description: Watches a source folder and converts markdown docs to html docs in a
+  target folder
+email:
 - wallace@midweekcrisis.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Guardfile
@@ -103,30 +111,32 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/darwalenator/guard-markdown
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1216822601046321711
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1216822601046321711
 requirements: []
-
 rubyforge_project: guard-markdown
-rubygems_version: 1.8.5
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Markdown folder > html folder conversion
 test_files: []
-