vimwiki_markdown 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdd35443aa295839dff9ecc54fcaaf48616e7fa53b5733be67edb2fee17b9320
-  data.tar.gz: 711548c56d682b546f93e8e22d80f8dc948947bf3f9eee2bff4caeafdd475943
+  metadata.gz: e5a405825bd200606206847893bfe9bf8c923ce22c93cb9e63338e604b8dd0ab
+  data.tar.gz: 4688061eb966a4d76d84f12fbb6100a252dc7f7b7ef24d6c444d95c5a658c8c7
 SHA512:
-  metadata.gz: 77964b75a2cedd98f97af51d7f738730c6740f3d3b634b4efea9a26ff438c7cd94f5fca1034ea4a0eca7a76355453d0992984693a08ce3f1da3b3f5d546496ad
-  data.tar.gz: 7cd72fdeaee7b2ee7718955b2b628ab8358a9b4eb3de2cadac63b952e93a13d605a8a0de3eb9064a2e821b92ea2c89bd8d319127356dad6e3548ba1c2243383e
+  metadata.gz: 9d596d8fdc9e3f88a66fe70e46e2e7a6e60caa06aec14fd2268fcaacc47190cfd385dca3187428342822af91ab7b410bd55012054eb40b188f62ae579a4161dd
+  data.tar.gz: ee2fdbfab074ebc339496a61d70751839899780e9bb9cb66596da7a6b118c04193c2c9c461523651dd6c86b435efd21549485486f2857a9220dac4b4f52ce8fb

data/README.md

@@ -56,14 +56,21 @@ of the site (e.g. `./` or `../../` etc)
 You can also have a `%date%` marker in your template file
 It will get rewritten with todays date in the format 29 March 2019
 
+#### Support for :local and :file links
+
+We have partial support for the `:local` and `:file` link types for vimwiki.
+If you are editing `foo.md` (in the root dir of your wiki) and you are linking to `bar.txt` stored in the same directory as `foo.md` you can do:
+
+* `[link text](local:bar.txt)` when output to HTML becomes <a href="../bar.txt">link text</a>
+* `[link text](file:bar.txt)` when output to HTML becomes <a href="/absolute/path/to/file">link text</a>
+
 #### Optional %nohtml
 
 If you place the text %nohtml anywhere in a wiki page, it will not be processed into html
 
 ## Contributing
 
-Pull requests are very welcome, especially if you want to implement some of the
-more interesting vimwiki links (e.g. :local etc.)
+Pull requests are very welcome
 
 1. Fork it ( https://github.com/patrickdavey/vimwiki_markdown/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/changelog.md

@@ -1,3 +1,6 @@
+## 0.5.0 [April 26 2020]
+Partial support for `local` and `file` links in urls. Thanks to @tfachmann for [the PR](https://github.com/patrickdavey/vimwiki_markdown/pull/26).
+
 ## 0.4.4 [June 16 2019]
 Allow fragments if they are for local vimwiki links only
 

data/lib/vimwiki_markdown/version.rb

@@ -1,3 +1,3 @@
 module VimwikiMarkdown
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 end

data/lib/vimwiki_markdown/vimwiki_link.rb

@@ -11,15 +11,16 @@ module VimwikiMarkdown
   class VimwikiLink
     MARKDOWN_LINK_REGEX = /\[(?<title>.*)\]\((?<uri>(?:(?!#).)*)(?<fragment>(?:#)?.*)\)/
 
-    attr_reader :title, :uri, :fragment, :source_markdown_directory, :markdown_extension, :root_path
+    attr_reader :title, :uri, :fragment, :source_markdown_directory, :markdown_extension, :root_path, :output_dir
 
-    def initialize(markdown_link, source_markdown_filepath, markdown_extension, root_path)
+    def initialize(markdown_link, source_markdown_filepath, markdown_extension, root_path, output_dir)
       @title = markdown_link.match(MARKDOWN_LINK_REGEX)[:title]
       @uri = markdown_link.match(MARKDOWN_LINK_REGEX)[:uri]
       @fragment = markdown_link.match(MARKDOWN_LINK_REGEX)[:fragment]
       @markdown_extension = markdown_extension
       @root_path = root_path
       @source_markdown_directory = Pathname.new(source_markdown_filepath).dirname
+      @output_dir = output_dir
       rewrite_local_links!
     end
 
@@ -35,9 +36,32 @@ module VimwikiMarkdown
         path = Pathname.new(uri)
         @uri = "#{path.dirname + path.basename(markdown_extension).to_s.parameterize}.html"
         @fragment = fragment.parameterize.prepend("#") unless fragment.empty?
+      elsif  /^file:/.match?(uri)
+        # begins with file: -> force absolute path if file exists
+        @uri = "#{source_markdown_directory + uri}" if uri_relative_path_exists?
+      elsif  /^local:/.match?(uri)
+        # begins with local: -> force relative path if file exists
+        source = Pathname.new(source_markdown_directory)
+        output = Pathname.new(output_dir)
+        @uri = "#{source.relative_path_from(output) + uri}" if uri_relative_path_exists?
       end
     end
 
+    def uri_relative_path_exists?
+      # remove file: or local: prefix
+      tmp = uri.sub(/^file:|^local:/, "") if uri.present?
+      path, title = tmp.split(/\.?\s+\"/)  # handle image title
+      path = Pathname.new(path)
+      path = path.realpath.relative_path_from(source_markdown_directory) if path.absolute?
+
+      if File.exist?(source_markdown_directory + path)
+        title = "\"#{title}" unless title.nil? || title.empty?
+        @uri = "#{path.to_s.gsub(/\ /, '%20')} #{title}".strip
+        return true
+      end
+      false
+    end
+
     def vimwiki_markdown_file_exists?
       File.exist?((source_markdown_directory + uri).sub_ext(markdown_extension)) ||
       absolute_path_to_markdown_file_exists?

data/lib/vimwiki_markdown/wiki_body.rb

@@ -63,7 +63,7 @@ class VimwikiMarkdown::WikiBody
 
   def convert_markdown_local_links!
     @markdown_body = @markdown_body.gsub(/\[.*?\]\(.*?\)/) do |match|
-      VimwikiMarkdown::VimwikiLink.new(match, options.input_file, options.extension, options.root_path).to_s
+      VimwikiMarkdown::VimwikiLink.new(match, options.input_file, options.extension, options.root_path, options.output_dir).to_s
     end
   end
 

data/spec/lib/vimwiki_markdown/vimwiki_link_spec.rb

@@ -1,29 +1,33 @@
-require 'spec_helper'
+require "spec_helper"
 
 module VimwikiMarkdown
   describe VimwikiLink do
-    let(:markdown_link) { "[title](http://www.google.com)" }
-    let(:source_filepath) { "unimportant" }
     let(:markdown_extension) { ".md" }
     let(:root_path) { "-" }
 
-    it "should leave external links alone" do
-      link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path)
-      expect(link.to_s).to eq(markdown_link)
-    end
-    
-    it "should not alter fragments which are part of a url" do
-      markdown_link = "[test](http://foo#Bar)"
+    context "external or fragment only" do
+      let(:markdown_link) { "[title](http://www.google.com)" }
+      let(:source_filepath) { "unimportant" }
+      let(:output_dir) { "unused in this scenario" }
 
-      link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path)
-      expect(link.to_s).to eq("[test](http://foo#Bar)")
-    end
+      it "should leave external links alone" do
+        link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path, output_dir)
+        expect(link.to_s).to eq(markdown_link)
+      end
+
+      it "should not alter fragments which are part of a url" do
+        markdown_link = "[test](http://foo#Bar)"
+
+        link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path, output_dir)
+        expect(link.to_s).to eq("[test](http://foo#Bar)")
+      end
 
-    it "should not alter fragment-only links" do
-      markdown_link = "[test](#GTD)"
+      it "should not alter fragment-only links" do
+        markdown_link = "[test](#GTD)"
 
-      link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path)
-      expect(link.to_s).to eq("[test](#GTD)")
+        link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path, output_dir)
+        expect(link.to_s).to eq("[test](#GTD)")
+      end
     end
 
     context "with an existing markdown file matching name" do
@@ -32,10 +36,12 @@ module VimwikiMarkdown
       let(:temp_wiki_dir) { Pathname.new(Dir.mktmpdir("temp_wiki_")) }
       let(:markdown_link) { "[test](#{existing_file})" }
       let(:source_filepath) { temp_wiki_dir + "index.md" }
+      let(:output_dir) { temp_wiki_dir + "temp_output_dir" }
 
       before(:each) do
         # here we create a stub test filename in the directory,
         FileUtils.mkdir_p((temp_wiki_dir + existing_file).dirname)
+        FileUtils.mkdir_p(output_dir)
         FileUtils.touch(temp_wiki_dir + existing_file)
       end
 
@@ -44,21 +50,21 @@ module VimwikiMarkdown
       end
 
       it "must convert same-directory markdown links correctly" do
-        link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path)
+        link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path, output_dir)
         expect(link.to_s).to eq("[test](#{existing_file_no_extension}.html)")
       end
 
       it "must convert same-directory markdown links with no extension correctly" do
