vimwiki_markdown 0.4.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9350bfdab384da03bd60949b18575b0d29b69df197e73370e5e20d5124a2105e
-  data.tar.gz: acf9164c1ff195e280364de0e3a341c618a7d892989a6d7702e6a7eab57bdd20
+  metadata.gz: d4893e1d18542936cff19882c791e51c9d8234cefaaec3751cff7fc9724eb70e
+  data.tar.gz: 1e51ef4d9df34eb09ad1cf0528efad3b3471e11790a3628594b27224e1560176
 SHA512:
-  metadata.gz: 25a3d1674dd3b8511ccc76e0be69b77e08a7aa87a311895019e0cb5649d65e37e4ef12423521318a4e35d6415e9bd205c9836f0b26233eab8a360b112cd85d2a
-  data.tar.gz: bdb112d177af8f0d5f039b847e9e94bd5d274aaf075b8a037ac7326f392c8393a4aac3fd6da18819c760066c447670d826b091b9c33d791b9f14e286a1994f3a
+  metadata.gz: d4301871b6d662d7f02c8c549dcdcd239633183f4bfb9a05f3c04c6d40405778da03ef88948a1d954a0d6b6b41c2c4df3a43602f2d3673108cbf1402b484442e
+  data.tar.gz: 908c6005ba6107459aa00297331a62eac008ccc88e4feb526943225d01dd6bdbd21307db1466303424a9fb0378c03cd29f7ca6a586b1274e82b39264739728d1

data/.travis.yml

@@ -4,6 +4,8 @@ before_install:
 language: ruby
 rvm:
   - 2.3.8
-  - 2.4.2
-  - 2.5.3
-  - 2.6.1
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0

data/README.md

@@ -6,6 +6,15 @@ to be converted to HTML.
 
 It is currently a work in progress (but working for me ;)
 
+## Example
+It turns this:
+
+![markdown](A.png)
+
+into
+
+![finished](B.png)
+
 ## Requirements
 
 Ruby installed on your computer & up to date version of vimwiki
@@ -56,14 +65,24 @@ 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 tasklists
+Vimwiki has support for complex todo lists which you can [read about in their help.txt](https://github.com/vimwiki/vimwiki/blob/619f04f89861c58e5a6415a4f83847752928252d/doc/vimwiki.txt#L1768). We do support turning them into HTML. This is _slightly different_ from the way that GitHub checklists are rendered, but, the syntax is a subset of GitHub lists so it should be fine. You can read about it in the [issue](https://github.com/patrickdavey/vimwiki_markdown/issues/27), but basically it should work fine.  You will want to add `styles` in for the various states that the todo lists can be in. The easiest way is to simply add the `styles` into your template. You can see the styles [in the sample template here](https://github.com/patrickdavey/vimwiki_markdown/blob/293f99e656819b9c5ecc0c831698ce58904eb774/example_files/default.tpl#L7-L45)
+
+#### 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,12 @@
+## 0.6.0 [April 26 2020]
+Support for todo lists with enhanced state options. Thanks to @primercuervo
+
+## 0.5.0 [April 26 2020]
+Partial support for `local` and `file` links in urls. Thanks to @tfachmann for the PR
+
+## 0.4.4 [June 16 2019]
+Allow fragments if they are for local vimwiki links only
+
 ## 0.4.3 [June 16 2019]
 temporarily revoke fragments until we're not altering old links
 

data/example_files/default.tpl

@@ -4,6 +4,45 @@
   <title>%title%</title>
 
   %pygments%
+<!--Style for Vimwiki Tasklist-->
+<style>
+.rejected {
+    background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAMAAAAMCGV4AAAACXBIWXMAAADFAAAAxQEdzbqoAAAAB3RJTUUH4QgEFhAtuWgv9wAAAPZQTFRFmpqam5iYnJaWnJeXnpSUn5OTopCQpoqKpouLp4iIqIiIrYCAt3V1vW1tv2xsmZmZmpeXnpKS/x4e/x8f/yAg/yIi/yQk/yUl/yYm/ygo/ykp/yws/zAw/zIy/zMz/zQ0/zU1/zY2/zw8/0BA/0ZG/0pK/1FR/1JS/1NT/1RU/1VV/1ZW/1dX/1pa/15e/19f/2Zm/2lp/21t/25u/3R0/3p6/4CA/4GB/4SE/4iI/46O/4+P/52d/6am/6ur/66u/7Oz/7S0/7e3/87O/9fX/9zc/93d/+Dg/+vr/+3t/+/v//Dw//Ly//X1//f3//n5//z8////gzaKowAAAA90Uk5T/Pz8/Pz8/Pz8/Pz8/f39ppQKWQAAAAFiS0dEEnu8bAAAAACuSURBVAhbPY9ZF4FQFEZPSKbIMmWep4gMGTKLkIv6/3/GPbfF97b3w17rA0kQOPgvAeHW6uJ6+5h7HqLdwowgOzejXRXBdx6UdSru216xuOMBHHNU0clTzeSUA6EhF8V8kqroluMiU6HKcuf4phGPr1o2q9kYZWwNq1qfRRmTaXpqsyjj17KkWCxKBUBgXWueHIyiAIg18gsse4KHkLF5IKIY10WQgv7fOy4ST34BRiopZ8WLNrgAAAAASUVORK5CYII=);
+    background-repeat: no-repeat;
+    background-position: 0 .2em;
+    padding-left: 5.5em;
+}
+.done0 {
+    background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAA7SURBVCiR7dMxEgAgCANBI3yVRzF5KxNbW6wsuH7LQ2YKQK1mkswBVERYF5Os3UV3gwd/jF2SkXy66gAZkxS6BniubAAAAABJRU5ErkJggg==);
+    background-repeat: no-repeat;
+    background-position: 0 .2em;
+    padding-left: 1.5em;
+}
+.done1 {
+    background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAABtSURBVCiR1ZO7DYAwDER9BDmTeZQMFXmUbGYpOjrEryA0wOvO8itOslFrJYAug5BMM4BeSkmjsrv3aVTa8p48Xw1JSkSsWVUFwD05IqS1tmYzk5zzae9jnVVVzGyXb8sALjse+euRkEzu/uirFomVIdDGOLjuAAAAAElFTkSuQmCC);
+    background-repeat: no-repeat;
+    background-position: 0 .15em;
+    padding-left: 1.5em;
+}
+.done2 {
+    background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAB1SURBVCiRzdO5DcAgDAVQGxjAYgTvxlDIu1FTIRYAp8qlFISkSH7l5kk+ZIwxKiI2mIyqWoeILYRgZ7GINDOLjnmF3VqklKCUMgTee2DmM661Qs55iI3Zm/1u5h9sm4ig9z4ERHTFzLyd4G4+nFlVrYg8+qoF/c0kdpeMsmcAAAAASUVORK5CYII=);
+    background-repeat: no-repeat;
+    background-position: 0 .15em;
+    padding-left: 1.5em;
+}
+.done3 {
+    background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAABoSURBVCiR7dOxDcAgDATA/0DtUdiKoZC3YhLkHjkVKF3idJHiztKfvrHZWnOSE8Fx95RJzlprimJVnXktvXeY2S0SEZRSAAAbmxnGGKH2I5T+8VfxPhIReQSuuY3XyYWa3T2p6quvOgGrvSFGlewuUAAAAABJRU5ErkJggg==);
+    background-repeat: no-repeat;
+    background-position: 0 .15em;
+    padding-left: 1.5em;
+}
+.done4 {
+    background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABIAAAAQCAYAAAAbBi9cAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAzgAAAM4BlP6ToAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAIISURBVDiNnZQ9SFtRFMd/773kpTaGJoQk1im4VDpWQcTNODhkFBcVTCNCF0NWyeDiIIiCm82QoIMIUkHUxcFBg1SEQoZszSat6cdTn1qNue92CMbEr9Sey+XC/Z/zu+f8h6ukUil3sVg0+M+4cFxk42/jH2wAqqqKSCSiPQdwcHHAnDHH9s/tN1h8V28ETdP+eU8fT9Nt62ancYdIPvJNtsu87bmjrJlrTDVM4RROJs1JrHPrD4Bar7A6cpc54iKOaTdJXCUI2UMVrQZ0Js7YPN18ECKkYNQcJe/OE/4dZsw7VqNXQMvHy3QZXQypQ6ycrtwDjf8aJ+PNEDSCzLpn7+m2pD8ZKHlKarYhy6XjEoCYGcN95qansQeA3fNdki+SaJZGTMQIOoL3W/Z89rxv+tokubNajlvk/vm+LFpF2XnUKZHI0I+QrI7Dw0OZTqdzUkpsM7mZTyfy5OPGyw1tK7AFSvmB/Ks8w8YwbUYbe6/3QEKv0vugfxWPnMLJun+d/kI/WLdizpNjMbAIKrhMF4OuwadBALqqs+RfInwUvuNi+fBd+wjogfogAFVRmffO02q01mZZ0HHdgXIzdz0QQLPezIQygX6llxNKKgOFARYCC49CqhoHIUTlss/Vx2phlYwjw8j1CAlfAiwQiJpiy7o1VHnsG5FISkoJu7Q/2YmmaV+i0ei7v38L2CBguSi5AAAAAElFTkSuQmCC);
+    background-repeat: no-repeat;
+    background-position: 0 .15em;
+    padding-left: 1.5em;
+}
+</style>
 </head>
 <body id="%title%">
   <h2 id="title">%title%</h2>

data/lib/vimwiki_markdown/options.rb

@@ -70,7 +70,8 @@ module VimwikiMarkdown
     end
 
     def output_fullpath
-      "#{output_dir}#{title.parameterize}.html"
+      filename = title.parameterize =~ /^\s*$/ ? title : title.parameterize
+      "#{output_dir}#{filename}.html"
     end
 
 

data/lib/vimwiki_markdown/version.rb

@@ -1,3 +1,3 @@
 module VimwikiMarkdown
-  VERSION = "0.4.3"
+  VERSION = "0.7.0"
 end

data/lib/vimwiki_markdown/vimwiki_link.rb

@@ -9,22 +9,24 @@
 
 module VimwikiMarkdown
   class VimwikiLink
-    MARKDOWN_LINK_REGEX = /\[(?<title>.*)\]\((?<uri>.*)\)/
+    MARKDOWN_LINK_REGEX = /\[(?<title>.*)\]\((?<uri>(?:(?!#).)*)(?<fragment>(?:#)?.*)\)/
 
-    attr_reader :title, :uri, :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
 
 
     def to_s
-      "[#{title}](#{uri})"
+      "[#{title}](#{uri}#{fragment})"
     end
 
     private
@@ -32,8 +34,37 @@ module VimwikiMarkdown
     def rewrite_local_links!
       if vimwiki_markdown_file_exists?
         path = Pathname.new(uri)
-        @uri = "#{path.dirname + path.basename(markdown_extension).to_s.parameterize}.html"
+
+        link_path = path.basename(markdown_extension).to_s.parameterize
+
+        link_path = path.basename(markdown_extension).to_s if link_path.match(/^\s*$/)
+
+        @uri = "#{path.dirname + link_path}.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?

data/lib/vimwiki_markdown/wiki_body.rb

@@ -25,8 +25,9 @@ class VimwikiMarkdown::WikiBody
       HTML::Pipeline::SyntaxHighlightFilter,
       HTML::Pipeline::TableOfContentsFilter
     ], { scope: "highlight"})
-    result = pipeline.call(html)
-    result[:output].to_s
+    @result = pipeline.call(html)
+    @result = @result[:output].to_s
+    enrich_li_class!
   end
 
 
@@ -63,7 +64,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
 
@@ -74,4 +75,15 @@ class VimwikiMarkdown::WikiBody
       CommonMarker.render_html(content, commonmarker_opts, commonmarker_exts)
     }
   end
+
+  def enrich_li_class!
+    syms_hash = { " ]" => 0, ".]" => 1, "o]" => 2, "O]" => 3, "X]" => 4 }
+    checkbox = /<li>\s*\[[\s.oOX]\]/
+    checkbox_start = /<li>\s*\[/
+    @result.gsub!(checkbox) do |m|
+      m.sub(checkbox_start, '<li class="done')
+        .sub(/[\s.oOX\]]*$/, syms_hash) << '">'
+    end
+    @result
+  end
 end

data/spec/lib/vimwiki_markdown/options_spec.rb

@@ -43,6 +43,11 @@ module VimwikiMarkdown
           expect(Options.new.output_fullpath).to eq("#{subject.output_dir}name-with-spaces.html")
         end
 
+        it "must not change filenames if paramteriezed returns an empty string" do
+          allow_any_instance_of(Options).to receive(:input_file) { "~/foo/世界.md" }
+          expect(Options.new.output_fullpath).to eq("#{subject.output_dir}世界.html")
+        end
+
         it "must correctly deal with filenames with capitalization issues" do
           allow_any_instance_of(Options).to receive(:input_file) { "~/foo/NAME WITH SPACES.md" }
           expect(Options.new.output_fullpath).to eq("#{subject.output_dir}name-with-spaces.html")

data/spec/lib/vimwiki_markdown/vimwiki_link_spec.rb

@@ -1,16 +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.title).to eq("title")
-      expect(link.uri).to eq("http://www.google.com")
+    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" }
+
+      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)"
+
+        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
@@ -19,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
 
@@ -31,35 +50,48 @@ module VimwikiMarkdown
       end
 
       it "must convert same-directory markdown links correctly" do
-        link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path)
-        expect(link.title).to eq("test")
-        expect(link.uri).to eq("#{existing_file_no_extension}.html")
+        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)
-        expect(link.title).to eq("test")
-        expect(link.uri).to eq("#{existing_file_no_extension}.html")
+        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, output_dir)
+        expect(link.to_s).to eq("[test](#{existing_file_no_extension}.html#wiki-heading)")
+      end
+
+      context "with chinese or unparamaterizable chars" do
+        let(:existing_file) { "世界#{markdown_extension}" }
+
+        it "must convert same-directory markdown links without paramaterization correctly" do
+          markdown_link = "[test](#{existing_file_no_extension})"
+
+          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
       end
 
       context "subdirectory linked files" do
         let(:existing_file) { "subdirectory/test.md" }
 
         it "must convert markdown links correctly" do
-          link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path)
-          expect(link.title).to eq("test")
-          expect(link.uri).to eq("#{existing_file_no_extension}.html")
+          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)
-          expect(link.title).to eq("subdirectory")
-          expect(link.uri).to eq("subdirectory/")
+          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
@@ -67,9 +99,8 @@ 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)
-          expect(link.title).to eq("test")
-          expect(link.uri).to eq("../test.html")
+          link = VimwikiLink.new("[test](../test)", source_filepath, markdown_extension, root_path, output_dir)
+          expect(link.to_s).to eq("[test](../test.html)")
         end
       end
 
@@ -79,24 +110,50 @@ module VimwikiMarkdown
         let(:root_path) { "../"}
 
         it "must convert absolute paths correctly" do
-          link = VimwikiLink.new("[test](/test.md)", source_filepath, markdown_extension, root_path)
-          expect(link.uri).to eq("/test.html")
+          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)
-          expect(link.uri).to eq("/test.html")
+          link = VimwikiLink.new("[test](/test)", source_filepath, markdown_extension, root_path, output_dir)
+          expect(link.to_s).to eq("[test](/test.html)")
         end
 
         context "from the root directory" do
           let(:source_filepath) { temp_wiki_dir + "index.md" }
 
           it "must convert absolute paths correctly" do
-            link = VimwikiLink.new("[test](/test)", source_filepath, markdown_extension, ".")
-            expect(link.uri).to eq("/test.html")
+            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
@@ -52,6 +52,36 @@ module VimwikiMarkdown
       expect(wiki_body.to_s).to match(/<a href="there.html">there<\/a>/)
     end
 
+    it "must enrich task list unchecked" do
+      allow_any_instance_of(VimwikiMarkdown::VimwikiLink).to receive(:vimwiki_markdown_file_exists?).and_return(true)
+      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("- [ ] This is one line")
+      expect(wiki_body.to_s).to match(/<li class="done0"> This is one line<\/li>/)
+    end
+
+    it "must enrich task list checked" do
+      allow_any_instance_of(VimwikiMarkdown::VimwikiLink).to receive(:vimwiki_markdown_file_exists?).and_return(true)
+      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("- [X] This is a checked line")
+      expect(wiki_body.to_s).to match(/<li class="done4"> This is a checked line<\/li>/)
+    end
+
+    it "must enrich task list parent 1" do
+      allow_any_instance_of(VimwikiMarkdown::VimwikiLink).to receive(:vimwiki_markdown_file_exists?).and_return(true)
+      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("- [.] This is a parent 1 line")
+      expect(wiki_body.to_s).to match(/<li class="done1"> This is a parent 1 line<\/li>/)
+    end
+
+    it "must enrich task list parent 2" do
+      allow_any_instance_of(VimwikiMarkdown::VimwikiLink).to receive(:vimwiki_markdown_file_exists?).and_return(true)
+      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("- [o] This is a parent 2 line")
+      expect(wiki_body.to_s).to match(/<li class="done2"> This is a parent 2 line<\/li>/)
+    end
+
+    it "must enrich task list parent 3" do
+      allow_any_instance_of(VimwikiMarkdown::VimwikiLink).to receive(:vimwiki_markdown_file_exists?).and_return(true)
+      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("- [O] This is a parent 3 line")
+      expect(wiki_body.to_s).to match(/<li class="done3"> This is a parent 3 line<\/li>/)
+    end
+
     describe "syntax highlighting" do
       it "must give correct classes" do
         allow(wiki_body).to receive(:get_wiki_markdown_contents)

data/spec/spec_helper.rb

@@ -107,6 +107,28 @@ def wiki_index_markdown
 
 > this is a blockquote
 > without a linebreak
+
+## Test for checks
+
+- [ ] This is one line
+- [X] This is a checked line
+- [ ] This is a parent line 1
+  - [ ] This is a child line 1
+  - [ ] This is a child line 2
+- [.] This is a parent line 2
+  - [X] This is a child line 1
+  - [ ] This is a child line 2
+  - [ ] This is a child line 3
+- [o] This is a parent line 2
+  - [X] This is a child line 1
+  - [X] This is a child line 2
+  - [ ] This is a child line 3
+- [O] This is a parent line 3
+  - [X] This is a child line 1
+  - [X] This is a child line 2
+  - [X] This is a child line 3
+  - [ ] This is a child line 4
+
 "
 end
 

data/vimwiki_markdown.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.0"
-  spec.add_development_dependency "rake", "~> 11.2"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0.12"
   spec.add_development_dependency "rspec-its", "~> 1.1"

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: vimwiki_markdown
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Patrick Davey
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-23 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +220,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- A.png
+- B.png
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -245,7 +247,7 @@ homepage: https://github.com/patrickdavey/wimwiki_markdown
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -260,8 +262,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Converts a github flavoured markdown vimwiki file into html.
 test_files: