editorkicker 0.1.0 → 0.2.0

data/CHANGES.txt

@@ -1,5 +1,16 @@
 releases:
 
+  - version:	0.2.0
+    date:	2008-09-15
+    enhancements:
+      - |
+	Support ENV['EDITOR_KICKER_INCLUDE'] and ENV['EDITOR_KICKER_EXCLUDE']
+	to specify include or exclude path explicitly.
+
+	  ## bash
+	  export EDITOR_KICKER_INCLUDE='/usr/lib/ruby/site-ruby/1.8'
+	  export EDITOR_KICKER_EXCLUDE='/usr/lib/ruby:./'
+
   - version:	0.1.0
     date:	2008-07-19
     enhancements:

data/README.txt

@@ -1,6 +1,6 @@
 = README.txt for EditorKicker
 
-Release: 0.1.0
+Release: 0.2.0
 
 http://editorkicker.rubyforge.org/
 http://rubyforge.org/projects/editorkicker/
@@ -28,9 +28,9 @@ You must install CGI-Exception library, too.
     $ 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/
+    $ wget http://rubyforge.org/projects/editorkicker/.../editorkicker-0.2.0.tar.gz
+    $ tar xzf editorkicker-0.2.0.tar.gz
+    $ cd editorkicker-0.2.0/
     $ sudo ruby install.rb
   
     ## install cgi-exception
@@ -42,8 +42,8 @@ You must install CGI-Exception library, too.
     $ 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.
+It is not recommended to install libraries by RubyGems, because
+'require rubygems' is an heavy-weight operation for CGI.
 
 
 
@@ -60,6 +60,12 @@ ATTENTION!  Don't forget to call 'M-x server-start' if you're Emacs user.
 Setting of $EDITOR_KICKER is optional. If $EDITOR_KICKER is not set,
 EditorKicker will detect TextMate or Emacs automatically.
 
+In addition, $EDITOR_KICKER_INCLUDE and $EDITOR_KICKER_EXCLUDE represents
+include and exclude path to find file.
+
+    $ export EDITOR_KICKER_EXCLUDE='/usr:/opt:./vendor/plugins'
+
+
 (for CGI/mod_ruby)
 
     #!/usr/bin/env ruby
@@ -75,7 +81,14 @@ EditorKicker will detect TextMate or Emacs automatically.
       ## for Emacs
       emacsclient = '/Applications/Emacs.app/Contents/MacOS/bin/emacsclient'
       ENV['EDITOR_KICKER'] = "#{emacsclient} -n -s /tmp/emacs501/server +%s '%s'"
+      ## for NetBeans
+      netbeans = "#{ENV['HOME']}/netbeans-6.1/bin/netbeans"
+      ENV['EDITOR_KICKER'] = "#{netbeans} --open %2$s:%1$s"
     end
+
+    ## you can specify include and/or exclude path to find file.
+    ENV['EDITOR_KICKER_INCLUDE'] = '/usr/local/lib/ruby/1.8/site_ruby:./lib'
+    ENV['EDITOR_KICKER_EXCLUDE'] = '/usr/local/lib:/opt/local/lib'
     
     cgi = CGI.new
     print cgi.header
@@ -87,7 +100,7 @@ If you're Emacs user, you have to change owner of socket file
 
     ### 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
+    $ sudo chown -R daemon /tmp/emacs501
 
 
 
@@ -105,7 +118,7 @@ Solution:
 
 Type 'M-x server start' in your Emacs.
 
-In addition if you are CGI user, set $EDITOR_KICKER environment variable
+In addition if you are CGI user, set ENV['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.)

data/editorkicker.gemspec

@@ -1,7 +1,7 @@
 #!/usr/bin/ruby
 
 ###
-### $Release: 0.1.0 $
+### $Release: 0.2.0 $
 ### Copyright 2008 kuwata-lab.com all rights reserved.
 ###
 
@@ -13,7 +13,7 @@ spec = Gem::Specification.new do |s|
   s.author      = "makoto kuwata"
   s.email       = "kwa(at)kuwata-lab.com"
   s.rubyforge_project = 'editorkicker'
-  s.version     = "0.1.0"
+  s.version     = "0.2.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"
@@ -28,6 +28,7 @@ spec = Gem::Specification.new do |s|
   files += %W[README.txt CHANGES.txt MIT-LICENSE setup.rb #{s.name}.gemspec]
   files += Dir.glob('plugin/**/*')
   #files += Dir.glob('doc-api/**/*')
+  files += Dir.glob('spec/**/*')
   s.files       = files
 end
 

data/lib/editor_kicker.rb

@@ -1,6 +1,6 @@
 ##
 ## $Rev$
-## $Release: 0.1.0 $
+## $Release: 0.2.0 $
 ## Copyright 2008 kuwata-lab.com all rights reserved.
 ##
 
@@ -27,11 +27,28 @@ module EditorKicker
     @@handler = handler
   end
 
+
+  def self.writable_check
+    return ExceptionHandler.writable_check
+  end
+  def self.writable_check=(flag)
+    ExceptionHandler.writable_check = flag
+  end
+
+
   class ExceptionHandler
 
+    @@writable_check = false  # don't check writable permission
+    def self.writable_check
+      @@writable_check
+    end
+    def self.writable_check=(flag)
+      @@writable_check = flag
+    end
+
     def initialize
       @kicker = self   # you can set Proc object to @kicker
-      @writable_check = false
+      @writable_check = @@writable_check
     end
 
     attr_accessor :command, :kicker, :writable_check
@@ -46,12 +63,13 @@ module EditorKicker
     def detect_location(ex, backtrace=nil)
       filepath = linenum = nil
       backtrace ||= ex.backtrace
+      @include, @exclude = detect_paths()
       if backtrace && !backtrace.empty?
         tuple = nil
         if backtrace.find {|str| tuple = get_location(str) }
           filepath, linenum = tuple
         end
-      #elsif ex.is_a?(SyntaxEx)
+      #elsif ex.is_a?(SyntaxError)
       #  if ex.to_s =~ /^(.+):(\d+): syntax error,/
       #    filepath, linenum = $1, $2.to_i
       #  end
@@ -61,11 +79,21 @@ module EditorKicker
       return filepath, linenum
     end
 
+    def _match_to(filename, path_list)
+      return path_list.any? {|path|
+        filename[0, path.length] == path }
+    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]
+      return nil unless str =~ /^(.+):(\d+)(:in `.+'|$)/
+      filename, linenum = $1, $2.to_i
+      arr = [filename, linenum]
+      return nil unless File.exist?(filename)
+      return arr if _match_to(filename, @include)
+      return nil if _match_to(filename, @exclude)
+      return nil if @writable_check && !File.writable?(filename)
+      return arr
     end
 
     ## detect command to invoke editor
@@ -77,6 +105,15 @@ module EditorKicker
       return "emacsclient -n +%s '%s'"
     end
 
+    def detect_paths
+      sep = File::PATH_SEPARATOR
+      s = ENV['EDITOR_KICKER_INCLUDE']
+      include = s ? s.split(sep) : []
+      s = ENV['EDITOR_KICKER_EXCLUDE']
+      exclude = s ? s.split(sep) : []
+      return include, exclude
+    end
+
     ## open file with editor
     def kick(filepath, linenum)
       if File.exists?(filepath)
@@ -94,7 +131,7 @@ module EditorKicker
     end
 
     def log(message)
-      $stderr.puts "** [EditorKicker] #{message}"
+      $stderr << "** [EditorKicker] #{message}\n"
     end
 
   end

data/plugin/rails/editorkicker/CHANGES.txt

@@ -1,5 +1,16 @@
 releases:
 
+  - version:	0.2.0
+    date:	2008-09-15
+    enhancements:
+      - |
+	Support ENV['EDITOR_KICKER_INCLUDE'] and ENV['EDITOR_KICKER_EXCLUDE']
+	to specify include or exclude path explicitly.
+
+	  ## bash
+	  export EDITOR_KICKER_INCLUDE='/usr/lib/ruby/site-ruby/1.8'
+	  export EDITOR_KICKER_EXCLUDE='/usr/lib/ruby:./'
+
   - version:	0.1.0
     date:	2008-07-19
     enhancements:

data/plugin/rails/editorkicker/README.txt

@@ -2,7 +2,7 @@
 EditorKicker plugin for Ruby on Rails
 =====================================
 
-Release: 0.1.0
+Release: 0.2.0
 
 
 About

data/plugin/rails/editorkicker/init.rb

@@ -1,6 +1,6 @@
 ##
 ## $Rev$
-## $Release: 0.1.0 $
+## $Release: 0.2.0 $
 ## Copyright 2008 kuwata-lab.com all rights reserved.
 ##
 
@@ -17,10 +17,13 @@ if defined?(RAILS_ENV) && RAILS_ENV == 'development'
 
     class RailsExceptionHandler < ExceptionHandler
 
-      def initialize(*args)
-        super
-        self.writable_check = true
-      end
+      self.writable_check = true
+      #--
+      #def initialize(*args)
+      #  super
+      #  @writable_check = true
+      #end
+      #++
 
       ## detect filepath and linenum
       def detect_location(ex, backtrace=nil)

data/plugin/rails/editorkicker/lib/editor_kicker.rb

@@ -1,6 +1,6 @@
 ##
 ## $Rev$
-## $Release: 0.1.0 $
+## $Release: 0.2.0 $
 ## Copyright 2008 kuwata-lab.com all rights reserved.
 ##
 
@@ -27,11 +27,28 @@ module EditorKicker
     @@handler = handler
   end
 
+
+  def self.writable_check
+    return ExceptionHandler.writable_check
+  end
+  def self.writable_check=(flag)
+    ExceptionHandler.writable_check = flag
+  end
+
+
   class ExceptionHandler
 
+    @@writable_check = false  # don't check writable permission
+    def self.writable_check
+      @@writable_check
+    end
+    def self.writable_check=(flag)
+      @@writable_check = flag
+    end
+
     def initialize
       @kicker = self   # you can set Proc object to @kicker
-      @writable_check = false
+      @writable_check = @@writable_check
     end
 
     attr_accessor :command, :kicker, :writable_check
@@ -46,12 +63,13 @@ module EditorKicker
     def detect_location(ex, backtrace=nil)
       filepath = linenum = nil
       backtrace ||= ex.backtrace
+      @include, @exclude = detect_paths()
       if backtrace && !backtrace.empty?
         tuple = nil
         if backtrace.find {|str| tuple = get_location(str) }
           filepath, linenum = tuple
         end
-      #elsif ex.is_a?(SyntaxEx)
+      #elsif ex.is_a?(SyntaxError)
       #  if ex.to_s =~ /^(.+):(\d+): syntax error,/
       #    filepath, linenum = $1, $2.to_i
       #  end
@@ -61,11 +79,21 @@ module EditorKicker
       return filepath, linenum
     end
 
+    def _match_to(filename, path_list)
+      return path_list.any? {|path|
+        filename[0, path.length] == path }
+    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]
+      return nil unless str =~ /^(.+):(\d+)(:in `.+'|$)/
+      filename, linenum = $1, $2.to_i
+      arr = [filename, linenum]
+      return nil unless File.exist?(filename)
+      return arr if _match_to(filename, @include)
+      return nil if _match_to(filename, @exclude)
+      return nil if @writable_check && !File.writable?(filename)
+      return arr
     end
 
     ## detect command to invoke editor
@@ -77,6 +105,15 @@ module EditorKicker
       return "emacsclient -n +%s '%s'"
     end
 
+    def detect_paths
+      sep = File::PATH_SEPARATOR
+      s = ENV['EDITOR_KICKER_INCLUDE']
+      include = s ? s.split(sep) : []
+      s = ENV['EDITOR_KICKER_EXCLUDE']
+      exclude = s ? s.split(sep) : []
+      return include, exclude
+    end
+
     ## open file with editor
     def kick(filepath, linenum)
       if File.exists?(filepath)
@@ -94,7 +131,7 @@ module EditorKicker
     end
 
     def log(message)
-      $stderr.puts "** [EditorKicker] #{message}"
+      $stderr << "** [EditorKicker] #{message}\n"
     end
 
   end

data/spec/editor_kicker_spec.rb

@@ -0,0 +1,124 @@
+###
+### $Rev$
+### $Release: 0.2.0 $
+### Copyright 2008 kuwata-lab.com all rights reserved.
+### MIT License
+###
+
+dir = File.dirname(File.dirname(File.expand_path(__FILE__)))
+$:.unshift File.join(dir, "spec")
+$:.unshift File.join(dir, "lib")
+
+require 'rubygems'
+require 'spec'
+require 'editor_kicker'
+
+def `(str)    #`
+  $stdout << str
+end
+
+ENV['EDITOR_KICKER'] = '<kicked: %s:%s>'
+
+
+class String
+  def write(arg)
+    self << arg
+  end
+  def puts(arg)
+    self << arg
+    self << arg unless arg[-1] == ?\n
+  end
+end
+
+def dummy_stdio
+  begin
+    $stdout = ''
+    $stderr = ''
+    yield $stdout, $stderr
+  ensure
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end
+
+
+## TODO: change to portable data
+err = ArgumentError.new('***dummy***')
+backtrace = [
+  "/usr/local/lib/ruby/gems/1.8/gems/rspec-1.1.4/lib/spec/example/example_group_methods.rb:46:in `module_eval'",
+  "/usr/local/lib/ruby/gems/1.8/gems/rspec-1.1.4/lib/spec/example/example_group_methods.rb:46:in `describe'",
+  "./spec/editor_kicker_spec.rb:9:in `raise_error'",
+  "./spec/editor_kicker_spec.rb:51",
+  "/usr/local/lib/ruby/gems/1.8/gems/rspec-1.1.4/lib/spec/extensions/class.rb:14:in `instance_eval'",
+]
+err.set_backtrace(backtrace)
+
+
+describe "EditorKicker" do
+
+  it "kicks command with filename and linenum" do
+    dummy_stdio do |stdout, stderr|
+      EditorKicker.handle_exception(err)
+      stdout.should == "<kicked: 46:/usr/local/lib/ruby/gems/1.8/gems/rspec-1.1.4/lib/spec/example/example_group_methods.rb>"
+      stderr.should == "** [EditorKicker] <kicked: 46:/usr/local/lib/ruby/gems/1.8/gems/rspec-1.1.4/lib/spec/example/example_group_methods.rb>\n"
+    end
+  end
+
+  it "does nothing when file is not found." do
+    err.set_backtrace([])
+    dummy_stdio do |stdout, stderr|
+      EditorKicker.handle_exception(err)
+      stdout.should == ''
+      stderr.should == ''
+    end
+    err.set_backtrace(backtrace)
+  end
+
+  it "ignores unwritable file when check_writable is true" do
+    val = EditorKicker.handler.writable_check
+    EditorKicker.handler.writable_check = true
+    begin
+      dummy_stdio do |stdout, stderr|
+        EditorKicker.handle_exception(err)
+        stdout.should == "<kicked: 9:./spec/editor_kicker_spec.rb>"
+        stderr.should == "** [EditorKicker] <kicked: 9:./spec/editor_kicker_spec.rb>\n"
+      end
+    ensure
+      EditorKicker.handler.writable_check = val
+    end
+  end
+
+  it "selects file not in ENV['EDITOR_KICKER_EXCLUDE']" do
+    dummy_stdio do |stdout, stderr|
+      ENV['EDITOR_KICKER_EXCLUDE'] = '/usr/lib:/usr/local/lib:/opt/local'
+      EditorKicker.handle_exception(err)
+      stdout.should == "<kicked: 9:./spec/editor_kicker_spec.rb>"
+      stderr.should == "** [EditorKicker] <kicked: 9:./spec/editor_kicker_spec.rb>\n"
+    end
+  end
+
+  it "selects file in ENV['EDITOR_KICKER_INCLUDE']" do
+    dummy_stdio do |stdout, stderr|
+      ENV['EDITOR_KICKER_INCLUDE'] = '/usr/local/lib/ruby/gems/1.8/'
+      ENV['EDITOR_KICKER_EXCLUDE'] = '/usr/lib:/usr/local/lib:/opt/local'
+      EditorKicker.handle_exception(err)
+      stdout.should == "<kicked: 46:/usr/local/lib/ruby/gems/1.8/gems/rspec-1.1.4/lib/spec/example/example_group_methods.rb>"
+      stderr.should == "** [EditorKicker] <kicked: 46:/usr/local/lib/ruby/gems/1.8/gems/rspec-1.1.4/lib/spec/example/example_group_methods.rb>\n"
+    end
+  end
+
+  it "does nothing when all file are excluded" do
+    dummy_stdio do |stdout, stderr|
+      ENV['EDITOR_KICKER_INCLUDE'] = nil
+      ENV['EDITOR_KICKER_EXCLUDE'] = '/usr:./'
+      EditorKicker.handle_exception(err)
+      stdout.should == ''
+      stderr.should == ''
+    end
+  end
+
+  ENV['EDITOR_KICKER_INCLUDE'] = nil
+  ENV['EDITOR_KICKER_EXCLUDE'] = nil
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: editorkicker
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - makoto kuwata
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-20 00:00:00 +09:00
+date: 2008-09-15 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,7 @@ files:
 - plugin/rails/editorkicker/lib/editor_kicker.rb
 - plugin/rails/editorkicker/MIT-LICENSE
 - plugin/rails/editorkicker/README.txt
+- spec/editor_kicker_spec.rb
 has_rdoc: false
 homepage: http://editorkicker.rubyforge.org/
 post_install_message: