xiki 0.5.1a → 0.5.3a

data/Gemfile

@@ -1,13 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'ruby2ruby'
-gem 'ParseTree'
-gem 'httparty'
-gem 'activesupport'
-gem 'method_source'
-gem 'net-ssh'
-gem 'net-ssh'
-gem 'rspec'
-gem 'memcached'
-gem 'el4r'
-
+gemspec

data/README.markdown

@@ -1,92 +1,116 @@
 # Summary
-This file tells how to install Xiki.  See http://xiki.org for a description of Xiki.
-
-Either install as a gem, or install from github.
+This file shows how to install Xiki.  See http://xiki.org for a description of Xiki.
 
 # Install Xiki
 
+Either install as a gem, or install from github.
+
 ## As a gem
 
-      $ gem install xiki
+      $ sudo gem install xiki --pre
 
-## From github
+## Or, 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
 
-# Verify the 'xiki' command works
+If you don't have permission, to run some of the commands put "sudo" at the beginning of the command.
+
+# Verify the 'xiki' shell command works
 
       $ xiki
 
-# Configure Emacs to use 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.
+
+# Configure your editor to use Xiki
+
+## Emacs
 
 If you're going to use Xiki with Emacs, do these steps:
 
-## Step 1: Download Emacs
+### Step 1: Download Emacs
 
-### On Mac:
-- Try Aquamacs 1.9.1 if you're new to emacs (it's more mac-like)
+#### 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
 - Or
-  - http://emacsformacosx.com/emacs-builds/Emacs-22.3-i386-10.5.7.dmg
-- Note: newer mac versions (after 22) have a bug that makes communicating with processes 1000 times slower.  Til this is fixed stick with the above versions.
+  - http://emacsformacosx.com
 
-### On Linux:
+#### On Linux:
 
       $ sudo apt-get install emacs
 
+#### On Windows:
+
+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: Do extra EmacsRuby (el4r) steps
 
-      $ gem contents el4r | grep setup.rb   # To see which dir to cd to in the next step
-      $ cd /Library/Ruby/Gems/1.8/gems/el4r-1.0.4/
-      $ ruby setup.rb
-      $ cd bin/
-      $ ruby -S el4r-rctool -p
-      $ sudo ruby -S el4r-rctool -i
+### Step 2: EmacsRuby (el4r) setup
 
-## Step 3: Require Xiki in EmacsRuby's config
+      $ 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 "/projects/xiki/lib"
+        $LOAD_PATH.unshift "<xiki dir>/lib"
         require 'xiki'
         Xiki.init
 
         KeyBindings.keys   # Use default key bindings
-        Styles.use_xiki_color_scheme   # Use xiki's color scheme
+        Themes.use "Default"  # Use xiki theme
 
 
-## Trouble-shooting
-The install is a bit rough at the moment...
+Be sure to substitute "&lt;xiki dir&gt;" with the actual dir.
 
-- If you get an error (and you probably will)
-  - If you got partially through the load
-    - you will be able to use these keys to trouble-shoot:
-      - Option-l to reload xiki and .emacs
-        - also use this when you see "el4r-instance is dead"
-      - Option-e to look at the latest error
-    - It will be Command instead of Option if you're not using Aquamacs
+### If you get an error
+If you got partially through the load...
 
-  - Or you can manually restart emacs (or reload .emacs) and look at the log
-    - Named something like: /tmp/el4r......log
+- You may be able to use these keys to trouble-shoot:
+   - Option+e to look at the latest error in the log
+   - 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:"
+     - 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
+
+## CodeMirror
 
-- If you get a "can't find header dir for ruby" error
-  $ sudo apt-get install ruby1.8-dev
+There's a simple prototype working, though it's not committed yet.
 
-- If you run into trouble installing EmacsRuby
-  - See: http://www.rubyist.net/~rubikitch/computer/el4r/index.en.html
-    - Click on 'Download / Install / Setup' link
+## 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.
 
 
-## Google group
-Join the google group for help with installing, or to chat about whatever or
-share your ideas:
+# 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
 

data/bin/xiki

@@ -16,31 +16,18 @@
 require 'rubygems'
 
 # Generate with correct path (see below)
-# xiki_dir = "/projects/xiki/"
 xiki_dir = File.expand_path "#{File.dirname(__FILE__)}/.."
-# p "xiki_dir: #{xiki_dir.inspect}"
 
-# $:.unshift xiki_dir #.sub(/\/$/, '')
 $:.unshift "#{xiki_dir}/lib" #.sub(/\/$/, '')
 
-# require "#{xiki_dir}/ol"
-require "ol"
-# Ol.line
-require "core_ext"
+require "xiki/ol"
+require "xiki/core_ext"
 
 $:.unshift "#{xiki_dir}/etc/command"
-# $:.unshift "#{xiki_dir}etc/command/stubs"
 
 require "xiki_command.rb"
-# load "xiki_command.rb"
 
 result = XikiCommand.run
 puts result if result != ""
 
 exit 0
-
-# TODO: Start with template, and when installing, change:
-  # - #!.. line to: result of: `which ruby`
-  # - xiki_dir to: Xiki.dir
-
-

data/etc/command/xiki_command.rb

@@ -19,11 +19,11 @@ class XikiCommand
   # Called by the 'xiki' shell command
   def self.run
 
-    xiki_root = File.expand_path "#{File.dirname(__FILE__)}/../.."
+    xiki_dir = File.expand_path "#{File.dirname(__FILE__)}/../.."
     argv = ARGV
 
     if argv.empty?
-      puts self.usage
+      puts "#{self.usage}\n"
       @@dont_show_output = true
       argv = ['start']   # So it continues on and starts server
     elsif argv.length == 1 && ['status', 'stop', 'restart'].member?(argv[0])
@@ -38,8 +38,8 @@ class XikiCommand
     wasnt_running = false
 
     begin
-      `mkfifo -m 666 /tmp/xikirequest` if ! File.exists?("/tmp/xikirequest")   # Always create first, so they have to be pipes and can't be files
-      `mkfifo -m 666 /tmp/xikiresponse` if ! File.exists?("/tmp/xikiresponse")
+      `mkfifo -m 600 /tmp/xikirequest` if ! File.exists?("/tmp/xikirequest")   # Always create first, so they have to be pipes and can't be files
+      `mkfifo -m 600 /tmp/xikiresponse` if ! File.exists?("/tmp/xikiresponse")
 
       # Try writing to pipe...
 
@@ -83,7 +83,7 @@ class XikiCommand
         pid_orig = Process.pid
 
         @@initial_request = path
-        xiki_process = "#{xiki_root}/etc/command/xiki_process.rb"
+        xiki_process = "#{xiki_dir}/etc/command/xiki_process.rb"
         Daemons.run xiki_process, :ARGV=>['start'], :monitor=>false, :multiple=>false, :dir_mode=>:normal, :dir=>"/tmp/", :log_dir=>"/tmp/", :log_output=>true
 
         # Aparently this line never gets reached
@@ -94,7 +94,7 @@ class XikiCommand
         process_succeeded = true
 
       rescue Exception=>e
-        puts "- service couldn't start!"
+        puts "- service couldn't start!:#{e.message}\n#{e.backtrace.join("\n")}\n\n"
       end
     end
 
@@ -126,51 +126,74 @@ class XikiCommand
         # old IO.select ["/tmp/xikiresponse"]
 
         response = response.gets   # will block if there's nothing in the pipe
-
         response.strip!
         response.gsub! "\036", "\n"   # Escape linebreaks as 036 char (record separator)
-        response = "" if @@dont_show_output
-        response
+        return "" if @@dont_show_output
+        self.add_coloring response
       end
     end
   end
 
   def self.usage
-    %`
-    > Summary
-    This command runs xiki menus, which come from simple files
-    found in ~/menus/.
-
-    > Show all menus
-    % xiki all
-
-    > Examples
-    Call 'ip' menu
-    % xiki ip
-    % xiki animals
-    % xiki tables
-
-    > Open 'ip' menu in emacs
-    % xiki -e ip
-
-    > Run under current dir
-    % xiki -e @git
-
-    > Service
-    Xiki automatically runs a service in the backgroundto keep
-    things fast.
-
-    % xiki   # With no args, it starts the service.
-    % xiki status
-    % xiki stop
-    % xiki restart
-    `.unindent
+    txt = %`
+      > Summary
+      The 'xiki' shell command is mostly meant to be called by programs
+      that want to interface with xiki.  But it is sometimes useful for
+      people to call it directly.  Example usages:
+
+      $ xiki ip
+      $ xiki docs/faq
+
+      > 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.
+
+      See this file for help setting up your editor:
+
+      $xiki/README.markdown
+
+      > Service
+      The 'xiki' shell command automatically runs a service in the
+      backgroundto keep things fast.
+
+      % xiki status
+      % xiki stop
+      % xiki restart
+
+      > Interfaces
+      Xiki can be used from...
+      - A text editor
+      - The 'xiki' shell command
+      - The http://xiki/ url in your browser (experimental)
+
+      For more information type:
+
+      $ xiki docs
+
+      > Google Group
+      Join the google group for help with installing, or just to chat or
+      share your ideas:
+
+      http://groups.google.com/group/xiki/
+
+      > Troubleshooting
+      Be sure to run this command to install required gems:
+
+      % bundle install
+
+      Also see $xiki/README.markdown
+
+      `.unindent
+
+    self.add_coloring txt
   end
 
   def self.ctrl action
     require 'daemons'
-    xiki_root = File.expand_path "#{File.dirname(__FILE__)}/../.."
-    xiki_process = "#{xiki_root}/etc/command/xiki_process.rb"
+    xiki_dir = File.expand_path "#{File.dirname(__FILE__)}/../.."
+    xiki_process = "#{xiki_dir}/etc/command/xiki_process.rb"
     Daemons.run xiki_process, :ARGV=>[action], :dir_mode=>:normal, :dir=>"/tmp/", :log_dir=>"/tmp/", :log_output=>true
     ""
   end
@@ -193,5 +216,56 @@ class XikiCommand
     nil
   end
 
-end
 
+  def self.add_coloring txt
+    return txt if ! STDOUT.tty?
+    txt.gsub!(/.+/) do |line|
+      case line
+      when /^(>) (.+)/
+        "#{self.heading_bracket $1} #{self.bold $2}"
+      when /^http:\/\/.+/
+        "#{self.url $&}"
+      when /^.+\/$/
+        "#{self.path $&}"
+      when /^( *- )(.*!)$/
+        "#{self.bullet $1}#{self.exclamation $2}"
+      when /^( *)(- )(.+: )(.+)/
+        "#{$1}#{self.bullet $2}#{self.label $3}#{$4}"
+      when /^( *)(- )(.+)/
+        "#{$1}#{self.bullet $2}#{$3}"
+
+      else
+        line
+      end
+    end
+
+    txt << "\n"   # Add extra linebreak, but only when in console
+    txt
+  end
+
+  def self.colorize txt, color_code
+    "\e[#{color_code}m#{txt}\e[0m"
+  end
+  def self.bullet txt
+    self.colorize txt, "1;31"   # Red # colorize("1;91")   # Red
+  end
+  def self.label txt
+    self.colorize txt, "1;33"   # Yellow
+  end
+  def self.path txt
+    colorize(txt, "1;90")
+  end
+  def self.url txt
+    colorize(txt, "1;36")   # Cyan
+  end
+  def self.heading_bracket txt
+    colorize(txt, "0;37")
+  end
+  def self.bold txt
+    colorize(txt, "1")
+  end
+  def self.exclamation txt
+    colorize(txt, "1;32")   # Green
+  end
+
+end

data/etc/command/xiki_process.rb

@@ -1,10 +1,6 @@
-# Don't hard-code, generate with script? - or use __file path xiki env var!
-require '/projects/xiki/lib/ol'
-require 'core_ext'
-
-require 'menu'
-
-require 'launcher'
+require 'xiki/core_ext'
+require 'xiki/menu'
+require 'xiki/launcher'
 
 Xiki.init
 

data/etc/install/el4r_setup.sh

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

data/etc/themes/Black_BG.notes

@@ -0,0 +1,8 @@
+$el.set_face_background :trailing_whitespace, "#333333"
+
+Styles.define :default, :bg=>'151515', :fg=>'fff'
+Styles.define :fringe, :bg=>'151515', :fg=>'111111'
+
+Styles.minibuffer_prompt :size=>110, :face=>"Monaco", :fg=>"#bbb"
+Styles.minibuffer :size=>110, :face=>"Monaco"
+Styles.echo_area :size=>110, :face=>"Monaco"