hilfer 0.11.7 → 0.11.8

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.11.8 / 15-Oct-2011
+* do locators for test and lib, whether or not rails is found
+* fix ssc pipe name, so it works again
+* quieten output unless verbose
+* fail gracefully on lack of wmctrl
+* add ssc piping to scite output window
+
 === 0.11.7 / 09-Oct-2011
 * quieten messages from scite
 

data/Manifest.txt

@@ -11,6 +11,7 @@ lib/hilfer/hilfer-icon.png
 lib/hilfer/hilfer_config.rb
 lib/hilfer/hilfer_item.rb
 lib/hilfer/hilfer_model.rb
+lib/hilfer/standard_locator.rb
 lib/hilfer/rails_locator.rb
 lib/hilfer/scite_editor.rb
 lib/hilfer/svn_colours.rb

data/README.txt

@@ -16,7 +16,7 @@ I wrote hilfer.
 
 === Main UI
 
-- Incremental keyboard search - just start typing in the window
+- Incremental keyboard search - just start typing in the window, then use up and down arrows.
 - Editable & hideable location bar showing current directory
 - multiple selections usually do The Right Thing.
 - Can track which file is currently in front in the editor.
@@ -54,21 +54,38 @@ I wrote hilfer.
 - left means close level(s)
 - right means open level(s)
 
+=== Standard shortcuts
+
+- Shift-Ctrl-T: go to test/spec
+- Shift-Ctrl-B: go to lib
+
 === Rails shortcuts
 
 - Shift-Ctrl-V: go to view, or view dir
 - Shift-Ctrl-C: go to controller, or controller dir
 - Shift-Ctrl-M: go to model, or model dir
-- Shift-Ctrl-T: go to test/spec
 - Shift-Ctrl-H: go to helpers dir
 - Shift-Ctrl-L: go to layouts dir
 - Shift-Ctrl-I: go to migrations
 - Shift-Ctrl-S: go to stylesheets
 - Shift-Ctrl-F: go to fixtures
-- Shift-Ctrl-B: go to lib
 - Shift-Ctrl-O: go to config
 - Shift-Ctrl-U: go to routes.rb
 
+=== SciTE director commands
+
+Use ssc to send commands directly to the instance of scite that was opened by
+hilfer.
+
+  ssc find:pipe
+
+will find the string 'pipe' in the current editor window.
+
+
+  find . -name *widge*.rb -exec grep open -Hn | ssc
+
+will send a F4 traversable list of file search results to scite's output window
+
 === Subversion colour highlighting
 
 	Svn::Wc::STATUS_NONE        => '#000', # black
@@ -86,16 +103,13 @@ I wrote hilfer.
 	Svn::Wc::STATUS_EXTERNAL    => '#000', # black
 	Svn::Wc::STATUS_UNVERSIONED => '#808', # purple
 
-=== SciTE director commands
-
-Use ssc to send commands directly to the instance of scite that was opened by
-hilfer.
-
 == PROBLEMS
 
 These may or may not be problems, as you like. No drag-and-drop. No
 icon themes. Can't create new files. Only opens files in SciTE.
 
+ssc will send command to the last version of hilfer that had focus.
+
 See TODO file
 
 == SYNOPSIS
@@ -113,11 +127,11 @@ See TODO file
 
 === Optional packages
 
+* wmctrl to raise SciTE editor window when files are opened
 * text-format for ssc to display extended scite director commands
 * subversion-ruby to display colour highlighted subversion status
 * gnome-terminal or Xfce Terminal executable
 * ActiveSupport to enable rails-specific shortcuts
-* wmctrl to raise SciTE editor window when files are opened
 
 == INSTALL:
 

data/TODO

@@ -1,3 +1,4 @@
+use focus: instead of wmctrl
 menu
 working sets, like eclipse
 option to connect to existing scite, by pid?
@@ -5,6 +6,7 @@ Sort by directories, then files. Needs Options.
 fix multiple selection editing, ie when several files are selected?
 shift-* to select all descendants
 alt-d to toggle deletion confirmation. Status icon to show warning?
+alt-n for new empty file, with similarity to current file
 Ctrl-H to Hide/unhide certain files. Right-click to hide, or Alt-H to hide
 
 autosize?

data/bin/hilfer

@@ -8,7 +8,8 @@ $options = { :debug => false, :hidden => false, :auto_sync => false, :quit_edito
 oparser = OptionParser.new
 oparser.on( '-y', '--auto-sync', 'track editor current file changes') { |o| $options[:host] = true }
 oparser.on( '-s', '--show-hidden', 'Show hidden files' ) { |o| $options[:user] = true }
-oparser.on( '-D', '-d', '-v', '--debug' ) { |o| puts "debug on"; $options[:debug] = true }
+oparser.on( '-D', '-d', '--debug' ) { |o| $options[:debug] = $options[:verbose] = true }
+oparser.on( '-v', '--verbose' ) { |o| $options[:verbose] = true }
 oparser.on( '-q', '--quit-editor', 'close editor on shutdown' ) { |o| $options[:quit_editor] = true }
 
 oparser.on( '-V', '--version', 'show version' ) do |o|

data/bin/ssc

@@ -9,50 +9,35 @@ rescue LoadError
   HAS_TEXT_FORMAT = false
 end
 
+$options = {}
+
 # display help and commands
 oparser = OptionParser.new
-oparser.banner = "Usage: ssc [-h] | cmd[ cmd][...]"
+oparser.banner = <<EOF
+Usage: ssc [options] | [ cmd] [...]" | STDIN
+
+if STDIN is given, pipe to the current scites output window
+
+EOF
+oparser.on( '-o', '--to-output', "Send stdin to scite's output pane") do |o|
+  $options[:pipe_to_output] = true
+end
+
+oparser.on( '-g', '--goto N[,N]', "go to the given line and column number") do |val|
+  $options[:goto] = val
+end
+
 oparser.on( '-h', '-?', '--help' ) do |o|
   puts oparser.to_s
-  puts
+end
+
+oparser.on( '--help-commands' ) do |o|
   puts "Send one or several commands to the current scite"
   if HAS_TEXT_FORMAT
     puts
     puts "Commands are (http://scintilla.sourceforge.net/SciTEDirector.html):"
     puts
-    st = <<EOF
-askfilename:|Return the name of the file being edited.
-askproperty:<key>|Return the value of a property.
-close:|Close the current file.
-closing:|Director is closing - SciTE closes if it was started by the director.
-currentmacro:<string>|Set the current macro to name.
-cwd:|Change the working directory.
-enumproperties:dyn|local|user|base|embed|Enumerate all the properties in the argument set.
-exportashtml:<path>|Save the document in HTML format as the indicated file.
-exportasrtf:<path>|Save the document in RTF format as the indicated file.
-exportaspdf:<path>|Save the document in PDF format as the indicated file.
-exportaslatex:<path>|Save the document in LaTeX format as the indicated file.
-exportasxml:<path>|Save the document in XML format as the indicated file.
-extender:<command>|Call the extension interface with the given command.
-find:<string>|Search for a string, select and show it.
-focus:<timeStamp>|On GTK+ bring this SciTE window to the front. The timeStamp is from the window manager and ensures that windows are only activated because of a user command. Has no effect on Windows as applications on Windows can only donate focus, not take focus.
-goto:<line>[,<col>]|Move caret to a particular line and make it visible. If there is a column number then select the word at that column number or move the caret there if no word is present.
-identity:<hwndDirector>|Sets the director window handle to which SciTE sends messages. The argument is in decimal.
-insert:<value>|Display the value in the editor pane replacing the selection.
-loadsession:<path>|Load a session as given by the indicated file.
-macrocommand:<command>|Execute a macro command. See the SciTE source code for the syntax of the command argument.
-macroenable:<enable>|If enable, display menu commands in SciTE for recording and playing macros.
-macrolist:<list>|Display a list for the user to choose from.
-menucommand:<cmd>|Execute a menu command based on numeric ID.
-open:<path>|Open the indicated file.
-output:<value>|Display the value in the output pane replacing the selection.
-property:<key>=<value>|Set a property to a value.
-quit:|Shut down SciTE.
-reloadproperties:|Reload properties from files.
-replaceall:<srch>\\000<rep>|Replace all instances of he search string in the document with the replace string.
-saveas:<path>|Save the document as the indicated file.
-savesession:<path>|Save a session as given by the indicated file.
-EOF
+    st = DATA.read
     cmds = st.split(/\n/)
     re = /(.*?)\|(.*)/
     tf = Text::Format.new( :format_style => :fill, :left_margin => 28, :columns => 90 )
@@ -62,8 +47,9 @@ EOF
       puts( "%-28s%-52s" % [ cmd, desc.strip ] )
     end
   else
+    puts DATA.read
     puts
-    puts "text/format not found. scite director commands not displayed."
+    puts "text/format not found. scite director commands uglified"
   end
   exit( 1 )
 end
@@ -72,18 +58,69 @@ end
 args = oparser.parse( ARGV )
 
 # which is the pipe file
-pipe_name_file_name = "/tmp/#{ENV['USER']}.hilfer.scite"
+pipe_name_file_name = "/tmp/hilfer.#{ENV['USER']}.scite"
 if !File.exists?( pipe_name_file_name )
   puts "#{pipe_name_file_name} does not exist"
   exit(1)
 end
 
+if ARGV.empty? && STDIN.tty?
+  puts oparser
+  exit 1
+end
+
 # open pipe and write commands
 pipe_name = IO.read( pipe_name_file_name ).chomp
 if File.exists? pipe_name
+  # responses go to the director pipe
   File.open( pipe_name, 'w+' ) do |file|
     for cmd in ARGV
+      cmd += ':' unless cmd.include?(':') || cmd[-1] == ':'
       file.puts cmd
     end
+
+    if $options[:pipe_to_output] || !STDIN.tty?
+      text = STDIN.read
+      # send IDM_CLEAROUTPUT
+      file.puts "menucommand:420"
+      file.puts "output:#{text.gsub "\n", '\n'}"
+    end
+
+    if $options[:goto]
+      file.puts "goto:#{$options[:goto]}"
+    end
   end
 end
+
+__END__
+askfilename:|Return the name of the file being edited.
+askproperty:<key>|Return the value of a property.
+close:|Close the current file.
+closing:|Director is closing - SciTE closes if it was started by the director.
+currentmacro:<string>|Set the current macro to name.
+cwd:|Change the working directory.
+enumproperties:dyn|local|user|base|embed|Enumerate all the properties in the argument set.
+exportashtml:<path>|Save the document in HTML format as the indicated file.
+exportasrtf:<path>|Save the document in RTF format as the indicated file.
+exportaspdf:<path>|Save the document in PDF format as the indicated file.
+exportaslatex:<path>|Save the document in LaTeX format as the indicated file.
+exportasxml:<path>|Save the document in XML format as the indicated file.
+extender:<command>|Call the extension interface with the given command.
+find:<string>|Search for a string, select and show it.
+focus:<timeStamp>|On GTK+ bring this SciTE window to the front. The timeStamp is from the window manager and ensures that windows are only activated because of a user command. Has no effect on Windows as applications on Windows can only donate focus, not take focus.
+goto:<line>[,<col>]|Move caret to a particular line and make it visible. If there is a column number then select the word at that column number or move the caret there if no word is present.
+identity:<hwndDirector>|Sets the director window handle to which SciTE sends messages. The argument is in decimal.
+insert:<value>|Display the value in the editor pane replacing the selection.
+loadsession:<path>|Load a session as given by the indicated file.
+macrocommand:<command>|Execute a macro command. See the SciTE source code for the syntax of the command argument.
+macroenable:<enable>|If enable, display menu commands in SciTE for recording and playing macros.
+macrolist:<list>|Display a list for the user to choose from.
+menucommand:<cmd>|Execute a menu command based on numeric ID.
+open:<path>|Open the indicated file.
+output:<value>|Display the value in the output pane replacing the selection.
+property:<key>=<value>|Set a property to a value.
+quit:|Shut down SciTE.
+reloadproperties:|Reload properties from files.
+replaceall:<srch>\\000<rep>|Replace all instances of he search string in the document with the replace string.
+saveas:<path>|Save the document as the indicated file.
+savesession:<path>|Save a session as given by the indicated file.

data/lib/hilfer/standard_locator.rb

@@ -0,0 +1,85 @@
+require 'pathname'
+
+=begin
+This handles various keypresses that jump to specific
+locations in a project. If a specific file isn't
+selected, the jump will go to the directory. Otherwise
+it will go to a specific file.
+=end
+class StandardLocator
+  attr_accessor :treeviewer
+
+  def initialize( treeviewer )
+    @treeviewer = treeviewer
+
+    @controller_re =       %r|^(.*?)/app/controllers/(.*?)/?(.*?)_controller.rb$|
+    @view_re =             %r|^(.*?)/app/views/(.*?)/?([^/.]*?\..*?)?$|
+    @model_re =            %r|^(.*?)/app/models/(.*?/?)([^/.]*?).rb$|
+    @unit_test_re =        %r|^(.*?)/test/unit/(.*?/?)(.*?)_test.rb$|
+    @functional_test_re =  %r|^(.*?)/test/functional/(.*?/?)(.*?)_controller_test.rb$|
+    @fixture_re =          %r|^(.*?)/test/fixtures/(.*?/?)(.*?).yml$|
+  end
+
+  def viewer_root
+    treeviewer.root_item.path
+  end
+
+  def goto_path( fs_path )
+    treeviewer.select_fs_path( viewer_root + fs_path, true )
+  end
+
+  def select_related_paths( widget, event, &block )
+    items = []
+    paths_to_select = []
+    widget.selection.selected_each do
+      |model, path, iter|
+      item = model.get_value( iter, 0 )
+      puts "item: #{item.path}" if $options[:debug]
+      new_path = yield( item )
+      puts "new_path #{new_path}" if $options[:debug]
+      paths_to_select << viewer_root + new_path
+    end
+
+    treeviewer.select_fs_paths( paths_to_select, true )
+  end
+
+  def handle_keypress( widget, event )
+    retval = true
+    case
+    # Shift-Ctrl-T - go to test, or test dir
+    when event.hardware_keycode == 28 && event.state.control_mask?  && event.state.shift_mask?
+      select_related_paths( widget, event ) do |item|
+        case
+          when md = @model_re.match( item.path )
+            '/test/unit/' + $2 + $3 + '_test.rb'
+          when md = @view_re.match( item.path )
+            '/test/functional/' + $2 + '_controller_test.rb'
+          when md = @controller_re.match( item.path )
+            '/test/functional/' + $2 + $3 + '_controller_test.rb'
+          when md = @fixture_re.match( item.path )
+            '/test/unit/' + $2 + $3.singularize + '_test.rb'
+          else
+            rp = Pathname.new( viewer_root )
+            if ( rp + 'test' ).exist?
+              '/test'
+            elsif (rp + 'spec').exist?
+              '/spec'
+            end
+        end
+      end
+
+    # Shift-Ctrl-B - go to lib dir
+    when event.hardware_keycode == 56 && event.state.control_mask? && event.state.shift_mask?
+      goto_path '/lib'
+
+    # Shift-Ctrl-O - go to config
+    when event.hardware_keycode == 32 && event.state.control_mask?  && event.state.shift_mask?
+      goto_path '/config'
+
+    else
+      retval = false
+    end
+    retval
+  end
+
+end

data/lib/hilfer/tree_viewer.rb

@@ -7,10 +7,10 @@ require 'hilfer/extensions.rb'
 
 # try to load Gnome terminal
 begin
-  require 'hilfer/gnome_terminal.rb'
+  require 'hilfer/gnome_terminal.rb' if $options[:verbose]
   HAS_GNOME_TERMINAL = true
 rescue
-  puts "gnome-terminal not available."
+  puts "gnome-terminal not available." if $options[:verbose]
   HAS_GNOME_TERMINAL = false
 end
 
@@ -25,12 +25,15 @@ end
 
 require 'hilfer/xterm.rb'
 
+# standard locator
+require 'hilfer/standard_locator.rb'
+
 # try to load rails locator
 begin
   require 'hilfer/rails_locator.rb'
   HAS_RAILS_LOCATOR = true
 rescue LoadError
-  puts "ActiveSupport not loaded. No rails-specific keystrokes"
+  puts "ActiveSupport not loaded. No rails-specific keystrokes" if $options[:verbose]
   HAS_RAILS_LOCATOR = false
 end
 
@@ -39,7 +42,7 @@ begin
   require 'hilfer/svn_colours.rb'
   HAS_SUBVERSION = true
 rescue LoadError
-  puts "svn/client not loaded. Coloured SVN status will not be displayed."
+  puts "svn/client not loaded. Coloured SVN status will not be displayed." if $options[:verbose]
   HAS_SUBVERSION = false
 end
 
@@ -79,6 +82,7 @@ class TreeViewer
     # locators are things that provide a set of shortcut keys
     # to jump to specific directories, files, or related locations
     @locators = []
+    @locators << StandardLocator.new( self )
     @locators << RailsLocator.new( self ) if HAS_RAILS_LOCATOR
 
     # pre-populate model from filesystem, only 1 level deep

data/lib/hilfer/version.rb

@@ -1,3 +1,3 @@
 module Hilfer
-  VERSION = '0.11.7'
+  VERSION = '0.11.8'
 end

data/lib/hilfer/window.rb

@@ -1,24 +1,38 @@
 # Currently only offers activate, which raises the window and give it focus
 class Window
   attr_accessor :window_id, :desktop, :pid, :title
-  
+
   def initialize( window_id, desktop, pid, title )
     @window_id, @desktop, @pid, @title = window_id, desktop, pid, title
   end
-  
+
   # create a new Window instance from the pid
   def self.pid( pid )
     list.find {|x| x.pid == pid.to_s }
   end
-  
+
+  def self.wmctrl( *args )
+    unless `which wmctrl` == ''
+      `wmctrl #{args * ' '}`
+    else
+      ''
+    end
+  rescue
+    ''
+  end
+
+  def wmctrl( *args )
+    self.class.wmctrl( *args )
+  end
+
   # window is the Window ID
   def activate
-    `wmctrl -i -R 0x#{window_id}`
+    wmctrl "-i -R 0x#{window_id}"
     $?
   end
-  
+
   def self.list
-    `wmctrl -lp`.split("\n").map do |line|
+    wmctrl( '-lp' ).split("\n").map do |line|
       line =~ /^(0x[[:xdigit:]]+)\s+(-?\d+)\s+(\d+)\s+(.*)/i
       Window.new( $1, $2, $3, $4 )
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hilfer
 version: !ruby/object:Gem::Version
-  version: 0.11.7
+  version: 0.11.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-09 00:00:00.000000000Z
+date: 2011-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gtk2
-  requirement: &82581120 !ruby/object:Gem::Requirement
+  requirement: &78167250 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,18 +21,18 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *82581120
+  version_requirements: *78167250
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &82580360 !ruby/object:Gem::Requirement
+  requirement: &78166110 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.7.1
   type: :development
   prerelease: false
-  version_requirements: *82580360
+  version_requirements: *78166110
 description: Programmers file browser for SciTE
 email: panic@semiosix.com
 executables:
@@ -57,6 +57,7 @@ files:
 - lib/hilfer/hilfer_config.rb
 - lib/hilfer/hilfer_item.rb
 - lib/hilfer/hilfer_model.rb
+- lib/hilfer/standard_locator.rb
 - lib/hilfer/rails_locator.rb
 - lib/hilfer/scite_editor.rb
 - lib/hilfer/svn_colours.rb