ghpreview 0.0.7 → 0.0.8

data/README.md

@@ -33,10 +33,14 @@ option:
 $ ghpreview -w README.md
 ```
 
-To use an alternate browser (Mac only), use the `-a` (or `--application`) option:
+To use an alternate browser, use the `-a` (or `--application`) option:
 
 ```bash
+# On Mac:
 $ ghpreview -a Safari.app README.md
+
+#On GNU/Linux:
+$ ghpreview -a konqueror README.md
 ```
 
 ## Why is this better than X?

data/lib/ghpreview.rb

@@ -1,2 +1,2 @@
-require 'ghpreview/version'
-require 'ghpreview/previewer'
+require_relative 'ghpreview/version'
+require_relative 'ghpreview/previewer'

data/lib/ghpreview/converter.rb

@@ -0,0 +1,23 @@
+require 'html/pipeline'
+
+module GHPreview
+  class Converter
+    def self.to_html(markdown)
+      context = {
+        asset_root: "http://assets.github.com/images/icons/",
+        gfm: false
+      }
+
+      pipeline = HTML::Pipeline.new([
+        HTML::Pipeline::MarkdownFilter,
+        HTML::Pipeline::SanitizationFilter,
+        HTML::Pipeline::ImageMaxWidthFilter,
+        HTML::Pipeline::HttpsFilter,
+        HTML::Pipeline::MentionFilter,
+        HTML::Pipeline::EmojiFilter,
+        HTML::Pipeline::SyntaxHighlightFilter
+      ], context)
+      result = pipeline.call(markdown)[:output].to_s
+    end
+  end
+end

data/lib/ghpreview/previewer.rb

@@ -1,94 +1,32 @@
-require 'erb'
-require 'html/pipeline'
-require 'listen'
-require 'httpclient'
+require_relative 'converter'
+require_relative 'wrapper'
+require_relative 'viewer'
+require_relative 'watcher'
 
 module GHPreview
   class Previewer
-    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
-      @http        = HTTPClient.new
-      generate_template_with_fingerprinted_stylesheet_links
+      Wrapper.generate_template_with_fingerprinted_stylesheet_links
 
+      @md_filepath = md_filepath
       @application = options[:application]
+
       options[:watch] ? listen : open
     end
 
     def listen
       puts "Previewing #{@md_filepath}. CTRL-C to stop."
-      open
-
-      filename = File.basename(@md_filepath)
-      dirname  = File.dirname(File.expand_path(@md_filepath))
-
-      Listen.to(dirname, filter: /#{filename}$/) do |modified|
+      Watcher.watch @md_filepath do
         open
       end
     end
 
     def open
-      html = markdown_to_html
-      html = wrap_content_with_full_document(html)
-      File.open(HTML_FILEPATH, 'w') { |f| f << html }
-
-      if RUBY_PLATFORM =~ /linux/
-        command = 'xdg-open'
-      else
-        command = @application ? "open -a #{@application}" : 'open'
-      end
-      `#{command} #{HTML_FILEPATH}`
+      html = Converter.to_html(File.read(@md_filepath))
+      html = Wrapper.wrap_html(html)
+      Viewer.view_html html, @application
     end
 
-    private
-
-    def markdown_to_html
-      markdown = File.read(@md_filepath)
-
-      context = {
-        asset_root: "http://assets.github.com/images/icons/",
-        gfm: false
-      }
-
-      pipeline = HTML::Pipeline.new([
-        HTML::Pipeline::MarkdownFilter,
-        HTML::Pipeline::SanitizationFilter,
-        HTML::Pipeline::ImageMaxWidthFilter,
-        HTML::Pipeline::HttpsFilter,
-        HTML::Pipeline::MentionFilter,
-        HTML::Pipeline::EmojiFilter,
-        HTML::Pipeline::SyntaxHighlightFilter
-      ], context)
-      result = pipeline.call(markdown)[:output].to_s
-    end
-
-    def generate_template_with_fingerprinted_stylesheet_links
-      if stale_template?(STYLED_TEMPLATE_FILEPATH)
-        stylesheet_links = @http.get(HOMEPAGE).body.split("\n").select do |line|
-          line =~ /https:.*github.*\.css/
-        end.join
-
-        raw_template = File.read(RAW_TEMPLATE_FILEPATH)
-        styled_template = ERB.new(raw_template).result(binding)
-        File.open(STYLED_TEMPLATE_FILEPATH, 'w') do |f|
-          f.write(styled_template)
-        end
-      end
-    end
-
-    def stale_template?(filepath)
-      return true unless File.exists?(filepath)
-      File.mtime(filepath) < (Time.now - TEMPLATE_CACHE_DURATION)
-    end
-
-    def wrap_content_with_full_document(content)
-      template = File.read(STYLED_TEMPLATE_FILEPATH)
-      ERB.new(template).result(binding)
-    end
   end
 end

data/lib/ghpreview/template.erb

@@ -1,5 +1,7 @@
+<!DOCTYPE html>
 <html>
   <head>
+    <meta charset='utf-8'>
     <%= stylesheet_links %>
     <style>
       body { padding: 30px 0; }

data/lib/ghpreview/version.rb

