octodown 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dad582795e7cd14b58107e3c533ecfc71503f4d2
-  data.tar.gz: 71b248c82c33cb1d4ed0991531f79dec0fb58da2
+  metadata.gz: b721d419c467bda182458949f39695c1b732d9e8
+  data.tar.gz: c118f3700a68ef6fa62416a28032bbc13b94129d
 SHA512:
-  metadata.gz: bf4eb1f65e95f3b94a6b76814f854ba2cda0ad59aed4ebff05232689009e5cad6cf10aa1b4704274b1fa7c62bde43a439c992a0804a4d6d23ce3751f8e57eda9
-  data.tar.gz: 4c986a05888c0d05b48de4dcc726f1e3ff2fbaea6ca32447170d5cc197d8f45357431892081b6d65e1d4d6f7b958940ad89c69888df2f84e4941a2f315ecaaa8
+  metadata.gz: 83597f2ebb4badd314fe9b5bb0671db01e5d673fdf363b1a0d7dd7145fe132f9bbf60d311db27bf1f74b9f82d64dde1c63bf744cc8fcfac6b5872812ee65401b
+  data.tar.gz: 297fd7ac4d5c7bf7ab649bee4b8c3137f977e88d0a72f2fd7f4e82c7030f341f3a5c36c146b5a1586834960c93adf200b5ab515f12406f656b06f0c4ee644d57

data/README.md

@@ -34,8 +34,8 @@ primary goal to reproduce it as faithfully as possible.
 ## Installation
 
   1. Install `icu4c` and `cmake`:
-    - Mac: `brew install icu4c cmake`
-    - Apt: `sudo apt-get install -y libicu-dev cmake`
+    - Mac: `brew install icu4c cmake pkg-config`
+    - Apt: `sudo apt-get install -y libicu-dev cmake pkg-config`
 
   2. Install octodown:
     - If you have a non-system Ruby (_highly recommended_):  `gem install

data/lib/octodown/support/relative_root_filter.rb

@@ -3,26 +3,63 @@ 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
+      attr_accessor :root
 
-          img['src'] = relative_path_from_document_root src unless http_uri? src
-        end
+      def call
+        @root = context[:original_document_root]
 
-        doc
+        filter_images doc.search('img')
+        filter_links doc.search('a')
       end
 
-      def relative_path_from_document_root(src)
-        File.join(context[:original_document_root], src).to_s
+      private
+
+      def relative_path_from_document_root(root, src)
+        File.join(root, src).to_s
       end
 
       def http_uri?(src)
         parsed_uri = URI.parse src
         parsed_uri.is_a? URI::HTTP
       end
+
+      # TODO: These two methods are highly similar and can be refactored, but
+      #   I'm can't find the right abstraction at the moment that isn't a total
+      #   hack involving bizarre object references and mutation
+
+      def filter_images(images)
+        images.each do |img|
+          src = img['src']
+
+          next if src.nil?
+
+          src.strip!
+
+          unless http_uri? src
+            path = relative_path_from_document_root root, src
+            img['src'] = path
+          end
+        end
+
+        doc
+      end
+
+      def filter_links(links)
+        links.each do |a|
+          src = a.attributes['href'].value
+
+          next if src.nil?
+
+          src.strip!
+
+          unless http_uri? src
+            path = relative_path_from_document_root root, src
+            a.attributes['href'].value = path
+          end
+        end
+
+        doc
+      end
     end
   end
 end

data/lib/octodown/version.rb

@@ -1,3 +1,3 @@
 module Octodown
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/spec/dummy/test.md

@@ -10,3 +10,5 @@ def some_code()
   puts 'Yeah, this is some code.'
 end
 ```
+
+[some-file](test.txt)

data/spec/markdown_generation_spec.rb

@@ -35,4 +35,10 @@ describe Octodown::Renderer::GithubMarkdown do
       end
     end
   end
+
+  describe 'local file linking' do
+    it 'includes the local file from correct location' do
+      expect(html).to include '<a href="tmp/test.txt">some-file</a>'
+    end
+  end
 end

data/spec/relative_root_filter_spec.rb

@@ -3,12 +3,24 @@ require 'tempfile'
 describe Octodown::Renderer::GithubMarkdown do
   subject { Octodown::Support::RelativeRootFilter.new(nil) }
 
+  # Testing private methods because Nokogirl is a black box
   it 'detects an non-HTTP/HTTPS URI correctly' do
-    expect(subject.http_uri?('assets/test.png')).to eq false
+    expect(subject.send(: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
+    expect(subject.send(:http_uri?, 'http://foo.com/assets/test.png'))
+      .to eq true
+    expect(subject.send(:http_uri?, 'https://foo.com/assets/test.png'))
+      .to eq true
+  end
+
+  it 'renders the relative root correctly' do
+    root = '/home/test'
+    src = 'dummy/test.md'
+
+    expect(subject.send(:relative_path_from_document_root, root, src)).to eq(
+      '/home/test/dummy/test.md'
+    )
   end
 end

data.tar.gz.sig

@@ -1 +1,2 @@
-,����t�n��+՞��OS<��U����u�dVQ�@{��)`�|7�E��x!�w����"�N�}�3i�9�r�uh��uҺU�_zt�� ���e�S����V:U&�
@����SIRHLw#Ƴ:��2�y��5%���
����f������Dzk�q��8���\G�Ewm(�G�;�7�m�)8����3��eG�#��)��d˛#�B��$��r�<��䁇>�
K���%�-D)�U5(����]G
+�S�{m
+�Q�z��P�:v��}�
��*Q";H@��D�uEJ����5ܟoe��H��5֒�����a%���)����&5{�z���m�z��)Œ����Q�U�]d3��<7��W;"0
~i��nQ��x�ҡ[*���0�z7���?Ǒ$[�y���T�����M'(�����xB

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octodown
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Ian Ker-Seymer
@@ -30,7 +30,7 @@ cert_chain:
   YGBeYMyEy7Q4wf7k4k5yyDUZyyaeg0DF/kNEN5llspJ9DHMP2cQqOiH+IQSNiUhR
   32sJqaZRHeJLDhZPLi5yXItTsQnPy6uob2oyypwFYTM=
   -----END CERTIFICATE-----
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-markup