soywiki 0.2.2 → 0.2.3

data/.gitignore

@@ -9,3 +9,4 @@ notes.txt
 *buffer
 wiki/
 soywiki.html
+wiki2/

data/Gemfile

@@ -1,4 +1,2 @@
 source :rubygems
-gem "couchrest"
-gem "sinatra"
 gem "haml"

data/Gemfile.lock

@@ -1,25 +1,10 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    couchrest (1.0.1)
-      json (>= 1.4.6)
-      mime-types (>= 1.15)
-      rest-client (>= 1.5.1)
     haml (3.0.25)
-    json (1.5.1)
-    mime-types (1.16)
-    rack (1.2.1)
-    rest-client (1.6.1)
-      mime-types (>= 1.16)
-    sinatra (1.1.2)
-      rack (~> 1.1)
-      tilt (~> 1.2)
-    tilt (1.2.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  couchrest
   haml
-  sinatra

data/README.markdown

@@ -1,7 +1,8 @@
 # SoyWiki
 
-SoyWiki is lightweight application that turns Vim into a fast and
-powerful wiki. 
+SoyWiki turns Vim into a powerful, lean, and fast wiki.  It's got all
+the protein of a more conventional wiki, but a lot less of the fat and
+cholesterol. 
 
 A quick overview of its characteristics and features:
 
@@ -124,7 +125,7 @@ You can get very far with SoyWiki using normal CamelCase WikiWords.
 
 But if you want, you can also namespace your WikiWords, like so:
 
-    namespaced.WikiWord
+    namespace.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
@@ -145,8 +146,8 @@ 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`.
+When you start SoyWiki for the first time, the active namespace is the
+default namespace `main`. 
 
 
 ## Wiki navigation 
@@ -157,7 +158,7 @@ commands:
 * `CTRL-k` and `CTRL-j` move the cursor directly to the next or previous WikiLink on the page
 * `ENTER` follows the WikiLink under the cursor
 * `,f` follows the first WikiLink after the cursor
-* `CTRL-l` opens a WikiLink in a vertical split window; press again
+* `CTRL-l` opens a WikiLink in a vertical split window; press `CTRL-l` again
 while the cursor is on the top line to close the new window 
 * `CTRL-h` does the same, but in a regular split window
 * `q` closes a split window 
@@ -260,21 +261,24 @@ same wiki page.
 ## Search
 
 * `:SWSearch` [term]
-* `:SWNamespacedSearch` [term]
+* `:SWNamespaceSearch` [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. 
+These commands search your SoyWiki wiki. `:SWNamespaceSearch` confines
+your search to the current namespace.
+
+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:
 
     :SWSearch Gnu
-    :SWNamespacedSearch Gnu
+    :SWNamespaceSearch Gnu
 
 You can use `:SWS` as a shortcut for `:SWSearch`. You can also
-tab-complete `:SWNS` to `:SWSNamespacedSearch`.
+tab-complete `:SWNS` to `:SWSNamespaceSearch`.
 
 Searches are case-insensitve.  
 
@@ -354,6 +358,12 @@ recursive, you can effectively nest outlines within outlines, like
 dreams within dreams.  
 
 
+## Exporting to HTML
+
+Want to share your wiki with non-Vim-users?  Export your wiki into a directory
+of html pages, type `soywiki --html` from the root directory of your wiki.
+
+
 ## Extra macros
 
 SoyWiki adds a few convenient Vim macros that you can use anytime. 
@@ -387,13 +397,6 @@ 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
 

data/Rakefile

@@ -32,10 +32,11 @@ desc "build and push website"
 task :web => :build_webpage do
   puts "Building and pushing website"
   `scp website/soywiki.html zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
+  `open http://danielchoi.com/software/soywiki.html`
 end
 
 desc "build website locally"
-task :weblocal => :build_webpage do
+task :build_web_locally => :build_webpage do
   Dir.chdir("website") do
     `open soywiki.html`
   end
@@ -51,6 +52,7 @@ task :build_webpage do
   end
 end
 
+
 desc "Run tests"
 task :test do 
   $:.unshift File.expand_path("test")

data/bin/soywiki-expand

@@ -13,10 +13,14 @@ PROCESSED_FILES = []
 def indent(text, level, mode)
   return text if mode == 'seamless'
   return text if level == 0
-  (':' * level) + ' ' +  text
+  ('|' * level) + ' ' +  text
 
 end
 
+def divider
+  puts '+' + '-' * 78 + '+'
+end
+
 def expand(file, mode, level=0)
   PROCESSED_FILES << file
   lines = File.readlines(file)
@@ -34,11 +38,11 @@ def expand(file, mode, level=0)
       end
       if File.file?(link.to_file_path) && !PROCESSED_FILES.include?(link.to_file_path) 
         if mode == 'seamful'
-          puts '.' * 10
+          divider
         end
         expand(link.to_file_path, mode, level + 1) # recursive call
         if mode == 'seamful'
-          puts '.' * 10
+          divider
         end
       elsif PROCESSED_FILES.include?(link) 
         puts indent("#{link} [[already expanded]]", level, mode)

data/lib/index_template.html.haml

@@ -0,0 +1,28 @@
+!!!
+%html
+  %head
+    :css
+      h3 { margin-top: 0 }
+      .sidebar { float:left; width: 20%; font-size: small }
+      .main { margin-left: 22%; width: 70% }
+      ul { list-style-type: none; margin-left: 0; padding-left: 0 }
+      .page-count { font-size: smaller; color: #CCC }
+  %body
+    .sidebar
+      %h3 Namespaces
+      %ul
+        - namespaces.each do |namespace, count|
+          %li
+            - if root 
+              %a{:href => "#{namespace}/index.html"}= namespace 
+            - else
+              %a{:href => "../#{namespace}/index.html"}= namespace 
+            %span.page-count
+              = count
+      - if ! root
+        %h3= namespace
+        %ul
+          - pages.each do |page|
+            %li
+              %a{:href => "#{page}.html"}= page
+

data/lib/page_template.html.haml

@@ -0,0 +1,27 @@
+!!!
+%html
+  %head
+    :css
+      h3 { margin-top: 0 }
+      .sidebar { float:left; width: 20%; font-size: small }
+      .main { margin-left: 22%; width: 70% }
+      ul { list-style-type: none; margin-left: 0; padding-left: 0 }
+      .page-count { font-size: smaller; color: #CCC }
+
+  %body
+    .sidebar
+      %h3 Namespaces
+      %ul
+        - namespaces.each do |namespace, count|
+          %li
+            %a{:href => "../#{namespace}/index.html"}= namespace 
+            %span.page-count
+              = count
+      %h3= namespace
+      %ul
+        - pages.each do |page|
+          %li
+            %a{:href => "#{page}.html"}= page
+    .main
+      %h2= title
+      %pre= body

data/lib/soywiki/html.rb

@@ -0,0 +1,104 @@
+require 'haml'
+module Soywiki
+  module Html
+
+    def self.href_wiki_links(text)
+      text = text.gsub(WIKI_WORD) {|match|
+        href = if match =~ /\w\./ # namespace
+          "../#{match.gsub(".", "/")}.html"
+        else
+          match + '.html'
+        end
+        %{<a href="#{href}">#{match}</a>}
+      }
+      return text
+    end
+
+    def self.href_hyperlinks(text)
+      text = text.gsub(HYPERLINK) {|match|
+        %{<a href="#{match}">#{match}</a>}
+      }
+      return text
+    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)
+      title = text.split("\n")[0]
+      body = process(text.split("\n")[1..-1].join("\n").strip)
+      Haml::Engine.new(PAGE_TEMPLATE).render(nil, :body => body, 
+                                             :title => title, 
+                                             :namespace => namespace,
+                                             :namespaces => namespaces, :pages => pages)
+    end
+
+
+    HTML_DIR = 'soywiki-html-export'
+    INDEX_PAGE_TEMPLATE = File.read(File.join(File.dirname(__FILE__), '..', 'index_template.html.haml'))
+
+    def self.wiki_page?(file)
+      file.gsub("/", '.') =~ WIKI_WORD
+    end
+
+    def self.make_index_page(dir, pages, namespaces)
+      outfile = File.join(HTML_DIR, dir, 'index.html')
+      html = Haml::Engine.new(INDEX_PAGE_TEMPLATE).render(nil, 
+                                             :namespace => dir, 
+                                             :root => false,
+                                             :pages => pages.map {|p| p.split('/')[1]}.sort, 
+                                             :namespaces => namespaces)
+      File.open(outfile, 'w') {|f| f.write html}
+      # puts "=> Writing #{outfile}"
+    end
+
+    def self.make_pages(dir, namespaces)
+      `mkdir -p #{HTML_DIR}/#{dir}`
+      pages = Dir["#{dir}/*"].select {|file| wiki_page? file} 
+      # make pages
+      pages.each do |file|
+        outfile =  File.join(HTML_DIR, file + '.html')
+        html = Soywiki::Html.generate_page(File.read(file), 
+                                           dir, 
+                                           pages.map {|p| p.split('/')[1]}.sort, 
+                                           namespaces)
+        File.open(outfile, 'w') {|f| f.write html}
+        # puts "Writing #{outfile}"
+      end
+      make_index_page(dir, pages, namespaces)
+    end
+
+    def self.make_root_index_page(namespaces)
+      outfile = File.join(HTML_DIR, 'index.html')
+      html = Haml::Engine.new(INDEX_PAGE_TEMPLATE).render(nil, 
+                                             :namespace => nil, 
+                                             :pages => [], 
+                                             :root => true,
+                                             :namespaces => namespaces)
+      File.open(outfile, 'w') {|f| f.write html}
+      # puts "=> Writing #{outfile}"
+    end
+
+    def self.export
+      `rm -rf #{HTML_DIR}/*`
+      namespaces = Dir["*"].select {|f| 
+        File.directory?(f) && f != HTML_DIR
+      }.map {|namespace|
+        count = Dir["#{namespace}/*"].select {|f| wiki_page?(f)}.size
+        [namespace, count]
+      }
+      namespaces.each do |namespace_dir, count|
+        make_pages namespace_dir, namespaces
+      end
+      # make root index page
+      make_root_index_page namespaces
+      puts "HTML files written to #{HTML_DIR}/"
+    end
+
+
+  end
+end
+

data/lib/soywiki.rb

@@ -1,8 +1,9 @@
 require 'string_ext'
 
 module Soywiki
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
   WIKI_WORD = /\b([a-z][\w_]+\.)?[A-Z][a-z]+[A-Z]\w*\b/
+  HYPERLINK = %r|\bhttps?://[^ >)\n\]]+|
 
   def self.run
     if %W( -v --version -h --help).include?(ARGV.first)
@@ -20,12 +21,23 @@ open the most recently modified wiki file.
 ---
 END
       exit
+    elsif ARGV.first == '--html'
+      self.html_export 
+      exit
+    else
+      vim = ENV['SOYWIKI_VIM'] || 'vim'
+      vimscript = File.expand_path("../soywiki.vim", __FILE__)
+      vim_command = "#{vim} -S #{vimscript} #{ARGV.first}"
+      exec vim_command
     end
+  end
 
-    vim = ENV['SOYWIKI_VIM'] || 'vim'
-    vimscript = File.expand_path("../soywiki.vim", __FILE__)
-    vim_command = "#{vim} -S #{vimscript} #{ARGV.first}"
-    exec vim_command
+  def self.html_export
+    require 'soywiki/html'
+    Html.export
   end
 end
 
+if __FILE__ == $0
+  Soywiki.run
+end

data/lib/soywiki.vim

@@ -4,8 +4,6 @@
 
 " This regex matches namedspaced WikiWords and unqualified WikiWords 
 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 '
 let s:find_pages_linking_in_command = 'soywiki-pages-linking-in '

data/soywiki.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'couchrest'
+  s.add_dependency 'haml'
 end

data/website/soywiki-template.html

@@ -47,7 +47,7 @@
             <div class="also-by">
               <h4>also by this developer</h4>
               <ul class="cross-promo">
-                <li><a href="http://vmail.com">vmail<a/></li>
+                <li><a href="http://danielchoi.com/software/vmail.html">vmail<a/></li>
                 <li><a href="http://instantwatcher.com">instantwatcher.com<a/></li>
                 <li><a href="http://openmbta.org">OpenMBTA<a/></li>
                 <li><a href="http://kindlefeeder.com">kindlefeeder.com<a/></li>

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Daniel Choi
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-12 00:00:00 -05:00
+date: 2011-02-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: couchrest
+  name: haml
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -55,8 +55,11 @@ files:
 - bin/soywiki-ls-t
 - bin/soywiki-pages-linking-in
 - bin/soywiki-rename
+- lib/index_template.html.haml
+- lib/page_template.html.haml
 - lib/soywiki.rb
 - lib/soywiki.vim
+- lib/soywiki/html.rb
 - lib/string_ext.rb
 - soywiki.gemspec
 - website/.gitignore