guard-redcarpet 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.swp
+*.gem
+.bundle
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-head@guard-redcarpet"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    exit 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if command -v bundle && [[ -s Gemfile ]]
+# then
+#   bundle
+# fi
+
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2011 Michael-Keith Bernard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Guard::Redcarpet
+
+[Guard](https://github.com/guard/guard) extension for Markdown using the
+[Redcarpet](https://github.com/tanoku/redcarpet) gem. There is an existing
+[guard-markdown](https://github.com/darwalenator/guard-markdown) gem, but it
+uses Kramdown.
+
+## Install
+
+This gem is an extension of Guard.
+
+Installation (command-line):
+
+    gem install guard-redcarpet
+
+Or via your Gemfile:
+
+    gem 'guard-redcarpet'
+
+Add the template to your Guardfile:
+
+    guard init redcarpet
+
+## Options
+
+You should familiarize yourself with the Redcarpet documentation before
+exploring some of the advanced features of this gem.
+
+### Output directory
+
+The default Guard template watches for .html.md and .html.markdown files:
+
+    guard 'redcarpet' do
+      watch(/^.+(\.html\.markdown)$/)
+      watch(/^.+(\.html\.md)$/)
+    end
+
+You can overried the output directory with the `output` option:
+
+    guard 'redcarpet', :output => 'compiled' do
+      watch(/^.+(\.html\.markdown)$/)
+      watch(/^.+(\.html\.md)$/)
+    end
+
+### Markdown and Render options
+
+Options for the `Redcarpet::Markdown` and `Redcarpet::Render::HTML` can be
+provided via the `markdown_options` and `render_options` options respectively.
+
+    guard 'redcarpet', :markdown_options => { :strikethrough => true } do
+      watch(/^.+(\.html\.markdown)$/)
+      watch(/^.+(\.html\.md)$/)
+    end
+
+
+    guard 'redcarpet', :render_options => { :no_links => true } do
+      watch(/^.+(\.html\.markdown)$/)
+      watch(/^.+(\.html\.md)$/)
+    end
+
+Consult the Redcarpet 2.0 documentation for details.
+
+## Special Thanks
+
+Much of the code for this gem was a direct port of the [guard-haml
+gem](https://github.com/manufaktor/guard-haml) by [Immanuel
+Häussermann](https://github.com/manufaktor)
+
+## Contribute
+
+* Hosted on [Github:
+  guard-redcarpet](https://github.com/SegFaultAX/guard-redcarpet)
+* Report issues, questions, or comments to the [issue
+  tracker](https://github.com/SegFaultAX/guard-redcarpet/issues)
+
+## License
+
+Copyright (c) 2011 Michael-Keith Bernard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

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

data/guard-redcarpet.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'guard/redcarpet/version'
+
+Gem::Specification.new do |s|
+  s.name        = "guard-redcarpet"
+  s.version     = Guard::RedcarpetVersion::VERSION
+  s.authors     = ["Michael-Keith Bernard"]
+  s.email       = ["mkbernard.dev@gmail.com"]
+  s.homepage    = "https://github.com/SegFaultAX/guard-redcarpet"
+  s.summary     = %q{Guard for Redcarpet}
+  s.description = %q{Compiles file.html.md and file.html.markdown files to file.html using Redcarpet gem.}
+
+  s.rubyforge_project = "guard-redcarpet"
+
+  s.files         = `git ls-files`.split("\n")
+  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_development_dependency "rspec"
+
+  s.add_runtime_dependency "redcarpet", ">= 2.0.0b5"
+  s.add_runtime_dependency "guard", ">= 0.8.8"
+end

data/lib/guard/redcarpet.rb

@@ -0,0 +1,63 @@
+require 'guard'
+require 'guard/guard'
+require 'guard/watcher'
+require 'redcarpet'
+
+module Guard
+  class Redcarpet < Guard
+
+    def initialize(watchers = [], options = {})
+      super(watchers, {
+        :notifications => true
+      }.merge(options))
+      @watchers, @options = watchers, options
+    end
+
+    def compile_file(file)
+      begin
+        compile_markdown(File.new(file).read)
+      rescue StandardError => e
+        ::Guard::UI.info "Redcarpet File Error: #{e}"
+      end
+    end
+
+    def compile_markdown(content)
+      begin
+        render = ::Redcarpet::Render::HTML.new(@options[:render_options] || {})
+        markdown = ::Redcarpet::Markdown.new(render, (@options[:markdown_options] || {}))
+        markdown.render content
+      rescue StandardError => e
+        ::Guard::UI.info "Redcarpet Error: #{e}"
+      end
+    end
+
+    def get_output(file)
+      file_dir = File.dirname(file)
+      file_dir = File.join(@options[:output], file_dir) if @options[:output]
+      file_name = File.basename(file).split(".")[0..-2].join(".") # remove extension
+
+      file_dir == '' ? file_name : File.join(file_dir, file_name)
+    end
+
+    def run_all
+      run_on_change Watcher.match_files(self, Dir.glob(File.join("**", "*.*")))
+    end
+
+    def run_on_change(paths)
+      paths.each do |file|
+        output_file = get_output file
+        FileUtils.mkdir_p File.dirname(output_file)
+        File.open(output_file, 'w') { |f| f.write(compile_file(file)) }
+        ::Guard::UI.info "# compiled markdown in '#{file}' to html in '#{output_file}'"
+        ::Guard::Notifier.notify("# compiled markdown in #{file}", :title => "Guard::Redcarpet", :image => :success) if @options[:notifications]
+      end
+    end
+
+    def notify(changed_files)
+      ::Guard.guards.reject{ |guard| guard == self }.each do |guard|
+        paths = Watcher.match_files(guard, changed_files)
+        guard.run_on_change paths unless paths.empty?
+      end
+    end
+  end
+end

data/lib/guard/redcarpet/templates/Guardfile

@@ -0,0 +1,4 @@
+guard 'redcarpet' do
+  watch(/^.+(\.html\.markdown)$/)
+  watch(/^.+(\.html\.md)$/)
+end

data/lib/guard/redcarpet/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  class RedcarpetVersion
+    VERSION = '0.0.1'
+  end
+end

data/spec/guard/redcarpet_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Guard::Redcarpet do
+  subject { Guard::Redcarpet.new }
+
+  describe "run all" do
+    it "should re-compile all files being watched" do
+      Guard::Redcarpet.stub(:run_on_change).with([]).and_return([])
+      Guard.stub(:guards).and_return([subject])
+      subject.run_all
+    end
+  end
+
+  describe "compiling markdown" do
+
+  end
+
+  describe "getting output" do
+    context "default" do
+      it "should return test/index.html.md as test/index.html" do
+        subject.get_output("test/index.html.md").should eq("test/index.html")
+      end
+
+      it "should return test/index.html.markdown as test/index.html" do
+        subject.get_output("test/index.html.markdown").should eq("test/index.html")
+      end
+    end
+
+    context "with output option" do
+      before :each do
+        subject.options[:output] = "demo/output"
+      end
+
+      it "should return test/index.html.md as demo/output/test/index.html" do
+        subject.get_output("test/index.html.md").should eq("demo/output/test/index.html")
+      end
+
+      it "should return test/index.html.markdown as demo/output/test/index.html" do
+        subject.get_output("test/index.html.markdown").should eq("demo/output/test/index.html")
+      end
+    end
+  end
+
+  describe "compiling markdown" do
+    context "default" do
+      it "should use default html renderer" do
+        subject.compile_markdown("# Title").should eq("<h1>Title</h1>\n")
+      end
+    end
+
+    context "markdown options" do
+      before :each do
+        subject.options[:markdown_options] = { :strikethrough => true }
+      end
+
+      it "should use markdown options, if provided" do
+        subject.compile_markdown("~~blah~~").should eq("<p><del>blah</del></p>\n")
+      end
+    end
+
+    context "render options" do
+      before :each do
+        subject.options[:render_options] = { :no_links => true }
+      end
+
+      it "should use markdown options, if provided" do
+        subject.compile_markdown("[G](http://www.google.com)").should eq("<p>[G](http:&#47;&#47;www.google.com)</p>\n")
+      end
+    end
+  end
+
+  describe 'building markdown to html' do
+    it 'should notify other guards upon completion' do
+      other_guard = mock('guard')
+      other_guard.should_receive(:watchers).and_return([])
+      Guard.stub(:guards).and_return([subject, other_guard])
+      subject.notify([])
+    end
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec'
+require 'guard/redcarpet'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  
+  config.before(:each) do
+    ENV["GUARD_ENV"] = 'test'
+    @fixture_path = Pathname.new(File.expand_path('../fixtures/', __FILE__))
+    @lib_path = Pathname.new(File.expand_path('../../lib/', __FILE__))
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: guard-redcarpet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael-Keith Bernard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &21104300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21104300
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &21103800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0b5
+  type: :runtime
+  prerelease: false
+  version_requirements: *21103800
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &21103300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *21103300
+description: Compiles file.html.md and file.html.markdown files to file.html using
+  Redcarpet gem.
+email:
+- mkbernard.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- guard-redcarpet.gemspec
+- lib/guard/redcarpet.rb
+- lib/guard/redcarpet/templates/Guardfile
+- lib/guard/redcarpet/version.rb
+- spec/guard/redcarpet_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/SegFaultAX/guard-redcarpet
+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-redcarpet
+rubygems_version: 1.8.9
+signing_key: 
+specification_version: 3
+summary: Guard for Redcarpet
+test_files: []