xiki 0.6.4 → 0.6.5

data/etc/command/copy_xiki_command_to.rb

@@ -1,6 +1,17 @@
-dest = ARGV[0]
+#
+# Used to "install" the 'xiki' shell command (copy it to
+# /usr/local/bin/) when installing Xiki manually from source
+# rather than as a gem.
+#
+dest = ARGV[0] || "/usr/local/bin/xiki"
 puts "Putting the 'xiki' shell command at:
-  #{dest}"
+
+  #{dest}
+
+You can pass a different path if you prefer...
+
+  $ xiki /bin/xiki
+"
 
 source = "etc/command/xiki_wrapper"
 
@@ -12,3 +23,5 @@ txt = File.read source
 txt.sub! /\(xiki_dir\)/, xiki_dir
 
 File.open(dest, "w", 0755) { |f| f << txt }
+
+puts "Finished."

data/etc/install/el4r_setup.sh

@@ -1,4 +1,4 @@
-cd `dirname \`gem contents trogdoro-el4r | grep setup.rb\``
+cd `dirname \`gem contents --prefix trogdoro-el4r | grep setup.rb\``
 ruby setup.rb
 cd bin/
 ruby -S el4r-rctool -p

data/lib/xiki.rb

@@ -258,7 +258,7 @@ class Xiki
 
       txt = File.read path
       return "- all/\n" + txt.scan(/^ *describe .*"(.+)"/).map{|o|
-        "- #{o}/"
+        "- #{o.first}/"
       }.join("\n")
     end
 

data/lib/xiki/console.rb

@@ -349,7 +349,7 @@ class Console
         return Remote.command path
       end
       if FileTree.handles?(path)
-        while(path.last =~ /^\$/) do   # Remove all !foo lines from path
+        while(path.last =~ /^\$ /) do   # Remove all $ foo lines from path
           path.pop
         end
         dir = path.join('')
@@ -357,6 +357,8 @@ class Console
         # If starts with ./, replace with current dir
         dir.sub! /^\.\//, "#{View.dir}/"
 
+        dir = Bookmarks[dir]
+
       end
       View.to orig
     end
@@ -364,7 +366,7 @@ class Console
     dir ||= $1 unless $1.empty?
     command = $2
 
-    return Tree.<<("- Directory doesn't exist) #{dir}") if dir && ! File.exists?(dir)
+    return Tree.<<("- Directory doesn't exist) #{dir}", :no_slash=>1) if dir && ! File.exists?(dir)
 
     if options[:sync]
       output = Console.run command, :dir=>dir, :sync=>true

data/lib/xiki/files.rb

@@ -266,6 +266,8 @@ class Files
 
     file ||= FileTree.tree_path_or_this_file
 
+    file = File.expand_path file
+
     # Else, reveal current file
     command = "open --reveal \"#{file}\""
     $el.shell_command(command)

data/lib/xiki/launcher.rb

@@ -210,7 +210,7 @@ class Launcher
 
     if line =~ /^ *@$/
       matches = Launcher.menu_keys
-      Tree.<< matches.sort.map{|o| "<< #{o.sub '_', ' '}/"}.join("\n"), :no_slash=>1
+      Tree.<< matches.sort.map{|o| "<< #{o.gsub '_', ' '}/"}.join("\n"), :no_slash=>1
       return
     end
 
@@ -323,7 +323,7 @@ class Launcher
 
         Line.sub! /\b$/, "..."
 
-        View.under matches.sort.map{|o| "<< #{o.sub '_', ' '}/"}.join("\n")
+        View.under matches.sort.map{|o| "<< #{o.gsub '_', ' '}/"}.join("\n")
         return
       end
     end
@@ -1086,7 +1086,9 @@ class Launcher
 
     # TODO: make generic
     # TODO: load all the adapters and construct the "rb|js" part of the regex
-    match = path.match(/(.+\/)(\w+)\.(rb|js|coffee|py|notes|menu|haml)\/(.*)/)
+
+    # Don't match if it's quoted (after a pipe)
+    match = path.match(/^([^|]+\/)(\w+)\.(rb|js|coffee|py|notes|menu|haml)\/(.*)/)
     if match
       dir, file, extension, path = match[1..4]
       # TODO: instead, call Launcher.invoke JsAdapter(dir, path), path
@@ -1095,7 +1097,7 @@ class Launcher
     end
 
     # For matches to filename instead of extensions?
-    match = path.match(/(.+\/)(Rakefile)\/(.*)/)
+    match = path.match(/^([^|]+\/)(Rakefile)\/(.*)/)
     if match
       dir, file, path = match[1..4]
       # TODO: instead, call Launcher.invoke JsAdapter(dir, path), path

data/lib/xiki/menu.rb

@@ -13,6 +13,7 @@ class Menu
       - gem/
     - .setup/
       - @~/menu/
+      - @$x/menu/
       - .reload_menus/
     - .api/
       > Summary
@@ -67,32 +68,23 @@ class Menu
       | If you want to create a very simple menu you can do so without code,
       | by just putting the menu in a file such as ~/menu/foo.menu. See:
       |
-      << docs/how_to_create/
+      << docs/creating/
     - .docs/
-      - .How to use/
-      - .How to create/
-      - .keys/
-        > Summary
-        | Helpful keyboard shortcuts when using menus.
-        |
-        | - as+menu
-        |   - Save changes to menu (or create new one)
-        | - to+menu
-        |   - Jump to file that implements menu
-        |
+      - .using/
+      - .creating/
     '
   end
 
   def self.install *args
     Xiki.dont_search
-    Tree.quote "
+      '
       > TODO
-      - implement this.
+      | implement this.
 
-      - Should it look for installed gems with this name?
-      - Should it just show commands to do a gem install?
-        - How would it know whether it the gem has a xiki menu?
-      "
+      - Look in gem dirs for installed gems with this name
+      - Google search for xiki menu on web
+        @google/"foo.menu"
+      '
   end
 
   def self.create *args
@@ -247,82 +239,184 @@ class Menu
     `
   end
 
-  def self.how_to_use *args
-    %`
-    > Summary
-    | How to use Xiki menus.  Note this refers to the wiki-style menus, not the menu bar.
-    |
-    | All menus can be used the same way.  Just type something and double-click
-    | on it (or type Ctrl-enter while the cursor is on the line).
-    |
-    - example/
-      | 1: type "foo" on a line (the "@" isn't necessary when the line isn't indented)
-      @ foo
-      |
-      | 2: double-click on it to drill in. You can try it on the line above. It will look like this:
-      @ foo/
-      |  - sammiches/
-      |  - dranks/
-      |
-      | 3: double-click to drill in further. It will look like this:
-      @ foo/
-      |  - sammiches/
-      |    - ham/
-      |    - tofu/
-      |  - dranks/
-      |
-    - using the mouse/
-      | You can click on the "bullets" (the - and + at the beginnings of lines)
-      | to expand and collapse.  You can also double-click to expand and
-      | collapse.
-      |
-    - search to narrow down/
-      | When you double-click a line the cursor turns blue and you can type
-      | letters to search and narrow down the list.
-      |
-    - misc keys/
-      | - Return: stops searching and launches (expands file or dir)
-      | - Tab: like return but hides others
-      | - ;: like return but collapses path
-      |
-      | - C-g: stops searching
+  def self.using *args
+    txt = %`
+      > Summary
+      | How to use Xiki menus.  Xiki menus are menus you type, not menu bar.
       |
-      | - Arrow keys: you can use them to go up and down and expand and collapse
+      | All xiki menus can be used the same way.  Just type something and
+      | double-click on it (or type Ctrl-enter while the cursor is on the line)
+      | to open the menu.
       |
-    `
+      - example/
+        | 1: Type "sammiches" on a line (the "@" isn't necessary when the line
+        |    isn't indented)
+        @sammiches
+        |
+        | 2: Double-click (or Ctrl-enter) on it to open it. You can try it on
+        |    the line above.  It will look like this:
+        | @sammiches/
+        |   + meat/
+        |   + veggie/
+        |   + checkout/
+        |
+        | 3: Double-click to open items. It will look like this:
+        | @sammiches/
+        |   + meat/
+        |   + veggie/
+        |     + cucumber/
+        |     + bark/
+        |   + checkout/
+        |
+      - mouse/
+        | You can click on the "bullets" (the - and + at the beginnings of lines)
+        | to expand and collapse.  You can also double-click to expand and
+        | collapse.
+        |
+      - keyboard/
+        | You can do everything with the keyboard that you can do with the mouse.
+        | Type Ctrl-enter while your cursor is on the same line as a menu or menu
+        | item to open it.  Or, if it already has things under it, it will collapse.
+        |
+        | Right after you open a menu, some keys you type have special meaning. This
+        | is the case whether you you used the mouse or keyboard to open the menu.
+        | The cursor turns into a block to indicate this.
+        |
+        | Special keys right after opening:
+        - search to narrow down/
+          | If you type numbers and letters, it incrementally narrows down the list.
+        - opening/
+          | Return - opens menu item cursor is on
+          | Tab - opens, hiding the other items at that level
+          | Ctrl-/ - opens, moving the item onto the same line as its parent
+          | Ctrl-1, Ctrl-2, Ctr-3, etc. - opens the nth item
+          | Ctrl-G: stops searching
+          |
+      `
+
+    Tree.children txt, args
   end
 
-  def self.how_to_create *args
+  def self.creating *args
     txt = %q`
       > Summary
-      | How to make your own menus in Xiki.  Note this refers to wiki-style
-      | menus (such as this one), not the menu bar.
+      | How to make your own Xiki menus.  This is strongly encouraged!  Make
+      | a bunch of menus for all the various things you do, if you're so
+      | inclined.  You can make menus for from simple notes, to powerful
+      | CRUD interfaces etc. for controlling external tools.
       |
+      - Pretend they exist/
+        | The easiest way to create new menus is to type them and open them as
+        | though they exist.  Xiki will then guide you through turning them
+        | into actual menus.
+        |
+        | The simplest option is the first one it shows you.  You can just type
+        | menu items inline to create the menu.  For example, you could type
+        | this:
+        |
+        | milkshakes/
+        |   - chocolate/
+        |   - vanilla/
+        |
+        | And then with your cursor on one of these lines you could type
+        | Ctrl-a Ctrl-m (for "as menu") to turn it into an actual menu.  Then,
+        | the next time you type "milkshakes" and open it, it would show the
+        | menu items.  For this menu to be useful, you'll probably want to add
+        | more items underneath them, or open the items to be prompted to
+        | create a ruby class to run when they're opened in the future.
+        |
+      - Screencasts/
+        | Check out these two points in one of the xiki screencast to see
+        | creating menus in action:
+        |
+        @http://www.youtube.com/watch?v=bUR_eUVcABg#t=1m30s
+        @http://www.youtube.com/watch?v=bUR_eUVcABg#t=1m57s
+        |
       - Creating .menu files/
-        | You can make menus without code, by just put "whatever.menu" files in the
-        | "menu/" dir in your home dir.
+        | You can make menus without code, by just putting "whatever.menu" files
+        | in the "menu" dir in your home dir.
+        |
+        | For example you could create a "drinks.menu" file, like the following.
+        | (The "|" characters aren't actually in the file).
+        |
+        | ~/menu/
+        |   - drinks.menu
+        |     | - fruit/
+        |     |   - lemonade/
+        |     |   - smoothie/
+        |     | - caffeinated/
+        |     |   - coffee/
+        |     |   - tea/
         |
-        | For example you could create a "foo.menu" file with the contents
-        | "- sammiches/..." etc:
+        | Then when you type drinks on a line and open it, it will look like
+        | this:
         |
-        - TODO: get these to expand out somehow! - maybe pass another arg to Tree.children below? - probably bad idea
-        - ~/menu/
-          - foo.menu
-            | - sammiches/
-            |   - ham/
-            |   - tofu/
-            | - dranks/
-            |   - foty/
+        | drinks/
+        |   + fruit/
+        |   + caffeinated/
         |
       - Delegating/
-        | This makes a foo/ menu that you can expand.  Even though these menus
-        | don't run code themselves, they can delegate to other menus or run code,
-        | like:
+        | You can make simple menus that delegate to other things, using the
+        | "@" character.  For example:
+        |
+        | ~/menu/
+        |   - foo.menu
+        |     | - @other menu/
+        |     | - @MyClass.my_method
+        |     | @$ shell command
+        |
+      - Wiki elements/
+        | You can put wiki elements in menus, like headings, paragraphs and
+        | bullet points.  Thus you can make a menu just to store notes:
+        |
+        | shopping list/
+        |   > Grocery
+        |   - Eggs
+        |   - Vodka
+        |
+        |   > Pet store
+        |   Not sure yet.  Maybe just a bunch of snakes.
+        |
+      - Creating .rb files/
+        | Create ruby files in ~/menu/ to make dynamic menus.  The .menu class
+        | method will be invoked.  Example:
+        |
+        | ~/menu/
+        |   - pie.rb
+        |     | class Pie
+        |     |   def self.menu *args
+        |     |     "
+        |     |     - fruit/
+        |     |       - apple/
+        |     |       - pumpkin/
+        |     |     - nuts/
+        |     |     "
+        |     |   end
+        |     | end
+        |
+        | To make a menu run a method, put a dot in front of it:
+        |
+        | ~/menu/
+        |   - pie.rb
+        |     | class Pie
+        |     |   def self.menu *args
+        |     |     "
+        |     |     - fruit/
+        |     |       - apple/
+        |     |       - pumpkin/
+        |     |     - .nuts/
+        |     |     "
+        |     |   end
+        |     |   def self.nuts *args
+        |     |     # Put any code here.  The string you return will be inserted
+        |     |     # into the tree.
+        |     |     "- pecan/\n- pecan/"
+        |     |   end
+        |     | end
+        |
         |
-        - ~/menu/
-          - foo.menu
-            | - @mymenu/
-            | - @MyClass.my_method
+        > For more info, see:
+        @menu/api/
         |
       `
 
@@ -579,8 +673,8 @@ Ol << "location: #{location.inspect}"
     return if orig == View.line
 
     # If it inserted something
-    output = Tree.siblings :everything=>1
-    # output = Tree.siblings :cross_blank_lines=>1, :everything=>1
+    # output = Tree.siblings :everything=>1
+    output = Tree.siblings :cross_blank_lines=>1, :everything=>1
 
     # Shouldn't this be looping like self.collapser_launcher ?
     Tree.to_parent

data/lib/xiki/search.rb

@@ -1112,7 +1112,7 @@ class Search
 
     char = Keys.input(:chars=>1, :prompt=>"Enter one char: ")
     if char == "m"
-      Launcher.open("- #{Xiki.dir}/\n  - ##\\bdef /")
+      Launcher.open("- #{Xiki.dir}\n  - ##\\bdef /")
     elsif char == "k"
       Launcher.open("- $x/key_bindings.rb\n  - ##\\bKeys\\./")
     elsif char == "l"

data/lib/xiki/tree.rb

@@ -1024,6 +1024,12 @@ class Tree
     siblings
   end
 
+  #
+  # Gets position before and after sibling bounds.
+  #
+  # Tree.sibling_bounds   # Returns: start, current line start, current line end, end
+  # Tree.sibling_bounds :cross_blank_lines=>1   # Returns: top, bottom
+  #
   def self.sibling_bounds options={}
     if options[:cross_blank_lines]   # If :cross_blank_lines, just jump to parent, then use .after_children
       orig = Location.new
@@ -1108,7 +1114,7 @@ class Tree
         last_indent = line_indent
         line_indent = tree[i+1]   # Use indent of following line
         line_indent = line_indent ? (line_indent[/^ */].length / 2) : 0
-        raise "Blank lines in trees between parents and children aren't allowed." if line_indent > 0 && line_indent > last_indent
+        raise "Blank lines in trees between parents and children aren't allowed.  Also 2 consecutive blank lines isn't allowed." if line_indent > 0 && line_indent > last_indent
       else
         line_indent = line[/^ */].length / 2
         line.strip!
@@ -1466,6 +1472,10 @@ class Tree
   # Tree.children "a\n  b\n  c", "a"
   #
   def self.children tree=nil, target=nil, options={}
+
+    # Read in file, if tree looks like a file path
+    tree = File.read(File.expand_path tree) if tree !~ /\n/ && tree =~ /^~/
+
     include_subitems = options[:include_subitems]   # Include sub-items for all children
 
     return self.children_at_cursor(tree) if tree.nil? || tree.is_a?(Hash)   # tree is actually options