github-markdown-preview 1.6.1 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    M2I4ZTQ5MDlkYWMyMTZkOWM4ZThmMDQyNTZiY2NhZDk3N2ZhYmM1OQ==
-  data.tar.gz: !binary |-
-    NTVlMjRiMGU4NzgzY2NmNzgzNzk3ZTFiNGM1NzkxOWM4ZDY2ZjNhOA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZmY1OWYxYWIxMGZiYWMyNjQwMGMyZDlmNmM5OGExM2UwYzc4ODI4ZTc0N2Y4
-    YmRjZmU0YmVkYTMxN2ZmM2NmNzkyY2Q2ZWRjOTQwOGNkOGFlOTNjNzk1NTQ5
-    ZjA4NTcyZDcwNDA0MjdkYjliYzk1MDRkMmM4ZWRjZjQxNjI1NmE=
-  data.tar.gz: !binary |-
-    MjlhYjhlMmExNjczNGEzNWE5MWJlODc4NzliZjc4OTYwZjI3OWY3NTM1YWY2
-    ZWU5NTk5MGU3MjAzNWQzODQxYTFkYmJmNDU3MDI2YWM1NzhmODUzNjRlNDUy
-    Yzg3NjNhOWMyNWY3ZDhmMDBjM2E5ZmNlNDlmODIxOWY3ZTc4OWI=
+SHA1:
+  metadata.gz: 934cef69d969c91a47e1a83202610d45ae2b9eb5
+  data.tar.gz: e428f16a7f79b7e75d0c660b97176be16d8cf223
+SHA512:
+  metadata.gz: ffdacce3bc2c2e0ece0bc594884e17fd8fb6d4eb364ee25df2028a288062a555f0774ce8644455f4311795b4b12d485639f7e9ca03abc0adbe64b9ea755a4b1c
+  data.tar.gz: 7819d7183b111e3e5f3567bf23bb14018d50c5a1a4d7b71dcd4c07664f2abf62475b730b6fef36e3a0cf6be36e75ca073608f09b2025e1099e65a2137b6b8779

data/.gitignore

@@ -30,6 +30,9 @@ target
 .idea
 out
 
+# markdown previews
+*.md.html
+
 # bundler suggested ignores
 *.gem
 *.rbc
@@ -37,6 +40,7 @@ out
 .config
 .yardoc
 Gemfile.lock
+Gemfile.optional.lock
 InstalledFiles
 _yardoc
 coverage
@@ -47,4 +51,4 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
+tmp

data/.travis.yml

@@ -1,7 +1,12 @@
-before_install: sudo apt-get install libicu-dev -y
 language: ruby
 rvm:
   - "1.8.7"
   - "1.9.3"
   - "2.0.0"
-env: RUBYOPT=rubygems
+env:
+  - INCLUDE_LINGUIST=true
+  - INCLUDE_LINGUIST=false
+
+before_install:
+  - gem update --system 2.1.11 #  todo: workaround for https://github.com/rubygems/rubygems/pull/763.  Delete it once that fix is released
+  - if [[ "$INCLUDE_LINGUIST" == "true" ]]; then BUNDLE_GEMFILE=Gemfile.optional; sudo apt-get install libicu-dev -y; fi

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 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)
+* [Update dependencies](https://github.com/dmarcotte/github-markdown-preview/pull/13)
+* Breaking changes:
+    - `preview.delete_on_exit` no longer exists.  To delete the preview on exit, pass the `:delete_on_exit = true` option ([example here](https://github.com/dmarcotte/github-markdown-preview#code))
+    - Since `github-linguist` is not longer required, previews on systems without it installed will not have syntax highlighting
+
 ## v1.6.1
 * Fix [#11](https://github.com/dmarcotte/github-markdown-preview/issues/11)
 

data/Gemfile.optional

@@ -0,0 +1,12 @@
+# custom Gemfile for bundling/testing with optional 'github-linguist' dep
+# usage: BUNDLE_GEMFILE=Gemfile.optional bundle <command>
+
+source 'https://rubygems.org'
+
+gemspec
+
+if RUBY_VERSION =~ /1.8/
+    gem 'escape_utils', '~> 0.3'
+end
+
+gem 'github-linguist'

data/bin/github-markdown-preview

@@ -3,11 +3,16 @@
 require 'github-markdown-preview'
 require 'optparse'
 
+comment_mode = false
 opt_parser = OptionParser.new do |opt|
   opt.banner = "Usage: github-markdown-preview PATH_TO_MD_FILE"
   opt.separator  ""
   opt.separator  "Options"
 
+  opt.on("-c", "--comment-mode", "renders a preview for Github comments/issues") do
+    comment_mode = true
+  end
+
   opt.on("-v", "--version", "print the version") do
     $stdout.puts 'github-markdown-preview version ' + GithubMarkdownPreview::VERSION
     Kernel.exit
@@ -23,7 +28,7 @@ end
 
 begin
   source_file = ARGV.at(0)
-  preview = GithubMarkdownPreview::HtmlPreview.new(source_file)
+  preview = GithubMarkdownPreview::HtmlPreview.new(source_file, { :delete_on_exit => true, :comment_mode => comment_mode })
 rescue GithubMarkdownPreview::FileNotFoundError
   $stderr.puts "#{source_file}: No such file"
   exit 1
@@ -35,9 +40,6 @@ else
   $stdout.puts preview.preview_file
 end
 
-# delete preview html on exit
-preview.delete_on_exit = true
-
 # make sure we've said what we have to say before we block watching the file
 $stdout.flush
 

data/github-markdown-preview.gemspec

@@ -9,17 +9,17 @@ Gem::Specification.new do |s|
   s.authors     = ['Daniel Marcotte']
   s.email       = 'dmarcotte@gmail.com'
   s.homepage    = 'https://github.com/dmarcotte/github-markdown-preview'
-  s.summary     = %q{Use your favorite editor plus the usual edit/refresh cycle to quickly write and polish your Github markdown files.}
-  s.description = %q{Local previews for Github Flavored Markdown files}
+  s.summary     = %q{Use your favorite editor plus the usual edit/refresh cycle to quickly write and polish your Github markdown}
+  s.description = %q{Local previews for Github markdown}
   s.license     = 'MIT'
 
-  s.add_dependency 'active_support', '~> 3.0.0'
-  s.add_dependency 'listen', '~> 1.3.1'
-  s.add_dependency 'pygments.rb', '0.5.2' # pin pygments.rb version to work around https://github.com/dmarcotte/github-markdown-preview/issues/11
-  s.add_dependency 'github-linguist', '~> 2.9.4'
-  s.add_dependency 'html-pipeline', '~> 0.3.1'
+  s.add_dependency 'listen', '1.3.1' # pin to latest version of listen which supports Ruby 1.8
+  s.add_dependency 'html-pipeline', '~> 1.1'
+  s.add_dependency 'sanitize', '2.0.3' # pin to latest version of sanitize which supports Ruby 1.8
+  s.add_dependency 'github-markdown', '~> 0.6'
+  s.add_dependency 'gemoji', '~> 1.5'
 
-  s.add_development_dependency 'minitest', '~> 4.7'
+  s.add_development_dependency 'minitest', '~> 5.2'
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake', '~> 10.1'
 

data/lib/github-markdown-preview.rb

@@ -1,8 +1,8 @@
-
 module GithubMarkdownPreview
   class FileNotFoundError < StandardError; end
 
   require 'github-markdown-preview/version'
   require 'github-markdown-preview/resources'
   require 'github-markdown-preview/html_preview'
+  require 'github-markdown-preview/filter/task_list_filter'
 end

data/lib/github-markdown-preview/filter/task_list_filter.rb

@@ -0,0 +1,48 @@
+require 'html/pipeline'
+
+module GithubMarkdownPreview
+  class Pipeline
+    # HTML filter that replaces `[ ] task` and `[x] task` list items with "task list" checkboxes
+    class TaskListFilter < HTML::Pipeline::Filter
+
+      COMPLETE_TASK_PATTERN = /^[\s]*(\[\s\])([\s]+[^\s]*)/
+      INCOMPLETE_TASK_PATTERN = /^[\s]*(\[x\])([\s]+[^\s]*)/
+
+      def task_pattern(complete)
+        task_character = complete ? 'x' : '\s'
+        /^[\s]*(\[#{task_character}\])([\s]+[^\s]*)/
+      end
+
+      def task_markup(complete)
+        "<input class=\"task-list-item-checkbox\" type=\"checkbox\" #{complete ? 'checked' : ''}>"
+      end
+
+      def call
+        doc.search('ul/li').each do |node|
+          first_child = node.children.first
+          next if !first_child.text?
+          content = first_child.to_html
+          html = task_list_item_filter(content)
+          next if html == content
+          node['class'] = 'task-list-item'
+          node.parent()['class'] = 'task-list'
+          first_child.replace(html)
+        end
+        doc
+      end
+
+      # Replace "[ ]" or "[x]" with corresponding checkbox input
+      def task_list_item_filter(text)
+        return text unless text.include?('[ ]') || text.include?('[x]')
+
+        [true, false].each do |complete|
+          text = text.gsub task_pattern(complete) do
+            task_markup(complete) + $2
+          end
+        end
+
+        text
+      end
+    end
+  end
+end

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

@@ -8,41 +8,62 @@ module GithubMarkdownPreview
   #
   # For a given file /path/to/file.md, generates /path/to/file.md.html
   class HtmlPreview
-
-    VERSION = '1.5'
-
     attr_reader :source_file, :preview_file
-    attr_accessor :delete_on_exit
 
-    def initialize(source_file)
+    begin
+      require 'linguist'
+      SYNTAX_HIGHLIGHTS = true
+    rescue LoadError => _
+      SYNTAX_HIGHLIGHTS = false
+    end
+
+    def initialize(source_file, options = {})
       unless File.exist?(source_file)
         raise FileNotFoundError.new("Cannot find source file: #{source_file}")
       end
 
+      options = {
+          :delete_on_exit => false,
+          :comment_mode => false
+      }.merge(options)
+
       @source_file = Pathname.new(source_file).realpath.to_s
 
       @preview_file = @source_file + '.html'
+      @preview_width = options[:comment_mode] ? 712 : 722
+
       @update_callbacks = []
 
       @pipeline_context = {
           :asset_root => "https://a248.e.akamai.net/assets.github.com/images/icons/",
-          :gfm => false
+          :base_url => "https://github.com/",
+          :gfm => options[:comment_mode]
       }
 
-      @preview_pipeline = HTML::Pipeline.new [
-                                                 HTML::Pipeline::MarkdownFilter,
-                                                 HTML::Pipeline::SanitizationFilter,
-                                                 HTML::Pipeline::ImageMaxWidthFilter,
-                                                 HTML::Pipeline::HttpsFilter,
-                                                 HTML::Pipeline::EmojiFilter,
-                                                 HTML::Pipeline::SyntaxHighlightFilter
-                                             ]
+      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
+
+      @preview_pipeline = HTML::Pipeline.new filters
 
       # generate initial preview
       update
 
       at_exit do
-        if :delete_on_exit
+        if options[:delete_on_exit]
           delete
         end
       end
@@ -69,7 +90,7 @@ module GithubMarkdownPreview
         raise FileNotFoundError.new("Source file deleted")
       end
 
-      markdown_render = @preview_pipeline.call(File.open(@source_file).read, @pipeline_context, {})[:output].to_s
+      markdown_render = @preview_pipeline.call(IO.read(@source_file), @pipeline_context, {})[:output].to_s
       preview_html = wrap_preview(markdown_render)
 
       File.open(@preview_file, 'w') do |f|
@@ -132,7 +153,7 @@ module GithubMarkdownPreview
           margin-top: 0;
         }
         .readme-content {
-          width: 750px;
+          width: #{@preview_width}px;
         }
       </style>
     </head>
@@ -147,4 +168,4 @@ CONTENT
 
   end
 
-end
+end

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

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

data/readme.md

@@ -1,38 +1,62 @@
 # Local Github Markdown Preview [![Build Status](https://secure.travis-ci.org/dmarcotte/github-markdown-preview.png)](http://travis-ci.org/dmarcotte/github-markdown-preview)
 
-Use your favorite editor plus the usual edit/refresh cycle to quickly write and polish your Github markdown files.
+Use your favorite editor plus the usual edit/refresh cycle to quickly write and polish your markdown for Github.
 
-This program marries [html-pipeline](https://github.com/jch/html-pipeline) with the [Listen file watcher](https://github.com/guard/listen) to provide a high-fidelity preview of Github Flavored Markdown in your local browser which automatically updates on edit.
+This program marries [html-pipeline](https://github.com/jch/html-pipeline) with the [Listen file watcher](https://github.com/guard/listen) to provide a high-fidelity preview (in your local browser, automatically updating on edit) of how Github will render your markdown.
 
 ![sample screenshot](sample.png "Local Github Markdown Preview output")
 
-## Installing
+## Installation
 ```
 gem install github-markdown-preview
 ```
-If the install fails, you may be missing a build dependency for the native extensions used in `github-linguist`.  Check your output for the following error, and install the suggested package:
-```
-*********** icu required (brew install icu4c or apt-get install libicu-dev) ***********
-```
-For any other failure, please [file an issue!](https://github.com/dmarcotte/github-markdown-preview/issues)
 
 ## Usage
-### Command line
+
+Generate a preview of how Github renders markdown files in a repository:
+
 ```bash
-# This will write the html preview along side your markdown file (<path/to/github-flavored/file.md.html>)
-# Open in your favorite browser and enjoy!
-github-markdown-preview <path/to/github-flavored/file.md>
+$ github-markdown-preview <path/to/markdown/file.md> # writes <path/to/markdown/file.md>
 ```
+
 * The `.html` preview is written beside your `.md` file so that you can validate [relative links](https://github.com/blog/1395-relative-links-in-markup-files) locally
 * The `.html` preview is deleted when the script exits
 
-### Code
+### Comment mode
+Use the `-c` switch to generate a preview of how Github renders comments/issues, which differs from repository markdown files in a few ways:
+* [newlines](https://help.github.com/articles/github-flavored-markdown#newlines) are rendered as hard breaks
+* `@mentions` are linked to the user's home page
+* [task lists](https://help.github.com/articles/github-flavored-markdown#task-lists) are rendered as checkboxes
+* [TODO](https://github.com/dmarcotte/github-markdown-preview/issues/17): auto-linked [references](https://help.github.com/articles/github-flavored-markdown#references)
+
+```bash
+$ github-markdown-preview -c <path/to/comment/draft.md> # writes <path/to/comment/draft.md.html>
+```
+
+### Enable syntax highlighting for code blocks
+To enable syntax highlighting for code blocks, you will need to install [`github-linguist`](https://github.com/github/linguist):
+```
+gem install github-linguist
+```
+
+Note that this install will fail unless your system meets the requirements needed to build its native extensions:
+* You will to either `brew install icu4c` or `apt-get install libicu-dev`
+* On Mac, you will need to have XCode installed (seems like a full install is required, not just the Command Line Tools)
+
+## Code
+Here's a sample file demonstrating how to call `github-markdown-preview` from your own code:
 ```ruby
 require 'github-markdown-preview'
 
 # create a preview, which writes the source_file.md.html file to disk
 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
+})
+
 # access the preview information
 preview.source_file # returns 'source_file.md'
 preview.preview_file # returns 'source_file.md.html'
@@ -52,27 +76,27 @@ preview.end_watch
 
 # delete the preview file from disk
 preview.delete
-
-# alternatively, tell the preview to delete itself when your program exits
-preview.delete_on_exit = true
 ```
 
-## Developing
+## Development
 ```bash
-bundle # grab the dependencies
-rake test # verify you're in good shape
+$ bundle install
+$ rake test
 ```
-If you get a `require` error, you may need to set `RUBYOPT` to tell Ruby to grab dependencies from `rubygems`
+
+Alternatively, to test with optional dependencies
 ```bash
-export RUBYOPT='rubygems' # you'll probably want to persist this wherever you manage your env variables
+$ BUNDLE_GEMFILE=Gemfile.optional bundle install
+$ BUNDLE_GEMFILE=Gemfile.optional rake test
 ```
+
 To run your development copy of the main script without installing it
-```
-bundle exec bin/github-markdown-preview
+```bash
+$ bundle exec bin/github-markdown-preview
 ```
 To install the your development copy to your system
-```
-rake install
+```bash
+$ rake install
 ```
 
 ## Contributing

data/test/filter/task_list_filter_test.rb

@@ -0,0 +1,87 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'github-markdown-preview'
+
+class HTML::Pipeline::MentionFilterTest < Minitest::Test
+
+  def filter(html)
+    doc  = Nokogiri::HTML::DocumentFragment.parse(html)
+
+    res  = GithubMarkdownPreview::Pipeline::TaskListFilter.call(doc)
+    assert_same doc, res
+
+    res.to_html
+  end
+
+  def test_filter_text_task
+    html = "<ul><li>[ ] task</li></ul>"
+    result  = filter(html)
+
+    assert_equal "<ul class=\"task-list\"><li class=\"task-list-item\">\n<input class=\"task-list-item-checkbox\" type=\"checkbox\"> task</li></ul>",
+                 result
+  end
+
+  def test_filter_text_task_done
+    html = "<ul><li>[x] task</li></ul>"
+    result  = filter(html)
+
+    assert_equal "<ul class=\"task-list\"><li class=\"task-list-item\">\n<input class=\"task-list-item-checkbox\" type=\"checkbox\" checked> task</li></ul>",
+                 result
+  end
+
+  def test_filter_tasks_with_leading_whitespace
+    html = "<ul><li>   [ ] task</li></ul>"
+    result  = filter(html)
+
+    assert_equal "<ul class=\"task-list\"><li class=\"task-list-item\">\n<input class=\"task-list-item-checkbox\" type=\"checkbox\"> task</li></ul>",
+                 result
+  end
+
+  def test_filter_rich_task
+    html = "<ul><li>[ ] <em>task</em></li></ul>"
+    result  = filter(html)
+
+    assert_equal "<ul class=\"task-list\"><li class=\"task-list-item\">\n<input class=\"task-list-item-checkbox\" type=\"checkbox\"><em>task</em>\n</li></ul>",
+                 result
+  end
+
+  def test_filter_sub_task
+    html = "<ul><li>[ ] task</li><ul><li>[ ] subtask</li></ul></ul>"
+    result  = filter(html)
+
+    assert_equal "<ul class=\"task-list\">\n<li class=\"task-list-item\">\n<input class=\"task-list-item-checkbox\" type=\"checkbox\"> task</li>\n<ul class=\"task-list\"><li class=\"task-list-item\">\n<input class=\"task-list-item-checkbox\" type=\"checkbox\"> subtask</li></ul>\n</ul>",
+                 result
+  end
+
+  def test_filter_combined_tasks
+    html = "<ul><li>[ ] task</li><li>[x] done task</li></ul>"
+    result  = filter(html)
+
+    assert_equal "<ul class=\"task-list\">\n<li class=\"task-list-item\">\n<input class=\"task-list-item-checkbox\" type=\"checkbox\"> task</li>\n<li class=\"task-list-item\">\n<input class=\"task-list-item-checkbox\" type=\"checkbox\" checked> done task</li>\n</ul>",
+                 result
+  end
+
+  def test_ignores_taskless_brackets
+    html = "<ul><li>[ ]</li></ul>"
+    result  = filter(html)
+
+    assert_equal "<ul><li>[ ]</li></ul>",
+                 result
+  end
+
+  def test_ignores_no_space_brackets
+    html = "<ul><li>[x]nospace</li></ul>"
+    result  = filter(html)
+
+    assert_equal "<ul><li>[x]nospace</li></ul>",
+                 result
+  end
+
+  def test_ignores_non_start_brackets
+    html = "<ul><li>nope [ ] not a task</li></ul>"
+    result  = filter(html)
+
+    assert_equal "<ul><li>nope [ ] not a task</li></ul>",
+                 result
+  end
+end

data/test/github-markdown-preview_test.rb

@@ -1,6 +1,6 @@
 require 'minitest/autorun'
 
-class TestBin < Minitest::Unit::TestCase
+class TestBin < Minitest::Test
   def setup
     @ghp_scipt = File.join(File.dirname(__FILE__), '..', 'bin', 'github-markdown-preview')
   end

data/test/html_preview_test.rb

@@ -2,7 +2,14 @@ require 'github-markdown-preview'
 require 'minitest/autorun'
 require 'tmpdir'
 
-class TestHtmlPreview < Minitest::Unit::TestCase
+begin
+  require 'linguist'
+  LINGUIST_LOADED = true
+rescue LoadError => _
+  LINGUIST_LOADED = false
+end
+
+class TestHtmlPreview < Minitest::Test
 
   def setup
     @ghp = GithubMarkdownPreview::HtmlPreview
@@ -10,7 +17,9 @@ class TestHtmlPreview < Minitest::Unit::TestCase
   end
 
   def write(file_name, text)
-    File.open(file_name, 'w') { |f| f.write(text) }
+    File.open(file_name, 'w') do |f|
+      f.puts(text)
+    end
   end
 
   def read(file_name)
@@ -43,12 +52,68 @@ class TestHtmlPreview < Minitest::Unit::TestCase
                  'Preview should be correct on initialization'
   end
 
-  def test_headers_without_space
+  def test_word_immediately_after_hash
     write(@source_file_path, '#foo')
     markdown_preview = @ghp.new( @source_file_path )
     assert_match /.*<h1>foo<\/h1>.*/,
                  read(markdown_preview.preview_file),
-                 'Preview should contain header'
+                 'Preview should render #foo as a header'
+  end
+
+  def test_comment_mode_word_immediately_after_hash
+    write(@source_file_path, '#foo')
+    markdown_preview = @ghp.new( @source_file_path, { :comment_mode => true } )
+    assert_match /.*#foo*/,
+                 read(markdown_preview.preview_file),
+                 'Preview should render #foo directly'
+  end
+
+  def test_default_mode_ignores_task_lists
+    write(@source_file_path, '- [ ] task')
+    markdown_preview = @ghp.new( @source_file_path)
+    assert_match markdown_preview.wrap_preview("<ul>\n<li>[ ] task</li>\n</ul>"),
+                 read(markdown_preview.preview_file),
+                 'Should not contain a task list item in default mode'
+  end
+
+  def test_comment_mode_task_lists
+    write(@source_file_path, '- [ ] task')
+    markdown_preview = @ghp.new( @source_file_path, { :comment_mode => true } )
+    assert_match markdown_preview.wrap_preview("<ul class=\"task-list\">\n<li class=\"task-list-item\">\n<input class=\"task-list-item-checkbox\" type=\"checkbox\"> task</li>\n</ul>"),
+                 read(markdown_preview.preview_file),
+                 'Should contain a task list item in comment mode'
+  end
+
+  def test_newlines_ignored
+    write(@source_file_path, "foo\nbar")
+    markdown_preview = @ghp.new( @source_file_path )
+    assert_match /.*foo\nbar*/,
+                 read(markdown_preview.preview_file),
+                 'Should not contain <br> for newline'
+  end
+
+  def test_comment_mode_newlines_respected
+    write(@source_file_path, "foo\nbar")
+    markdown_preview = @ghp.new( @source_file_path, { :comment_mode => true } )
+    assert_match markdown_preview.wrap_preview("<p>foo<br>\nbar</p>"),
+                 read(markdown_preview.preview_file),
+                 'Should insert <br> for newline in comment mode'
+  end
+
+  def test_at_mentions_not_linked
+    write(@source_file_path, "@username")
+    markdown_preview = @ghp.new( @source_file_path )
+    assert_match markdown_preview.wrap_preview("<p>@username</p>"),
+                 read(markdown_preview.preview_file),
+                 '@mentions should not be linked'
+  end
+
+  def test_comment_mode_at_mentions_linked
+    write(@source_file_path, "@username")
+    markdown_preview = @ghp.new( @source_file_path, { :comment_mode => true } )
+    assert_match markdown_preview.wrap_preview('<p><a href="https://github.com/username" class="user-mention">@username</a></p>'),
+                 read(markdown_preview.preview_file),
+                 '@mentions should create links'
   end
 
   def test_wrapper_markup_included
@@ -59,6 +124,25 @@ class TestHtmlPreview < Minitest::Unit::TestCase
                  'Wrapper markup should be in preview file'
   end
 
+  if LINGUIST_LOADED
+    def test_uses_syntax_highlighting
+      write(@source_file_path, "```ruby\nnil\n```")
+      markdown_preview = @ghp.new( @source_file_path )
+
+      assert_equal markdown_preview.wrap_preview("<div class=\"highlight highlight-ruby\"><pre><span class=\"kp\">nil</span>\n</pre></div>"),
+                   read(markdown_preview.preview_file),
+                   'Decorated code should be in preview file'
+    end
+  else
+    def test_no_syntax_highlighting
+      write(@source_file_path, "```ruby\nnil\n```")
+      markdown_preview = @ghp.new( @source_file_path )
+      assert_equal markdown_preview.wrap_preview("<pre lang=\"ruby\"><code>nil\n</code></pre>"),
+                   read(markdown_preview.preview_file),
+                   'Undecorated code should be in preview file'
+    end
+  end
+
   def test_update_preview
     write(@source_file_path, '## foo')
     markdown_preview = @ghp.new( @source_file_path )
@@ -90,8 +174,7 @@ class TestHtmlPreview < Minitest::Unit::TestCase
   def test_preview_delete_on_exit
     at_exit { assert !File.exist?(@source_file_path + '.html'), 'Preview file should be deleted on exit' }
     write(@source_file_path, '## foo')
-    markdown_preview = @ghp.new( @source_file_path )
-    markdown_preview.delete_on_exit = true
+    @ghp.new( @source_file_path, { :delete_on_exit => true } )
   end
 
   def test_update_callbacks
@@ -118,6 +201,8 @@ class TestHtmlPreview < Minitest::Unit::TestCase
       updated_by_watch
     }
 
+    markdown_preview.end_watch
+
     assert_match /.*<h2>foo bar<\/h2>.*/,
                  read(markdown_preview.preview_file)
                  'Preview file should be updated correctly by file watcher'
@@ -138,4 +223,4 @@ class TestHtmlPreview < Minitest::Unit::TestCase
     end
   end
 
-end
+end

metadata

@@ -1,138 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: github-markdown-preview
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Daniel Marcotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: active_support
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
-  name: listen
+  name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: pygments.rb
+  name: sanitize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 2.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
-  name: github-linguist
+  name: github-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.4
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.4
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: html-pipeline
+  name: gemoji
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '5.2'
 - !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: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
-description: Local previews for Github Flavored Markdown files
+description: Local previews for Github markdown
 email: dmarcotte@gmail.com
 executables:
 - github-markdown-preview
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.optional
 - LICENSE.txt
 - Rakefile
 - bin/github-markdown-preview
@@ -141,12 +142,14 @@ files:
 - data/css/github2.css
 - github-markdown-preview.gemspec
 - lib/github-markdown-preview.rb
+- lib/github-markdown-preview/filter/task_list_filter.rb
 - lib/github-markdown-preview/html_preview.rb
 - lib/github-markdown-preview/resources.rb
 - lib/github-markdown-preview/version.rb
 - readme.md
 - sample.png
 - sample_preview.md
+- test/filter/task_list_filter_test.rb
 - test/github-markdown-preview_test.rb
 - test/html_preview_test.rb
 homepage: https://github.com/dmarcotte/github-markdown-preview
@@ -159,21 +162,22 @@ 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.7
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Use your favorite editor plus the usual edit/refresh cycle to quickly write
-  and polish your Github markdown files.
+  and polish your Github markdown
 test_files:
+- test/filter/task_list_filter_test.rb
 - test/github-markdown-preview_test.rb
 - test/html_preview_test.rb