github-markdown-preview 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 934cef69d969c91a47e1a83202610d45ae2b9eb5
-  data.tar.gz: e428f16a7f79b7e75d0c660b97176be16d8cf223
+  metadata.gz: 8bed903b1a1fd75cbd36702278337c725310bb14
+  data.tar.gz: b2ec291a7ecc75481648c09128a7ab0dc11ff86f
 SHA512:
-  metadata.gz: ffdacce3bc2c2e0ece0bc594884e17fd8fb6d4eb364ee25df2028a288062a555f0774ce8644455f4311795b4b12d485639f7e9ca03abc0adbe64b9ea755a4b1c
-  data.tar.gz: 7819d7183b111e3e5f3567bf23bb14018d50c5a1a4d7b71dcd4c07664f2abf62475b730b6fef36e3a0cf6be36e75ca073608f09b2025e1099e65a2137b6b8779
+  metadata.gz: e768067cde5cd2cbac67d5202133e7d88a48db4661ecab1987f96761a1c4f0d068330d5d95a75728920fc860bc58fc2546976e68ed1c5567a14b167dfa446f34
+  data.tar.gz: 50a50c99c7bdd26bf35f41bba912e4bf907c2f58cf72ce827578d0a8137af409c1690cdedcd22522b273caa4e1559b50eaf7e03c40e38954513224663ed85331

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - "1.8.7"
   - "1.9.3"
   - "2.0.0"
+  - "2.1.0"
 env:
   - INCLUDE_LINGUIST=true
   - INCLUDE_LINGUIST=false

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v2.1.0
+* Add option `:preview_file` for specifying a custom preview file
+* Refactor so the filters and context used to configure html-pipeline can be easily overriden/monkey-patched
+
 ## v2.0.0
 * Add the ability to render a [preview of how Github renders comments/issues](https://github.com/dmarcotte/github-markdown-preview#comment-mode)
 * Make the `github-linguist` dependency [optional](https://github.com/dmarcotte/github-markdown-preview/pull/14)

data/lib/github-markdown-preview/html_preview.rb

@@ -22,42 +22,22 @@ module GithubMarkdownPreview
         raise FileNotFoundError.new("Cannot find source file: #{source_file}")
       end
 
+      @source_file = Pathname.new(source_file).realpath.to_s
+
       options = {
           :delete_on_exit => false,
-          :comment_mode => false
+          :comment_mode => false,
+          :preview_file => @source_file + '.html'
       }.merge(options)
 
-      @source_file = Pathname.new(source_file).realpath.to_s
-
-      @preview_file = @source_file + '.html'
+      @preview_file = options[:preview_file]
       @preview_width = options[:comment_mode] ? 712 : 722
 
       @update_callbacks = []
 
-      @pipeline_context = {
-          :asset_root => "https://a248.e.akamai.net/assets.github.com/images/icons/",
-          :base_url => "https://github.com/",
-          :gfm => options[:comment_mode]
-      }
-
-      filters = [
-          HTML::Pipeline::MarkdownFilter,
-          HTML::Pipeline::SanitizationFilter,
-          HTML::Pipeline::ImageMaxWidthFilter,
-          HTML::Pipeline::HttpsFilter,
-          HTML::Pipeline::EmojiFilter
-      ]
-
-      if HtmlPreview::SYNTAX_HIGHLIGHTS
-        filters << HTML::Pipeline::SyntaxHighlightFilter
-      end
+      @pipeline_context = pipeline_context(options)
 
-      if options[:comment_mode]
-        filters << HTML::Pipeline::MentionFilter
-        filters << GithubMarkdownPreview::Pipeline::TaskListFilter
-      end
-
-      @preview_pipeline = HTML::Pipeline.new filters
+      @preview_pipeline = HTML::Pipeline.new pipeline_filters(options)
 
       # generate initial preview
       update
@@ -83,6 +63,39 @@ module GithubMarkdownPreview
       end
     end
 
+    ##
+    # Compute the context to pass to html-pipeline based on the given options
+    def pipeline_context(options)
+      {
+          :asset_root => "https://a248.e.akamai.net/assets.github.com/images/icons/",
+          :base_url => "https://github.com/",
+          :gfm => options[:comment_mode]
+      }
+    end
+
+    ##
+    # Compute the filters to use in the html-pipeline based on the given options
+    def pipeline_filters(options)
+      filters = [
+          HTML::Pipeline::MarkdownFilter,
+          HTML::Pipeline::SanitizationFilter,
+          HTML::Pipeline::ImageMaxWidthFilter,
+          HTML::Pipeline::HttpsFilter,
+          HTML::Pipeline::EmojiFilter
+      ]
+
+      if HtmlPreview::SYNTAX_HIGHLIGHTS
+        filters << HTML::Pipeline::SyntaxHighlightFilter
+      end
+
+      if options[:comment_mode]
+        filters << HTML::Pipeline::MentionFilter
+        filters << GithubMarkdownPreview::Pipeline::TaskListFilter
+      end
+
+      filters
+    end
+
     ##
     # Update the preview file
     def update

data/lib/github-markdown-preview/version.rb

@@ -1,3 +1,3 @@
 module GithubMarkdownPreview
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/readme.md

@@ -54,7 +54,9 @@ preview = GithubMarkdownPreview::HtmlPreview.new('source_file.md')
 # you can also configure your preview with a couple of options
 preview = GithubMarkdownPreview::HtmlPreview.new('source_file.md', {
     :delete_on_exit => true, # delete the preview when the program exits
-    :comment_mode => true # render using the rules for Github comments/issues
+    :comment_mode => true, # render using the rules for Github comments/issues
+    :preview_file => 'custom_preview_file.html' # write preview to the given filename,
+                                                # rather than the default 'source_file.md.html'
 })
 
 # access the preview information

data/test/html_preview_test.rb

@@ -223,4 +223,15 @@ class TestHtmlPreview < Minitest::Test
     end
   end
 
+  def test_custom_preview_file
+    write(@source_file_path, '## foo')
+    custom_preview = File.join(Dir.tmpdir, 'custom_preview.html')
+    markdown_preview = @ghp.new( @source_file_path, { :preview_file => custom_preview} )
+    assert_equal custom_preview,
+                 markdown_preview.preview_file
+    assert_match /.*<h2>foo<\/h2>.*/,
+                 read(markdown_preview.preview_file),
+                 'Should write to the custom preview file'
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-markdown-preview
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Daniel Marcotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-31 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen