soywiki 0.0.1 → 0.0.2

data/.gitignore

@@ -7,3 +7,5 @@ pkg/
 .rvmrc
 notes.txt
 *buffer
+website/
+wiki/

data/MIT-LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Daniel Choi, http://danielchoi.com/software/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.markdown

@@ -0,0 +1,356 @@
+# SoyWiki
+
+SoyWiki is lightweight application that turns Vim into a fast and
+powerful wiki. 
+
+A quick overview of its characteristics and features:
+
+* flat text files
+* maximum data portability
+* high interoperability with Unix tools
+* Vim text editing power
+* super-efficient modes of wiki traversal 
+* Git for versioning, distributed workflows, and blaming
+* CamelCase wiki words
+* namespaced wiki words
+* autocompletion of wiki words
+* automated global renaming of wiki words
+* syntax colored wiki words
+* outliner-like capability with expansion commands
+* operates on all POSIX systems (e.g. OS X, Linux, FreeBSD)
+
+SoyWiki builds on Vim's strengths as a text editor and interface to the
+Unix operating system, SoyWiki makes it possible to create, navigate,
+and refactor wiki content at the speed of thought. 
+
+SoyWiki is good for tracking projects, contacts, ideas, and collecting
+and organizing research. SoyWiki combines the affordances of notebooks,
+index cards, and Post-it notes, and adds the power of hyperlinks and
+automatic indexing.
+
+SoyWiki makes a great writing aid, especially if you do your writing in
+Vim. You can have SoyWiki open in multiple Vim windows, tabs, and
+buffers, alongside any number of regular Vim windows. Throw in a bunch
+of Vim abbreviations (`:help abbreviations`), a large monitor, and a
+teapot, and you'll have your paper, essay, book, or screenplay written
+in record time.
+
+You don't need to shell out $$ for tools like [Scrivener][scriv] if you
+appreciate how much more powerful Vim is for editing and navigating text
+and how liberating it is to be able to store your content in the
+non-proprietary, universal plain-text format. Proprietary tools and
+formats will come and go every few years, but the plain text file format
+and Vim are forever.
+
+SoyWiki is free and open source.
+
+[scriv]:http://www.literatureandlatte.com/scrivener.php
+
+## Prerequisites
+
+* a recent version of Vim (SoyWiki is developed against Vim 7.2 and 7.3)
+* a recent version of Ruby (SoyWiki is developed using Ruby 1.9.2)
+* RubyGems (if Ruby version is older than 1.9)
+* a recent version of Git (1.7.0.4 or above to be safe)
+
+The current version of SoyWiki assumes a Unix environment. 
+
+To use SoyWiki you should be fairly good at using Vim. More than 80
+percent of the SoyWiki codebase implements the VimScript interface
+layer.
+
+## Installation
+
+    gem install soywiki
+
+Test your installation by typing `soywiki -h`. You should see SoyWiki's help.
+
+On some systems you may run into a PATH issue, where the system can't find the
+`soywiki` command after installation. Please report this if you encounter this
+problem, and mention what system you're using. You might want to try 
+
+    sudo gem install soywiki
+
+If you ever want to uninstall SoyWiki from your system, execute this command:
+
+    gem uninstall soywiki
+
+... and all traces of SoyWiki will removed.
+
+New and improved versions of SoyWiki will be released over time. To install the
+latest version, just type `gem install soywiki` again.
+
+
+## Starting SoyWiki
+
+Before you start SoyWiki, create a directory that will hold your wiki
+files and `cd` into it. Then you can start SoyWiki with
+
+    soywiki
+
+You can make as many SoyWiki wikis on your system as you want just by
+creating directories for them. It's not a good idea however to nest
+SoyWiki wiki directories within each other, for reasons that will become
+clear below.
+
+To use MacVim as your SoyWiki Vim engine, you can run soywiki like this
+
+    SOYWIKI_VIM=mvim soywiki
+
+or you can `export SOYWIKI_VIM=mvim` in your `~/.bash_profile` and then
+just run `soywiki`.
+
+## Basic usage
+
+For basic use, SoyWiki works exactly like a typical wiki.
+
+You write text, and when you want to create a new wiki page, you come up
+with a WikiWord for it and format it in CamelCase. The wiki-link you
+just typed will automatically be syntax-highlighted, and pressing ENTER
+on it will take you to the new page. Creating WikiWords and pressing
+ENTER on them is the main way of linking wiki pages together. You'll be
+surprised at how powerful this simple mechanism is for organizing your
+notes. 
+
+That's all you need to know to get started. 
+
+## Wiki navigation 
+
+Because SoyWiki is not just wiki but a Vim program, it lets you work a
+lot faster and with more economy than browser-based wikis. 
+
+You can navigate a SoyWiki wiki very quickly with the following
+commands. 
+
+* `CTRL-n` and `CTRL-p` move the cursor directly to the next or previous wiki-link on the page
+* `ENTER` follows the wiki-link under the cursor
+* `,f` follows the first wiki-link after the cursor
+* `,-` opens a wiki-link in a split window
+* `,|` does the same, but in a vertical split window
+
+You can also use Vim's jump motions `CTRL-o` and `CTRL-i` to move back
+and forth in your jump history. See `:help jump-motions` for more on
+this. You can press `CTRL-^` to toggle between the current page and the
+last page you looked at.
+
+You can view all the pages in your wiki, most recently modified first,
+by press `,m`. This opens both a page list and autocompletion window.
+You can use the standard Vim autocompletion commands here to find the
+page you want and call it up.  See Vim's `:help ins-completion-menu` for
+further instructions.
+
+When you're on a wiki page and you want to see all the other wiki pages
+that link in to it, press `,M`. If there is only one page that links in,
+you'll be taken there automatically.
+
+`,o` opens the first normal web hyperlink -- the ones that begin with http://
+or https:// -- on or after the cursor in your default web browser.
+
+Under the covers, SoyWiki uses the command `gnome-open` or `open` to
+launch your web browser. This should cover Linux Gnome desktop and OS X
+users. You can change the command SoyWiki uses to open a hyperlink by
+adding this to your `~/.vimrc`:
+
+    let g:SoyWiki#browser_command = "your browser command here"
+
+If your Vim has `netrw`, you can open a hyperlink directly in same Vim
+window by putting the cursor at the beginning of a hyperlink and typing
+`gf`, or `C-w f` if you want to open the webpage in a split window.  See
+`:help netrw` for more information.
+
+## Wiki-link autocompletion
+
+When you're writing a wiki page and you want to link to another page,
+SoyWiki can help you autocomplete your wiki-link. Press `CTRL-x CTRL-u`
+in Vim insert mode to invoke it.
+
+
+## Wiki refactoring
+
+You can rename a wiki page with`,r`. You'll see a prompt asking
+you for the new name. Make sure it is valid CamelCase. After you press
+ENTER, SoyWiki will rename the page and update all the links on other
+pages in your wiki that need updating because of the change.
+
+You can delete a page with `,#`. 
+
+Beyond the standard cut and paste, SoyWiki gives you four fast ways of
+shuttling text from one wiki page to another.
+
+First, highlight the text you want to move with Vim's visual mode. (See
+`:help visual-mode` for more info) 
+
+Then, type
+
+* `:SWInsert [target]` to move the text to the top of target page
+* `:SWAppend [target]` to move the text to the bottom of the target page
+* `:SWLinkInsert [target]` performs `:SWInsert` and replaces the text with a WikiWord link
+* `:SWLinkAppend [target]` performs `:SWAppend` and replaces the text with a WikiWord link
+
+`[target]` is the name of the file that contains the wiki page you're
+targeting. Press `TAB` for autocompletion help.
+
+These commands will open the target page (if it isn't open already) in a
+split window and insert or append the selected text into it.  If the
+target page doesn't exist, it will be created.
+
+You can use these shortcuts:
+
+* `:SWInsert` → `:SWI`
+* `:SWAppend` → `:SWA`
+
+With `:SWLinkInsert` and `:SWLinkAppend` you can use tab-autocompletion
+to avoid typing out the whole command name.
+
+
+## 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.  See `:help quickfix`
+for more QuickFix commands. 
+
+Searches are case-insensitve by default. To do a case-sensitive search,
+add a `\C` to your search string, e.g.:
+
+    :SWSearch Gnu\C
+
+Again, you can use `:SWS` as a shortcut.
+
+Under the hood, `:SWSearch` is just a thin wrapper around the `:vimgrep`
+command.
+
+
+## Revision history and distributed workflows
+
+SoyWiki delegates revision-tracking, syncing, and collaboration
+workflows to Git.  SoyWiki automatically creates a Git repository in
+your wiki directory and automatically commits all the edits you make to
+it.  You can sync a SoyWiki wiki between two computers using the
+standard Git push and pull commands.  Collaborators can also edit a
+common wiki this way, in peer to peer fashion. 
+
+SoyWiki provides a few convenient key mappings to view the revision
+history of a wiki page: 
+
+* `,l` shows a `git-log` view of the revision history of the current page
+* `,b` shows a `git-blame` view of the current page, which shows when each line was added and by whom.
+* `:SWLogStat` shows a `git log --stat` view of the current page's revision history
+
+You can always bypass Vim and SoyWiki altogether and use Git directly to
+inspect your revision history. The Git repo for your SoyWiki wiki will
+be located in the same directory as your wiki files.
+
+To sync your SoyWiki wiki between two personal computers, just follow
+the general instructions [here][git-sync].
+
+[git-sync]:http://www-cs-students.stanford.edu/~blynn/gitmagic/ch03.html
+
+
+## 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. 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 conceptual wiki space. 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 the 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
+
+SoyWiki lets you render a wiki page in "expanded" form.  What this does
+is expand all the wiki links on the page that appear alone on a line to
+include their content inline. This works recursively in all the included
+wiki pages (though it does not go into vicious circles because it only
+expands each link once).
+
+The rendered page appears in a Vim scratch buffer. From there you can
+write it out to a new text file, pipe it to `lpr` to print it, or
+whatever you like. 
+
+There are two forms of expansion: seamful and seamless. Seamful
+expansion expands wiki links into wiki pages and clearly marks where
+this has happened by including markers along with the WikiWord that was
+expanded. Seamless expansion does not mark a point of expansion with
+anything, and it erases the WikiWord that got expanded. 
+
+* `,x` expands a wiki page seamfully
+* `,X` expands a wiki page seamlessly
+
+Both modes of expansion are useful when you want to assemble a long
+piece of writing by using one page as a master outline and linking from
+this to other wiki pages that include the real content. And since
+expansion is recursive, you can effectively nest outlines within
+outlines, like dreams within dreams.  
+
+
+## Why CamelCase WikiLinks rule
+
+Some people don't like the CamelCase (a.k.a. WikiCase) wiki link
+pattern. But SoyWiki embraces it and wants everyone to adopt it, for the
+following reasons:
+
+* Besides being the original, CamelCase is the most elegantly minimalist approach to linking wiki pages together -- "with no additional markup whatsoever," as [Ward Cunningham put it][ward]. 
+* It encourages you more than other wiki link patterns to create wiki pages with succinctly descriptive names.  
+* Because the link pattern is so minimal and succinct, inserting them in
+your notes interrupts your flow of
+thought a lot less than other wiki patterns.
+* It is very conducive to storing
+wiki pages in plain text files: the page names can map directly to Unix
+file names without any awkward character escaping.
+
+[ward]:http://c2.com/cgi/wiki?WikiCase
+
+
+## Why name a wiki engine after a legume?
+
+I am a fan of food made of [soy][soylink]: soy ice cream, soy milk, soy
+burgers, soy butter, you name it. The word "soy" has come to signify a
+newer, lighter, healthier alternative to the same old same old. SoyWiki
+may not be an actual soy product, but it tries to be a wiki engine with
+soy-like benefits.
+
+[soylink]:http://www.mayoclinic.com/health/soy/NS_patient-soy
+
+## How to contact the developer
+
+My name is Daniel Choi. I am based in Cambridge, Massachusetts, USA, and you
+can email me at dhchoi {at} gmail.com.  
+
+## How to support the SoyWiki project
+
+If you find SoyWiki very useful, feel free to drop me a note to say so. If you
+have a bug to report or a good feature to suggest, please file it on the [issue
+tracker][1].  
+
+[1]:https://github.com/danchoi/soywiki/issues
+
+

data/Rakefile

@@ -5,13 +5,34 @@ require 'json'
 require 'rake'
 require 'rake/testtask'
 require 'bundler'
-# require 'soywiki'
+require 'soywiki'
 
 Bundler::GemHelper.install_tasks
 
-desc "Start Sinatra webapp"
-task :sinatra do
-# TODO
+desc "build and push website"
+task :web do
+  version = Soywiki::VERSION
+  Dir.chdir("website") do
+    puts "updating website"
+    puts `./run.sh #{Soywiki::VERSION}`
+  end
+end
+
+desc "build website locally"
+task :weblocal => :build_webpage do
+  Dir.chdir("website") do
+    `open soywiki.html`
+  end
+end
+
+desc "build webpage"
+task :build_webpage do
+  $LOAD_PATH.unshift 'website'
+  require 'gen'
+  Dir.chdir("website") do
+    html = Webpage.generate(Soywiki::VERSION)
+    File.open('soywiki.html', 'w') {|f| f.puts html}
+  end
 end
 
 desc "Run tests"

data/bin/soywiki

@@ -6,4 +6,4 @@ rescue LoadError
   require 'soywiki'
 end
 
-
+Soywiki.run

data/bin/soywiki-expand

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+require 'soywiki'
+
+# Takes any wiki link that stands alone on a line and expands it
+
+WIKI_LINK_PATTERN =  /^\s*(([a-z]\w+\.)?[A-Z][a-z]+[A-Z]\w*|\.[A-Z][a-z]+[A-Z]\w*)\s*$/
+
+PROCESSED_FILES = []
+
+def indent(text, level, mode)
+  return text if mode == 'seamless'
+  return text if level == 0
+  (': ' * level) +  text
+
+end
+
+def expand(file, mode, level=0)
+  PROCESSED_FILES << file
+  lines = File.readlines(file)
+  if mode == 'seamless'
+    lines.shift 2  # strips title
+  end
+  lines = lines.join.strip.split("\n")
+  lines.each do |line|
+    # note that the wiki link must be alone on the line to be expanded
+    if line =~ WIKI_LINK_PATTERN 
+      link = line.strip
+      if link =~ /^\./ # short link in namespace (relative link)
+        namespace = file.namespace
+        link = [namespace, link].join
+      end
+      if File.file?(link.to_file_path) && !PROCESSED_FILES.include?(link.to_file_path) 
+        if mode == 'seamful'
+          puts '.' * 10
+        end
+        expand(link.to_file_path, mode, level + 1) # recursive call
+        if mode == 'seamful'
+          puts '.' * 10
+        end
+
+      elsif PROCESSED_FILES.include?(link) 
+        puts indent("#{link} [[already expanded]]", level, mode)
+      else
+        puts indent("#{link} [[no file found]]", level, mode)
+      end
+    else
+      puts indent(line, level, mode)
+    end
+  end
+end
+
+mode, file = *ARGV
+
+expand(file, mode)
+
+

data/bin/soywiki-ls-t

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require 'soywiki'
+
+xs = Dir.glob(File.join('**', '*')).select {|x|
+  File.file?(x) && 
+    x.gsub('/', '.') =~ Soywiki::WIKI_WORD
+}.sort_by {|x|
+  File.stat(x).mtime
+}.reverse.map {|x| x.to_page_title}
+puts xs.join("\n")

data/bin/soywiki-pages-linking-in

@@ -1,29 +1,30 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
-
-class String
-  def is_namespaced?
-    self.split(".").size == 2
-  end
-end
+require 'soywiki'
 
 def inbound_links_to?(file, page_title)
   return false unless File.file?(file)
   return false if (file =~ /(\.swo|\.swp)$/ || file =~ /^\./)
   body =   File.read(file)
-  body =~ /[\A\s\n\b]#{page_title}\b/
+  body =~ /[\A\s\n\b]#{page_title.gsub(".", "\.")}\b/
 end
 
 target_page = ARGV.first
 
-if target_page.is_namespaced?
+if target_page.namespaced?
   namespace, page = *target_page.split(".")
-  # find all files in this name space
-  Dir.glob("#{namespace}.*").select do |file|
+  # find all files in this namespace
+  xs = Dir.glob(File.join("#{namespace}", "*")).select do |file|
     inbound_links_to?(file, target_page) || inbound_links_to?(file, ".#{page}")
-  end.each {|file| puts file}
+  end
+  ys = Dir.glob(File.join("**", '*')).select do |file|
+    inbound_links_to?(file, target_page) 
+  end
+  (xs + ys).uniq.sort.
+    each {|x| puts x.to_page_title}
 else
-  Dir.glob("*").select do |file|
+  Dir.glob(File.join("**", '*')).select do |file|
     inbound_links_to?(file, target_page)
-  end.each {|file| puts file}
+  end.
+    each {|file| puts file.to_page_title}
 end

data/bin/soywiki-rename

@@ -1,53 +1,92 @@
 #!/usr/bin/env ruby
+require 'soywiki'
+
 oldname, newname = *ARGV
 
-class String
-  def is_namespaced?
-    self.split(".").size == 2
-  end
-end
 
-target_files = `grep -lF '#{oldname}' *`.strip.split(/\n/)
-target_files.each do |file|
-  text = File.read(file)
-  text.gsub!(/\b#{oldname}\b/, newname)
-  File.open(file, 'w') {|f| f.puts text}
+MEMO = ["Updating inbound and outbound links..."]
+
+def report(file, oldname, newname)
+  MEMO <<  "  - In #{file}: #{oldname.to_page_title} -> #{newname.to_page_title}"
 end
 
-# deal with links without namespace
+def change_all_absolute_links(oldname, newname)
+  MEMO << "- Updating all absolute links"
+  target_files = `grep -rlF '#{oldname.to_page_title}' *`.strip.split(/\n/)
+  target_files.each do |file|
+    text = File.read(file)
+    text.gsub!(/\b#{oldname.to_page_title}\b/, newname.to_page_title)
+    File.open(file, 'w') {|f| f.puts text}
+    report file, oldname.to_page_title, newname.to_page_title
+  end
+end
 
-old_short = oldname.split(".")[1]
-new_short = newname.split(".")[1]
+# Three other cases to cover, involving namespaces:
+#
+# Case 1: Oldname is namespaced, and Newname is in same namespace
+#
+# In the directory for OldName's namespace, change all referenecs to
+# .OldName to .NewName
 
-if old_short && !new_short
-  # where going from a namespaced name to a top-level name
-  old_namespace = oldname.split(".")[0]
-  target_files = `grep -lF '\<#{old_short}\>' *`.strip.split(/\n/)
+if oldname.namespaced? && (oldname.namespace == newname.namespace)
+  MEMO << "- Updating relative links in same namespace"
+  target_files = `grep -rlF '#{oldname.short_page_title}' #{oldname.namespace}/*`.strip.split(/\n/)
   target_files.each do |file|
     text = File.read(file)
-    text.gsub!(/\b#{old_short}\b/, newname)
+    text.gsub!(/([\b\s\n]\.)(#{oldname.short_page_title})\b/, '\1' + newname.short_page_title)
     File.open(file, 'w') {|f| f.puts text}
+    report file, oldname.short_page_title, newname.short_page_title
   end
-  # change all the .Wikiwords in the newname file to fully namespaced
-  # links with namespace of newname.downcase
-  if File.exist?(newname)
-    text = File.read(newname)
-    #text.gsub!(relative_wiki_word, "#{newname.downcase}.#{$1}")
-    # ".Pear".gsub!(/\A\.([A-Z][a-z]+[A-Z]\w*)/, "TEST.#{$1}")
-    text.gsub!(/([\A\s\n\b])\.([A-Z][a-z]+[A-Z]\w*)/, '\1' + newname.downcase + '.\2')
-    File.open(newname, 'w') {|f| f.puts text}
-  end
-elsif !old_short && new_short
-  # where going from a top-level name to a namespaced one 
-  # no action needed
-elsif !old_short && !new_short
-  # no action needed
-elsif old_short && new_short
-  target_files = `grep -lF '#{old_short}' *`.strip.split(/\n/)
-  puts target_files.inspect
+end
+
+# newname can be absolutized or top level or relative
+def change_relative_inbound_links(oldname, newname)
+  MEMO << "- Updating relative inbound links"
+  target_files = `grep -rlF '#{oldname.to_page_title}' #{oldname.namespace}/*`.strip.split(/\n/)
   target_files.each do |file|
     text = File.read(file)
-    text.gsub!(/\b#{old_short}\b/, new_short)
+    text.gsub!(/[\b\s\n]\.(#{oldname.short_page_title})\b/, "." + newname)
     File.open(file, 'w') {|f| f.puts text}
+    report file, oldname.short_page_title, newname
   end
 end
+
+RELATIVE_LINK_REGEX =/([\A\s\n\b])\.([A-Z][a-z]+[A-Z]\w*)/
+
+def absolutize_relative_outbound_links(oldname, newname)
+  MEMO << "Absolutizing relative inbound links"
+  if File.exist?(newname.to_file_path)
+    text = File.read(newname.to_file_path)
+    matches = text.scan(RELATIVE_LINK_REGEX)
+    text.gsub!(RELATIVE_LINK_REGEX, '\1' + oldname.namespace + '.\2')
+    File.open(newname.to_file_path, 'w') {|f| f.puts text}
+    MEMO <<  "  - In file #{file}: Absolutized these relative links: #{matches.inspect}"
+  end
+end
+
+
+# Case 2: Oldname is namespaced, and Newname is in different namespace
+if oldname.namespaced? && newname.namespaced? && (oldname.namespace != newname.namespace)
+  # In the directory for OldName's namespace, change all references to
+  # .OldName to newnamespace.NewName (i.e. NewName).
+  change_relative_inbound_links(oldname, newname)
+  # And in the renamed file, change all relative references to
+  # .PageName to oldnamespace.PageName
+  absolutize_relative_outbound_links(oldname, newname)
+end
+
+# Case 3: Oldname is namespaced, and Newname is top level
+if oldname.namespaced? && !newname.namespaced? 
+  # In the directory for OldName's namespace, change all references to
+  # .OldName to TopLevelNewName (i.e. NewName)
+  change_relative_inbound_links(oldname, newname)
+  # And in the renamed file, change all relative references to
+  # .PageName to oldnamespace.PageName
+  absolutize_relative_outbound_links(oldname, newname)
+end
+
+# Finally,
+
+change_all_absolute_links oldname, newname
+
+puts MEMO.join("\n")

data/lib/soywiki.rb

@@ -1,8 +1,57 @@
 
-vim = ENV['VMAIL_VIM'] || 'vim'
+class String
+  def is_namespaced?
+    self.split(/\.|\//).size == 2
+  end
 
-vimscript = File.expand_path("../soywiki.vim", __FILE__)
+  alias :namespaced? :is_namespaced?
 
-vim_command = "#{vim} -S #{vimscript}"
+  # TODO change this to a Windows compatible approach
+  def to_file_path
+    self.gsub(".", "/")
+  end
+
+  def to_page_title
+    self.gsub("/", ".")
+  end
+
+  def short_page_title
+    self.to_page_title.split('.')[1]
+  end
+
+  def namespace
+    return nil unless self.namespaced?
+    self.to_page_title.split('.')[0]
+  end
+end
+
+
+module Soywiki
+  VERSION = '0.0.2'
+  WIKI_WORD = /\b([a-z][\w_]+\.)?[A-Z][a-z]+[A-Z]\w*\b|\.[A-Z][a-z]+[A-Z]\w*\b/
+
+  def self.run
+    if %W( -v --version -h --help).include?(ARGV.first)
+      puts "soywiki #{Soywiki::VERSION}"
+      puts "by Daniel Choi dhchoi@gmail.com"
+      puts
+      puts <<END
+---
+Usage: soywiki [wiki file]
+
+Run the command in a directory you've made to contain soywiki files.
+
+Specifying a wiki file is optional. If you don't specify a file, soywiki will
+open the most recently modified wiki file. 
+---
+END
+      exit
+    end
+
+    vim = ENV['SOYWIKI_VIM'] || 'vim'
+    vimscript = File.expand_path("../soywiki.vim", __FILE__)
+    vim_command = "#{vim} -S #{vimscript} #{ARGV.first}"
+    exec vim_command
+  end
+end
 
-exec vim_command

data/lib/soywiki.vim

@@ -2,15 +2,16 @@
 " Maintainer:	Daniel Choi <dhchoi@gmail.com>
 " License: MIT License (c) 2011 Daniel Choi
 
-" this matched namedspaced WikiWords, top-level WikiWords, and relative .WikiWords in a
-" namespace
-let s:wiki_link_pattern =  '\C\<\([a-z]\+\.\)\?[A-Z][a-z]\+[A-Z]\w*\>\|\.[A-Z][a-z]\+[A-Z]\w*\>'
+" This regex matches namedspaced WikiWords, top-level WikiWords, and relative
+" .WikiWords in a namespace
+let s:wiki_link_pattern =  '\C\<\([a-z][[:alnum:]_]\+\.\)\?[A-Z][a-z]\+[A-Z]\w*\>\|\.[A-Z][a-z]\+[A-Z]\w*\>'
 
 let s:rename_links_command = 'soywiki-rename '
 let s:find_pages_linking_in_command = 'soywiki-pages-linking-in '
+let s:expand_command = 'soywiki-expand '
+let s:ls_command = 'soywiki-ls-t '
 let s:search_for_link = ""
 
-
 func! s:trimString(string)
   let string = substitute(a:string, '\s\+$', '', '')
   return substitute(string, '^\s\+', '', '')
@@ -34,12 +35,25 @@ func! s:title_without_namespace(page_title)
   endif
 endfunc
 
+func! s:namespace_of_title(page_title)
+  if len(split(a:page_title, '\.')) == 2
+    return get(split(a:page_title, '\.'), 0)
+  else
+    ""
+  endif
+endfunc
+
+
 func! s:is_wiki_page()
-  let title_line = getline(1)
-  return (match(title_line, s:wiki_link_pattern) == 0)
+  return (match(getline(1), s:wiki_link_pattern) == 0)
 endfunc
-func! s:save_page()
-"  write
+
+func! s:page_title2file(page)
+  return substitute(a:page, '\.', '/', 'g')
+endfunc
+
+func! s:filename2pagetitle(page)
+  return substitute(a:page, '/', '.', 'g')
 endfunc
 
 func! s:list_pages()
@@ -50,13 +64,13 @@ endfunc
 
 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:]]*$', '', '')
-  " see if he have a namespaced link
+  " see if we have a link relative to the namespace
   if (match(link, '^\.')) == 0
     " find the namespace from the page title
-    let link = s:page_namespace() . link
+    let link = s:page_namespace() . link " this link already has a period at the beginning
   endif
-
   let link = substitute(link, '^[^\.[:alnum:]]', '', '') " link may begin with period
   return link
 endfunc
@@ -89,23 +103,40 @@ func! s:find_next_wiki_link(backward)
 endfunc
 
 func! s:load_page(page, split)
-  let page = a:page
   if (s:is_wiki_page())
     write
   endif
-  if (!filereadable(page)) 
+
+  let file = s:page_title2file(a:page)
+
+  if (!filereadable(file)) 
     " create the file
-    call writefile([a:page, '', ''], page) 
+    let namespace = s:namespace_of_title(a:page)
+    if len(namespace) > 0
+      call system("mkdir -p " . namespace)
+    endif
+    call writefile([a:page, '', ''], file) 
   endif
   if (a:split == 2) 
-    exec "vsplit ". page
+    exec "vsplit ". file
   else
-    exec "split ". page
+    exec "split ". file
   endif
   if (a:split == 0) 
     wincmd p 
     close
   endif
+  
+  if len(s:search_for_link) > 0 
+    let res =  search(s:search_for_link, 'cw')
+    let s:search_for_link = ''
+  endif
+endfunc
+
+func! s:load_most_recently_modified_page()
+  let pages = split(system(s:ls_command), "\n")
+  let start_page = len(pages) > 0 ? get(pages, 0) : "HomePage" 
+  call s:load_page(start_page, 0)
 endfunc
 
 func! s:delete_page()
@@ -114,12 +145,12 @@ func! s:delete_page()
   call delete(file)
   call system("git commit " . bufname('%') . " -m 'deletion'")
   " go to most recently saved
-  " call feedkeys("\<C-o>")
-  let target = s:trimString(system("ls -t | head -1"))
+  let target = s:trimString(system(s:ls_command . " | head -1"))
   exec "e " . target
   exec "bdelete " . bufnr
   redraw
   echom  "Deleted " . file
+  call s:load_most_recently_modified_page()
 endfunc
 
 func! s:prompt_for_wiki_word(prompt, default)
@@ -131,29 +162,34 @@ func! s:prompt_for_wiki_word(prompt, default)
 endfunc
 
 func! s:rename_page()
-  let file = bufname('%')
-  let newname = s:prompt_for_wiki_word("Rename file: ", l:file)
-  if (filereadable(newname)) 
-    exe "echom '" . newname . " already exists!'"
+  let oldfile = bufname('%')
+  let newfile = s:page_title2file( s:prompt_for_wiki_word("Rename oldfile: ", l:oldfile) )
+  if (oldfile == newfile)
+    echo "Canceled"
+    return
+  endif
+  if (filereadable(newfile)) 
+    exe "echom '" . newfile . " already exists!'"
     return
   endif
-  call system("git mv " . l:file . " " .  newname)
-  exec "e ". newname
+  call system("git mv " . l:oldfile . " " .  newfile)
+  exec "e ". newfile
   " replace all existing inbound links  
   " TODO replace this with a ruby script
-  call system(s:rename_links_command . file . " " . newname)
+  exec "! " . s:rename_links_command . oldfile . " " . newfile
   call system("git commit -am 'rename wiki page'")
   e!
 endfunc
 
 func! s:create_page()
-  let newname = s:prompt_for_wiki_word("New page title: ", "")
-  if (filereadable(newname)) 
-    exe "echom '" . newname . " already exists!'"
+  let title = s:prompt_for_wiki_word("New page title: ", "") 
+  let newfile = s:page_title2file(title)
+  if (filereadable(newfile)) 
+    exe "echom '" . newfile . " already exists!'"
     return
   endif
-  call writefile([newname, '', ''], newname)
-  exec "e ". newname
+  call writefile([s:filename2pagetitle(title), '', ''], newfile)
+  exec "e ". newfile
 endfunc
 
 func! s:save_revision()
@@ -171,7 +207,7 @@ func! s:show_revision_history(stat)
 endfunc
 
 func! s:show_blame()
-  exec ":!git blame " . bufname('%')
+  exec ":! git blame --date=relative " . bufname('%')
 endfunc
 
 
@@ -180,9 +216,9 @@ endfunc
 
 func! s:get_page_list()
   if len(bufname('%')) == 0
-    let s:page_list = split(system("ls -t"), "\n")
+    let s:page_list = split(system(s:ls_command), "\n")
   else
-    let s:page_list = split(system("ls -t | grep -vF '" . bufname('%') . "'" ), "\n")
+    let s:page_list = split(system(s:ls_command . " | grep -vF '" . bufname('%') . "'" ), "\n")
   endif
 endfunction
 
@@ -216,6 +252,8 @@ func! s:reduce_matches()
 endfunc
 
 function! s:page_list_window(complete_function, prompt)
+  " remember the original window 
+  let s:return_to_winnr = winnr()
   topleft split page-list-buffer
   setlocal buftype=nofile
   setlocal noswapfile
@@ -224,6 +262,7 @@ function! s:page_list_window(complete_function, prompt)
   inoremap <silent> <buffer> <cr> <Esc>:call <SID>select_page()<CR> 
   inoremap <buffer> <Tab> <Esc>:call <SID>reduce_matches()<cr>
   noremap <buffer> q <Esc>:close<cr>
+  inoremap <buffer> <Esc> <Esc>:close<cr>
   exec "setlocal completefunc=" . a:complete_function
   " c-p clears the line
   call setline(1, a:prompt)
@@ -292,6 +331,7 @@ endfun
 function! s:select_page()
   let page = s:trimString( get(split(getline(line('.')), ": "), 1) )
   close
+  exe s:return_to_winnr . "wincmd w"
   if (page == '0' || page == '') " no selection
     return
   end
@@ -299,14 +339,9 @@ function! s:select_page()
 	for item in s:matching_pages
 	  if (item == page)
       call s:load_page(page, 0)
-
       break
     end
 	endfor
-  echo s:search_for_link 
-  if len(s:search_for_link) > 0 
-    call search('\<' . s:search_for_link . '\>')
-  endif
 endfunction
 
 "------------------------------------------------------------------------
@@ -319,11 +354,7 @@ func! s:list_pages_linking_in()
   let s:pages_linking_in  = split(system(s:find_pages_linking_in_command . s:page_title()), "\n")
   let s:search_for_link = s:title_without_namespace( s:page_title())
   if len(s:pages_linking_in) == 1
-    let file =  get(s:pages_linking_in, 0)
-    write
-    exec "e " . file
-    " not perfectly targeted but OK for now
-    call search(s:search_for_link)
+    call s:load_page(get(s:pages_linking_in, 0), 0)
   elseif len(s:pages_linking_in) == 0
     echom "No pages link to " . s:page_title() . "!"
   else
@@ -358,17 +389,101 @@ function! CompletePagesLinkingIn_InSelectionWindow(findstart, base)
   endif
 endfun
 
+"------------------------------------------------------------------------
+" This appends the selected text (use visual-mode) to the page selected
+" in the page selection window.
+func! s:extract(...) range
+  if a:0 != 3
+    return s:error("Incorrect number of arguments")
+  endif
+
+  let first = a:firstline
+  let last = a:lastline
+  let file = a:1
+
+  if match(file, s:wiki_link_pattern) == -1
+    echom "Target page must be a WikiWord!"
+    return
+  endif
+
+  let mode = a:2 " append or insert
+  let link = a:3 " replace with link ?
+  let range = first.",".last
+  silent exe range."yank"
+  if link
+    let replacement = s:filename2pagetitle(file)
+    silent exe "norm! :".first.",".last."change\<CR>".replacement."\<CR>.\<CR>"
+  else
+    " this one just deletes the line
+    silent exe "norm! :".first.",".last."change\<CR>.\<CR>"     
+  endif
+  if bufnr(file) == -1 || bufwinnr(bufnr(file)) == -1
+    if !filereadable(file)
+      " create the file
+      let page_title = s:filename2pagetitle(file)
+      let namespace = s:namespace_of_title(page_title)
+      if len(namespace) > 0
+        call system("mkdir -p " . namespace)
+      endif
+      call writefile([page_title, '', ''], file) 
+    endif
+    exec "split ".file
+  else
+    let targetWindow = bufwinnr(bufnr(file))
+    exe targetWindow."wincmd w"
+  end
+  if mode == 'append'
+    normal G
+    silent put
+    silent put= ''
+  elseif mode == 'insert'
+    call cursor(2, 0)
+    silent put
+  end
+  write!
+endfunc
+
+
+func! s:error(str)
+  echohl ErrorMsg
+  echomsg a:str
+  echohl None
+endfunction
+
+func! s:insert_divider()
+  let divider = '------------------------------------------------------------------------'
+  silent put! =divider
+  silent put=''
+endfunc
+"------------------------------------------------------------------------
+" SEARCH
+func! s:wiki_search(pattern)
+
+  let pattern = (empty(a:pattern)  ? @/ : a:pattern)
+  execute printf('vimgrep/%s/ %s', pattern, "**/*")
+endfunc
+
 "------------------------------------------------------------------------
 " This opens a new buffer with all the lines with just WikiLinks on them
 " expanded (recursively). This is not a wiki buffer but a text buffer
 
-func! s:unfurl()
-  let res = system("soywiki-unfurl " . bufname('%'))
+func! s:expand(seamless)
+  if a:seamless == 1
+    " seamful, the default
+    echom "Expanding seamfully. Please wait."
+    let res = system(s:expand_command . " seamless " . bufname('%'))
+  else " seamless
+    echom "Expanding seamlessly. Please wait."
+    let res = system(s:expand_command . " seamful " . bufname('%'))
+  endif
   vertical botright new 
   setlocal buftype=nofile "scratch buffer for viewing; user can write
-  put =res
-  1delete
-  normal 1G
+  silent! put =res
+  silent! 1delete
+  silent! normal 1G
+  redraw
+  echom "Expanded " . (a:seamless == 0 ? 'seamfully' : 'seamlessly') . "."
+
 endfunc
 
 "------------------------------------------------------------------------
@@ -388,6 +503,13 @@ func! s:global_mappings()
   noremap <leader>m :call <SID>list_pages()<CR>
   noremap  <leader>M :call <SID>list_pages_linking_in()<CR>
   noremap <silent> <leader>o :call <SID>open_href()<cr> 
+
+  command! -bar -nargs=1 -range -complete=file SWAppend :<line1>,<line2>call s:extract(<f-args>, 'append', 0)
+  command! -bar -nargs=1 -range -complete=file SWInsert :<line1>,<line2>call s:extract(<f-args>, 'insert', 0)
+  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>)
 endfunc 
 
 " this checks if the buffer is a SoyWiki file (from firstline)
@@ -399,16 +521,27 @@ func! s:prep_buffer()
     nnoremap <buffer> - :call <SID>follow_link_under_cursor(1)<cr> 
     nnoremap <buffer> \| :call <SID>follow_link_under_cursor(2)<cr> 
     noremap <buffer> <leader>f :call <SID>follow_link(0)<CR>
-    noremap <buffer> <leader>n :call <SID>find_next_wiki_link(0)<CR>
-    noremap <buffer> <leader>p :call <SID>find_next_wiki_link(1)<CR>
+    noremap <buffer> <c-n> :call <SID>find_next_wiki_link(0)<CR>
+    noremap <buffer> <c-p> :call <SID>find_next_wiki_link(1)<CR>
+
     noremap  <leader>c :call <SID>create_page()<CR>
-    command! -buffer SWDelete :call s:delete_page()
     command! -buffer SWRename :call s:rename_page()
+
+    noremap <buffer> <leader>r :call <SID>rename_page()<CR>
+    command! -buffer SWDelete :call s:delete_page()
+    noremap <buffer> <leader># :call <SID>delete_page()<CR>
+
     command! -buffer SWLog :call s:show_revision_history(0)
     noremap <buffer> <leader>l :call <SID>show_revision_history(0)<CR>
     command! -buffer SWLogStat :call s:show_revision_history(1)
     command! -buffer SWBlame :call s:show_blame()
-    noremap <buffer> <leader>x :call <SID>unfurl()<CR>
+    noremap <buffer> <leader>b :call <SID>show_blame()<CR>
+
+
+
+    noremap <buffer> <leader>x :call <SID>expand(0)<CR>
+    noremap <buffer> <leader>X :call <SID>expand(1)<CR>
+
     set nu
     setlocal completefunc=CompletePage
     augroup <buffer>
@@ -428,14 +561,9 @@ endfunc
 
 call s:global_mappings()
 
-autocmd  WinEnter * call s:highlight_wikiwords() 
+autocmd  BufReadPost,BufNewFile,WinEnter * call s:highlight_wikiwords() 
 autocmd  BufEnter * call s:prep_buffer() 
 
-" load most recent page
-let pages = split(system("ls -t" ), "\n")
-let start_page = len(pages) > 0 ? get(pages, 0) : "HomePage" 
-call s:load_page(start_page, 0)
-
 if (!isdirectory(".git"))
   call system("git init")
   echom "Created .git repository to store revisions"
@@ -453,3 +581,12 @@ if !exists("g:SoyWiki#browser_command")
   endif
 endif
 
+if len(bufname("%")) == 0
+  call s:load_most_recently_modified_page()
+else
+  call s:load_page(bufname("%"), 0)
+endif
+
+call s:get_page_list()
+syntax on
+let mapleader = ','

data/soywiki.gemspec

@@ -1,9 +1,10 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 
+require 'soywiki'
 Gem::Specification.new do |s|
   s.name        = "soywiki"
-  s.version     = "0.0.1"
+  s.version     = Soywiki::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Daniel Choi"]
   s.email       = ["dhchoi@gmail.com"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Daniel Choi
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-07 00:00:00 -05:00
+date: 2011-02-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,9 +35,10 @@ email:
 - dhchoi@gmail.com
 executables: 
 - soywiki
+- soywiki-expand
+- soywiki-ls-t
 - soywiki-pages-linking-in
 - soywiki-rename
-- soywiki-unfurl
 extensions: []
 
 extra_rdoc_files: []
@@ -46,12 +47,14 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
-- README.md
+- MIT-LICENSE.txt
+- README.markdown
 - Rakefile
 - bin/soywiki
+- bin/soywiki-expand
+- bin/soywiki-ls-t
 - bin/soywiki-pages-linking-in
 - bin/soywiki-rename
-- bin/soywiki-unfurl
 - lib/soywiki.rb
 - lib/soywiki.vim
 - soywiki.gemspec

data/README.md

@@ -1,3 +0,0 @@
-# SoyWiki
-
-readme goes here

data/bin/soywiki-unfurl

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-
-# takes any wiki link that stands alone on a line and expands it
-#
-WIKI_LINK_PATTERN =  /^\s*(([a-z]+\.)?[A-Z][a-z]+[A-Z]\w*|\.[A-Z][a-z]+[A-Z]\w*)\s*$/
-
-PROCESSED_FILES = []
-def unfurl(file)
-  PROCESSED_FILES << file
-  lines = File.readlines(file)
-  lines.shift 2
-  lines = lines.join.strip.split("\n")
-  lines.each do |line|
-    if line =~ WIKI_LINK_PATTERN 
-      link = line.strip
-      if link =~ /^\./ # short link in namespace (relative link)
-        namespace = file.split(".")[0]
-        link = [namespace, link].join
-      end
-      if File.file?(link) && !PROCESSED_FILES.include?(link) 
-        unfurl link # recursive
-      elsif PROCESSED_FILES.include?(link) 
-        puts "#{link} [already expanded]"
-      else
-        puts "#{link} [no file found]"
-      end
-    else
-      puts line
-    end
-  end
-end
-
-ARGV.each do |file|
-  unfurl(file)
-end
-