godo 1.0.0

data.tar.gz.sig

@@ -0,0 +1,2 @@
+K�R��Os?���bs��Ble�MS���R?ʘ�<��o���2K����j����-�2�bX�c��_����n�Im����6�5d�j��g2?��
+%$Hɇ�ד�J�^��Pi���"o��ŕ_6=�7��}d�ۇ��1��wZ�z�/y��o��g¢�+G���%幫���>T���{���ց9*۟.O��������#�񇞧����H�]7vR��p?��khD~�㷮4x�P`6�j��H��$s	

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-03-05
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/godo
+lib/godo.rb
+lib/finder.rb
+lib/iterm.rb
+lib/project.rb
+lib/session.rb
+lib/template.yml

data/README.txt

@@ -0,0 +1,73 @@
+= godo
+
+* http://rubymatt.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 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).
+
+== FEATURES/PROBLEMS:
+
+* All-in-one configuration file
+* Flexible heuristics for detecting project type
+* Flexible actions for running commands
+
+== SYNOPSIS:
+
+godo project-search-string
+
+To override the project type use -o <matcher-name>
+
+== REQUIREMENTS:
+
+* Trollop
+* rb-appscript
+
+== INSTALL:
+
+* sudo gem install godo
+* godo --install
+* mate|vi|emacs ~/.godo
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Matt Mower <self@mattmower.com>
+
+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/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/godo.rb'
+
+Hoe.new('godo', Godo::VERSION) do |p|
+  p.rubyforge_name = 'rubymatt'
+  p.developer( 'Matt Mower', 'self@mattmower.com' )
+  p.extra_deps << ['trollop','>= 1.7']
+  p.extra_deps << ['rb-appscript','>= 0.5.1']
+  p.remote_rdoc_dir = 'godo'
+end
+
+# vim: syntax=Ruby

data/bin/godo

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby -w
+
+require 'rubygems'
+require 'trollop'
+require 'godo'
+
+opts = Trollop::options do
+  opt :install, "Create a fresh ~/.godo configuration file"
+  opt :override, "Override heuristics to specify project type", :short => 'o', :type => :string
+end
+
+if opts[:install]
+  begin
+    Godo.install_config
+    puts "Installed configuration file ~/.godo, please customise"
+    exit 0
+  rescue => e
+    puts e.message
+    exit 1
+  end
+else
+  begin
+    Godo.invoke( ARGV.shift, opts )
+  rescue Errno::ENOENT => e
+    puts e.message
+    puts "Use --install to create the default configuration file."
+    exit 1
+  else
+    exit 0
+  end
+end

data/lib/finder.rb

@@ -0,0 +1,50 @@
+require 'find'
+
+module Godo
+  
+  class Finder
+    
+    def self.find( query, options )
+      finder = Finder.new( options["projects"], options["ignores"] )
+      finder.find( Regexp.escape( query ) )
+    end
+    
+    def initialize( roots, ignores )
+      @roots = roots.map { |root| File.expand_path( root ) }
+      @ignores = ignores.map { |ignore| Regexp.compile( "/#{ignore}" ) }
+    end
+    
+    def find( query )
+      matches = []
+      @roots.each do |root|
+        # puts "Searching for #{query} in #{root}"
+        Find.find( root ) do |path|
+          if filtered?( path )
+            Find.prune
+          elsif matches?( path, query )
+            matches << path
+          end
+        end
+      end
+      
+      # puts "Found: #{matches.inspect}"
+      matches
+    end
+    
+    def matches?( path, query )
+      path.match( query )
+    end
+
+    def filtered?( path )
+      !File.directory?( path ) || excluded?( path )
+    end
+
+    def excluded?( path )
+      ignore = !!@ignores.detect { |ignore| ignore.match( path ) }
+      #puts "Ignore: #{path.inspect} -> #{ignore.inspect}"
+      ignore
+    end
+    
+  end
+  
+end

data/lib/godo.rb

@@ -0,0 +1,82 @@
+require 'yaml'
+
+module Godo
+  VERSION = '1.0.0'
+  LIBPATH = File.expand_path( File.dirname( __FILE__ ) )
+  
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : File.join( LIBPATH, *args )
+  end
+  
+  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
+  
+  def self.copy( from, path, overwrite = false )
+    if File.exists?( path ) && !overwrite
+      raise "Cannot overwrite #{path}. Please delete first and try again."
+    else
+      File.open( File.expand_path( path ), "w" ) do |file|
+        file.write( File.read( from ) )
+      end
+    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
+      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 )
+      require 'project'
+      project = Project.new( @options, @config )
+      project.invoke( path )
+    end
+  end
+  
+end

data/lib/iterm.rb

@@ -0,0 +1,24 @@
+require 'session'
+require 'appscript'
+
+module Godo
+  
+  class ITermSession < Session
+    
+    def initialize( path )
+      super( path )
+      @@iterm ||= Appscript::app( 'iTerm' )
+    end
+      
+    def start
+      @session = @@iterm.current_terminal.sessions.end.make( :new => :session )
+      @session.exec( :command => 'bash -l' )
+    end
+    
+    def execute( command )
+      @session.write( :text => command )
+    end
+    
+  end
+  
+end

data/lib/project.rb

@@ -0,0 +1,79 @@
+module Godo
+  
+  class Project
+    
+    def initialize( options, config )
+      @options = options
+      @heuristics = config["heuristics"]
+      @actions = config["actions"]
+      @matchers = config["matchers"]
+      
+      require config["sessions"].downcase
+      @session_class = Godo.const_get( "#{config[ "sessions" ]}Session" )
+    end
+    
+    def invoke( path )
+      matcher = find_match( path )
+      if matcher
+        puts "Project type: #{matcher["name"]}"
+        invoke_actions( path, matcher["actions"] )
+      else
+        puts "No matching project type"
+      end
+    end
+    
+  private
+    def invoke_actions( path, action_group )
+      session = @session_class.new( path )
+      
+      missing_actions = action_group.find_all { |action| !@actions.has_key?( action ) }
+      if missing_actions.empty?
+        action_group.each { |action_name|
+          action = @actions[action_name]
+          exit = case action["exit"]
+          when true
+            true
+          when "true"
+            true
+          when "1"
+            true
+          when "y"
+            true
+          else
+            false
+          end
+          
+          puts "\trunning: #{action_name} (exit: #{exit})"
+          session.create( action["label"], action["command"], exit )
+        }
+      else
+        missing_actions.each do |action|
+          puts "\tMissing action: #{action}"
+        end
+      end
+    end
+  
+    def find_match( path )
+      if @options[:override]
+        puts @options[:override]
+        @matchers.find { |matcher| matcher["name"] == @options[:override] }
+      else
+        @matchers.detect { |matcher|
+          matcher["heuristics"].all? { |heuristic|
+            satisfies?( path, heuristic )
+          }
+        }
+      end
+    end
+  
+    def satisfies?( path, heuristic )
+      eval( @heuristics[heuristic], get_binding( path ) )
+    end
+    
+    def get_binding( project_path )
+      binding
+    end
+    
+  end
+  
+end

data/lib/session.rb

@@ -0,0 +1,57 @@
+module Godo
+  
+  class Session
+    attr_reader :path
+    
+    def initialize( path )
+      @path = path
+      @counters = Hash.new { 0 }
+    end
+    
+    def create( label, command, exit )
+      start
+      set_label( label )
+      execute( "cd #{path}; clear;" )
+      
+      if command
+        puts "Command: #{command}"
+        command = eval( "\"" + command + "\"", get_binding )
+        puts "\tNow: #{command}"
+        execute( command )
+      end
+      
+      if exit
+        execute( "sleep 5; exit" )
+      end
+    end
+    
+    def set_label( label )
+      if label
+        label = eval( "\"" + label + "\"" )
+        execute( "echo -n -e \"\\033]0;#{label}\\007\"; clear;" )
+      else
+        execute( "clear;" )
+      end
+    end
+    
+    def start
+      raise "#{self.class.name} must implement #start"
+    end
+    
+    def execute( command )
+      raise "#{self.class.name} must implement #execute"
+    end
+    
+    def counter( name )
+      @counters[name] += 1
+      "#{@counters[name]}"
+    end
+    
+  private
+    def get_binding( project_path = @path )
+      binding
+    end
+    
+  end
+  
+end

data/lib/template.yml

@@ -0,0 +1,202 @@
+# Heuristics are used to "sniff" a project folder once found
+# and determine whether it is of some kind, e.g. a Rails project.
+# Heuristic code should be a ruby expression returning true or
+# false. The value of 'project_path' will be bound to the found
+# path when the heuristic is run.
+#
+heuristics:
+  rails: |
+    File.exists?( File.join( project_path, "config", "environment.rb" ) ) &&
+    File.exists?( File.join( project_path, "config", "environments", "development.rb" ) ) &&
+    File.exists?( File.join( project_path, "config", "environments", "test.rb" ) )
+  rspec: |
+    File.exists?( File.join( project_path, "spec" ) )
+  svn: |
+    File.exists?( File.join( project_path, ".svn" ) )
+  git: |
+    File.exists?( File.join( project_path, ".git" ) )
+  true: |
+    true
+
+# Actions are shell commands that are run in their own terminal session (by default
+# this will be a new tab in iTerm). Each action can optionally label the terminal
+# session.
+#
+# Where the session should not hang around after the command has run (e.g. opening
+# a GUI app) then specify
+#   exit: true.
+# This will ensure that the session is closes without causing AppleScript
+# errors due to terminal sessions getting re-numbered.
+#
+actions:
+  say:
+    command: "say #{project_path}"
+    exit: true
+  mongrel:
+    label: mongrel
+    command: mongrel_rails start
+  devlog:
+    label: dev-log
+    command: tail -f log/development.log
+  reqlog:
+    label: req-log
+    command: tail -f log/request.log
+  autotest-unit:
+    label: tests
+    command: autotest
+  autotest-spec:
+    label: specs
+    command: autotest
+  console:
+    label: console
+    command: ruby script/console
+  irb:
+    label: IRB
+    command: irb
+  diffly:
+    command: diffly .
+    exit: true
+  browser:
+    command: open -a BonEcho http://localhost:3000/
+    exit: true
+  terminal:
+    label: Con-#{counter(:terminal)}
+  textmate:
+    command: mate .
+    exit: true
+  view-git:
+    command: (PATH=/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/usr/X11/bin:/opt/local/bin:/usr/local/bin nohup gitk &)
+    exit: true
+
+# A list of paths that should be ignored when searching for the project path
+#
+ignores:
+  - \.svn
+  - \.git
+  - CVS
+  - app
+  - lib
+  - vendor
+  - config
+  - db
+  - log
+  - public
+  - script
+  - test
+  - spec
+  - tmp
+  - doc
+  - components
+  - rdoc
+  - generators
+  - data
+  - man
+  - build
+  - backup
+  - bin
+  - include
+  - .*\.lproj
+  - .*\.xcodeproj
+  - .*\.wdgtproj
+  - .*\.app
+
+# Once the project folder has been identified each listed matcher, in turn, gets to run
+# its heuristics against the folder. Once a matcher has all of its heuristics succeed
+# that matcher is selected and its action are run.
+#
+# Where matchers share common heuristics they should be listed in order of most to least
+# specific, e.g. rail+spec+svn should be listed before rails+svn otherwise the more
+# specific matcher will not get a chance to run.
+#
+matchers:
+  -
+    name: rails+spec+svn
+    heuristics:
+      - rspec
+      - rails
+      - svn
+    actions:
+      - say
+      - mongrel
+      - devlog
+      - reqlog
+      - autotest-spec
+      - console
+      - irb
+      - terminal
+      - terminal
+      - diffly
+      - browser
+      - textmate
+  -
+    name: rails+spec+git
+    heuristics:
+      - rails
+      - rspec
+      - git
+    actions:
+      - say
+      - mongrel
+      - devlog
+      - reqlog
+      - autotest-spec
+      - console
+      - irb
+      - terminal
+      - terminal
+      - view-git
+      - browser
+      - textmate
+  -
+    name: rails+svn
+    heuristics:
+      - rails
+      - svn
+    actions:
+      - say
+      - mongrel
+      - devlog
+      - reqlog
+      - autotest-unit
+      - console
+      - irb
+      - terminal
+      - terminal
+      - diffly
+      - browser
+      - textmate
+  -
+    name: rails+git
+    heuristics:
+      - rails
+      - git
+    actions:
+      - say
+      - mongrel
+      - devlog
+      - reqlog
+      - autotest-unit
+      - console
+      - irb
+      - terminal
+      - terminal
+      - view-git
+      - browser
+      - textmate
+  -
+    name: default
+    heuristics:
+      - true
+    actions:
+      - terminal
+      - say
+
+# A list of project root paths to be searched
+projects:
+  - ~/Projects/ruby
+  - ~/Projects/rails
+  - ~/Projects/Cocoa
+
+# The session controller to use. Right now iTerm is the only
+# game in town.
+sessions: ITerm

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: godo
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Matt Mower
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDMjCCAhqgAwIBAgIBADANBgkqhkiG9w0BAQUFADA/MQ0wCwYDVQQDDARzZWxm
+  MRkwFwYKCZImiZPyLGQBGRYJbWF0dG1vd2VyMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTA3MTAwMzIzMjkwN1oXDTA4MTAwMjIzMjkwN1owPzENMAsGA1UEAwwEc2Vs
+  ZjEZMBcGCgmSJomT8ixkARkWCW1hdHRtb3dlcjETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMVQejbmmtJD6FfTwc9+
+  QsWEqNFgNL8+tbrpxUuT8J2j0O0Pvkhw3wGT3tzMdXlnaz+OwUz8qU6HGwDAiK/3
+  zWAGuBRApkIAooTryRWLYmkZfnZidG8A2msmRwQd84Rkzn6Vgad+46o6jQfJSgy1
+  pDsZVfsRcUZ0dWetp+ll7Lq/4HyecdNgRfmrQh6pmKwIUmh5cj91iBX3NEqx5TN6
+  AKkYIOBMuOnBMNrXvApH10ruvus1d/PiJIjAavvbgSih+vyB8NTXTF4kOhKXnF0w
+  Zx3CF5asJejopRGNUcY9Vmjr7WiRHhUnFjc8hs385MlQNKEdAirVwIIgWfkQwJO+
+  GQ0CAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFL99
+  Fuw4VZwExQog/QSr8zIFfj1WMA0GCSqGSIb3DQEBBQUAA4IBAQATHmiqgSFKeJQM
+  QZjefTiRH6q1TgnJEt0/ylb9gNUCBpIFC1QOtuf68NAt90n6q1CZ51W3EreOPmi2
+  k2UxzfnPH6av2HQxmC1Xwv+X/eKF65shy/D75XWeCKLwynlXbA0cSjkV8/jSDB9I
+  pPXX1PjTNmzS2oNGSBroG567Uod41eAjlFA2FQTSWu/lDaYvLBjupGzz59/lZfkl
+  oCvK+OORDtfJ/a8CdYuD7PltGIEGV9srqdsEsmcrXGHaZt+jGRLYi60h5ZEd7lOm
+  1WEvMXOXF3ofp87Yw1MSpG7yQyr0i5DW6VM3v6AP0ABxoM4p80JDHhwAmKWRWWQk
+  yMQ/kUco
+  -----END CERTIFICATE-----
+
+date: 2008-03-08 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.7"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rb-appscript
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !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).
+email: 
+- self@mattmower.com
+executables: 
+- godo
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/godo
+- lib/godo.rb
+- lib/finder.rb
+- lib/iterm.rb
+- lib/project.rb
+- lib/session.rb
+- lib/template.yml
+has_rdoc: true
+homepage: http://rubymatt.rubyforge.org/godo
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rubymatt
+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
+test_files: 
+- test/test_godo.rb

metadata.gz.sig

@@ -0,0 +1,2 @@
+/H=A�v�sH�z��Z�y,�A=ױ%(q�:"����q�0Z���T3zzOB�ԐG�RK���򊰜��id �K�C�i�����t�}�5T�Y�C�������޹��1&^`��+����jw
+�2��#OdZ��}��m��4��ض�'�:7թ͏7K7�1�g%��땰D��;��Q\��4:)�f������̱�+x1=���0.�D�B��vt*�,���ZԐ݊�)�zx/��]$ѷ��:��4