xiki 0.6.0 → 0.6.1

data/README.markdown

@@ -1,5 +1,8 @@
 # Summary
-This file shows how to install Xiki.  See http://xiki.org for a description of Xiki.
+
+This file shows how to install Xiki.  For a description of Xiki see:
+
+http://xiki.org
 
 # Install Xiki
 
@@ -13,33 +16,37 @@ Either install as a gem, or install from github.
 
       $ git clone git@github.com:trogdoro/xiki.git
       $ cd xiki
-      $ gem install bundler
-      $ bundle install --system
-      $ cp <xiki dir>/etc/command/xiki_wrapper /usr/local/bin/xiki
-      $ chmod 755 /usr/local/bin/xiki
+      $ sudo gem install bundler
+      $ sudo bundle install --system
+      $ sudo ruby etc/command/copy_xiki_command_to.rb /usr/local/bin/xiki
 
-If you don't have permission, to run some of the commands put "sudo" at the beginning of the command.
+You don't need "sudo" at the beginning if you're using rvm and your
+/usr/local/bin/ dir is writable.
 
 # Verify the 'xiki' shell command works
 
       $ xiki
 
-It should delay slightly the first time, but be fast subsequent times.  If you run into errors and then fix them, you'll want to run the "xiki restart" command.
+It should delay slightly the first time, but be fast subsequent
+times.  If you run into errors and then fix them, you'll want to
+run the "xiki restart" command.
 
 # Configure your editor to use Xiki
 
 ## Emacs
 
-If you're going to use Xiki with Emacs, do these steps:
+Emacs is the most supported editor.  Don't worry though, you don't
+have to know emacs to use it with Xiki.
 
 ### Step 1: Download Emacs
 
 #### On Mac:
+
 - Try Aquamacs if you're new to emacs (it's more mac-like)
-  - http://aquamacs.org/download-classic.shtml
-  - works well with rvm, because it loads .bash_login
+   - http://aquamacs.org/download-classic.shtml
+   - works well with rvm, because it loads .bash_login
 - Or
-  - http://emacsformacosx.com
+   - http://emacsformacosx.com
 
 #### On Linux:
 
@@ -52,33 +59,31 @@ We just patched el4r, so there's a chance Xiki might work in windows.
 - Skip the 'xiki' shell command step
 - Maybe try this emacs? http://ourcomments.org/Emacs/EmacsW32.html
 
-
 ### Step 2: EmacsRuby (el4r) setup
 
-      $ cd <xiki dir>
+      $ cd `xiki dir`
       $ sudo bash etc/install/el4r_setup.sh
 
 If you're using rvm, the sudo may not be necessary.
 
-If you're using the xiki gem, you can paste this for the above cd:
-
-      $ cd `dirname \`gem contents xiki | grep Gemfile\``
-
 ### Step 3: Require Xiki in EmacsRuby's config
 Sample configuration:
 
       ~/.el4r/init.rb:
-        $LOAD_PATH.unshift "<xiki dir>/lib"
+        $LOAD_PATH.unshift "(xiki dir)/lib"
         require 'xiki'
         Xiki.init
 
         KeyBindings.keys   # Use default key bindings
         Themes.use "Default"  # Use xiki theme
 
+Be sure to substitute '(xiki dir)' with the actual dir.  If you
+don't know it, run this command:
 
-Be sure to substitute "&lt;xiki dir&gt;" with the actual dir.
+      $ xiki dir
 
 ### If you get an error
+
 If you got partially through the load...
 
 - You may be able to use these keys to trouble-shoot:
@@ -86,31 +91,34 @@ If you got partially through the load...
    - Option+l to reload xiki and .emacs
       - also use this when you see "el4r-instance is dead"
 - If you can't use the keys, look at the log
-  - Named something like: /tmp/el4r......log
-  - Go to the end and search backward for the last error
-     - probably contains ":Error:"
-  - Restart emacs (or reload .emacs) manually to reload
+   - Named something like: /tmp/el4r......log
+   - Go to the end and search backward for the last error
+      - probably contains ":Error:"
+   - Restart emacs (or reload .emacs) manually to reload
 - See "Issues Loading Xiki" buffer (under "Window" menu bar menu)
 
-
 ## Vim
 
 Vim support is very partially implemented, but should be pretty
 straight-forward to implement.  It turns out vim is very easy to
 extend using ruby.  See this file to try it out:
 
-./etc/vim/vim_status.notes
+(xiki dir)/etc/vim/vim_status.notes
 
 ## CodeMirror
 
 There's a simple prototype working, though it's not committed yet.
 
 ## Other editors
-Are you in the bay area and savvy at extending your editor (vim, sublime, textmate, rubymine)?  Ping me on the google group and we'll get together and pair on making a Xiki extension for it.
 
+Are you in the bay area and savvy at extending your editor (vim,
+sublime, textmate, rubymine)?  Ping me on the google group and
+we'll get together and pair on making a Xiki extension for it.
 
 # Google group
-Join the google group for help with installing, or to chat about whatever or share your ideas:
 
-  http://groups.google.com/group/xiki
+Join the google group for help with installing, or to chat about
+whatever or share your ideas:
+
+http://groups.google.com/group/xiki
 

data/etc/command/copy_xiki_command_to.rb

@@ -0,0 +1,14 @@
+dest = ARGV[0]
+puts "Putting the 'xiki' shell command at:
+  #{dest}"
+
+source = "etc/command/xiki_wrapper"
+
+xiki_dir = Dir.pwd
+
+puts ""   # Blank line
+
+txt = File.read source
+txt.sub! /\(xiki_dir\)/, xiki_dir
+
+File.open(dest, "w", 0755) { |f| f << txt }

data/etc/command/xiki_command.rb

@@ -108,7 +108,7 @@ class XikiCommand
   def self.get_response
 
     # Simulate timeout error if process not running
-    process_running = `ps -e` =~ /xiki_process.rb/
+    process_running = `ps -ef` =~ /xiki_process.rb/
     if ! process_running
       raise Timeout::Error
     end
@@ -146,13 +146,17 @@ class XikiCommand
 
       > Setting up your editor
       The most common way to use Xiki is from a text editor.  For
-      example, typing "tables" on any blank line and double-clicking on
-      it (or typing control-enter or command-enter) to browse and update
-      your mysql database.
+      example, from in a text editor, typing "tables" on any blank line
+      and then double-clicking on it (or typing control-enter or
+      command-enter) to browse and update your mysql database.
 
-      See this file for help setting up your editor:
+      See the README.markdown file in the Xiki dir for help setting up
+      your editor. You can view it by typing this command or going to
+      this url:
 
-      $xiki/README.markdown
+      $ xiki readme
+
+      https://github.com/trogdoro/xiki
 
       > Service
       The 'xiki' shell command automatically runs a service in the
@@ -180,11 +184,10 @@ class XikiCommand
       http://twitter.com/xiki
 
       > Troubleshooting
-      Be sure to run this command to install required gems:
+      A couple commands to help you trouble-shoot:
 
       % bundle install
-
-      Also see $xiki/README.markdown
+      % xiki readme
 
       `.unindent
 
@@ -224,7 +227,9 @@ class XikiCommand
       case line
       when /^(>) (.+)/
         "#{self.heading_bracket $1} #{self.bold $2}"
-      when /^http:\/\/.+/
+      when /^(>>+) (.+)/
+        "#{self.heading_bracket $1} #{self.path $2}"
+      when /^ *https?:\/\/.+/
         "#{self.url $&}"
       when /^.+\/$/
         "#{self.path $&}"
@@ -251,7 +256,7 @@ class XikiCommand
     self.colorize txt, "1;31"   # Red # colorize("1;91")   # Red
   end
   def self.label txt
-    self.colorize txt, "1;33"   # Yellow
+    self.colorize txt, "1;90"   # Gray
   end
   def self.path txt
     colorize(txt, "1;90")

data/etc/command/xiki_wrapper

@@ -1,2 +1,2 @@
 #!/usr/bin/env ruby
-load "/projects/xiki/bin/xiki"
+load "(xiki_dir)/bin/xiki"

data/etc/www/sinatra_server.rb

@@ -1,5 +1,4 @@
 require 'sinatra'
-require "/projects/xiki/lib/xiki/ol.rb"
 
 set :port, 8161
 set :bind, '127.0.0.1'
@@ -286,14 +285,11 @@ def index menu
 
   #   rescue e=>Exception
   #     puts "<pre>#{e.message}\n#{e.backtrace}</pre>"
-  #     Ol << "e: #{e.message}"
-  #     Ol << "e: #{e.backtrace}"
   #     Ol << "If we get the permission problem, provide .notes file that will run command to run xiki command once (message explaining it first)!"
   #   end
 
   # TODO: return different string when the service is down
 
-  # Ol << "Extract to new method: suggest_creating!!"
   if txt.empty?
     menu = menu.sub /\/$/, ''
 

data/lib/xiki.rb

@@ -44,8 +44,8 @@ class Xiki
         | Double-click on these lines to add the executable 'xiki' command to
         | your path:
         |
-        @$ cp #{Xiki.dir}etc/command/xiki_wrapper /usr/local/bin/xiki
-        @$ chmod 755 /usr/local/bin/xiki
+        @#{Xiki.dir}/
+          $ ruby etc/command/copy_xiki_command_to.rb /usr/local/bin/xiki
         |
         | Then you can type 'xiki' on a command line outside of emacs as a
         | shortcut to opening xiki and opening menus, like so:

data/lib/xiki/launcher.rb

@@ -750,6 +750,9 @@ class Launcher
       View.to_nth orig
     else
       Move.to_window 1
+      if prefix.is_a? Fixnum
+        View.line = prefix
+      end
     end
 
     line = Line.value

data/menu/dimensions_config.menu

@@ -1,4 +1,5 @@
 - full/View.dimensions_full; Styles.font_size 110
+- half/width = 166; width += 3 if ! View.scroll_bars; View.dimensions_set width, 59, 0, 902; Styles.font_size 110; Window.visibility('full')
 - medium/Styles.font_size 160
 - small/View.dimensions_set 50, 15, 100, 22; Styles.font_size 110
 - tiny/20, 10, 40, 22

data/menu/dir.rb

@@ -0,0 +1,5 @@
+class Directory
+  def self.menu *args
+    Xiki.dir
+  end
+end

data/menu/itunes.rb

@@ -25,7 +25,6 @@ class Itunes
   @@use_pipe_delimiter = "set Applescript's text item delimiters to \"|\""
 
   def self.songs name=nil
-
     # If nothing passed, list all songs
     if name.nil?
       tracks = Applescript.run "iTunes", "get the name of every track of library playlist 1 as string", :delimiter=>"|"
@@ -35,7 +34,6 @@ class Itunes
     end
 
     Applescript.run "iTunes", "play track \"#{name}\""
-
   end
 
   def self.current
@@ -56,13 +54,13 @@ class Itunes
 
   def self.next
     Applescript.run "iTunes", "next track"
+    ".flash - #{self.current}"
   end
   def self.previous
     Applescript.run "iTunes", "previous track"
   end
 
   def self.artists artist=nil, track=nil
-
     # If nothing passed, list artists
 
     if artist.nil?

data/menu/markdown.rb

@@ -3,6 +3,10 @@ require 'redcarpet'
 
 class Markdown
 
+  def self.to_xiki_format txt
+    txt = txt.gsub(/^#+/){"#{'>' * $&.length}"}
+  end
+
   def self.render txt
     markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, :autolink=>true, :space_after_headers=>true)
     html = markdown.render txt

data/menu/readme.rb

@@ -0,0 +1,6 @@
+class Readme
+  def self.menu *args
+    txt = File.read "#{Bookmarks["$x"]}README.markdown"
+    Markdown.to_xiki_format txt
+  end
+end

data/menu/shell_commands.menu

@@ -1 +1,3 @@
+> See
 << console/
+<< xiki/setup/install command/

data/menu/web_interface.rb

@@ -7,6 +7,10 @@ class WebInterface
     @http://xiki
 
     - install/
+      - warning/
+        | Beware, the web interface is currently experimental and
+        | has security holes that need to be patched (blocking)
+        | non-priveleged users from using sensitive menus.
       - Mac/
         - 1. Configure Apache/
           @/etc/apache2/other/
@@ -43,6 +47,11 @@ class WebInterface
             - Restore) @chmod/644/
         - 3. Restart Apache/
           @apache/restart/
+      - Linux/
+        The steps are the same as for the Mac, but with these
+        differences:
+        - Use the 'sites-available' dir instead of 'other'
+        - Run "a2ensite xiki" on the command line before restarting apache
     - start/
       @$xiki/etc/www/
         % ruby -rubygems sinatra_server.rb

data/xiki.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "xiki"
-  s.version = "0.6.0"
+  s.version = "0.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Craig Muth"]
@@ -18,9 +18,11 @@ Gem::Specification.new do |s|
     "LICENSE",
     "README.markdown"
   ]
+
+  s.rdoc_options += %w[--exclude etc/templates/.*]
+
   files = `git ls-files`.split("\n")
 
-# TMP
   files = files.select{|o| o !~ /^etc\/xiki/}
 
   s.files = files
@@ -39,7 +41,6 @@ Gem::Specification.new do |s|
   s.add_dependency('net-scp')
   s.add_dependency('net-sftp')
   s.add_dependency('rspec')
-  s.add_dependency('memcached')
   s.add_dependency('trogdoro-el4r', [">= 1.0.7"])
 
   s.add_dependency('file-tail')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xiki
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -171,22 +171,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: memcached
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: trogdoro-el4r
   requirement: !ruby/object:Gem::Requirement
@@ -282,6 +266,7 @@ files:
 - README.markdown
 - Rakefile
 - bin/xiki
+- etc/command/copy_xiki_command_to.rb
 - etc/command/xiki_command.rb
 - etc/command/xiki_process.rb
 - etc/command/xiki_wrapper
@@ -471,6 +456,7 @@ files:
 - menu/diffs.menu
 - menu/dimensions_config.menu
 - menu/dimensions_config.rb
+- menu/dir.rb
 - menu/disk.rb
 - menu/do.rb
 - menu/docs.menu
@@ -544,6 +530,7 @@ files:
 - menu/rails.rb
 - menu/rake.rb
 - menu/random.menu
+- menu/readme.rb
 - menu/redis.menu
 - menu/redmine.rb
 - menu/riak_tree.rb
@@ -614,7 +601,9 @@ homepage: http://xiki.org
 licenses:
 - MIT
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --exclude
+- etc/templates/.*
 require_paths:
 - .
 required_ruby_version: !ruby/object:Gem::Requirement