vimwiki_markdown 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de2e7b948c3ae02f7dcda86ea0adc4f8868fb00b
-  data.tar.gz: 67c994ac7ea16eb5087d3dbbf3b65d591d2e8322
+  metadata.gz: 726b831c9bb819ebbe7bd054e85d47926d008142
+  data.tar.gz: 2fc210b9ee34a717e9ea98b51122f646e1e8629f
 SHA512:
-  metadata.gz: 5f4e57d022af88b4eeacbc550ac7b68d80c12d846537c2cf2b5805be41868fc36ea65cfc44b098dea113e08444cbe2f90a508c5ce65ecd5b1b4c7dc534a381dd
-  data.tar.gz: 4f19b24a1fd5ed29ffc67b3843ae9cf5f4b29bf6e03fbb1ced98ce8824152a3c2d5600af2c501c0c54e9a6b39b81afedde5b77773aa847a2d1cb21e3d1a52879
+  metadata.gz: aa137e60a6d1e2e53ee2f0a46a55b14de20971ddb29d31eafe182adb3b9dd4a228596fb8210d9b2f3ce2f56e8b9d81db14220f15c2d3407074cb013151ff37c8
+  data.tar.gz: d71c4e2e0ff8e45d2dac61f6c3ebd1de3bfe4e784880113becaeb13ec06302a9db09ef5eb0265ff097478ead5378c8c31434707b692cc169e11d1fe1cda25aa2

data/README.md

@@ -8,7 +8,7 @@ It is currently a work in progress (but working for me ;)
 
 ## Requirements
 
-Ruby installed on your computer
+Ruby installed on your computer & up to date version of vimwiki
 
     https://www.ruby-lang.org/en/installation/
 
@@ -16,11 +16,6 @@ Install the vimwiki_markdown gem
 
     $ gem install vimwiki_markdown
 
-Note, the current version of vimwiki does not allow binaries to be called
-for the generation of html.  This was added on the master branch in [this commit](https://github.com/vimwiki/vimwiki/commit/c1a5bb51adc8cacaa70e2804106817b68295f932)
-
-Currently you will need to make sure you are running the dev branch of vimwiki, or add that commit in yourself
-
 ## Setup
 
 Ensure that your vimiwiki directive in your .vimrc is setup for markdown.  For
@@ -64,6 +59,9 @@ A sample tpl file is available here https://raw.githubusercontent.com/patrickdav
 
 ## Contributing
 
+Pull requests are very welcome, especially if you want to implement some of the
+more interesting vimwiki links (e.g. :local etc.)
+
 1. Fork it ( https://github.com/patrickdavey/vimwiki_markdown/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/changelog.md

@@ -1,3 +1,10 @@
+## 0.2.0 [March 6th 2016]
+* Adds the ability for `[[source|title]]` style links to be parsed correctly
+* Allows links with subdirectories `[[path/in/a/subdir/file]]` links to work
+* Also allows vimwiki links formatted with markdown syntax to work, this
+  feature is currently implemented on the dev branch. This means you can
+  link to [my markdownfile](blah.md) and it'll be parsed correctly
+
 ## 0.1.3 [August 11th 2015]
 * Adding the TableOfContents filter so that bookmarks are created.
 

data/lib/vimwiki_markdown/options.rb

@@ -5,13 +5,13 @@ module VimwikiMarkdown
     DEFAULTS = ["1", #force - 1/0
                  "markdown",
                  "md",
-                 "/home/patrick/vimwiki/site_html/",
-                 "/home/patrick/vimwiki/index.md",
-                 "/home/patrick/vimwiki/site_html/style.css",
-                 "/home/patrick/vimwiki/templates/",
+                 "~/vimwiki/site_html/",
+                 "~/vimwiki/index.md",
+                 "~/vimwiki/site_html/style.css",
+                 "~/vimwiki/templates/",
                  "default",
                  ".tpl",
-                 "-"]
+                 "-"].freeze
 
     FORCE            = 0
     SYNTAX           = 1
@@ -53,6 +53,7 @@ module VimwikiMarkdown
       @template_default = arguments[TEMPLATE_DEFAULT]
       @template_ext = arguments[TEMPLATE_EXT]
       @root_path = arguments[ROOT_PATH]
+      @root_path = "." if @root_path == "-"
       raise "Must be markdown" unless syntax == 'markdown'
     end
 

data/lib/vimwiki_markdown/version.rb

@@ -1,3 +1,3 @@
 module VimwikiMarkdown
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/vimwiki_markdown/vimwiki_link.rb

@@ -0,0 +1,52 @@
+# This class takes in a string of a markdown link and spits out
+# a correctly formed markdown link, with absolute and relative
+# links to markdown files correctly altered.
+#
+# The main thing we're working around is that markdown files can
+# be linked to with (or without) an extension. That and we're also
+# rewiring the filenames to be parameterized
+
+
+module VimwikiMarkdown
+  class VimwikiLink
+    MARKDOWN_LINK_REGEX = /\[(?<title>.*)\]\((?<uri>.*)\)/
+
+    attr_reader :title, :uri, :source_markdown_directory, :markdown_extension, :root_path
+
+    def initialize(markdown_link, source_markdown_filepath, markdown_extension, root_path)
+      @title = markdown_link.match(MARKDOWN_LINK_REGEX)[:title]
+      @uri = markdown_link.match(MARKDOWN_LINK_REGEX)[:uri]
+      @markdown_extension = markdown_extension
+      @root_path = root_path
+      @source_markdown_directory = Pathname.new(source_markdown_filepath).dirname
+      rewrite_local_links!
+    end
+
+
+    def to_s
+      "[#{title}](#{uri})"
+    end
+
+    private
+
+    def rewrite_local_links!
+      if vimwiki_markdown_file_exists?
+        path = Pathname.new(uri)
+        @uri = "#{path.dirname + path.basename(markdown_extension).to_s.parameterize}.html"
+      end
+    end
+
+    def vimwiki_markdown_file_exists?
+      File.exist?(source_markdown_directory + uri) ||
+      File.exist?(source_markdown_directory + "#{uri}.#{markdown_extension}") ||
+      absolute_path_exists?
+    end
+
+    def absolute_path_exists?
+      path = Pathname(uri)
+      path.absolute? && (
+        File.exist?(source_markdown_directory + root_path + path.to_s.sub(/^\//,"")) ||
+        File.exist?(source_markdown_directory + root_path + path.to_s.sub(/^\//,"").sub(/$/, ".#{markdown_extension}")))
+    end
+  end
+end

data/lib/vimwiki_markdown/wiki_body.rb

@@ -1,6 +1,8 @@
 require 'active_support/inflector'
 require 'github/markup'
 require 'html/pipeline'
+require 'pathname'
+require "vimwiki_markdown/vimwiki_link"
 
 class VimwikiMarkdown::WikiBody
 
@@ -31,11 +33,32 @@ class VimwikiMarkdown::WikiBody
   end
 
   def fixlinks
-    #convert wiki_links to markdown links
-    # [This link](http://example.net/)
+    convert_wiki_style_links_with_title_bar!
+    convert_wiki_style_links!
+    convert_markdown_local_links!
+  end
+
+  def convert_wiki_style_links_with_title_bar!
+    wiki_bar = /\[\[(?<source>.*)\|(?<title>.*)\]\]/
+    @markdown_body.gsub!(wiki_bar) do
+      source = Regexp.last_match[:source]
+      title = Regexp.last_match[:title]
+      "[#{title}](#{source})"
+    end
+  end
+
+  def convert_wiki_style_links!
     @markdown_body.gsub!(/\[\[(.*?)\]\]/) do
-      link_title = Regexp.last_match[1]
-      "[#{link_title}](#{link_title.parameterize}.html)"
+      link= Regexp.last_match[1]
+      "[#{link}](#{link})"
     end
   end
+
+  def convert_markdown_local_links!
+    @markdown_body.gsub!(/\[.*\]\(.*\)/) do |match|
+      VimwikiMarkdown::VimwikiLink.new(match, options.input_file, options.extension, options.root_path).to_s
+    end
+
+  end
+
 end

data/lib/vimwiki_markdown.rb

@@ -1,6 +1,7 @@
 require "vimwiki_markdown/version"
 require "vimwiki_markdown/options"
 require "vimwiki_markdown/template"
+require "vimwiki_markdown/vimwiki_link"
 require "vimwiki_markdown/wiki_body"
 require "vimwiki_markdown/exceptions"
 

data/spec/lib/vimwiki_markdown/options_spec.rb

@@ -13,7 +13,7 @@ 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('/home/patrick/vimwiki/templates/default.tpl') }
+      its(:template_filename) { should eq('~/vimwiki/templates/default.tpl') }
     end
   end
 end

data/spec/lib/vimwiki_markdown/vimwiki_link_spec.rb

@@ -0,0 +1,94 @@
+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")
+    end
+
+    context "with an existing markdown file matching name" do
+      let(:existing_file) { "test.#{markdown_extension}" }
+      let(:existing_file_no_extension) { existing_file.gsub(/\.#{markdown_extension}$/,"") }
+      let(:temp_wiki_dir) { Pathname.new(Dir.mktmpdir("temp_wiki_")) }
+      let(:markdown_link) { "[test](#{existing_file})" }
+      let(:source_filepath) { temp_wiki_dir + "index.md" }
+
+      before(:each) do
+        # here we create a stub test filename in the directory,
+        FileUtils.mkdir_p((temp_wiki_dir + existing_file).dirname)
+        FileUtils.touch(temp_wiki_dir + existing_file)
+      end
+
+      after(:each) do
+        FileUtils.rm_r(temp_wiki_dir)
+      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")
+      end
+
+      it "must convert same-directory markdown links with no extension correctly" do
+        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")
+      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")
+        end
+      end
+
+      context "../ style links" do
+        let(:existing_file) { "test.md" }
+        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")
+        end
+      end
+
+      context "aboslutely linked files" do
+        let(:existing_file) { "test.md" }
+        let(:source_filepath) { temp_wiki_dir + "subdirectory/index.md" }
+        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")
+        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")
+        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")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/vimwiki_markdown/wiki_body_spec.rb

@@ -6,20 +6,31 @@ require 'rspec-html-matchers'
 module VimwikiMarkdown
   describe WikiBody do
 
-    let(:options) { Options.new }
-    let(:wiki_body) { WikiBody.new(options) }
-    before do
-      allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
-      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return(wiki_index_markdown)
-    end
+    let(:wiki_body) { WikiBody.new(double(:options, input_file: 'blah', extension: 'md', root_path: '-')) }
+    let(:markdown_file_content) { wiki_index_markdown }
 
     it "must convert wiki links" do
+      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return(markdown_file_content)
+      allow_any_instance_of(VimwikiMarkdown::VimwikiLink).to receive(:vimwiki_markdown_file_exists?).and_return(true)
       expect(wiki_body.to_s).to match(/<a href="books.html">Books<\/a>/)
     end
 
+    it "must convert wiki links with separate titles correctly" do
+      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("[[http://www.google.com|google]]")
+      expect(wiki_body.to_s).to match(/<a href="http:\/\/www.google.com">google<\/a>/)
+    end
+
     it "must not put a break tag in a blockquote" do
+      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return(markdown_file_content)
+      allow_any_instance_of(VimwikiMarkdown::VimwikiLink).to receive(:vimwiki_markdown_file_exists?).and_return(true)
       expect(wiki_body.to_s).not_to match(/blockquote<br>/)
     end
 
+    it "must leave normal content alone" 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("hello")
+      expect(wiki_body.to_s).to match(/hello/)
+    end
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimwiki_markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Patrick Davey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2016-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -216,9 +216,11 @@ files:
 - lib/vimwiki_markdown/options.rb
 - lib/vimwiki_markdown/template.rb
 - lib/vimwiki_markdown/version.rb
+- lib/vimwiki_markdown/vimwiki_link.rb
 - lib/vimwiki_markdown/wiki_body.rb
 - spec/lib/vimwiki_markdown/options_spec.rb
 - spec/lib/vimwiki_markdown/template_spec.rb
+- spec/lib/vimwiki_markdown/vimwiki_link_spec.rb
 - spec/lib/vimwiki_markdown/wiki_body_spec.rb
 - spec/spec_helper.rb
 - vimwiki_markdown.gemspec
@@ -242,12 +244,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Converts a github flavoured markdown vimwiki file into html.
 test_files:
 - spec/lib/vimwiki_markdown/options_spec.rb
 - spec/lib/vimwiki_markdown/template_spec.rb
+- spec/lib/vimwiki_markdown/vimwiki_link_spec.rb
 - spec/lib/vimwiki_markdown/wiki_body_spec.rb
 - spec/spec_helper.rb