ghpreview 0.0.2 → 0.0.3

data/README.md

@@ -1,12 +1,12 @@
 # ghpreview
 
-Say you're writing a README for your project, or any other Markdown that will 
-eventually be displayed on Github. You want a way to preview this locally 
-before you push it.
+When you're writing a README for your project, you want a way to preview the 
+Markdown locally before you push it. `ghpreview` is a command-line utility that 
+opens your Markdown file in a browser. It uses Github styling and (optionally) 
+automatically refreshes every time you save your source.
 
-`ghpreview` opens a preview of your Markdown file in a browser. It uses Github 
-styling and (optionally) automatically refreshes every time you save your 
-source.
+While README files are the most common use case, `ghpreview` works with any 
+Markdown file.
 
 ## Installation
 
@@ -16,19 +16,32 @@ $ gem install ghpreview
 
 ## Usage
 
-`ghpreview` is a command-line utility.
-
 ```bash
 $ ghpreview README.md
 ```
 
 This will open your default browser with a preview of README.md exactly as it 
-will appear on Github. For a live-updating preview, use the -w (watch) option:
+will appear on Github. For a live-updating preview, use the `-w` (or `--watch`) 
+option:
 
 ```bash
 $ ghpreview -w README.md
 ```
 
+## Why is this better than X?
+
+There are several tools available for previewing Markdown files, and many that 
+provide a Github-like style. I've personally used 
+[Marked](http://markedapp.com), [Mou](http://mouapp.com), and the 
+[vim-markdown](https://github.com/maba/vim-markdown-preview) plugin. All are 
+good tools, but none are able to truly reproduce the custom features added to 
+[Github Flavored Markdown](http://github.github.com/github-flavored-markdown/). 
+This is especially notable with fenced code blocks and syntax highlighting.
+
+`ghpreview` is an accurate preview because it uses Github's own [HTML 
+processing filters](https://github.com/jch/html-pipeline) to generate the HTML, 
+and Github's own stylesheets to style it.
+
 ## Contributing
 
 1. Fork it

data/ghpreview.gemspec

@@ -19,5 +19,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'listen'
   gem.add_dependency 'rb-fsevent'
+  gem.add_dependency 'html-pipeline'
   gem.add_dependency 'httpclient'
 end

data/lib/ghpreview/previewer.rb

@@ -1,19 +1,18 @@
 require 'erb'
-require 'httpclient'
+require 'html/pipeline'
 require 'listen'
+require 'httpclient'
 
 module GHPreview
   class Previewer
-    API_URI                  = 'https://api.github.com/markdown/raw'
-    HOMEPAGE                 = 'https://github.com'
     HTML_FILEPATH            = '/tmp/ghpreview.html'
     RAW_TEMPLATE_FILEPATH    = "#{File.dirname(__FILE__)}/template.erb"
     STYLED_TEMPLATE_FILEPATH = "/tmp/ghpreview-template.erb"
+    HOMEPAGE                 = 'https://github.com'
+    TEMPLATE_CACHE_DURATION  = 60 * 60 * 24 * 7 # one week
 
     def initialize(md_filepath, options = {})
       @md_filepath = md_filepath
-      @md_filename = md_filepath.split('/').last
-      @md_filedir  = md_filepath.split('/').unshift('.').uniq[0..-2].join('/')
       @http        = HTTPClient.new
       generate_template_with_fingerprinted_stylesheet_links
 
@@ -23,7 +22,11 @@ module GHPreview
     def listen
       puts "Previewing #{@md_filepath}. CTRL-C to stop."
       open
-      Listen.to(@md_filedir, filter: /#{@md_filename}$/) do |modified|
+
+      filename = File.basename(@md_filepath)
+      dirname  = File.dirname(File.expand_path(@md_filepath))
+
+      Listen.to(dirname, filter: /#{filename}$/) do |modified|
         open
       end
     end
@@ -44,8 +47,17 @@ module GHPreview
 
     def markdown_to_html
       markdown = File.read(@md_filepath)
-      message  = @http.post API_URI, body: markdown, header: {'Content-Type' => 'text/plain'}
-      message.body
+      pipeline = HTML::Pipeline.new([
+        HTML::Pipeline::MarkdownFilter,
+        HTML::Pipeline::SanitizationFilter,
+        HTML::Pipeline::CamoFilter,
+        HTML::Pipeline::ImageMaxWidthFilter,
+        HTML::Pipeline::HttpsFilter,
+        HTML::Pipeline::MentionFilter,
+        HTML::Pipeline::EmojiFilter,
+        HTML::Pipeline::SyntaxHighlightFilter
+      ], gfm: false)
+      result = pipeline.call(markdown)[:output].to_s
     end
 
     def generate_template_with_fingerprinted_stylesheet_links
@@ -62,7 +74,7 @@ module GHPreview
 
     def stale_template?(filepath)
       return true unless File.exists?(filepath)
-      File.mtime(filepath) < (Time.now - 60 * 60 * 24)
+      File.mtime(filepath) < (Time.now - TEMPLATE_CACHE_DURATION)
     end
 
     def wrap_content_with_full_document(content)

data/lib/ghpreview/version.rb

@@ -1,3 +1,3 @@
 module GHPreview
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ghpreview
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2012-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement