soywiki 0.9.6 → 0.9.7

data/README.markdown

@@ -490,6 +490,19 @@ pattern. But SoyWiki stands with CamelCase.
 No wiki link pattern is perfect! All involve trade-offs. The CamelCase
 pattern gives you a lot in return for its particular compromises. 
 
+## Hyperlinks
+
+There may come the time when you want to link to content, that
+isn't part of your wiki. The common link-syntax will allow
+you to refer to websites. But if you want to link
+to something in your own filesystem you can
+also use the `file://` schema. This schema
+actually only allows absolute file paths. To circumvent
+this problem we have added support for our own schema:
+`soyfile://` which allows to link to files relative
+to the wiki root or, if you use vim's
+*autochdir* option, relative to the current namespace.
+
 
 ## Bug reports and feature requests
 

data/lib/soywiki.rb

@@ -1,9 +1,10 @@
 require 'string_ext'
 module Template_Substitution; end
 module Soywiki
-  VERSION = '0.9.6'
+  VERSION = '0.9.7'
   WIKI_WORD = /\b([a-z0-9][\w_]+\.)?[A-Z][a-z]+[A-Z0-9]\w*\b/
-  HYPERLINK = %r|\bhttps?://[^ >)\n\]]+|
+  SCHEMES = %w{https http file soyfile}
+  HYPERLINK = %r|\b(?:#{SCHEMES.join('|')})://[^ >)\n\]]+|
 
   def self.run
     require 'getoptlong'

data/lib/soywiki.vim

@@ -12,7 +12,8 @@ let mapleader = ','
 
 " This regex matches namedspaced WikiWords and unqualified WikiWords 
 let s:wiki_link_pattern =  '\C\m\<\([a-z0-9][[:alnum:]_]\+\.\)\?[A-Z][a-z]\+[A-Z0-9]\w*\>'
-let s:http_link_pattern = '\v(https|http|file|):[^ >)\]]+\V'
+let s:uri_link_pattern = '\v(https|http|file|soyfile):[^ >)\]]+\V'
+let s:soyfile_pattern = '\v^soyfile:[^ >)\]]+\V'
 let s:wiki_or_web_link_pattern =  '\C\<\([a-z0-9][[:alnum:]_]\+\.\)\?[A-Z][a-z]\+[A-Z0-9]\w*\>\|https\?:[^ >)\]]\+'
 
 let s:rename_links_command = 'soywiki-rename '
@@ -33,6 +34,12 @@ func! s:page_title()
   return page_title
 endfunc
 
+func! s:current_namespace_path()
+  let absolutepath = expand('%:p')
+  let dir_path = fnamemodify(absolutepath, ':h')
+  return dir_path
+endfunc
+
 func! s:wiki_root()
   let root_path = split(system("git rev-parse --show-toplevel"), "\n")[0] . '/'
   return root_path
@@ -167,7 +174,7 @@ endfunc
 
 func! s:follow_link_under_cursor(split)
   let word = expand("<cWORD>")
-  if match(word, s:http_link_pattern) != -1
+  if match(word, s:uri_link_pattern) != -1
     call s:open_href_under_cursor()
     return
   endif
@@ -595,19 +602,49 @@ endfunc
 "------------------------------------------------------------------------
 func! s:open_href_under_cursor()
   let word = expand("<cWORD>")
-  let href = matchstr(word, s:http_link_pattern)
-  let command = g:SoyWiki#browser_command . " '" . href . "' "
+  let soyuri = matchstr(word, s:uri_link_pattern)
+  let uri = s:expand_iana_uri(soyuri)
+  let command = g:SoyWiki#browser_command . " '" . uri . "' "
   call system(command)
   echom command 
 endfunc
 
 func! s:find_next_href_and_open()
-  let res = search(s:http_link_pattern, 'cw')
+  let res = search(s:uri_link_pattern, 'cw')
   if res != 0
     call s:open_href_under_cursor()
   endif
 endfunc
 
+func! s:expand_iana_uri(soyuri)
+  if match(a:soyuri, s:soyfile_pattern) != -1
+    let autochdir_rel_path = s:current_namespace_path()
+    let wiki_rel_path = s:wiki_root()
+
+    let filepath = substitute(a:soyuri, 'soyfile://', '', '')
+
+    " the case that the soyfile is actually an absolute path
+    if match(filepath, '\v^/') != -1
+      return "file://" . filepath
+    endif
+
+    let autochdir_path = fnamemodify(autochdir_rel_path . '/' . filepath, ':p')
+    let wiki_path = fnamemodify(wiki_rel_path . '/' . filepath, ':p')
+    let uri_path_part = wiki_path
+
+    " the case that the path supplied was relative to
+    " the current namespace directory (autochdir-option)
+    if filereadable(autochdir_path)
+      let uri_path_part = autochdir_path
+    endif
+
+    return 'file://' . uri_path_part
+  else
+    " return non-soyfile uris unchanged
+    return a:soyuri
+  end
+endfunc
+
 func! s:goto_homepage(main)
   if a:main
     call s:load_page("main.HomePage", 0)
@@ -701,7 +738,7 @@ func! s:highlight_wikiwords()
   if (s:is_wiki_page()) 
     "syntax clear
     exe "syn match Comment /". s:wiki_link_pattern. "/"
-    exe "syn match Constant /". s:http_link_pattern . "/"
+    exe "syn match Constant /". s:uri_link_pattern . "/"
   endif
 endfunc
 

data/lib/soywiki/html.rb

@@ -7,6 +7,7 @@ module Soywiki
     HTML_DIR = 'html-export'
     INDEX_PAGE_TEMPLATE = File.read(File.join(File.dirname(__FILE__), '..', 'index_template.html.haml'))
     BROKEN_MARKDOWN_HYPERLINK = %r|\[([^\]]+)\]\(\[(#{HYPERLINK})\]\(\2\)\)|
+    @current_namespace = nil
 
     def self.href_wiki_links(text)
       text = text.gsub(WIKI_WORD) {|match|
@@ -24,17 +25,38 @@ module Soywiki
       substitute = if @markdown then '[\\0](\\0)' else '<a href="\\0">\\0</a>' end
       text = text.gsub(HYPERLINK, substitute)
       if @markdown
-          text = text.gsub(BROKEN_MARKDOWN_HYPERLINK, '[\\1](\\2)')
+        text = text.gsub(BROKEN_MARKDOWN_HYPERLINK, '[\\1](\\2)')
       end
+      text = text.gsub(HYPERLINK) { |uri| soyfile_to_uri(uri) }
       return text
     end
 
+    def self.soyfile_to_uri(uri)
+      uri_after_scheme = %r{[^ >)\n\]]+}
+      if uri =~ %r{^soyfile://(#{uri_after_scheme})}
+        path = choose_soyfile_path($1)
+        return "file://#{path}" if path[0] == '/'
+      else
+        return uri
+      end
+    end
+
+    def self.choose_soyfile_path(path)
+      return path if path[0] == '/'
+      wiki_root = Dir.getwd
+      autochdir_path = File.absolute_path(
+        File.join(wiki_root, @current_namespace, path))
+      wiki_path = File.absolute_path(File.join(wiki_root, path))
+      File.exists?(autochdir_path) ? autochdir_path : wiki_path
+    end
+
     def self.process(t)
       href_hyperlinks(href_wiki_links(t))
     end
 
     PAGE_TEMPLATE = File.read(File.join(File.dirname(__FILE__), '..', 'page_template.html.haml'))
     def self.generate_page(text, namespace, pages, namespaces)
+      @current_namespace = namespace
       text = text.split("\n")
 
       title = text.shift || ''
@@ -123,11 +145,13 @@ module Soywiki
         count = Dir["#{namespace}/*"].select {|f| wiki_page?(f)}.size
         [namespace, count]
       }
+      @current_namespace = nil
       namespaces.each do |namespace_dir, count|
         make_pages namespace_dir, namespaces
       end
       # make root index page
       make_root_index_page namespaces
+      @current_namespace = nil
       puts "HTML files written to #{HTML_DIR}/"
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soywiki
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.9.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-09-21 00:00:00.000000000 Z
 dependencies: []
 description: A personal and collaborative wiki for Vim users
 email: