vimwiki_markdown 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5636664b80e372cd4c98a16085fe14b68980ebf3fd3a157e9ebc1d80c180deb
-  data.tar.gz: dc91ee37f24f106c6bff4fcab62aaaff08268503c60931aab3018458200a0d04
+  metadata.gz: 3645fe30ab3bb81638bf374ee0299069ceee5680889609a6ae65bba411f1b4a6
+  data.tar.gz: 14e2433a0fdd60bb0cda3a424996746f85b3c07a2c8e846c24a0a4573d52d8ce
 SHA512:
-  metadata.gz: 96b262067d0c6c39f177a033509de167dfcef9bc1ab85882ea5416c25dceb840735068a8e2abce9c45fa3e51c229215528f0f0d8eb3921159a32bde6b381f312
-  data.tar.gz: b35470a89642b92ba7dac607c0693f3e7cf99b2a65a57439924edbfa4ac1f90935e59b833926b662fe330c8a2d6dbd7e9d019f6c586cf5cb36e723d9b974c559
+  metadata.gz: e3afa0beac17b69d85c6aba84d2f2bf5f63925d84b0bd9867e2c210d151706416bcc330c58695975fde7abfd16934b702769696d7bacdf07d72ac176406004ca
+  data.tar.gz: 6557dfcd016610ddc5360478be922ffbf14ccc31182f4c1dde589800804a632900c89191a12e50132a42c0cda96c46c0abbf3eb34755366a2b0636fd1d475112

data/README.md

@@ -28,18 +28,6 @@ this we use the custom_wiki2html parameter.  My .vimrc looks like this:
 
 The most important part is the *'custom_wiki2html': 'vimwiki_markdown'*
 
-### Fix for vimwiki links.
-In vimwiki at the moment, it deletes any files in the site_html directory which do not match
-against the markdown files (once they are translated into linked html).  Now, in vimwiki_markdown
-we use ActiveSupports paramaterized method, as it's nicer on links.  If you want to have a
-significant speed up, then you need to patch your vimwiki plugin to not delete files it
-shouldn't be.  Here are links to the relevant bits:
-
-1. [Add this function](https://github.com/patrickdavey/vimwiki-1/blob/9ebca2182fcf10e1bbf61abc8b4a535ce790480d/autoload/vimwiki/html.vim#L242-247)
-2. [Make the is_html_uptodate look like this](https://github.com/patrickdavey/vimwiki-1/blob/9ebca2182fcf10e1bbf61abc8b4a535ce790480d/autoload/vimwiki/html.vim#L224-241)
-3. For the moment, remove the call to deleting files `call s:delete_html_files(path_html)` - will work out a way around that later, not there now.
-4. Might be some other things, check the diff in the above commits or open an issue.
-
 ### Install issues.
 There have been some issues with getting dependencies installed. Before opening an issue, please check if you can use [rvm](http://rvm.io/) to install the gem, as RVM is magic and makes everything work ;)
 
@@ -60,6 +48,15 @@ to [this commit](https://github.com/patrickdavey/vimwiki_markdown/commit/8645883
 It will get rewritten with the relative path to the root
 of the site (e.g. `./` or `../../` etc)
 
+#### Optional %date% marker.
+
+You can also have a `%date%` marker in your template file
+It will get rewritten with todays date in the format 29 March 2019
+
+#### 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
@@ -71,6 +68,11 @@ more interesting vimwiki links (e.g. :local etc.)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+## Known Issues
+
+In the `vimwiki_markdown` gem, links are written out using Rails' paramaterized method. That is, a link like "my awesome link" is turned into "my-awesome-link". Vimwikis built-in support for
+checking whether a file needs to be re-generated or not uses a mixture of timestamp and whether the output file exists. Unfortunately, vimwiki _doesn't_ paramaterize their output files, so, quite often there's
+a mismatch in terms of whether a file exists. I had patched previous version of vimwiki, but, I haven't done it with the latest version. If you _want_ to look at it, there's [some information in a previous version of this README](https://github.com/patrickdavey/vimwiki_markdown/blob/4cf18a3fb329895e2062a1a56c83074d215e93c4/README.md#fix-for-vimwiki-links), but, you're on your own ;)
 
 ## License
 

data/changelog.md

@@ -1,3 +1,6 @@
+## 0.3.3 [March 29 2019]
+Support for %date% and %nohtml tags
+
 ## 0.3.2 [March 28 2019]
 
 Bugfix

data/lib/vimwiki_markdown.rb

@@ -12,6 +12,9 @@ module VimwikiMarkdown
     options = Options.new
     template_html = Template.new(options)
     body_html = WikiBody.new(options)
+
+    return if body_html.to_s =~ /%nohtml/
+
     combined_body_template = template_html.to_s.gsub('%content%', body_html.to_s)
 
     File.write(options.output_fullpath, combined_body_template)

data/lib/vimwiki_markdown/template.rb

@@ -1,4 +1,6 @@
 require 'rouge'
+require 'date'
+
 module VimwikiMarkdown
   class Template
 
@@ -24,8 +26,10 @@ module VimwikiMarkdown
     end
 
     def fixtags(template)
-      @template = template.gsub('%title%',title).gsub('%pygments%',pygments_wrapped_in_tags)
-      @template = @template.gsub('%root_path%', root_path)
+      @template = template.gsub('%title%',title)
+                          .gsub('%pygments%',pygments_wrapped_in_tags)
+                          .gsub('%root_path%', root_path)
+                          .gsub('%date%', Date.today.strftime("%e %b %Y"))
     end
 
     def pygments_wrapped_in_tags

data/lib/vimwiki_markdown/version.rb

@@ -1,3 +1,3 @@
 module VimwikiMarkdown
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/lib/vimwiki_markdown/wiki_body.rb

@@ -62,5 +62,4 @@ class VimwikiMarkdown::WikiBody
       VimwikiMarkdown::VimwikiLink.new(match, options.input_file, options.extension, options.root_path).to_s
     end
   end
-
 end

data/spec/lib/vimwiki_markdown/options_spec.rb

@@ -12,7 +12,6 @@ module VimwikiMarkdown
 
       its(:force) { should be(true) }
       its(:syntax) { should eq('markdown') }
-      its(:output_fullpath) { should eq("#{subject.output_dir}#{subject.title.parameterize}.html") }
       its(:template_filename) { should eq('~/vimwiki/templates/default.tpl') }
 
       describe "extension" do
@@ -33,6 +32,28 @@ module VimwikiMarkdown
           expect(Options.new.title).to eq("Index")
         end
       end
+
+      describe "#output_fullpath" do
+        it "must rewrite files so that they match the paramaterized title" do
+          expect(Options.new.output_fullpath).to eq("#{subject.output_dir}#{subject.title.parameterize}.html")
+        end
+
+        it "must correctly deal with filenames with spaces in them" 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")
+        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")
+        end
+
+        it "must correctly deal with filenames with spaces and a different extension" do
+          allow_any_instance_of(Options).to receive(:extension) { "wiki" }
+          allow_any_instance_of(Options).to receive(:input_file) { "~/foo/name with spaces.wiki" }
+          expect(Options.new.output_fullpath).to eq("#{subject.output_dir}name-with-spaces.html")
+        end
+      end
     end
   end
 end

data/spec/lib/vimwiki_markdown/template_spec.rb

@@ -3,6 +3,7 @@ require 'vimwiki_markdown/options'
 require 'vimwiki_markdown/template'
 require 'vimwiki_markdown/exceptions'
 require 'rspec-html-matchers'
+require 'date'
 
 module VimwikiMarkdown
   describe Template do
@@ -44,5 +45,17 @@ module VimwikiMarkdown
         expect(rendered_template).to include("./rootStyle.css")
       end
     end
+
+    context "using %date" do
+      before do
+        allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
+      end
+
+      it "replaces %date% with todays date" do
+        allow(File).to receive(:open).with(options.template_filename,"r").and_return(StringIO.new(wiki_template))
+        rendered_template = Template.new(options).to_s
+        expect(rendered_template).to include(Date.today.strftime("%e %b %Y"))
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -151,6 +151,7 @@ def wiki_template
     <div class="row">
       <div class="span12">
         <h2 id="title">%title%</h2>
+        <p><small>Page created on %date%</small></p>
         %content%
       </div>
     </div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimwiki_markdown
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Patrick Davey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-27 00:00:00.000000000 Z
+date: 2019-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler