vimwiki_markdown 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aced79dd558ad5f073dc4e57fb727e95f7341dc5
-  data.tar.gz: 49fc383b31e5def606eb2d08de02fe56549f1861
+  metadata.gz: f15a379fe2281d0a38bd24c2bdf359017dda45d1
+  data.tar.gz: 513869385056bd8578cb850cd8682f42efd93ecd
 SHA512:
-  metadata.gz: b01693f8c5149f6c712335a64bd27bad5ac843705a6ac8b5a81b077326e250acf5974ce352c624a2f8be266d96732738cfe401d3140ae1211e131dd2fce94ec2
-  data.tar.gz: 520c570ee5a4748672f9506d8b5e53d6ebc37554e681cd9c9eae50409f771d4b2734a0759d864ee9716b42da809a5271818af21906c768f17e0fd4bcf5334897
+  metadata.gz: a7c9cf57dc30a2f88b88bada446122a0406076d5d1a69f93fb0e3e0d53c9dc18fb714e57b412c024f39b281d782f1d2c411818d63fc8ab3f62eb868a3277f0ab
+  data.tar.gz: 937e1c37ac549bef675e94723fc9c7c1dd51a5aa8540de506dad665d9460cdb253a2495b202bd91f030a9f27191beb1e05dc3499d6fce325bbd7c6010c7139a8

data/README.md

@@ -59,6 +59,17 @@ 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)
 
+#### Using Custom Template Tag
+
+Including a line with `%template <template name>` in any of your Vimwiki pages will will force the generator to use `<template name>.tpl` rather than `default.tpl` for that page.
+
+`<template name>` cannot contain any spaces
+
+#### Using Custom Title Tag
+
+Including a line with `%title <title name>` in any of your Vimwiki pages will force the generator to replace `%title%` in your template file with `<title name>` rather than the name of the file itself.
+*You can have spaces in your titles now!*
+
 ## Contributing
 
 Pull requests are very welcome, especially if you want to implement some of the

data/changelog.md

@@ -1,3 +1,6 @@
+## 0.2.6 [Jan 18 2018]
+Add %template and %title options
+
 ## 0.2.4 [Jan 01 2017]
 Make directory links work correctly. If you now link to
 a directory [somedir](somedir/) then that link will be preserved

data/lib/vimwiki_markdown/options.rb

@@ -26,7 +26,7 @@ module VimwikiMarkdown
 
     attr_reader :force, :syntax, :extension, :output_dir,
                 :input_file, :css_file, :template_path,
-                :template_default, :template_ext, :root_path
+                :template_default, :template_ext, :root_path, :tags
 
 =begin  force : [0/1] overwrite an existing file
           syntax : the syntax chosen for this wiki
@@ -54,10 +54,26 @@ module VimwikiMarkdown
       @template_ext = arguments[TEMPLATE_EXT]
       @root_path = arguments[ROOT_PATH]
       @root_path = "./" if @root_path == "-"
+      @tags = pull_tags
       raise "Must be markdown" unless syntax == 'markdown'
     end
 
+    def get_file_contents
+      file = File.open(input_file, "r")
+      file.read
+    end
+
+    def pull_tags
+      tags = Hash.new
+      get_file_contents.split("\n").each do |li|
+        tags['template'] = li.split.last if (li[/%template \S+./])
+        tags['title'] = li.sub(/%title /, '') if (li[/%title .+/])
+      end
+      return tags
+    end
+
     def template_filename
+      return "#{template_path}#{tags['template']}#{template_ext}" if @tags['template']
       "#{template_path}#{template_default}#{template_ext}"
     end
 
@@ -66,11 +82,12 @@ module VimwikiMarkdown
     end
 
     def title
+      return File.basename(tags['title'], ".md").split(/ |\_/).map(&:capitalize).join(" ") if @tags['title']
       File.basename(input_file, ".md").capitalize
     end
 
     def output_fullpath
-      "#{output_dir}#{title.parameterize}.html"
+      "#{output_dir}#{File.basename(input_file, ".md")}.html"
     end
 
     private

data/lib/vimwiki_markdown/version.rb

@@ -1,3 +1,3 @@
 module VimwikiMarkdown
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/lib/vimwiki_markdown/wiki_body.rb

