soywiki 0.1.3 → 0.1.4

data/README.markdown

@@ -116,6 +116,39 @@ content.
 
 That's all you need to know to get started. 
 
+## Namespaced WikiWords
+
+You can get very far with SoyWiki using normal CamelCase WikiWords.  
+
+    NormalWikiWord
+
+But if you want, you can also namespace your WikiWords, like so:
+
+    namespaced.WikiWord
+
+A namespaced WikiWord is a WikiWord prefixed by a namespace and a
+period. The namespace word must start with a lower-case letter and
+consist only of letters, numbers, and underscore characters. You can't
+chain namespace words together: the maximum nesting level is 1.
+
+Namespaced WikiWords help organize your wiki space conceptually. They also
+have two other benefits: 
+
+First, wiki pages that represent a namespaced WikiWord are stored under a
+subdirectory named after the namespace. This can help reduce clutter in
+your wiki directory.
+
+Every WikiWord namespace lets you use abbreviated links within that
+namespace. For example, if you are editing a page called
+`recipes.SoyMacaroni` and you want to link to another page in the same
+namespace called `recipes.SoyRaspberrySmoothie` you can type the link as
+just `SoyRaspberrySmoothie`. SoyWiki will know that this is a link to
+another page in the same namespace. 
+
+When you first start SoyWiki, the active namespace the is the default
+namespace `main`.
+
+
 ## Wiki navigation 
 
 You can navigate a SoyWiki wiki very quickly with the following
@@ -225,21 +258,28 @@ same wiki page.
 
 ## Search
 
-To search your SoyWiki wiki, type `:SWSearch [search term]`. Vim will
-load any matches in the quickfix list window.  If there are matches, you
-can use `:cn` and `:cp` to go from match to match, `:cl` to list the
-matches, and `:cc [item number]` to see a particular match ln the list.  See
-`:help quickfix` to see the list of matches. for more QuickFix commands. 
+* `:SWSearch` [term]
+* `:SWNamespacedSearch` [term]
+
+These commands search your SoyWiki wiki. Vim will load any matches in
+the quickfix list window.  If there are matches, you can use `:cn` and
+`:cp` to go from match to match, `:cl` to list the matches, and `:cc
+[item number]` to see a particular match ln the list.  See `:help
+quickfix` to see the list of matches. for more QuickFix commands. 
+
+Examples:
 
-Searches are case-sensitve by default. To do a case-insensitive search,
-add a `\c` to your search string, e.g.:
+    :SWSearch Gnu
+    :SWNamespacedSearch Gnu
 
-    :SWSearch Gnu\c
+You can use `:SWS` as a shortcut for `:SWSearch`. You can also
+tab-complete `:SWNS` to `:SWSNamespacedSearch`.
 
-Again, you can use `:SWS` as a shortcut.
+Searches are case-insensitve.  
 
 Under the hood, `:SWSearch` is just a thin wrapper around the `:vimgrep`
-command.
+command. Use `:vimgrep` directly if you want to do anything more
+specific.
 
 Tip: You can flag important notes in your wiki content by typing flags
 like TODO or IMPORTANT on the same line, and then use `:SWSearch` and
@@ -279,42 +319,6 @@ non-programmers, so a future version of SoyWiki may provide a more
 user-friendly interface for distributed collaboration workflows.
 
 
-## Namespaced WikiWords
-
-You can get very far with SoyWiki using normal CamelCase WikiWords.  
-
-    NormalWikiWord
-
-But if you want, you can also namespace your WikiWords, like so:
-
-    namespaced.WikiWord
-
-A namespaced WikiWord is a WikiWord prefixed by a namespace and a
-period. The namespace word must start with a lower-case letter and
-consist only of letters, numbers, and underscore characters. You can't
-chain namespace words together: the maximum nesting level is 1.
-
-Namespaced WikiWords help organize your wiki space conceptually. They also
-have two other benefits: 
-
-First, wiki pages that represent a namespaced WikiWord are stored under a
-subdirectory named after the namespace. This can help reduce clutter in
-your wiki directory.
-
-Second, a WikiWord namespace lets you use abbreviated links within that
-namespace. For example, if you are editing a page called
-`recipes.SoyMacaroni` and you want to link to another page in the same
-namespace called `recipes.SoyRaspberrySmoothie` you can type the link in
-this special abbreviated form:
-
-    .SoyRaspberrySmoothie
-
-SoyWiki will know from the leading period that this is a link to another
-page in the same namespace. 
-
-WikiLink autocompletion also works with abbreviated namespaced links. Just type a
-period, and invoke autocompletion with `CTRL-x CTRL-u`.
-
 
 ## Expanding a wiki page
 

data/lib/soywiki.rb

@@ -1,6 +1,6 @@
 
 class String
-  # TODO change this to a Windows compatible approach
+  # not Windows compatible 
   def to_file_path
     self.gsub(".", "/")
   end
@@ -20,7 +20,7 @@ end
 
 
 module Soywiki
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
   WIKI_WORD = /\b([a-z][\w_]+\.)?[A-Z][a-z]+[A-Z]\w*\b/
 
   def self.run

data/lib/soywiki.vim

@@ -3,7 +3,8 @@
 " License: MIT License (c) 2011 Daniel Choi
 
 " This regex matches namedspaced WikiWords and unqualified WikiWords 
-let s:wiki_link_pattern =  '\C\<\([a-z][[:alnum:]_]\+\.\)\?[A-Z][a-z]\+[A-Z]\w*\>'
+let s:wiki_link_pattern =  '\C\m\<\([a-z][[:alnum:]_]\+\.\)\?[A-Z][a-z]\+[A-Z]\w*\>'
+
 
 let s:http_link_pattern = 'https\?:[^ >)\]]\+'
 let s:rename_links_command = 'soywiki-rename '
@@ -40,6 +41,7 @@ func! s:namespace_of_title(page_title)
     return get(segments, 0)
   else
     call s:display_missing_namespace_error(len(segments))
+    return ""
   endif
 endfunc
 
@@ -92,11 +94,15 @@ func! s:list_pages()
   call s:page_list_window(s:get_page_list(), "Select page: ")
 endfunc
 
+func! s:trim_link(link)
+  let link = matchstr(a:link, s:wiki_link_pattern)
+  return link
+endfunc
+
 " returns a fully namespaced link
 func! s:link_under_cursor()
-  let link = expand("<cWORD>") 
-  " strip off non-letters at the end (e.g., a comma)
-  let link = substitute(link, '[^[:alnum:]]*$', '', '')
+  let link = s:trim_link(expand("<cWORD>"))
+  " strip off non-letters at the end and beginning (e.g., a comma)
   if ! s:has_namespace(link)
     let link = s:infer_namespace(link)
   endif
@@ -151,6 +157,9 @@ func! s:load_page(page, split)
   if (!filereadable(file)) 
     " create the file
     let namespace = s:namespace_of_title(a:page)
+    if namespace == ""
+      return
+    end
     call system("mkdir -p " . namespace)
     call writefile([title, '', ''], file) 
   endif
@@ -257,8 +266,7 @@ func! s:pages_in_this_namespace(pages)
   let namespace = s:page_namespace()
   let pages = filter( a:pages,  'v:val =~ "^' . namespace . '\."')
   " strip leading namespace
-  let pages = map( pages, "substitute(v:val, '^" . namespace . "\.', '', '') " )
-  return pages
+  return map(pages, "substitute(v:val, '^" . namespace . "\.', '', '') ")
 endfunc
 
 " When user press TAB after typing a few characters in the page selection
@@ -304,44 +312,37 @@ function! s:page_list_window(page_match_list, prompt)
   " call feedkeys("a", 't')
 endfunction
 
-" This function assumes s:matching_pages has been set by the calling function
 function! CompletePageTitle(findstart, base)
-  let fragment = expand("<cWORD>")
-  if !exists("s:matching_pages")
-    let s:matching_pages = s:get_page_list()
-  endif
-  if match(fragment, '^[A-Z]') == 0 
-    " we have a WikiWord without a namespace; filter down to pages in pages in this
-    " namespace
-    let s:matching_pages = s:pages_in_this_namespace(s:matching_pages)
-  endif
   if a:findstart
     " locate the start of the word
-    " Assume we're in a page select window if there is a ': ' in the line.
-    " Admittedly, this is not work well in all cases
-    if bufname('') == 'page-list-buffer'
-      " by starting after prompt ': '
-      let start = match(getline('.'), ': ') + 2
-    else
-      " locate the start of the word
-      let line = getline('.')
-      let start = col('.') - 1
-      while start > 0 && line[start - 1] =~ '\a'
-        let start -= 1
-      endwhile
-    end
+    let line = getline('.')
+    let start = col('.') - 1
+    while start > 0 && line[start - 1] =~ '\m[[:alnum:]\.]'
+      let start -= 1
+    endwhile
     return start
   else
     let base = s:trimString(a:base)
     if (base == '')
-      return s:matching_pages
+      return s:get_page_list()
     else
       let res = []
-      for m in s:matching_pages
-        if m =~ '\c' . base 
-          call add(res, m)
-        endif
-      endfor
+      if bufname('') == 'page-list-buffer'
+        let pages = s:get_page_list()
+        for m in pages
+          if m =~ '\c' . base 
+            call add(res, m)
+          endif
+        endfor
+      else
+        " autocomplete inline
+        let pages = base =~ '\C^[a-z]' ? s:get_page_list() : s:pages_in_this_namespace(s:get_page_list())
+        for m in pages
+          if m =~ '^\c' . base 
+            call add(res, m)
+          endif
+        endfor
+      endif
       return res
     endif
   endif
@@ -450,10 +451,13 @@ func! s:insert_divider()
 endfunc
 "------------------------------------------------------------------------
 " SEARCH
-func! s:wiki_search(pattern)
-
+func! s:wiki_search(pattern, in_this_namespace)
   let pattern = (empty(a:pattern)  ? @/ : a:pattern)
-  execute printf('vimgrep/%s/ %s', pattern, "**/*")
+  if a:in_this_namespace
+    execute printf('vimgrep/\c%s/ %s', pattern, s:page_namespace()."/*")
+  else
+    execute printf('vimgrep/\c%s/ %s', pattern, "*/*")
+  endif
 endfunc
 
 "------------------------------------------------------------------------
@@ -517,8 +521,8 @@ func! s:global_mappings()
   command! -bar -nargs=1 -range -complete=file SWLinkAppend :<line1>,<line2>call s:extract(<f-args>, 'append', 1)
   command! -bar -nargs=1 -range -complete=file SWLinkInsert :<line1>,<line2>call s:extract(<f-args>, 'insert', 1)
 
-  command! -bar -nargs=1 SWSearch :call s:wiki_search(<f-args>)
-  " TODO a search confined to current namespace
+  command! -bar -nargs=1 SWSearch :call s:wiki_search(<f-args>, 0)
+  command! -bar -nargs=1 SWNamespaceSearch :call s:wiki_search(<f-args>, 1)
 
   autocmd  BufReadPost,BufNewFile,WinEnter,BufEnter,BufNew,BufAdd * call s:highlight_wikiwords() 
   autocmd  BufEnter * call s:prep_buffer() 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Daniel Choi