showmd 1.0.0

data/lib/pagedown/Markdown.Sanitizer.js

@@ -0,0 +1,108 @@
+(function () {
+    var output, Converter;
+    if (typeof exports === "object" && typeof require === "function") { // we're in a CommonJS (e.g. Node.js) module
+        output = exports;
+        Converter = require("./Markdown.Converter").Converter;
+    } else {
+        output = window.Markdown;
+        Converter = output.Converter;
+    }
+        
+    output.getSanitizingConverter = function () {
+        var converter = new Converter();
+        converter.hooks.chain("postConversion", sanitizeHtml);
+        converter.hooks.chain("postConversion", balanceTags);
+        return converter;
+    }
+
+    function sanitizeHtml(html) {
+        return html.replace(/<[^>]*>?/gi, sanitizeTag);
+    }
+
+    // (tags that can be opened/closed) | (tags that stand alone)
+    var basic_tag_whitelist = /^(<\/?(b|blockquote|code|del|dd|dl|dt|em|h1|h2|h3|i|kbd|li|ol|p|pre|s|sup|sub|strong|strike|ul)>|<(br|hr)\s?\/?>)$/i;
+    // <a href="url..." optional title>|</a>
+    var a_white = /^(<a\shref="((https?|ftp):\/\/|\/)[-A-Za-z0-9+&@#\/%?=~_|!:,.;\(\)]+"(\stitle="[^"<>]+")?\s?>|<\/a>)$/i;
+
+    // <img src="url..." optional width  optional height  optional alt  optional title
+    var img_white = /^(<img\ssrc="(https?:\/\/|\/)[-A-Za-z0-9+&@#\/%?=~_|!:,.;\(\)]+"(\swidth="\d{1,3}")?(\sheight="\d{1,3}")?(\salt="[^"<>]*")?(\stitle="[^"<>]*")?\s?\/?>)$/i;
+
+    function sanitizeTag(tag) {
+        if (tag.match(basic_tag_whitelist) || tag.match(a_white) || tag.match(img_white))
+            return tag;
+        else
+            return "";
+    }
+
+    /// <summary>
+    /// attempt to balance HTML tags in the html string
+    /// by removing any unmatched opening or closing tags
+    /// IMPORTANT: we *assume* HTML has *already* been 
+    /// sanitized and is safe/sane before balancing!
+    /// 
+    /// adapted from CODESNIPPET: A8591DBA-D1D3-11DE-947C-BA5556D89593
+    /// </summary>
+    function balanceTags(html) {
+
+        if (html == "")
+            return "";
+
+        var re = /<\/?\w+[^>]*(\s|$|>)/g;
+        // convert everything to lower case; this makes
+        // our case insensitive comparisons easier
+        var tags = html.toLowerCase().match(re);
+
+        // no HTML tags present? nothing to do; exit now
+        var tagcount = (tags || []).length;
+        if (tagcount == 0)
+            return html;
+
+        var tagname, tag;
+        var ignoredtags = "<p><img><br><li><hr>";
+        var match;
+        var tagpaired = [];
+        var tagremove = [];
+        var needsRemoval = false;
+
+        // loop through matched tags in forward order
+        for (var ctag = 0; ctag < tagcount; ctag++) {
+            tagname = tags[ctag].replace(/<\/?(\w+).*/, "$1");
+            // skip any already paired tags
+            // and skip tags in our ignore list; assume they're self-closed
+            if (tagpaired[ctag] || ignoredtags.search("<" + tagname + ">") > -1)
+                continue;
+
+            tag = tags[ctag];
+            match = -1;
+
+            if (!/^<\//.test(tag)) {
+                // this is an opening tag
+                // search forwards (next tags), look for closing tags
+                for (var ntag = ctag + 1; ntag < tagcount; ntag++) {
+                    if (!tagpaired[ntag] && tags[ntag] == "</" + tagname + ">") {
+                        match = ntag;
+                        break;
+                    }
+                }
+            }
+
+            if (match == -1)
+                needsRemoval = tagremove[ctag] = true; // mark for removal
+            else
+                tagpaired[match] = true; // mark paired
+        }
+
+        if (!needsRemoval)
+            return html;
+
+        // delete all orphaned tags from the string
+
+        var ctag = 0;
+        html = html.replace(re, function (match) {
+            var res = tagremove[ctag] ? "" : match;
+            ctag++;
+            return res;
+        });
+        return html;
+    }
+})();

data/lib/showmd.rb

@@ -0,0 +1,9 @@
+require_relative "showmd/preview_generator"
+
+if ARGV.size != 1
+  puts "Argument error, showmd only accepts one argument. It must me a path to a markdown file."
+else
+  file_path = File.join(Dir.pwd, ARGV[0])
+  puts "Generating Preview #{file_path}"
+  Showmd::PreviewGenerator.new(file_path).generate
+end

data/lib/showmd/markdown_preview.html

@@ -0,0 +1,77 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>README.md - showmd preview</title>
+    <style type="text/css">
+    #preview{
+      width: 80%;
+      margin: auto;
+      background: white;
+      padding: 10px 30px;
+      box-shadow: 5px 5px 1px grey;
+    }
+    body{
+      background: #d3d3d3;
+    }
+    footer{
+      width: 80%;
+      margin:auto;
+      text-align: right;
+      padding-top: 15px;
+    }
+    img{
+      max-width: 100%;
+    }
+    </style>
+    <script type="text/javascript" src="../pagedown/Markdown.Converter.js"></script>
+    <script type="text/javascript" src="../pagedown/Markdown.Sanitizer.js"></script>
+    <script type="text/javascript" src="../pagedown/Markdown.Extra.js"></script>
+  </head>
+
+  <body>
+    <div id="markdown">## Showmd
+### An executable to preview markdown in your browser
+
+Showmd lets you preview markdown files in your browser from the command line, it's a lightweight utility that will take the path to a markdown file and open up a preview in your browser. The markdown file is read and converted to HTML using [pagedown](https://code.google.com/p/pagedown/) and [pagedown-extra](https://github.com/jmcmanus/pagedown-extra) javascript libraries, a temporary file is created and previewed using [launchy](http://github.com), so as everything is done client side you don't even need a net connection.
+
+### Installation
+
+```
+	gem install showmd
+```
+
+### Usage
+
+```
+	showmd my_project/README.md
+```
+
+### Screenshot
+
+![](http://cih-static.s3.amazonaws.com/blog/showmd-screenshot.png)
+
+### Tests
+
+```
+	rake test
+```
+
+### Licence
+
+See [Licence.txt](https://github.com/cih/showmd/blob/master/Licence.txt)
+</div>
+    <div id="preview"></div>
+    <footer>Preview generated using <a href="http://github.com/cih/showmd">showmd</footer>
+
+    <script type="text/javascript">
+      (function () {
+        var converter = Markdown.getSanitizingConverter();
+        var markdown = document.getElementById("markdown");
+        var preview = document.getElementById("preview")
+        Markdown.Extra.init(converter);
+        preview.innerHTML = converter.makeHtml(markdown.innerHTML);
+        markdown.innerHTML = "";
+      })();
+    </script>
+  </body>
+</html>

data/lib/showmd/preview_generator.rb

@@ -0,0 +1,41 @@
+require 'launchy'
+
+module Showmd
+  class InputError < StandardError;end;
+  class PreviewGenerator
+  # Pass in a md file path, read the file, build an html file and open in the default browser
+    attr_accessor :input_path, :output_path, :template_path, :markdown
+
+    def initialize(file)
+      @input_path = file
+      @output_path = File.expand_path(File.join(File.dirname(__FILE__), "markdown_preview.html"))
+      @template_path = File.expand_path(File.join(File.dirname(__FILE__), "template.html"))
+    end
+
+    def generate
+      read_md_file
+      build_html_file
+      open_in_browser
+    end
+
+    def read_md_file
+      begin
+        @markdown = File.read(input_path)
+      rescue => exception
+        raise InputError, "Sorry showmd was unable to read the file, please use a valid markdown file."
+      end
+    end
+
+    def build_html_file
+      template_text = File.read(template_path)
+      html_string = template_text.gsub(/<% markdown %>/, markdown)
+      html_string.gsub!(/<% page_title %>/, File.basename(input_path))
+
+      File.open(output_path, "w") {|file| file.puts html_string}
+    end
+
+    def open_in_browser
+      Launchy.open("file://localhost/#{output_path}")
+    end
+  end
+end

data/lib/showmd/template.html

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><% page_title %> - showmd preview</title>
+    <style type="text/css">
+    #preview{
+      width: 80%;
+      margin: auto;
+      background: white;
+      padding: 10px 30px;
+      box-shadow: 5px 5px 1px grey;
+    }
+    body{
+      background: #d3d3d3;
+    }
+    footer{
+      width: 80%;
+      margin:auto;
+      text-align: right;
+      padding-top: 15px;
+    }
+    img{
+      max-width: 100%;
+    }
+    </style>
+    <script type="text/javascript" src="../pagedown/Markdown.Converter.js"></script>
+    <script type="text/javascript" src="../pagedown/Markdown.Sanitizer.js"></script>
+    <script type="text/javascript" src="../pagedown/Markdown.Extra.js"></script>
+  </head>
+
+  <body>
+    <div id="markdown"><% markdown %></div>
+    <div id="preview"></div>
+    <footer>Preview generated using <a href="http://github.com/cih/showmd">showmd</footer>
+
+    <script type="text/javascript">
+      (function () {
+        var converter = Markdown.getSanitizingConverter();
+        var markdown = document.getElementById("markdown");
+        var preview = document.getElementById("preview")
+        Markdown.Extra.init(converter);
+        preview.innerHTML = converter.makeHtml(markdown.innerHTML);
+        markdown.innerHTML = "";
+      })();
+    </script>
+  </body>
+</html>

data/lib/showmd/version.rb

@@ -0,0 +1,3 @@
+module Showmd
+  VERSION = "1.0.0"
+end

data/showmd.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'showmd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "showmd"
+  spec.version       = Showmd::VERSION
+  spec.authors       = ["Chris Holmes"]
+  spec.email         = ["tochrisholmes@gmail.com"]
+  spec.description   = %q{An executable to preview markdown in your browser}
+  spec.summary       = %q{Showmd lets you preview markdown files in your browser from the command line, it's a lightweight utility that will take the path to a markdown file and open up a preview in your browser.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = ["showmd"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+
+  spec.add_dependency "launchy"
+end

data/spec/fixtures/template.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>valid.md - showmd preview</title>
+   </head>
+
+   <body>
+   	<% markdown %>
+   	<h1>HTML Template!</h1>
+   </body>
+</html>

data/spec/fixtures/valid.md

@@ -0,0 +1,3 @@
+### showmd testfile
+
+*Here we have some markdown!*

data/spec/preview_generator_spec.rb

@@ -0,0 +1,61 @@
+require_relative '../lib/showmd/preview_generator'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/pride'
+
+module Showmd
+  class PreviewGeneratorSpec < MiniTest::Test
+
+    INVALID_FILE = File.expand_path(File.join(File.dirname(__FILE__), "fixtures", "doesnt_exist.html"))
+    TEST_OUTPUT_PATH = File.expand_path(File.join(File.dirname(__FILE__), "fixtures", "preview.html"))
+    TEST_TEMPLATE_PATH = File.expand_path(File.join(File.dirname(__FILE__), "fixtures", "template.html"))
+    VALID_MD_FILE = File.expand_path(File.join(File.dirname(__FILE__), "fixtures", "valid.md"))
+
+    describe "read_md_file" do
+      it "should read a valid file" do
+        preview_generator = Showmd::PreviewGenerator.new(VALID_MD_FILE)
+        preview_generator.read_md_file.must_match "*Here we have some markdown!*"
+      end
+
+      it "should raise if file is invalid" do
+        lambda do
+          Showmd::PreviewGenerator.new(INVALID_FILE).read_md_file
+        end.must_raise(Showmd::InputError)
+      end
+    end
+
+    describe "build_html_file" do
+      before do
+        @preview_generator = Showmd::PreviewGenerator.new(VALID_MD_FILE)
+        @preview_generator.read_md_file
+        @preview_generator.output_path = TEST_OUTPUT_PATH
+        @preview_generator.template_path = TEST_TEMPLATE_PATH
+      end
+      it "should read from the html template" do
+        @preview_generator.build_html_file
+
+        File.exist?(@preview_generator.output_path).must_be :==, true
+        File.delete(@preview_generator.output_path)
+      end
+
+      it "should contain the markdown string" do
+        @preview_generator.build_html_file
+
+        File.read(@preview_generator.output_path).must_match "*Here we have some markdown!*"
+        File.delete(@preview_generator.output_path)
+      end
+    end
+
+    describe "generate" do
+      it "should call methods to read, build and open" do
+        showmd = MiniTest::Mock.new
+        def Launchy.open(x);;end
+        preview_generator = Showmd::PreviewGenerator.new(VALID_MD_FILE).generate
+
+        showmd.expect :read_md_file, true
+        showmd.expect :build_html_file, true
+        showmd.expect :open_in_browser, true
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: showmd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An executable to preview markdown in your browser
+email:
+- tochrisholmes@gmail.com
+executables:
+- showmd
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/showmd
+- lib/.DS_Store
+- lib/pagedown/Markdown.Converter.js
+- lib/pagedown/Markdown.Editor.js
+- lib/pagedown/Markdown.Extra.js
+- lib/pagedown/Markdown.Sanitizer.js
+- lib/showmd.rb
+- lib/showmd/markdown_preview.html
+- lib/showmd/preview_generator.rb
+- lib/showmd/template.html
+- lib/showmd/version.rb
+- showmd.gemspec
+- spec/fixtures/template.html
+- spec/fixtures/valid.md
+- spec/preview_generator_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Showmd lets you preview markdown files in your browser from the command line,
+  it's a lightweight utility that will take the path to a markdown file and open up
+  a preview in your browser.
+test_files:
+- spec/fixtures/template.html
+- spec/fixtures/valid.md
+- spec/preview_generator_spec.rb