@@ -13,6 +13,7 @@ class VimwikiMarkdown::WikiBody
   def to_s
     @markdown_body = get_wiki_markdown_contents
     fixlinks
+    remove_tags
     github_markup = GitHub::Markup.render('README.markdown', markdown_body)
     pipeline = HTML::Pipeline.new [
       HTML::Pipeline::SyntaxHighlightFilter,
@@ -60,4 +61,13 @@ class VimwikiMarkdown::WikiBody
     end
   end
 
+  def remove_tags
+    @markdown_body.gsub!(/%template \S+/) do
+      ""
+    end
+    @markdown_body.gsub!(/%title \S+/) do
+      ""
+    end
+  end
+
 end

data/spec/lib/vimwiki_markdown/options_spec.rb

@@ -3,17 +3,31 @@ require 'vimwiki_markdown/options'
 
 module VimwikiMarkdown
   describe Options do
-    subject { Options.new }
+    let(:markdown_file_content) {wiki_template_title_markdown}
+    let(:options) { Options.new }
+    subject {options}
 
     context "no options passed" do
       before do
+        allow(File).to receive(:open).and_return(StringIO.new("# title \n ## subtitle"))
         allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
       end
 
       its(:force) { should be(true) }
       its(:syntax) { should eq('markdown') }
-      its(:output_fullpath) { should eq("#{subject.output_dir}#{subject.title.parameterize}.html") }
+      its(:output_fullpath) { should eq("#{subject.output_dir}#{File.basename(subject.input_file, ".md")}.html") }
       its(:template_filename) { should eq('~/vimwiki/templates/default.tpl') }
     end
+
+    context "file with tags in it" do
+      before do
+        allow(File).to receive(:open).and_return(StringIO.new(markdown_file_content))
+        allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
+      end
+
+      its(:template_filename) { should eq('~/vimwiki/templates/alt_template.tpl') }
+      its(:title) { should eq('Super Cool Title')}
+    end
+
   end
 end

data/spec/lib/vimwiki_markdown/template_spec.rb

@@ -7,11 +7,13 @@ require 'rspec-html-matchers'
 module VimwikiMarkdown
   describe Template do
     let(:options) { Options.new }
+    let(:markdown_file_content) {wiki_index_markdown}
 
     context "template" do
 
       subject { Template.new(options).to_s }
       before do
+        allow(File).to receive(:open).and_return(StringIO.new(markdown_file_content))
         allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
         allow(File).to receive(:open).with(options.template_filename,"r").and_return(StringIO.new(wiki_template))
       end
@@ -22,6 +24,7 @@ module VimwikiMarkdown
 
     context "missing pygments" do
       before do
+        allow(File).to receive(:open).and_return(StringIO.new(markdown_file_content))
         allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
       end
 
@@ -33,6 +36,7 @@ module VimwikiMarkdown
 
     context "using %root_path%" do
       before do
+        allow(File).to receive(:open).and_return(StringIO.new(markdown_file_content))
         allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
       end
 

data/spec/lib/vimwiki_markdown/wiki_body_spec.rb

@@ -38,6 +38,18 @@ module VimwikiMarkdown
       expect(wiki_body.to_s).to match(/<a href="here.html">here<\/a>/)
       expect(wiki_body.to_s).to match(/<a href="there.html">there<\/a>/)
     end
+
+    it "must remove template tags" do
+      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("%template test\n")
+      expect(wiki_body.to_s).not_to match(/%template/)
+      expect(wiki_body.to_s).not_to match(/test/)
+    end
+
+    it "must remove title tags" do
+      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("%title test\n")
+      expect(wiki_body.to_s).not_to match(/%title/)
+      expect(wiki_body.to_s).not_to match(/test/)
+    end
   end
 
 end

data/spec/spec_helper.rb

@@ -110,6 +110,16 @@ def wiki_index_markdown
 "
 end
 
+def wiki_template_title_markdown
+"
+%title super cool title\n
+%template alt_template\n
+## Todo\n
+  1. add template functionality\n
+  2. add title functionality\n
+"
+end
+
 def wiki_template
 <<-WIKITEMPLATE
 <!DOCTYPE html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimwiki_markdown
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Patrick Davey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -245,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Converts a github flavoured markdown vimwiki file into html.