gh-preview 1.0.0

data/spec/fixtures/example.html

@@ -0,0 +1,71 @@
+<h2>
+<a id="githubpreview" class="anchor" href="#githubpreview" aria-hidden="true"><span class="octicon octicon-link"></span></a>GithubPreview</h2>
+
+<h3>
+<a id="a-small-sinatra-application-to-preview-github-readme-files-easy-" class="anchor" href="#a-small-sinatra-application-to-preview-github-readme-files-easy-" aria-hidden="true"><span class="octicon octicon-link"></span></a>A small Sinatra application to preview GitHub README files, easy ;)</h3>
+
+<p>This gem provides a small Sinatra application to preview GitHub README files or any markdown file.</p>
+
+<h2>
+<a id="installation" class="anchor" href="#installation" aria-hidden="true"><span class="octicon octicon-link"></span></a>Installation</h2>
+<div class="highlight"><pre><span class="n">gem</span> <span class="n">install</span> <span class="n">gh</span><span class="o">-</span><span class="n">preview</span>
+</pre></div>
+<p>No need to add it to your Gemfile, it will be globally available.</p>
+
+<h2>
+<a id="usage" class="anchor" href="#usage" aria-hidden="true"><span class="octicon octicon-link"></span></a>Usage</h2>
+
+<p>From any directory containing a <code>README.md</code> file :</p>
+<div class="highlight"><pre>nicolas@desktop:~/PROJECTS/GITHUB/gh-preview<span class="nv">$ </span>gh-preview server
+</pre></div>
+<h2>
+<a id="options" class="anchor" href="#options" aria-hidden="true"><span class="octicon octicon-link"></span></a>Options</h2>
+<div class="highlight"><pre>Usage:
+  gh-preview server <span class="o">[</span>options<span class="o">]</span>
+
+Options:
+  -f, <span class="o">[</span>--file<span class="o">=</span>FILE<span class="o">]</span>  <span class="c"># File to serve   (default: README.md)</span>
+  -p, <span class="o">[</span>--port<span class="o">=</span>PORT<span class="o">]</span>  <span class="c"># Port for server (default 4000)</span>
+</pre></div>
+<h2>
+<a id="contribute" class="anchor" href="#contribute" aria-hidden="true"><span class="octicon octicon-link"></span></a>Contribute</h2>
+
+<p>You can contribute to this plugin in many ways such as :</p>
+
+<ul class="task-list">
+<li>Helping with documentation</li>
+<li>Contributing code (features or bugfixes)</li>
+<li>Reporting a bug</li>
+<li>Submitting translations</li>
+</ul>
+
+<p>this is <del>good</del> bad</p>
+
+<table>
+<thead>
+<tr>
+<th>Column1</th>
+<th>Column2</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Line1</td>
+<td>Hello</td>
+</tr>
+<tr>
+<td>Line2</td>
+<td>World</td>
+</tr>
+</tbody>
+</table>
+
+<p>This is <u>underlined</u> but this is still <em>italic</em></p>
+
+<p>This is <mark>highlighted</mark></p>
+
+<ol class="task-list">
+<li>item1</li>
+<li>item2</li>
+<li>item3</li>
+</ol>

data/spec/fixtures/example.md

@@ -0,0 +1,56 @@
+## GithubPreview
+
+### A small Sinatra application to preview GitHub README files, easy ;)
+
+This gem provides a small Sinatra application to preview GitHub README files or any markdown file.
+
+## Installation
+
+```ruby
+gem install gh-preview
+```
+
+No need to add it to your Gemfile, it will be globally available.
+
+## Usage
+
+From any directory containing a ```README.md``` file :
+
+```sh
+nicolas@desktop:~/PROJECTS/GITHUB/gh-preview$ gh-preview server
+```
+
+## Options
+
+```sh
+Usage:
+  gh-preview server [options]
+
+Options:
+  -f, [--file=FILE]  # File to serve   (default: README.md)
+  -p, [--port=PORT]  # Port for server (default 4000)
+```
+
+## Contribute
+
+You can contribute to this plugin in many ways such as :
+
+* Helping with documentation
+* Contributing code (features or bugfixes)
+* Reporting a bug
+* Submitting translations
+
+this is ~~good~~ bad
+
+ Column1 | Column2
+---------|--------
+Line1    | Hello
+Line2    | World
+
+This is _underlined_ but this is still *italic*
+
+This is ==highlighted==
+
+1. item1
+2. item2
+3. item3

data/spec/lib/gh_preview/config_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe GhPreview::Config do
+
+  include GhPreview::Config
+
+  it "should have a view folder" do
+    expect(views_folder).to eq File.join(Dir.pwd, 'views')
+  end
+
+
+  it "should have a public folder" do
+    expect(public_folder).to eq File.join(Dir.pwd, 'public')
+  end
+end

data/spec/lib/gh_preview/converter_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe GhPreview::Converter do
+
+  include GhPreview::Converter
+
+  def markdown_content
+    load_fixture('example.md')
+  end
+
+
+  def html_content
+    load_fixture('example.html')
+  end
+
+
+  it "should render markdown to html" do
+    expect{ to_html(markdown_content).to eq html_content }
+  end
+
+end

data/spec/lib/gh_preview/server_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe GhPreview::Server do
+
+  def setup_app(file)
+    Capybara.app = GhPreview::Server.new(file)
+  end
+
+
+  describe 'the preview process', type: :feature do
+    context 'when file is not present' do
+      it 'should render an error' do
+        setup_app('toto.md')
+        visit '/'
+        expect(page).to have_content "toto.md doesn't exist !"
+      end
+    end
+
+    context 'when README.md is present' do
+      it 'should render the file' do
+        setup_app(fixture_path('example.md'))
+        visit '/'
+        expect(page).to have_content 'A small Sinatra application to preview GitHub README files, easy ;)'
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'simplecov'
+require 'rack/test'
+require 'rspec'
+require 'capybara/rspec'
+require 'codeclimate-test-reporter'
+require 'support/helper'
+
+## Configure SimpleCov
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  CodeClimate::TestReporter::Formatter
+]
+
+## Start Simplecov
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+## Configure RSpec
+RSpec.configure do |config|
+  include Helper
+
+  config.color = true
+  config.fail_fast = false
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+ENV['RACK_ENV'] = 'test'
+require 'gh_preview'

data/spec/support/helper.rb

@@ -0,0 +1,12 @@
+module Helper
+
+  def load_fixture(fixture)
+    File.read(fixture_path(fixture))
+  end
+
+
+  def fixture_path(fixture)
+    File.expand_path(File.dirname(__FILE__) + "/../fixtures/#{fixture}")
+  end
+
+end

data/spec/zeus_plan.rb

@@ -0,0 +1,25 @@
+require 'zeus/rails'
+
+class ZeusPlan < Zeus::Rails
+
+  def boot
+  end
+
+
+  def prerake
+    require 'rake'
+  end
+
+
+  def rake
+    Rake.application.run
+  end
+
+
+  def default_env
+    require 'gh_preview'
+  end
+
+end
+
+Zeus.plan = ZeusPlan.new

data/views/_headers.haml

@@ -0,0 +1,7 @@
+%title= "#{GhPreview::Config::NAME}"
+%script{ type: 'text/javascript', src: 'https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.js' }
+%script{ type: 'text/javascript', src: 'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js' }
+%link{ type: 'text/css', rel: 'stylesheet', href: 'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css' }
+%link{ type: 'text/css', rel: 'stylesheet', href: '/stylesheets/github-markdown.css' }
+%link{ type: 'text/css', rel: 'stylesheet', href: '/stylesheets/application.css' }
+%style{ type: 'text/css' }= Pygments.css(style: 'trac')

data/views/_nav_bar.haml

@@ -0,0 +1,9 @@
+%nav{ class: 'navbar navbar-default' }
+  %div{ class: 'container-fluid' }
+    %div{ class: 'navbar-header' }
+      %button{ type: 'button', class: 'navbar-toggle collapsed', data_toggle: 'collapse', data_target: '#navbar', aria_expanded: 'false', aria_controls: 'navbar' }
+        %span{ class: 'sr-only' } Toggle navigation
+        %span{ class: 'icon-bar' }
+        %span{ class: 'icon-bar' }
+        %span{ class: 'icon-bar' }
+      %a{ class: 'navbar-brand', href: '#' }= "#{GhPreview::Config::NAME}"

data/views/_page.haml

@@ -0,0 +1,9 @@
+.container
+  .row
+    .col-md-12
+
+      = styled_flash
+
+      %article{ class: 'markdown-body entry-content' }
+        :preserve
+          #{@text}

data/views/index.haml

@@ -0,0 +1,13 @@
+!!! 5
+%html
+
+  %head= render partial: 'headers'
+
+  %body
+
+    %a{ href: "#{GhPreview::Config::GITHUB_URL}" }
+      %img{ alt: 'Fork me on GitHub', src: 'http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png', class: 'ribbons' }
+
+    .container
+      = render partial: 'nav_bar'
+      = render partial: 'page'

data/zeus.json

@@ -0,0 +1,9 @@
+{
+  "command": "ruby -rubygems -r./spec/zeus_plan -eZeus.go",
+  "plan": {
+    "boot": {
+      "prerake": { "rake": [] },
+      "default_env": {}
+    }
+  }
+}

metadata

@@ -0,0 +1,466 @@
+--- !ruby/object:Gem::Specification
+name: gh-preview
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nicolas Rodriguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: sinatra-flash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: task_list
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: rinku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: zeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+description: A small gem to preview GitHub README files
+email:
+- nrodriguez@jbox-web.com
+executables:
+- gh-preview
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- AUTHORS
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/gh-preview
+- gh-preview.gemspec
+- lib/gh_preview.rb
+- lib/gh_preview/config.rb
+- lib/gh_preview/converter.rb
+- lib/gh_preview/redcarpet_filter.rb
+- lib/gh_preview/runner.rb
+- lib/gh_preview/server.rb
+- lib/gh_preview/version.rb
+- lib/sinatra/flash/style_patch.rb
+- public/stylesheets/application.css
+- public/stylesheets/github-markdown.css
+- spec/fixtures/example.html
+- spec/fixtures/example.md
+- spec/lib/gh_preview/config_spec.rb
+- spec/lib/gh_preview/converter_spec.rb
+- spec/lib/gh_preview/server_spec.rb
+- spec/spec_helper.rb
+- spec/support/helper.rb
+- spec/zeus_plan.rb
+- views/_headers.haml
+- views/_nav_bar.haml
+- views/_page.haml
+- views/index.haml
+- zeus.json
+homepage: http://jbox-web.github.io/gh-preview/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: This gem provides a small Sinatra application to preview GitHub README files
+test_files:
+- spec/fixtures/example.html
+- spec/fixtures/example.md
+- spec/lib/gh_preview/config_spec.rb
+- spec/lib/gh_preview/converter_spec.rb
+- spec/lib/gh_preview/server_spec.rb
+- spec/spec_helper.rb
+- spec/support/helper.rb
+- spec/zeus_plan.rb