@@ -1,3 +1,3 @@
 module GHPreview
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/ghpreview/viewer.rb

@@ -0,0 +1,24 @@
+module GHPreview
+  class Viewer
+    HTML_FILEPATH = '/tmp/ghpreview.html'
+
+    def self.view_html(html, application = nil)
+      File.open(HTML_FILEPATH, 'w') { |f| f << html }
+
+      if RUBY_PLATFORM =~ /linux/
+        command = if application
+                    `#{application} #{HTML_FILEPATH} </dev/null &>/dev/null &`
+                    else
+                    `xdg-open #{HTML_FILEPATH}`
+                  end
+      else
+        command = if application
+                    "open -a #{application}"
+                  else
+                    'open'
+                  end
+        `#{command} #{HTML_FILEPATH}`
+      end
+    end
+  end
+end

data/lib/ghpreview/watcher.rb

@@ -0,0 +1,16 @@
+require 'listen'
+
+module GHPreview
+  class Watcher
+    def self.watch(filepath)
+      yield
+
+      filename = File.basename(filepath)
+      dirname  = File.dirname(File.expand_path(filepath))
+
+      Listen.to(dirname, filter: /#{filename}$/) do |modified|
+        yield
+      end
+    end
+  end
+end

data/lib/ghpreview/wrapper.rb

@@ -0,0 +1,40 @@
+require 'erb'
+require 'httpclient'
+
+module GHPreview
+  class Wrapper
+    GITHUB_URL               = 'https://github.com'
+    STYLED_TEMPLATE_FILEPATH = "/tmp/ghpreview-template.erb"
+    TEMPLATE_CACHE_DURATION  = 60 * 60 * 24 * 7 # one week
+    RAW_TEMPLATE_FILEPATH    = "#{File.dirname(__FILE__)}/template.erb"
+
+    def self.generate_template_with_fingerprinted_stylesheet_links
+      http = HTTPClient.new
+
+      if stale_template?(STYLED_TEMPLATE_FILEPATH)
+        stylesheet_links = http.get(GITHUB_URL).body.split("\n").select do |line|
+          line =~ /https:.*github.*\.css/
+        end.join
+
+        raw_template = File.read(RAW_TEMPLATE_FILEPATH)
+        styled_template = ERB.new(raw_template).result(binding)
+        File.open(STYLED_TEMPLATE_FILEPATH, 'w') do |f|
+          f.write(styled_template)
+        end
+      end
+    end
+
+    def self.wrap_html(content)
+      template = File.read(STYLED_TEMPLATE_FILEPATH)
+      ERB.new(template).result(binding)
+    end
+
+    private
+
+    def self.stale_template?(filepath)
+      return true unless File.exists?(filepath)
+      File.mtime(filepath) < (Time.now - TEMPLATE_CACHE_DURATION)
+    end
+
+  end
+end

data/spec/converter_spec.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+require_relative '../lib/ghpreview/converter'
+
+describe GHPreview::Converter do
+  let(:converter) { GHPreview::Converter }
+
+  it "converts markdown to HTML" do
+    expect(converter.to_html('# Foo')).to eql('<h1>Foo</h1>')
+  end
+
+  it "passes through non-ASCII characters" do
+    expect(converter.to_html('# Baña')).to eql('<h1>Baña</h1>')
+  end
+end

data/spec/preview_readme

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require './lib/ghpreview'
+
+GHPreview::Previewer.new('README.md')

data/spec/watch_readme

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require './lib/ghpreview'
+
+GHPreview::Previewer.new('README.md', watch: true)

data/spec/wrapper_spec.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+require_relative '../lib/ghpreview/wrapper'
+
+describe GHPreview::Wrapper do
+  let(:wrapper) { GHPreview::Wrapper }
+
+  it "wraps an HTML fragment in a full document" do
+    fragment = '<h1>foo</h1>'
+    expect(wrapper.wrap_html(fragment)).to include('<html>')
+  end
+
+  it "passes through non-ASCII chars" do
+    expect(wrapper.wrap_html('<h1>Baña</h1>')).to include('Baña')
+  end
+
+  it "specifies the charset" do
+    expect(wrapper.wrap_html('# foo')).to include("charset='utf-8'")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ghpreview
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+date: 2013-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -107,9 +107,17 @@ files:
 - bin/ghpreview
 - ghpreview.gemspec
 - lib/ghpreview.rb
+- lib/ghpreview/converter.rb
 - lib/ghpreview/previewer.rb
 - lib/ghpreview/template.erb
 - lib/ghpreview/version.rb
+- lib/ghpreview/viewer.rb
+- lib/ghpreview/watcher.rb
+- lib/ghpreview/wrapper.rb
+- spec/converter_spec.rb
+- spec/preview_readme
+- spec/watch_readme
+- spec/wrapper_spec.rb
 homepage: http://github.com/newcontext/ghpreview
 licenses: []
 post_install_message: 
@@ -134,5 +142,9 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Command line utility for previewing Markdown files with Github styling
-test_files: []
+test_files:
+- spec/converter_spec.rb
+- spec/preview_readme
+- spec/watch_readme
+- spec/wrapper_spec.rb
 has_rdoc: