github-markdown-preview 1.5.0

data/sample_preview.md

@@ -0,0 +1,22 @@
+# Sample Preview Render
+
+Uses github css to preview not only structure and content, but also _look_ and **feel** (awkward bolding and italics for demonstration purposes)
+
+Emoji support: :rocket:
+
+Relative links: [readme.md](readme.md)
+
+Syntax highlighting example courtesy of http://stackoverflow.com/a/705754
+```ruby
+class HelloWorld
+   def initialize(name)
+      @name = name.capitalize
+   end
+   def sayHi
+      puts "Hello #{@name}!"
+   end
+end
+
+hello = HelloWorld.new("World")
+hello.sayHi
+```

data/test/github-markdown-preview_test.rb

@@ -0,0 +1,25 @@
+require 'minitest/autorun'
+
+class TestBin < Minitest::Unit::TestCase
+  def setup
+    @ghp_scipt = File.join(File.dirname(__FILE__), '..', 'bin', 'github-markdown-preview')
+  end
+
+  def test_no_params
+    IO.popen("bundle exec #{@ghp_scipt}") do |io|
+      assert_match /Usage.*/, io.read, 'No parameter call should output usage'
+    end
+  end
+
+  def test_version_ouput
+    IO.popen("bundle exec #{@ghp_scipt} -v") do |io|
+      assert_match GithubMarkdownPreview::VERSION, io.read, '-v call should output version'
+    end
+  end
+
+  def test_file_not_found
+    IO.popen("bundle exec #{@ghp_scipt} this_file_does_not_exist 2>&1") do |io|
+      assert_match /.*No such file/, io.read, 'Bad file name should get a helpful error'
+    end
+  end
+end

data/test/html_preview_test.rb

@@ -0,0 +1,132 @@
+require 'github-markdown-preview'
+require 'minitest/autorun'
+require 'tmpdir'
+
+class TestHtmlPreview < Minitest::Unit::TestCase
+
+  def setup
+    @ghp = GithubMarkdownPreview::HtmlPreview
+    @source_file_path = File.join(Dir.tmpdir, 'test.md')
+  end
+
+  def write(file_name, text)
+    File.open(file_name, 'w') { |f| f.write(text) }
+  end
+
+  def read(file_name)
+    assert File.exist?(file_name), "Cannot read file: #{file_name}"
+    File.open(file_name).read
+  end
+
+  ##
+  # Helper method based on Fowler's advice in http://martinfowler.com/articles/nonDeterminism.html#AsynchronousBehavior
+  #
+  # Requires you pass a block which returns true when your asynchronous process has finished
+  def wait_for_async_operation
+    start_time = Time.now
+    wait_limit = 5
+    polling_interval = 0.1
+
+    until yield
+      if Time.now - start_time > wait_limit
+        flunk 'Async operation should not time out.'
+      end
+      sleep (polling_interval)
+    end
+  end
+
+  def test_create_preview_on_init
+    write(@source_file_path, '## foo')
+    markdown_preview = @ghp.new( @source_file_path )
+    assert_match /.*<h2>foo<\/h2>.*/,
+                 read(markdown_preview.preview_file),
+                 'Preview should be correct on initialization'
+  end
+
+  def test_wrapper_markup_included
+    write(@source_file_path, '## foo')
+    markdown_preview = @ghp.new( @source_file_path )
+    assert_equal markdown_preview.wrap_preview("<h2>foo<\/h2>"),
+                 read(markdown_preview.preview_file),
+                 'Wrapper markup should be in preview file'
+  end
+
+  def test_update_preview
+    write(@source_file_path, '## foo')
+    markdown_preview = @ghp.new( @source_file_path )
+    assert_match /.*<h2>foo<\/h2>.*/, read(markdown_preview.preview_file),
+                 'Preview should be initially rendered correctly'
+
+    write(@source_file_path, '## foo bar')
+    markdown_preview.update
+    assert_match /.*<h2>foo bar<\/h2>.*/,
+                 read(markdown_preview.preview_file),
+                 'Preview should be updated correctly'
+  end
+
+  def test_preview_beside_src_file
+    write(@source_file_path, '## foo')
+    markdown_preview = @ghp.new( @source_file_path )
+    assert_equal File.dirname(@source_file_path),
+                 File.dirname(markdown_preview.preview_file),
+                 'Preview file should be in same dir as source file'
+  end
+
+  def test_preview_delete
+    write(@source_file_path, '## foo')
+    markdown_preview = @ghp.new( @source_file_path )
+    markdown_preview.delete
+    assert !File.exist?(markdown_preview.preview_file), 'Preview file should been deleted'
+  end
+
+  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
+  end
+
+  def test_update_callbacks
+    write(@source_file_path, '## foo')
+    markdown_preview = @ghp.new( @source_file_path )
+    first_update_callback_called = false
+    second_update_callback_called = false
+    markdown_preview.on_update { first_update_callback_called = true }
+    markdown_preview.on_update { second_update_callback_called = true }
+    markdown_preview.update
+    assert first_update_callback_called, 'First update callback should be called'
+    assert second_update_callback_called, 'Second update callback should be called'
+  end
+
+  def test_watch_source_file
+    write(@source_file_path, '## foo')
+    markdown_preview = @ghp.new( @source_file_path )
+    updated_by_watch = false
+    markdown_preview.on_update { updated_by_watch = true }
+    markdown_preview.watch
+
+    write(@source_file_path, '## foo bar')
+
+    wait_for_async_operation { updated_by_watch }
+
+    assert_match /.*<h2>foo bar<\/h2>.*/,
+                 read(markdown_preview.preview_file)
+                 'Preview file should be updated correctly by file watcher'
+  end
+
+  def test_file_not_found
+    assert_raises GithubMarkdownPreview::FileNotFoundError do
+      @ghp.new('this_file_does_not_exist')
+    end
+  end
+
+  def test_file_deleted_behind_us
+    assert_raises GithubMarkdownPreview::FileNotFoundError do
+      write(@source_file_path, '## foo')
+      markdown_preview = @ghp.new( @source_file_path )
+      File.delete(@source_file_path)
+      markdown_preview.update
+    end
+  end
+
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: github-markdown-preview
+version: !ruby/object:Gem::Version 
+  version: 1.5.0
+platform: ruby
+authors: 
+- Daniel Marcotte
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-05-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: listen
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: github-linguist
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: html-pipeline
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.0.12
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id006 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id006
+  type: :development
+  version_requirements: *id007
+description: Use your favorite editor plus the usual edit/refresh cycle to quickly write and polish your Github markdown files.
+email: dmarcotte@gmail.com
+executables: 
+- github-markdown-preview
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- bin/github-markdown-preview
+- contributing.md
+- data/css/github.css
+- data/css/github2.css
+- github-markdown-preview.gemspec
+- lib/github-markdown-preview.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/github-markdown-preview_test.rb
+- test/html_preview_test.rb
+homepage: https://github.com/dmarcotte/github-markdown-preview
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id006
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id006
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Local previews for Github Flavored Markdown files
+test_files: 
+- test/github-markdown-preview_test.rb
+- test/html_preview_test.rb