viewmd 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: def90ea77cc1d012d5715ade12cf309f50c1e5bb
-  data.tar.gz: 6cc5b29e5e42b08043e93a54973081dff2249e9c
+  metadata.gz: 7be3c05b0aaa2b6b2bda0a81620064159ce58d66
+  data.tar.gz: 1ea291a7e59697181ae36496b3a1f883bed176b5
 SHA512:
-  metadata.gz: 6a291e71610a7edf45d32acaeee2820c18d0187075be89998979cf276854cb6774a0274bc6a1885c41716dc933f0d37540dd616fc26dc064a06b0ee5b780e059
-  data.tar.gz: 210f7cb1d9144ea120276c08b47ffd7c39f1e1b46dbb40d3c1928f27c984e6a7c2a0cd536fba36a3b721bab0c60ef88e913b26a55ef46a2e3e52cdaaa8c60142
+  metadata.gz: f145c2a21bb119ed3400bbab50eadeceabd1b734c3ad77a395c3fdf403c245853f0d56e976920990752fa7ba6d6a66b66bbcdfda397b18f6e95df0cd494f23b2
+  data.tar.gz: 3be059a0d417ab6859f5e2776a7c3894da5679fa1850fb9878f486a2fae1f57dde80058e505cd6a1af2d2fbbcd0df95cb997147e746807e5aae3559a8c8fde88

data/README.md

@@ -1,6 +1,6 @@
 # Viewmd
 
-Viewmd is a command line tool for viewing your Markdown files (e.g. README.md) in your local browser. Uses [GitHub dialect](https://help.github.com/articles/github-flavored-markdown) of Markdown, so the result should look very close to what you'd see on Github if you put the file on GitHub.
+Viewmd is a command line tool for viewing your Markdown files (e.g. README.md) in your local browser. Uses [GitHub dialect](https://help.github.com/articles/github-flavored-markdown) of Markdown and some elements of [GitHub CSS for syntax highlighting](https://github.com/aahan/pygments-github-style), so the result should resemble what you'd see on Github once you commit the file.
 
 I guess, we all hate committing files with bugs. In case of Markdown files, like README.md, it's possible to make some little mistake while editing the file (e.g. forget the trailing triple-backticks) and end up with an incorrectly formatted file checked in to your repository. Seeing it only on GitHub already, for example, and having to do another little fix & commit just to fix this little formatting mistake seens like an untidy process to me. Thus I created this really simple command-line tool to see how the file would look like *before* committing. 
 
@@ -10,17 +10,9 @@ Please note that I tested it on MacOS only. If you use other OS in your developm
 
 ## Installation
 
-If you prefer managing your tools through your application's Gemfile, add this line there:
+This gem has many GitHub-specific dependencies (primarily, due to the use of [html-pipeline](https://github.com/jch/html-pipeline)). So, gem version conflicts are quite likely if you try to install this tool using Gemfile.
 
-```ruby
-gem 'viewmd', group: :development, require: false
-```
-
-And then execute:
-
-    $ bundle
-
-Or, better yet, as with all generic dev-tools, install the gem yourself environment-wide as:
+Install the gem yourself environment-wide as:
 
     $ gem install viewmd
 
@@ -43,9 +35,14 @@ The public API should not be considered stable.
 
 ## Dependencies
 
-* [github-markup](https://github.com/github/markup)
+* [html-pipeline](https://github.com/jch/html-pipeline)
 * [github-markdown](https://rubygems.org/gems/github-markdown)
+* [github-linguist](https://github.com/github/linguist)
+* [pygments.rb](https://github.com/tmm1/pygments.rb)
+* [rinku](https://github.com/vmg/rinku)
+* [sanitize](https://github.com/rgrove/sanitize)
 * [launchy](https://github.com/copiousfreetime/launchy)
+* CSS from [pygments-github-style](https://github.com/aahan/pygments-github-style)
 
 ## Contributing
 

data/lib/viewmd.rb

@@ -1,12 +1,28 @@
 require 'viewmd/version'
-require 'github/markup'
+require 'html/pipeline'
+
+require 'pygments.rb'
+
 require 'launchy'
 require 'tempfile'
+require 'open-uri'
 
 module Viewmd
   def self.view(name)
-    Tempfile.create(['viewmd','.htm'],Dir.tmpdir,File::CREAT|File::TRUNC|File::RDWR, 0600) do |f|
-      f << GitHub::Markup.render(name, File.read(name))
+    Tempfile.create(["viewmd-#{name}-",'.htm'],Dir.tmpdir,File::CREAT|File::TRUNC|File::RDWR, 0600) do |f|
+      pipeline = HTML::Pipeline.new [
+        HTML::Pipeline::MarkdownFilter,
+        HTML::Pipeline::SanitizationFilter,
+        HTML::Pipeline::AutolinkFilter,
+        HTML::Pipeline::SyntaxHighlightFilter
+      ], gfm: true
+      result = pipeline.call File.read(name)
+      f << "<!DOCTYPE html><html><head><style>"
+      f << "pre { background-color: #f7f7f7; padding: 16px; font-size: 85%; margin-bottom: 16px; line-height: 1.45; }"
+      f << open('https://raw.githubusercontent.com/aahan/pygments-github-style/master/github.css').read
+      f << "</style></head><body>"
+      f << result[:output].to_s
+      f << "</body></html>"
       f.flush
       Launchy.open(f.path) 
       # joining the launchy thread doesn't help to wait for browser to close before deleting the file

data/lib/viewmd/version.rb

@@ -1,3 +1,3 @@
 module Viewmd
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/viewmd.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Viewmd::VERSION
   spec.authors       = ['moonfly (Andrey Pronin)']
   spec.email         = ['moonfly.msk@gmail.com']
-  spec.summary       = %q{Command line tool for viewing Markdown files (GitHub Markup) in a browser}
-  spec.description   = %q{Command line tool for viewing Markdown files (GitHub Markup) in a browser}
+  spec.summary       = %q{Command line tool for viewing Markdown files (with GitHub Markdown extensions) in a browser}
+  spec.description   = %q{Command line tool for viewing Markdown files (with GitHub Markdown extensions) in a browser}
   spec.homepage      = 'https://github.com/moonfly/viewmd'
   spec.license       = "MIT"
 
@@ -25,12 +25,14 @@ Gem::Specification.new do |spec|
   spec.rdoc_options = ['--charset=UTF-8']
   spec.extra_rdoc_files = %w[README.md CONTRIBUTORS.md LICENSE.md]
   
-  spec.add_dependency 'github-markup', '>= 1.3'
   spec.add_dependency 'launchy', '>= 2.4'
   spec.add_dependency 'github-markdown', '>= 0.6'
+  spec.add_dependency 'html-pipeline', '>= 1.11'
+  spec.add_dependency 'pygments.rb', '>= 0.6'
+  spec.add_dependency 'github-linguist', '>= 3.1'
+  spec.add_dependency 'rinku', '>= 1.7'
+  spec.add_dependency 'sanitize', '>= 3.0'
   
   spec.add_development_dependency "bundler", ">= 1.6"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'coveralls'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: viewmd
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - moonfly (Andrey Pronin)
@@ -11,35 +11,49 @@ cert_chain: []
 date: 2014-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: github-markup
+  name: launchy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: launchy
+  name: github-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: github-markdown
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,49 +67,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: github-linguist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
+        version: '3.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rinku
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.7'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sanitize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,7 +136,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Command line tool for viewing Markdown files (GitHub Markup) in a browser
+description: Command line tool for viewing Markdown files (with GitHub Markdown extensions)
+  in a browser
 email:
 - moonfly.msk@gmail.com
 executables:
@@ -153,5 +182,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Command line tool for viewing Markdown files (GitHub Markup) in a browser
+summary: Command line tool for viewing Markdown files (with GitHub Markdown extensions)
+  in a browser
 test_files: []