ghpreview 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github-preview.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Adam McCrea
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# ghpreview
+
+Say you're writing a README for your project, or any other Markdown that will 
+eventually be displayed on Github. You want a way to preview this locally 
+before you push it.
+
+`ghpreview` opens a preview of your Markdown file in a browser. It uses Github 
+styling and (optionally) automatically refreshes every time you save your 
+source.
+
+## Installation
+
+```bash
+$ gem install ghpreview
+```
+
+## Usage
+
+`ghpreview` is a command-line utility.
+
+```bash
+$ ghpreview README.md
+```
+
+This will open your default browser with a preview of README.md exactly as it 
+will appear on Github. For a live-updating preview, use the -w (watch) option:
+
+```bash
+$ ghpreview -w README.md
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/ghpreview

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'ghpreview'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: ghpreview [options] FILE"
+  opts.separator ""
+
+  opts.on("-w", "--watch", "Watch for changes") do |w|
+    options[:watch] = w
+  end
+end.parse!
+
+GHPreview::Previewer.new(ARGV[0], options)

data/ghpreview.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ghpreview/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ghpreview"
+  gem.version       = GHPreview::VERSION
+  gem.authors       = ["Adam McCrea"]
+  gem.email         = ["adam@adamlogic.com"]
+  gem.description   = %q{Command line utility for previewing Markdown files with Github styling}
+  gem.summary       = gem.description
+  gem.homepage      = "http://github.com/newcontext/ghpreview"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'listen'
+  gem.add_dependency 'rb-fsevent'
+  gem.add_dependency 'httpclient'
+end

data/lib/ghpreview.rb

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

data/lib/ghpreview/previewer.rb

@@ -0,0 +1,69 @@
+require 'erb'
+require 'httpclient'
+require 'listen'
+
+module GHPreview
+  class Previewer
+    API_URI                  = 'https://api.github.com/markdown/raw'
+    HOMEPAGE                 = 'https://github.com'
+    HTML_FILEPATH            = '/tmp/ghpreview.html'
+    RAW_TEMPLATE_FILEPATH    = "#{File.dirname(__FILE__)}/template.erb"
+    STYLED_TEMPLATE_FILEPATH = "/tmp/ghpreview-template.erb"
+
+    def initialize(md_filepath, options = {})
+      @md_filepath = md_filepath
+      @md_filename = md_filepath.split('/').last
+      @md_filedir  = md_filepath.split('/').unshift('.').uniq[0..-2].join('/')
+      generate_template_with_fingerprinted_stylesheet_links
+
+      options[:watch] ? listen : open
+    end
+
+    def listen
+      puts "Previewing #{@md_filepath}. CTRL-C to stop."
+      open
+      Listen.to(@md_filedir, filter: /#{@md_filename}$/) do |modified|
+        open
+      end
+    end
+
+    def open
+      html = markdown_to_html
+      html = wrap_content_with_full_document(html)
+      File.open(HTML_FILEPATH, 'w') { |f| f << html }
+      `open #{HTML_FILEPATH}`
+    end
+
+    private
+
+    def markdown_to_html
+      markdown = File.read(@md_filepath)
+      client   = HTTPClient.new
+      message  = client.post API_URI, body: markdown, header: {'Content-Type' => 'text/plain'}
+      message.body
+    end
+
+    def generate_template_with_fingerprinted_stylesheet_links
+      if stale_template?(STYLED_TEMPLATE_FILEPATH)
+        uri = URI.parse(HOMEPAGE)
+        stylesheet_links = uri.read.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.write(STYLED_TEMPLATE_FILEPATH, styled_template)
+      end
+    end
+
+    def stale_template?(filepath)
+      return true unless File.exists?(filepath)
+      File.mtime(filepath) < (Time.now - 60 * 60 * 24)
+    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

@@ -0,0 +1,16 @@
+<html>
+  <head>
+    <%= stylesheet_links %>
+    <style>
+      body { padding: 30px 0; }
+      #readme { width: 914px; margin: 0 auto; }
+    </style>
+  </head>
+  <body>
+    <div id="readme">
+      <article class="markdown-body">
+        <%%= content %>
+      </article>
+    </div>
+  </body>
+</html>

data/lib/ghpreview/version.rb

@@ -0,0 +1,3 @@
+module GHPreview
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: ghpreview
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam McCrea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Command line utility for previewing Markdown files with Github styling
+email:
+- adam@adamlogic.com
+executables:
+- ghpreview
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ghpreview
+- ghpreview.gemspec
+- lib/ghpreview.rb
+- lib/ghpreview/previewer.rb
+- lib/ghpreview/template.erb
+- lib/ghpreview/version.rb
+homepage: http://github.com/newcontext/ghpreview
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Command line utility for previewing Markdown files with Github styling
+test_files: []