editorkicker 0.1.0

data/CHANGES.txt

@@ -0,0 +1,6 @@
+releases:
+
+  - version:	0.1.0
+    date:	2008-07-19
+    enhancements:
+      - First released.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2008 kuwata-lab.com all rights reserved.
+
+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.txt

@@ -0,0 +1,133 @@
+= README.txt for EditorKicker
+
+Release: 0.1.0
+
+http://editorkicker.rubyforge.org/
+http://rubyforge.org/projects/editorkicker/
+
+
+
+== About
+
+EditorKicker is a pretty utility to invoke your favorite editor
+and open errored file when CGI script or Rails program cause error.
+
+
+
+== Install
+
+(for Ruby on Rails)
+
+    $ ruby script/plugin install http://github.com/kwatch/editorkicker.git/ruby/plugin/rails/editorkicker
+
+(for CGI/mod_ruby)
+
+You must install CGI-Exception library, too.
+
+    ## install EditorKicker
+    $ sudo gem install editorkicker
+    ## or
+    $ cd /tmp
+    $ wget http://rubyforge.org/projects/editorkicker/.../editorkicker-XXX.tar.gz
+    $ tar xzf editorkicker-XXX.tar.gz
+    $ cd editorkicker-XXX/
+    $ sudo ruby install.rb
+  
+    ## install cgi-exception
+    $ sudo gem install cgi-exception
+    ## or
+    $ cd /tmp
+    $ wget http://rubyforge.org/projects/cgi-exception
+    $ tar xzf cgi-exception-XXX.tar.gz
+    $ cd cgi-exception-XXX/
+    $ sudo ruby install.rb
+
+It is not recommended to install by RubyGems, because 'require rubygems'
+is an heavy-weight operation for CGI.
+
+
+
+== Setup
+
+ATTENTION!  Don't forget to call 'M-x server-start' if you're Emacs user.
+
+(for Ruby on Rails)
+
+    $ export EDITOR_KICKER="mate -n %s '%s'"             (for TextMate)
+    $ export EDITOR_KICKER="emacsclient -n +%s '%s'"     (for Emacs)
+    $ ruby script/server          # development mode
+
+Setting of $EDITOR_KICKER is optional. If $EDITOR_KICKER is not set,
+EditorKicker will detect TextMate or Emacs automatically.
+
+(for CGI/mod_ruby)
+
+    #!/usr/bin/env ruby
+    require 'cgi'
+    require 'cgi_exception'
+  
+    ### load and set up editor-kicker only when running in local machine
+    if ENV['SERVER_NAME'] == 'localhost'
+      require 'editor_kicker'
+      ## for TextMate
+      mate = '/Applications/TextMate.app/Contents/Resources/mate'
+      ENV['EDITOR_KICKER'] = "#{mate} -l %s '%s'"
+      ## for Emacs
+      emacsclient = '/Applications/Emacs.app/Contents/MacOS/bin/emacsclient'
+      ENV['EDITOR_KICKER'] = "#{emacsclient} -n -s /tmp/emacs501/server +%s '%s'"
+    end
+    
+    cgi = CGI.new
+    print cgi.header
+    print "<h1>Hello</h1>"
+    ...
+
+If you're Emacs user, you have to change owner of socket file
+(ex. '/tmp/emacsXXX/server') to Apache's process user.
+
+    ### assume that CGI script is executed by 'daemon' user.
+    ### ('/tmp/emacs501/server' will be created by M-x server-strart)
+    $ sudo chown -R daemon /tmp/emacs501/server
+
+
+
+== Trouble shooting
+
+
+=== (Emacs) can't find socket
+
+Error:
+
+  emacsclient: can't find socket; have you started the server?
+  To start the server in Emacs, type "M-x server-start".
+
+Solution:
+
+Type 'M-x server start' in your Emacs.
+
+In addition if you are CGI user, set $EDITOR_KICKER environment variable
+to "emacsclient -n -s /tmp/emacs501/server +%s '%s'" in your CGI script
+to specify socket file by '-s' option.
+(Notice that '-s' option of emacsclient is available from Emacs 22.)
+
+
+
+== Todo
+
+* Merb support
+* Mack support
+* Ramaze support
+
+
+
+== Author
+
+makoto kuwata <kwa(at)kuwata-lab.com>
+
+Copyright 2008 kuwata-lab.com all rights reserved.
+
+
+
+== License
+
+MIT License

data/editorkicker.gemspec

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby
+
+###
+### $Release: 0.1.0 $
+### Copyright 2008 kuwata-lab.com all rights reserved.
+###
+
+require 'rubygems'
+
+spec = Gem::Specification.new do |s|
+  ## package information
+  s.name        = "editorkicker"
+  s.author      = "makoto kuwata"
+  s.email       = "kwa(at)kuwata-lab.com"
+  s.rubyforge_project = 'editorkicker'
+  s.version     = "0.1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.homepage    = "http://editorkicker.rubyforge.org/"
+  s.summary     = "a pretty tool to invoke your favorite editor when error raised"
+  s.description = <<-'END'
+  EditorKicker is a pretty tool to invoke your favorite editor and open
+  errored file automatically when error raised in your script.
+  END
+
+  ## files
+  files = []
+  files += Dir.glob('lib/*')
+  files += %W[README.txt CHANGES.txt MIT-LICENSE setup.rb #{s.name}.gemspec]
+  files += Dir.glob('plugin/**/*')
+  #files += Dir.glob('doc-api/**/*')
+  s.files       = files
+end
+
+# Quick fix for Ruby 1.8.3 / YAML bug   (thanks to Ross Bamford)
+if (RUBY_VERSION == '1.8.3')
+  def spec.to_yaml
+    out = super
+    out = '--- ' + out unless out =~ /^---/
+    out
+  end
+end
+
+if $0 == __FILE__
+  Gem::manage_gems
+  Gem::Builder.new(spec).build
+end

data/lib/editor_kicker.rb

@@ -0,0 +1,104 @@
+##
+## $Rev$
+## $Release: 0.1.0 $
+## Copyright 2008 kuwata-lab.com all rights reserved.
+##
+
+##
+## Invoke your favorite editor and Open errored file by it.
+##
+## Don't forget to do `M-x server-start' if you use Emacs.
+##
+module EditorKicker
+
+  def self.handle_exception(ex)
+    self.handler.handle(ex)
+  end
+
+  class <<self
+    alias handle handle_exception
+  end
+
+  def self.handler
+    @@handler
+  end
+
+  def self.handler=(handler)
+    @@handler = handler
+  end
+
+  class ExceptionHandler
+
+    def initialize
+      @kicker = self   # you can set Proc object to @kicker
+      @writable_check = false
+    end
+
+    attr_accessor :command, :kicker, :writable_check
+
+    ## detect error location from error and open related file
+    def handle(ex)
+      filepath, linenum = detect_location(ex)
+      kick(filepath, linenum) if filepath && linenum
+    end
+
+    ## get filename and linenum from error
+    def detect_location(ex, backtrace=nil)
+      filepath = linenum = nil
+      backtrace ||= ex.backtrace
+      if backtrace && !backtrace.empty?
+        tuple = nil
+        if backtrace.find {|str| tuple = get_location(str) }
+          filepath, linenum = tuple
+        end
+      #elsif ex.is_a?(SyntaxEx)
+      #  if ex.to_s =~ /^(.+):(\d+): syntax error,/
+      #    filepath, linenum = $1, $2.to_i
+      #  end
+      elsif ex.to_s =~ /\A(.+):(\d+): /  # for SyntaxError
+        filepath, linenum = $1, $2.to_i
+      end
+      return filepath, linenum
+    end
+
+    ## get filepath and linenum from string
+    def get_location(str)
+      return nil if str !~ /^(.+):(\d+)(:in `.+'|$)/
+      return nil if @writable_check && !File.writable?($1)
+      return [$1, $2.to_i]
+    end
+
+    ## detect command to invoke editor
+    def detect_command
+      command = ENV['EDITOR_KICKER']
+      return command if command
+      bin = '/Applications/TextMate.app/Contents/Resources/mate'
+      return "#{bin} -l %s '%s'" if test(?f, bin)
+      return "emacsclient -n +%s '%s'"
+    end
+
+    ## open file with editor
+    def kick(filepath, linenum)
+      if File.exists?(filepath)
+        @kicker.call(filepath, linenum)
+      else
+        log("#{filepath}: not found.")
+      end
+    end
+
+    ## default activity of kick()
+    def call(filepath, linenum)     # should separate to a class?
+      command = (@command || detect_command()) % [linenum, filepath]  # or [filepath, linenum]
+      log(command)
+      `#{command.untaint}`
+    end
+
+    def log(message)
+      $stderr.puts "** [EditorKicker] #{message}"
+    end
+
+  end
+
+  self.handler = ExceptionHandler.new
+
+end

data/plugin/rails/editorkicker/CHANGES.txt

@@ -0,0 +1,6 @@
+releases:
+
+  - version:	0.1.0
+    date:	2008-07-19
+    enhancements:
+      - First released.

data/plugin/rails/editorkicker/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2008 kuwata-lab.com all rights reserved.
+
+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/plugin/rails/editorkicker/README.txt

@@ -0,0 +1,67 @@
+=====================================
+EditorKicker plugin for Ruby on Rails
+=====================================
+
+Release: 0.1.0
+
+
+About
+-----
+
+EditorKicker is a pretty tool to invoke your favorite editor and
+open errored file automatically when an exception raised on your script.
+This is a plug-in of EditorKicker for Ruby on Rails.
+
+Notice that this plug-in works only under development mode.
+So it is no problem to commit this plug-in files into your app repository.
+
+
+Target
+------
+
+* Rails version
+  - 2.1.X
+  - 2.0.X
+  - 1.2.X (I hope)
+
+* Supported text editor by default
+  - TextMate
+  - Emacs
+
+
+Install
+-------
+
+  $ ruby script/plugin install http://github.com/kwatch/editorkicker.git/ruby/plugin/rails/editorkicker
+
+
+Usage
+-----
+
+1. Intall EditorKicker plugin into your Rails application.
+2. (optional) Set environtment variable $EDITOR_KICKER with command string to
+   invoke text editor (default "mate -l %s '%s'" or "emacsclient -n +%s '%s').
+3. Restart Rails server in development mode.
+4. Do 'M-x server-start' if you want to use Emacs. (*** IMPORTANT! ***)
+
+
+Setup
+-----
+
+Environment variable $EDITOR_KICKER represents command string to invoke your
+favorite editor with filename and linenum.
+Default is "mate -l %s '%s'" or "emacsclient -n +%s '%s'".
+
+
+Author
+------
+
+makoto kuwata <kwa(at)kuwata-lab.com>
+
+Copyright 2008 kuwata-lab.com all rights reserved.
+
+
+License
+-------
+
+MIT License

data/plugin/rails/editorkicker/init.rb

@@ -0,0 +1,64 @@
+##
+## $Rev$
+## $Release: 0.1.0 $
+## Copyright 2008 kuwata-lab.com all rights reserved.
+##
+
+##
+## Notice that this plugin is loaded only when in development mode.
+## So you can commit this plugin into your Rails app repository.
+##
+
+if defined?(RAILS_ENV) && RAILS_ENV == 'development'
+
+  require 'editor_kicker'
+
+  module ::EditorKicker
+
+    class RailsExceptionHandler < ExceptionHandler
+
+      def initialize(*args)
+        super
+        self.writable_check = true
+      end
+
+      ## detect filepath and linenum
+      def detect_location(ex, backtrace=nil)
+        if ex.is_a?(ActionView::TemplateError)
+          # assert ex.respond_to?(:file_name)
+          # assert ex.respond_to?(:line_number)
+          filepath, linenum = ex.file_name, ex.line_number
+          if filepath && linenum
+            filepath = "app/views/#{filepath}" unless filepath[0] == ?/ || filepath =~ /\Aapp\/views\//
+            return filepath, linenum
+          end
+        end
+        # assert ex.respond_to?(:application_backtrace)
+        return super(ex, ex.application_backtrace)
+      end
+
+    end
+
+    self.handler = RailsExceptionHandler.new
+
+  end
+
+
+  module ::ActionController   #:nodoc:
+    module Rescue   #:nodoc:
+      protected
+
+      alias _rescue_action_locally_orig rescue_action_locally   #:nodoc:
+
+      def rescue_action_locally(ex)  # :nodoc:
+        ret = _rescue_action_locally_orig(ex) # call original
+        ::EditorKicker.handle_exception(ex)
+        ret
+      end
+
+    end
+  end
+
+  ::ActionController::Base.new.logger.info("** [EditorKicker] loaded.")
+
+end