godo 1.0.1 → 1.0.2

data/Manifest.txt

@@ -5,7 +5,7 @@ Rakefile
 bin/godo
 lib/godo.rb
 lib/finder.rb
-lib/iterm.rb
 lib/project.rb
 lib/session.rb
 lib/template.yml
+lib/sessions/iterm_session.rb

data/README.txt

@@ -1,28 +1,40 @@
 = godo
 
-* http://rubymatt.rubyforge.org/godo
+* http://simplyruby.rubyforge.org/godo
 
 == DESCRIPTION:
 
 go (to project) do (stuffs)
 
-godo provides a smart way of opening a project folder and invoking a set of commands appropriate to
-that project. Examples might be starting mongrel, tailing one or more logs, starting consoles or IRB,
-opening empty terminal sessions, or making ssh connections.
+godo provides a smart way of opening a project folder in multiple terminal tabs and, in each tab,
+invoking a commands appropriate to that project. For example if the folder contains a Rails project
+the actions might include: starting mongrel, tailing one or more logs, starting consoles or IRB
+sessions, tailing production logs, opening an editor, running autospec, or gitk.
 
-godo works by searching your project paths for a search string and attempting to find the project you
-are talking about. It makes some straightforward efforts to disambiguate.
+godo works by searching your project paths for a given search string and trying to match it against
+paths found in one or more configured project roots. It will make some straightforward efforts to
+disambiguate among multiple matches to find the one you want.
 
-godo then uses heuristics (which can be overriden or extended) to figure out what type of project it is,
-for example a RoR project using RSpec and Subversion. It then invokes a series of action appropriate to
-that project type, each action in its own terminal session.
+godo then uses configurable heuristics to figure out what type of project it is, for example "a RoR
+project using RSpec and Subversion". From that it will invokes a series of action appropriate to the
+type of project detected with each action being run, from the project folder, in its own terminal
+session.
 
 godo is entirely configured by a YAML file (~/.godo) that contains project types, heuristics, actions,
-project paths, and a session controller.
+project paths, and a session controller. A sample configuration file is provided that can be installed
+using godo --install.
 	
-godo comes with an iTerm session controller that uses the rb-appscript gem to control iTerm. It should
-be straightforward to add a controller for Leopard Terminal or a controller that works in a different way
-(e.g. creating new windows instead of new tabs).
+godo comes with an iTerm session controller for MacOSX that uses the rb-appscript gem to control iTerm
+(see lib/session.rb and lib/sessions/iterm_session.rb). It should be relatively straightforward to add
+new controller (e.g. for Leopard Terminal.app), or a controller that works in a different way (e.g. by
+creating new windows instead of new tabs). There is nothing MacOSX specific about the rest of godo so
+creating controllers for other unixen should be straightforward if they can be controlled from ruby.
+
+godo is a rewrite of my original 'gp' script (http://matt.blogs.it/entries/00002674.html) which fixes
+a number of the deficiencies of that script, turns it into a gem, has a better name, and steals the
+idea of using heuristics to detect project types from Solomon Whites gp variant (http://onrails.org/articles/2007/11/28/scripting-the-leopard-terminal).
+	
+godo lives at the excellent GitHub: http://github.com/mmower/godo/ and accepts patches.
 
 == FEATURES/PROBLEMS:
 
@@ -32,9 +44,19 @@ be straightforward to add a controller for Leopard Terminal or a controller that
 
 == SYNOPSIS:
 
-godo project-search-string
+To install the default configuration (will not overwrite an existing configuration file)
+
+godo --install
+
+To open a project with it's actions
 
-To override the project type use -o <matcher-name>
+godo <project>
+
+Where project is a search term that will match part of the project path name.
+
+To open a project and override the project type (i.e. do not use heuristics):
+	
+godo -o <matcher> <project>
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -5,7 +5,7 @@ require 'hoe'
 require './lib/godo.rb'
 
 Hoe.new('godo', Godo::VERSION) do |p|
-  p.rubyforge_name = 'rubymatt'
+  p.rubyforge_name = 'simplyruby'
   p.developer( 'Matt Mower', 'self@mattmower.com' )
   p.extra_deps << ['trollop','>= 1.7']
   p.extra_deps << ['rb-appscript','>= 0.5.1']

data/bin/godo

@@ -20,7 +20,7 @@ if opts[:install]
   end
 else
   begin
-    Godo.invoke( ARGV.shift, opts )
+    Godo.godo( ARGV.shift, opts )
   rescue Errno::ENOENT => e
     puts e.message
     puts "Use --install to create the default configuration file."

data/lib/finder.rb

@@ -6,7 +6,18 @@ module Godo
     
     def self.find( query, options )
       finder = Finder.new( options["projects"], options["ignores"] )
-      finder.find( Regexp.escape( query ) )
+      paths = finder.find( Regexp.escape( query ) )
+      
+      if paths.size > 1
+        paths = strip_inexact_matches( query, paths )
+        if paths.size > 1
+          if base_match( paths )
+            paths[0,1]
+          end
+        end
+      end
+      
+      paths
     end
     
     def initialize( roots, ignores )
@@ -45,6 +56,22 @@ module Godo
       ignore
     end
     
+    def strip_inexact_matches( query, paths )
+      # If any of the paths have the query as a complete path component
+      # then strip any paths that don't
+      if paths.any? { |path| path.split( File::SEPARATOR ).any? { |component| query == component } }
+        paths.select { |path| path.split( File::SEPARATOR ).any? { |component| query == component } }
+      else
+        paths
+      end
+    end
+    
+    def base_match( paths )
+      # Is the first path a prefix for all subsequent-paths
+      path_match = Regexp.compile( "^#{paths.first}" )
+      paths[1..-1].all? { |path| path.match( path_match ) }
+    end
+    
   end
   
 end

data/lib/godo.rb

@@ -1,21 +1,28 @@
 require 'yaml'
 
 module Godo
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
   LIBPATH = File.expand_path( File.dirname( __FILE__ ) )
   
+  # When called with no arguments this will return the path to the gem
+  # library for godo. Any arguments are then appended to the library
+  # path.
   def self.libpath( *args )
     args.empty? ? LIBPATH : File.join( LIBPATH, *args )
   end
   
+  # This method copies the template configuration file from the gem
+  # into the users home directory. It will raise an exception if the
+  # user already has a config file.
   def self.install_config
-    raise "Will not overwrite config. Please delete ~/.godo if you wish to update it." if File.exists?( File.expand_path( '~/.godo' ) )
     self.copy( libpath( 'template.yml' ), '~/.godo' )
   end
-  
+
+  # Copy a file handling overwrite protection.
   def self.copy( from, path, overwrite = false )
+    path = File.expand_path( path )
     if File.exists?( path ) && !overwrite
-      raise "Cannot overwrite #{path}. Please delete first and try again."
+      raise "Will not overwrite #{path}. Please delete first and try again."
     else
       File.open( File.expand_path( path ), "w" ) do |file|
         file.write( File.read( from ) )
@@ -23,59 +30,25 @@ module Godo
     end
   end
   
-  def self.invoke( query, options )
-    Invoker.new( options ).invoke( query )
-  end
-  
-  class Invoker
-    
-    def initialize( options )
-      @options = options
-      @config = YAML::load( File.read( File.expand_path( "~/.godo" ) ) )
-    end
-    
-    def invoke( query )
-      require 'finder'
-      paths = Finder.find( query, @config )
-      if paths.empty?
-        puts "No match for: #{query}"
-      else
-        paths = strip_inexact_matches( query, paths )
-        if paths.size > 1
-          if base_match( paths )
-            invoke_project( paths.first )
-          else
-            puts "Multiple ambgiuous matches for: #{query}"
-            paths.each do |path|
-              puts "\t#{path}"
-            end
-          end
-        else
-          invoke_project( paths.first )
-        end
-      end
-    end
-
-    def strip_inexact_matches( query, paths )
-      # If any of the paths have the query as a complete path component
-      # then strip any paths that don't
-      if paths.any? { |path| path.split( File::SEPARATOR ).any? { |component| query == component } }
-        paths.select { |path| path.split( File::SEPARATOR ).any? { |component| query == component } }
-      else
-        paths
+  # Given the query attempt to find a project path in any of the users configured
+  # project roots that matches. If a clear match is made detect the type of
+  # project and invoke the appropriate actions.
+  def self.godo( query, options )
+    config = YAML::load( File.read( File.expand_path( "~/.godo" ) ) )
+    require 'finder'
+    paths = Finder.find( query, config )
+    if paths.empty?
+      puts "No paths match for: #{query}"
+    elsif paths.size > 1
+      puts "Multiple, ambgiuous, paths match for: #{query}"
+      paths.each do |path|
+        puts "\t#{path}"
       end
-    end
-    
-    def base_match( paths )
-      # Is the first path a prefix for all subsequent-paths
-      path_match = Regexp.compile( "^#{paths.first}" )
-      paths[1..-1].all? { |path| path.match( path_match ) }
-    end
-
-    def invoke_project( path )
+    else
+      puts "Matching project: #{paths.first}"
       require 'project'
-      project = Project.new( @options, @config )
-      project.invoke( path )
+      project = Project.new( options, config )
+      project.invoke( paths.first )
     end
   end
   

data/lib/project.rb

@@ -1,3 +1,5 @@
+require 'session'
+
 module Godo
   
   class Project
@@ -7,9 +9,7 @@ module Godo
       @heuristics = config["heuristics"]
       @actions = config["actions"]
       @matchers = config["matchers"]
-      
-      require config["sessions"].downcase
-      @session_class = Godo.const_get( "#{config[ "sessions" ]}Session" )
+      @session_class = Godo.const_get( config["sessions"] )
     end
     
     def invoke( path )

data/lib/session.rb

@@ -52,4 +52,7 @@ module Godo
     
   end
   
+  # Load all Session subclasses in lib/sessions/*.rb
+  Dir.glob( "#{libpath('sessions')}/*.rb" ) { |path| require path }
+  
 end

data/lib/template.yml

@@ -194,4 +194,4 @@ projects:
 
 # The session controller to use. Right now iTerm is the only
 # game in town.
-sessions: ITerm
+sessions: ITermSession

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: godo
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Matt Mower
@@ -60,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.5.1
     version: 
-description: go (to project) do (stuffs)  godo provides a smart way of opening a project folder and invoking a set of commands appropriate to that project. Examples might be starting mongrel, tailing one or more logs, starting consoles or IRB, opening empty terminal sessions, or making ssh connections.  godo works by searching your project paths for a search string and attempting to find the project you are talking about. It makes some straightforward efforts to disambiguate.  godo then uses heuristics (which can be overriden or extended) to figure out what type of project it is, for example a RoR project using RSpec and Subversion. It then invokes a series of action appropriate to that project type, each action in its own terminal session.  godo is entirely configured by a YAML file (~/.godo) that contains project types, heuristics, actions, project paths, and a session controller.  godo comes with an iTerm session controller that uses the rb-appscript gem to control iTerm. It should be straightforward to add a controller for Leopard Terminal or a controller that works in a different way (e.g. creating new windows instead of new tabs).
+description: "go (to project) do (stuffs)  godo provides a smart way of opening a project folder in multiple terminal tabs and, in each tab, invoking a commands appropriate to that project. For example if the folder contains a Rails project the actions might include: starting mongrel, tailing one or more logs, starting consoles or IRB sessions, tailing production logs, opening an editor, running autospec, or gitk.  godo works by searching your project paths for a given search string and trying to match it against paths found in one or more configured project roots. It will make some straightforward efforts to disambiguate among multiple matches to find the one you want.  godo then uses configurable heuristics to figure out what type of project it is, for example \"a RoR project using RSpec and Subversion\". From that it will invokes a series of action appropriate to the type of project detected with each action being run, from the project folder, in its own terminal session.  godo is entirely configured by a YAML file (~/.godo) that contains project types, heuristics, actions, project paths, and a session controller. A sample configuration file is provided that can be installed using godo --install.  godo comes with an iTerm session controller for MacOSX that uses the rb-appscript gem to control iTerm (see lib/session.rb and lib/sessions/iterm_session.rb). It should be relatively straightforward to add new controller (e.g. for Leopard Terminal.app), or a controller that works in a different way (e.g. by creating new windows instead of new tabs). There is nothing MacOSX specific about the rest of godo so creating controllers for other unixen should be straightforward if they can be controlled from ruby.  godo is a rewrite of my original 'gp' script (http://matt.blogs.it/entries/00002674.html) which fixes a number of the deficiencies of that script, turns it into a gem, has a better name, and steals the idea of using heuristics to detect project types from Solomon Whites gp variant (http://onrails.org/articles/2007/11/28/scripting-the-leopard-terminal).  godo lives at the excellent GitHub: http://github.com/mmower/godo/ and accepts patches."
 email: 
 - self@mattmower.com
 executables: 
@@ -79,12 +79,12 @@ files:
 - bin/godo
 - lib/godo.rb
 - lib/finder.rb
-- lib/iterm.rb
 - lib/project.rb
 - lib/session.rb
 - lib/template.yml
+- lib/sessions/iterm_session.rb
 has_rdoc: true
-homepage: http://rubymatt.rubyforge.org/godo
+homepage: http://simplyruby.rubyforge.org/godo
 post_install_message: 
 rdoc_options: 
 - --main
@@ -105,10 +105,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: rubymatt
+rubyforge_project: simplyruby
 rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
-summary: go (to project) do (stuffs)  godo provides a smart way of opening a project folder and invoking a set of commands appropriate to that project
+summary: go (to project) do (stuffs)  godo provides a smart way of opening a project folder in multiple terminal tabs and, in each tab, invoking a commands appropriate to that project
 test_files: 
 - test/test_godo.rb