octodown 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ae27659b96dc1aed9d8e54fc5fae1eb5af80ecb
-  data.tar.gz: a312690de332fd10839cc6d554c1caeb60043ed9
+  metadata.gz: bce562e8fb22b507adb9254a3a477e580e8476aa
+  data.tar.gz: 8bad0909539c3c0ec5976b899e3d8591db901b7c
 SHA512:
-  metadata.gz: 01102c2586155236c32827b65e9ec201ed96b32e90beb10ceb594a08a6a3318e2ff4cdce647f07cb3cecf61d36f5a8ab18b6762e5fd7e5df3030b9cfcc4dc85d
-  data.tar.gz: a27239bef742f5a5f4d42b63c0558f478428fe2e6992e671945cb5f181584db336c057e82970bd2a9d4961ad4dfb2304871ba5fbb61e3ced8a0bbb6f6e2695e4
+  metadata.gz: 52a608f823bea53fd6bfc09ba7cc4c5f5c40954d7977e798a6635c040e68e252c55c6013f1034b0e9e0ee574c7b0b24e694312f5c34ee0edd6d80702916e972a
+  data.tar.gz: 5e4d3e21b4127e3ac90ea4edbbc85231b771953c57ff1844f3490e218a92447c12bbc27d4ed4b24d17ccbf8e81e3adbcde6ad0b0276293218d77843fe6df90f9

data/README.md

@@ -7,16 +7,18 @@ Ever wanted to easily preview what you markdown would look like *exactly* on
 Github? Ever wanted to do that from inside of a Terminal? Well this Gem is for
 you. Dead simple. Never get caught writing ugly markdown again.
 
+![Octodown GIF](assets/octodown.gif?raw=true)
+
 ## Features:
 
   * Uses the same markdown parsers and CSS as Github for true duplication.
-    - Yes emojis *are* included
+    - Yes emojis *are* included.
   * Fast. `octodown` uses native parsers to ensure performance.
-  * Multiple CSS styles. Choose from either:
+  * Multiple CSS styles. Choose from either.
     - `$ octodown --style atom README.md`
     - The `github.com` markdown (default)
     - The `Atom` text editor markdown
-  * Properly parses `STDIN`
+  * Properly parses `STDIN`.
     - `$ cat README.md | octodown`
 
 ## Installation
@@ -33,17 +35,17 @@ you. Dead simple. Never get caught writing ugly markdown again.
 
   1. Basic:
     * `$ octodown README.md`
-  2. Markdown preview styling
+  2. Markdown preview styling:
     * `$ octodown --style atom README.md`
-  3. *nix lovers
+  3. *nix lovers:
     * `$ echo '# Hello world!' | octodown --raw > index.html`
 
 ## Notes
 
-  1. With no arguments given, octodown will read STDIN until EOF is reached. In
-  order to work with this mode, type what you want into the input, then press
+  1. With no arguments given, octodown will read `STDIN` until `EOF` is reached.
+    * In order to work with this mode, type what you want into the input, then press
   `Ctrl-D` when finished.
-  2. octodown attempts to use default OS support for opening HTML files from
+  2. `octodown` attempts to use default OS support for opening HTML files from
   terminal. In Mac, this would be the `open` command; for Linux it is either
   `xdg-open` or `x-www-browser`. If these are not set, octodown will not
   automatically open the file in the browser. If octodown doesn't have the

data/bin/octodown

@@ -11,10 +11,7 @@ OptionParser.new do |opts|
   opts.banner = 'Usage: octodown [options]'
 
   opts.on(
-    '-s',
-    '--style [STYLE]',
-    [:github, :atom],
-    'Choose style (atom, github)'
+    '-s', '--style [STYLE]', [:github, :atom], 'Choose style (atom, github)'
   ) do |s|
     options[:style] = s
   end
@@ -32,15 +29,15 @@ end.parse!
 def main(options)
   include Octodown::Support
 
-  input_contents = ARGF.read
+  content = ARGF.read
   style = options[:style] || 'github'
+  path = File.dirname(File.expand_path(ARGF.path))
 
   if options[:raw]
-    puts Helpers.markdown_to_raw_html input_contents, style
+    puts Helpers.markdown_to_raw_html content, style, path
   else
-    browser = Browser.new
-    html_file = Helpers.markdown_to_html input_contents, style
-    browser.open html_file
+    html_file = Helpers.markdown_to_html content, style, path
+    Browser.new.open html_file
   end
 end
 

data/lib/octodown/renderer/github_markdown.rb

@@ -5,10 +5,11 @@ require 'html/pipeline'
 module Octodown
   module Renderer
     class GithubMarkdown
-      attr_reader :content
+      attr_reader :content, :document_root
 
-      def initialize(content)
+      def initialize(content, document_root)
         @content = content
+        @document_root = document_root
       end
 
       def to_html
@@ -18,12 +19,16 @@ module Octodown
       private
 
       def context
-        { :asset_root => 'https://assets-cdn.github.com/images/icons/' }
+        {
+          :asset_root => 'https://assets-cdn.github.com/images/icons/',
+          :original_document_root => document_root
+        }
       end
 
       def pipeline
         ::HTML::Pipeline.new [
           ::HTML::Pipeline::MarkdownFilter,
+          ::Octodown::Support::RelativeRootFilter,
           ::HTML::Pipeline::SanitizationFilter,
           ::HTML::Pipeline::ImageMaxWidthFilter,
           ::HTML::Pipeline::MentionFilter,

data/lib/octodown/support/helpers.rb

@@ -1,16 +1,18 @@
 module Octodown
   module Support
     module Helpers
+      include Octodown::Renderer
+
       # TODO: Find a better home for this logic
-      def self.markdown_to_html(contents, template)
-        html = markdown_to_raw_html(contents, template)
+      def self.markdown_to_html(content, template, path)
+        html = markdown_to_raw_html(content, template, path)
         tmp = Octodown::Support::HTMLFile.new 'octodown'
         tmp.persistent_write html
       end
 
-      def self.markdown_to_raw_html(contents, template)
-        unstyled_html = Octodown::Renderer::GithubMarkdown.new(contents).to_html
-        Octodown::Renderer::HTML.new(unstyled_html, template).render
+      def self.markdown_to_raw_html(content, template, path)
+        unstyled_html = GithubMarkdown.new(content, path).to_html
+        HTML.new(unstyled_html, template).render
       end
     end
   end

data/lib/octodown/support/relative_root_filter.rb

@@ -0,0 +1,28 @@
+require 'uri'
+
+module Octodown
+  module Support
+    class RelativeRootFilter < HTML::Pipeline::Filter
+      def call
+        doc.search('img').each do |img|
+          next if img['src'].nil?
+
+          src = img['src'].strip
+
+          img['src'] = relative_path_from_document_root src unless http_uri? src
+        end
+
+        doc
+      end
+
+      def relative_path_from_document_root(src)
+        File.join(context[:original_document_root], src).to_s
+      end
+
+      def http_uri?(src)
+        parsed_uri = URI.parse src
+        parsed_uri.is_a? URI::HTTP
+      end
+    end
+  end
+end

data/lib/octodown/version.rb

@@ -1,3 +1,3 @@
 module Octodown
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/octodown.rb

@@ -2,6 +2,7 @@ require 'octodown/renderer/github_markdown'
 require 'octodown/renderer/html'
 require 'octodown/support/browser'
 require 'octodown/support/helpers'
+require 'octodown/support/relative_root_filter'
 require 'octodown/support/html_file'
 require 'octodown/version'
 

data/spec/markdown_generation_spec.rb

@@ -3,7 +3,7 @@ require 'tempfile'
 describe Octodown::Renderer::GithubMarkdown do
   let(:dummy_path) { File.join(File.dirname(__FILE__), 'dummy', 'test.md') }
   let(:html) do
-    Octodown::Renderer::GithubMarkdown.new(File.read(dummy_path)).to_html
+    Octodown::Renderer::GithubMarkdown.new(File.read(dummy_path), 'tmp').to_html
   end
 
   it 'create HTML from markdown file' do

data/spec/relative_root_filter_spec.rb

@@ -0,0 +1,14 @@
+require 'tempfile'
+
+describe Octodown::Renderer::GithubMarkdown do
+  subject { Octodown::Support::RelativeRootFilter.new(nil) }
+
+  it 'detects an non-HTTP/HTTPS URI correctly' do
+    expect(subject.http_uri?('assets/test.png')).to eq false
+  end
+
+  it 'detects HTTP/HTTPS URI correctly' do
+    expect(subject.http_uri?('http://foo.com/assets/test.png')).to eq true
+    expect(subject.http_uri?('https://foo.com/assets/test.png')).to eq true
+  end
+end

data/spec/template_rendering_spec.rb

@@ -3,7 +3,7 @@ require 'tempfile'
 describe Octodown::Renderer::HTML do
   let(:dummy_path) { File.join(File.dirname(__FILE__), 'dummy', 'test.md') }
   let(:html) do
-    Octodown::Renderer::GithubMarkdown.new(File.read(dummy_path)).to_html
+    Octodown::Renderer::GithubMarkdown.new(File.read(dummy_path), 'tmp').to_html
   end
 
   subject { Octodown::Renderer::HTML.new(html, 'github').render }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octodown
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ian Ker-Seymer
@@ -30,7 +30,7 @@ cert_chain:
   YGBeYMyEy7Q4wf7k4k5yyDUZyyaeg0DF/kNEN5llspJ9DHMP2cQqOiH+IQSNiUhR
   32sJqaZRHeJLDhZPLi5yXItTsQnPy6uob2oyypwFYTM=
   -----END CERTIFICATE-----
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2015-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-markup
@@ -205,6 +205,7 @@ files:
 - assets/atom.css
 - assets/favicon.png
 - assets/github.css
+- assets/octodown.gif
 - bin/octodown
 - lib/octodown.rb
 - lib/octodown/renderer/github_markdown.rb
@@ -212,12 +213,14 @@ files:
 - lib/octodown/support/browser.rb
 - lib/octodown/support/helpers.rb
 - lib/octodown/support/html_file.rb
+- lib/octodown/support/relative_root_filter.rb
 - lib/octodown/template/octodown.html.erb
 - lib/octodown/version.rb
 - octodown.gemspec
 - spec/browser_spec.rb
 - spec/dummy/test.md
 - spec/markdown_generation_spec.rb
+- spec/relative_root_filter_spec.rb
 - spec/spec_helper.rb
 - spec/template_rendering_spec.rb
 homepage: https://github.com/ianks/octodown
@@ -248,5 +251,6 @@ test_files:
 - spec/browser_spec.rb
 - spec/dummy/test.md
 - spec/markdown_generation_spec.rb
+- spec/relative_root_filter_spec.rb
 - spec/spec_helper.rb
 - spec/template_rendering_spec.rb