-        markdown_link =  "[test](#{existing_file_no_extension})"
+        markdown_link = "[test](#{existing_file_no_extension})"
 
-        link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path)
+        link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path, output_dir)
         expect(link.to_s).to eq("[test](#{existing_file_no_extension}.html)")
       end
 
       it "must convert same-directory markdown links with url fragments correctly" do
         markdown_link = "[test](#{existing_file_no_extension}#Wiki Heading)"
 
-        link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path)
+        link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path, output_dir)
         expect(link.to_s).to eq("[test](#{existing_file_no_extension}.html#wiki-heading)")
       end
 
@@ -66,16 +72,15 @@ module VimwikiMarkdown
         let(:existing_file) { "subdirectory/test.md" }
 
         it "must convert markdown links correctly" do
-          link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path)
+          link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path, output_dir)
           expect(link.to_s).to eq("[test](#{existing_file_no_extension}.html)")
         end
 
         it "must convert directory links correctly" do
-          markdown_link =  "[subdirectory](subdirectory/)"
-          link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path)
+          markdown_link = "[subdirectory](subdirectory/)"
+          link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path, output_dir)
           expect(link.to_s).to eq("[subdirectory](subdirectory/)")
         end
-
       end
 
       context "../ style links" do
@@ -83,7 +88,7 @@ module VimwikiMarkdown
         let(:source_filepath) { temp_wiki_dir + "subdirectory/index.md" }
 
         it "must convert sub-directory markdown links correctly" do
-          link = VimwikiLink.new("[test](../test)", source_filepath, markdown_extension, root_path)
+          link = VimwikiLink.new("[test](../test)", source_filepath, markdown_extension, root_path, output_dir)
           expect(link.to_s).to eq("[test](../test.html)")
         end
       end
@@ -94,12 +99,12 @@ module VimwikiMarkdown
         let(:root_path) { "../"}
 
         it "must convert absolute paths correctly" do
-          link = VimwikiLink.new("[test](/test.md)", source_filepath, markdown_extension, root_path)
+          link = VimwikiLink.new("[test](/test.md)", source_filepath, markdown_extension, root_path, output_dir)
           expect(link.to_s).to eq("[test](/test.html)")
         end
 
         it "must convert absolute paths without extension correctly" do
-          link = VimwikiLink.new("[test](/test)", source_filepath, markdown_extension, root_path)
+          link = VimwikiLink.new("[test](/test)", source_filepath, markdown_extension, root_path, output_dir)
           expect(link.to_s).to eq("[test](/test.html)")
         end
 
@@ -107,11 +112,37 @@ module VimwikiMarkdown
           let(:source_filepath) { temp_wiki_dir + "index.md" }
 
           it "must convert absolute paths correctly" do
-            link = VimwikiLink.new("[test](/test)", source_filepath, markdown_extension, ".")
+            link = VimwikiLink.new("[test](/test)", source_filepath, markdown_extension, ".", output_dir)
             expect(link.to_s).to eq("[test](/test.html)")
           end
         end
       end
+
+      context "links with local: files" do
+        let(:sample_png) { "foo.png" }
+
+        before do
+          FileUtils.touch(temp_wiki_dir + sample_png)
+        end
+
+        it "must convert local paths correctly" do
+          link = VimwikiLink.new("[test](local:#{sample_png})", source_filepath, markdown_extension, root_path, output_dir)
+          expect(link.to_s).to eq("[test](../#{sample_png})")
+        end
+      end
+
+      context "links with file: files" do
+        let(:sample_png) { "foo.png" }
+
+        before do
+          FileUtils.touch(temp_wiki_dir + sample_png)
+        end
+
+        it "must convert local paths correctly" do
+          link = VimwikiLink.new("[test](file:#{sample_png})", source_filepath, markdown_extension, root_path, output_dir)
+          expect(link.to_s).to eq("[test](#{temp_wiki_dir + sample_png})")
+        end
+      end
     end
   end
 end

data/spec/lib/vimwiki_markdown/wiki_body_spec.rb

@@ -6,7 +6,7 @@ require 'rspec-html-matchers'
 module VimwikiMarkdown
   describe WikiBody do
 
-    let(:wiki_body) { WikiBody.new(double(:options, input_file: 'blah', extension: 'md', root_path: '-')) }
+    let(:wiki_body) { WikiBody.new(double(:options, input_file: 'blah', extension: 'md', root_path: '-', output_dir: ".")) }
     let(:markdown_file_content) { wiki_index_markdown }
 
     it "must convert wiki links" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimwiki_markdown
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Patrick Davey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-23 00:00:00.000000000 Z
+date: 2020-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler