vimwiki_markdown 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6acc95dd6a5614bd65208e682f3f92c60c19c48db675a27e21fdfb619ab4a97d
-  data.tar.gz: e122a4b7e074c092bcb503c019441fe3c5e25c3d5fd6de03a97f95810e32ed13
+  metadata.gz: 94fcdf721504210b46ed56769e3529838982092414094c950ccddaa747086f9f
+  data.tar.gz: 219b35ea5da34b1cf75f962432073a8f97c972a62d14403b35dfae442f98b794
 SHA512:
-  metadata.gz: c116b7dd75f305b1a7bdcdbc1eb5a952e2c95c6d78f236683a3cd96900f8b3d2c6b5843e1e7d37f5f2ec6bf2aca46b65d419ae1ec81583541a937868a033b390
-  data.tar.gz: 4babd45bcc33303e45a0b46f909456733fc6c1be8d1cc24c3cdc1fdaaa4fd3d61762364fe050910e601da552149f9f6a2bbcbafe69be213f3d8b1d4ede2776ef
+  metadata.gz: 5c51b9de26115ee93f512404af7e84544088406df98a4c0861095da736dd78821f12e59b40e639f7bbea13f20bc460eb14bf9b4daa911c3bd00202ccd587f1e9
+  data.tar.gz: 5ccfb995fa5e7966379fc34dc40a0799614bf59b59d780fc0932a413a3876bebccdbc3bf4166cbda209a9e8bbc78593673816a44b4a5768cc90a80e6fc33f958

data/README.md

@@ -56,13 +56,16 @@ 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>
+* `[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
 

data/changelog.md

@@ -1,5 +1,8 @@
+## 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](https://github.com/patrickdavey/vimwiki_markdown/pull/26).
+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

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/version.rb

@@ -1,3 +1,3 @@
 module VimwikiMarkdown
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

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
 
 
@@ -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/wiki_body_spec.rb

@@ -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

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.0"
-  spec.add_development_dependency "rake", "~> 11.2"
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimwiki_markdown
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Patrick Davey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-25 00:00:00.000000000 Z
+date: 2020-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     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
@@ -260,8 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Converts a github flavoured markdown vimwiki file into html.