guard-toc 0.1.4

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/* 
+.rvmrc
+
+## MAC OS
+.DS_Store
+.Trashes
+.com.apple.timemachine.supported
+.fseventsd

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in guard-krammer.gemspec
+gemspec

data/README.md

@@ -0,0 +1,45 @@
+# Guard::Toc #
+Toc guard will watch a folder for changes and add each of the files in the specified folder to a specified file as links.
+
+## Install ##
+
+You're going to need [Guard](https://github.com/guard/guard) too.
+
+Install with
+	
+	$ gem install guard-toc
+	
+Or add it to your Gemfile
+
+	gem 'guard-toc'    
+	
+## Usage ##
+
+Go see the [Guard usage doc](https://github.com/guard/guard#readme) for general instructions
+
+## The Guardfile - where the magic happens
+	
+The Guardfile is where you define your desired input and output paths.
+Create it with:
+
+	$ guard init toc
+	
+Then tweak the watch statements to your hearts content. It'll look a lot like this:
+
+    guard 'toc', :convert_on_start => true, :dry_run => true do
+    	# Will not convert while :dry_run is true. Once you're happy with your watch statements remove it
+    	watch (/source_dir\/(.+\/)*(.+\.)(html_or_other_extension)/i) {"input_dir|output_dir|output_file|path_to_optional_template.html.erb"}
+    end
+  
+The guard statement defines which guard your configuring and sets any optional parameters.
+
+*	: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.
+
+## Have Fun ##
+
+Go see the other [great guards available](https://github.com/guard/guard/wiki/List-of-available-Guards)
+
+# TODO #
+
+* Test

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/guard-toc.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "guard/toc/version"
+
+Gem::Specification.new do |s|
+  s.name        = "guard-toc"
+  s.version     = Guard::TocVersion::VERSION
+  s.authors     = ["Jon Kinney"]
+  s.email       = ["jonkinney@gmail.com"]
+  s.homepage    = "https://github.com/j2fly/guard-toc"
+	s.summary     = %q{Markdown folder > html folder conversion}
+  s.description = %q{Watches a source folder and converts markdown docs to html docs in a target folder}
+
+  s.rubyforge_project = "guard-toc"
+
+  s.files         = `git ls-files`.split("\n") 
+	# s.files					= Dir.glob('{lib}/**/*')
+  #s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  #s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]  
+
+	s.add_dependency 'guard', '>= 0.2.2'
+	s.add_dependency 'kramdown', '~> 0.13.3'
+end

data/lib/guard/toc.rb

@@ -0,0 +1,74 @@
+require 'guard'
+require 'guard/guard'
+require 'guard/watcher'
+require 'Kramdown'
+
+module Guard  
+  class Toc < Guard
+
+    def initialize(watchers=[], options={})
+      super              
+      @options = {
+        :convert_on_start => true,
+        :dry_run          => false
+      }.update(options)
+    end         
+    
+    def start
+      UI.info("Guard::Toc is building a list of links\n")
+      run_all if @options[:convert_on_start]
+    end
+    
+    def run_all
+      files = Dir.glob("**/*.*")
+      targets = Watcher.match_files(self, files)
+      run_on_change targets
+    end
+    
+    def run_on_change(paths)
+      paths.uniq.each do |path|
+        input, output, outfile, template = path.split("|")
+        info = "Created '#{output}/#{outfile}' from the directory '#{input}'"
+        info = "#{info} via '#{template}'" unless template.nil? 
+        UI.info info 
+        unless @options[:dry_run]
+          # make sure directory path exists
+          reg = /(.+\/).+\.\w+/i
+          target_path = output.gsub(reg,"\\1")
+          FileUtils.mkpath target_path unless target_path.empty?
+
+          full_file_list = Dir.entries(input)
+          
+          # Trim "." and ".." off of the file list
+          file_list = full_file_list[2,full_file_list.length-2]
+          
+          # Don't list the index.html file (or whatever it is named) in itself
+          if input==output
+            file_list = file_list - ["#{outfile}"]
+          end
+          
+          source = "<ul class='toc_links'>\n"
+          if file_list.length > 0
+            file_list.each do |file|
+              file_name = file.gsub(/.html/ix,'').gsub(/_/ix,' ').capitalize
+              source += "      <li><a href='#{output}/#{file}'>#{file_name}</a></li>\n"
+            end
+          end
+          source += "    </ul>"
+                                            
+          kram_ops = { :input => "kramdown", :output => "html" }
+          kram_ops.update({ :template => template }) unless template.nil?
+          
+          doc = Kramdown::Document.new(source, kram_ops).to_html
+        
+          File.open("#{output}/#{outfile}", "w") do |f|
+            f.write(doc)
+          end
+        end
+      end
+      true
+    end
+
+
+  end
+end

data/lib/guard/toc/templates/Guardfile

@@ -0,0 +1,4 @@
+guard 'toc', :convert_on_start => true, :dry_run => true do
+	# Will not convert while :dry_run is true. Once you're happy with your watch statements remove it
+	watch (/source_dir\/(.+\/)*(.+\.)(html_or_other_extension)/i) {"input_dir|output_dir|output_file|path_to_optional_template.html.erb"}
+end

data/lib/guard/toc/templates/README.md

@@ -0,0 +1,45 @@
+# Guard::Toc #
+Toc guard will watch a folder for changes and add each of the files in the specified folder to a specified file as links.
+
+## Install ##
+
+You're going to need [Guard](https://github.com/guard/guard) too.
+
+Install with
+	
+	$ gem install guard-toc
+	
+Or add it to your Gemfile
+
+	gem 'guard-toc'    
+	
+## Usage ##
+
+Go see the [Guard usage doc](https://github.com/guard/guard#readme) for general instructions
+
+## The Guardfile - where the magic happens
+	
+The Guardfile is where you define your desired input and output paths.
+Create it with:
+
+	$ guard init toc
+	
+Then tweak the watch statements to your hearts content. It'll look a lot like this:
+
+    guard 'toc', :convert_on_start => true, :dry_run => true do
+    	# Will not convert while :dry_run is true. Once you're happy with your watch statements remove it
+    	watch (/source_dir\/(.+\/)*(.+\.)(html_or_other_extension)/i) {"input_dir|output_dir|output_file|path_to_optional_template.html.erb"}
+    end
+  
+The guard statement defines which guard your configuring and sets any optional parameters.
+
+*	: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.
+
+## Have Fun ##
+
+Go see the other [great guards available](https://github.com/guard/guard/wiki/List-of-available-Guards)
+
+# TODO #
+
+* Test

data/lib/guard/toc/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module TocVersion
+    VERSION = "0.1.4"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: guard-toc
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+  prerelease: 
+platform: ruby
+authors:
+- Jon Kinney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70143896591140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70143896591140
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: &70143896589700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70143896589700
+description: Watches a source folder and converts markdown docs to html docs in a
+  target folder
+email:
+- jonkinney@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- guard-toc.gemspec
+- lib/guard/toc.rb
+- lib/guard/toc/templates/Guardfile
+- lib/guard/toc/templates/README.md
+- lib/guard/toc/version.rb
+homepage: https://github.com/j2fly/guard-toc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: guard-toc
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Markdown folder > html folder conversion
+test_files: []