hurl 0.0.2 → 0.0.3

data/History.txt

@@ -0,0 +1,9 @@
+== 0.0.3 / 2008-03-31
+
+* API slightly changed to reflect more fluent usage
+* Bug fixes and updated documentation
+
+== 0.0.2 / 2008-03-31
+
+* Switched to using Mr. Bones to manage gem packaging and deployment
+* Code refactored and test coverage increased

data/Manifest.txt

@@ -0,0 +1,35 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/hurl
+hurls.rb
+lib/hurl.rb
+lib/hurl/iterm.rb
+lib/hurl/iterm_session.rb
+lib/hurl/project.rb
+lib/hurl/session.rb
+lib/hurl/terminal.rb
+lib/hurl/terminal_session.rb
+spec/hurl_spec.rb
+spec/spec_helper.rb
+tasks/ann.rake
+tasks/annotations.rake
+tasks/bones.rake
+tasks/doc.rake
+tasks/gem.rake
+tasks/manifest.rake
+tasks/post_load.rake
+tasks/rubyforge.rake
+tasks/setup.rb
+tasks/spec.rake
+tasks/svn.rake
+tasks/test.rake
+test/hurl/iterm_session_test.rb
+test/hurl/iterm_test.rb
+test/hurl/project_test.rb
+test/hurl/session_test.rb
+test/hurl/terminal_session_test.rb
+test/hurl/terminal_test.rb
+test/hurl_test.rb
+test/test_helper.rb

data/{README → README.txt}

@@ -1,15 +1,12 @@
-About
-=====
-Hurl is an Applescript wrapper built to assist in scripting terminal events.  By defining some actions in a config file (hurls.rb) you can open terminal tabs & launch applications with one command (hurl).  ITerm and Terminal.app are supported and adding new apps is fairly straight forward.
+== HURL
+    by Justin Marney
+    http://hurl.rubyforge.org
 
-Install
-=======
-The ruby appscript gem is required.
+== DESCRIPTION:
 
-sudo gem install hurl
+Hurl is an Applescript wrapper built to assist in scripting terminal events.  By defining some actions in a config file (hurls.rb) you can open terminal tabs & launch applications with one command (hurl).  ITerm and Terminal are supported and adding new apps is fairly straight forward.
 
-Usage
-=====
+== FEATURES/PROBLEMS:
 
 When hurl is called from the command line with a directory path it will search for a hurls.rb file in the root and the lib directory.  Actions in this file will be executed in the order they are defined.  
 
@@ -20,7 +17,7 @@ using Terminal
 In order to execute a command in the tab that hurl was called from:
 
 this_tab do |t|
-  t.exec "ls"
+  t.hurl "ls"
 end
 
 Command line executables can be called directly:
@@ -30,22 +27,21 @@ this_tab do |t|
   t.ls
 end
 
-The project_dir method returns the path passed into hurl:
+The dir method returns the project directory passed into hurl:
 
 this_tab do |t|
-  t.cd project_dir
-  t.exec "script/server run"
+  t.cd dir
+  t.hurl "script/server run"
 end
 
 You can create a new tab using create_tab:
 
 create_tab do |t|
-  t.cd project_dir
+  t.cd dir
   t.autotest
 end
 
-Example
-=======
+== SYNOPSIS:
 
 # Here is an example hurl.rb placed in ~/your_project/lib
 # run hurl ~/your_project to watch awesome happen.
@@ -55,18 +51,33 @@ Example
 
 # This will launch Textmate from the project directory.
 this_tab do |t|
-  t.cd project_dir
+  t.cd dir
   t.mate "." 
 end
 
 # Then open a new tab, cd to the proj dir, and launch autotest.
 create_tab do |t|
-  t.cd project_dir
-  t.exec "autotest --rails"
+  t.cd dir
+  t.hurl "autotest --rails"
 end
 
 # Then open another new tab, cd to the proj dir, and start the server.
 create_tab do |t|
-  t.cd project_dir
-  t.exec "script/server run"
-end
+  t.cd dir
+  t.hurl "script/server run"
+end
+
+== REQUIREMENTS:
+
+appscript
+mocha (if you want to run the tests)
+
+== INSTALL:
+
+sudo gem install hurl
+
+== LICENSE:
+
+Copyright (c) 2008 Justin Marney
+
+This work is licensed under the Creative Commons Attribution 3.0 United States License. To view a copy of this license, visit http://creativecommons.org/licenses/by/3.0/us/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.

data/Rakefile

@@ -0,0 +1,24 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+load 'tasks/setup.rb'
+
+ensure_in_path 'lib'
+require 'hurl'
+
+task :default => 'test'
+
+PROJ.name = 'hurl'
+PROJ.authors = 'Justin Marney'
+PROJ.email = 'gotascii@gmail.com'
+PROJ.url = 'http://hurl.rubyforge.org'
+PROJ.description = "rb-appscript wrapper built to assist in scripting terminal events."
+PROJ.rubyforge_name = 'hurl'
+PROJ.version = Hurl::VERSION
+PROJ.tests = FileList['test/**/*_test.rb']
+PROJ.exclude << '\.git'
+PROJ.exclude << '^_.*'
+depend_on 'rb-appscript'
+
+# EOF

data/bin/hurl

@@ -1,97 +1,15 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 require 'rubygems'
-require 'appscript'
-include Appscript
 
-class Project
-  attr_accessor :project_dir, :appscript
+require File.expand_path(
+    File.join(File.dirname(__FILE__), '..', 'lib', 'hurl'))
 
-  def initialize(dir)
-    @project_dir = dir
-  end
+include Hurl
+self.dir=(ARGV.shift)
+using ITerm
+["", "lib"].each do |path|
+  hurls = File.join(dir, path, 'hurls.rb')
+  require hurls if File.exist? hurls
 end
 
-class Session
-  def initialize(sesh)
-    @session = sesh
-  end
-
-  def method_missing(command, *args)
-    cmd = command.to_s + args.inject('') do |opts, arg| opts += ' ' + arg.to_s end
-    exec(cmd)
-  end
-end
-
-class ITermSession < Session
-  def exec(command)
-    @session.write(:text => command)
-  end
-end
-
-class ITerm < Project
-  def initialize(dir)
-    @appscript = app('iTerm').current_terminal
-    super(dir)
-  end
-  
-  def create_tab
-    @appscript.launch_(:session => "Default Session")
-    yield ITermSession.new(@appscript.sessions.last) if block_given?
-  end
-
-  def this_tab
-    yield ITermSession.new(@appscript.current_session) if block_given?
-  end
-end
-
-class TerminalSession < Session
-  def exec(command)
-    @session.do_script(command, :in => @session)
-  end
-end
-
-class Terminal < Project
-  def initialize(dir)
-    @appscript = app('Terminal').windows[0]
-    super(dir)
-  end
-
-  def create_tab(&block)
-    @appscript.activate
-    app("System Events").keystroke("t", :using => :command_down)
-    yield TerminalSession.new(@appscript.tabs.last) if block_given?
-  end
-
-  def this_tab
-    @appscript.activate
-    yield TerminalSession.new(@appscript.tabs.first) if block_given?
-  end
-end
-
-module Hurler
-  attr_accessor :project_dir
-
-  def using(klass)
-    @wrapper = klass.new(@project_dir)
-  end
-
-  def create_tab(&block)
-    @wrapper.create_tab(&block)
-  end
-
-  def this_tab(&block)
-    @wrapper.this_tab(&block)
-  end
-end
-
-if __FILE__ == $0
-  include Hurler
-  project_dir = ARGV.shift
-  using ITerm
-  ["", "/lib"].each do |path|
-    hurls = "#{project_dir}#{path}/hurls.rb"
-    puts hurls
-    require hurls if File.exist? hurls
-  end
-end

data/hurls.rb

@@ -0,0 +1,4 @@
+create_tab do |t|
+  t.ls
+  t.cd dir
+end

data/lib/hurl/iterm.rb

@@ -0,0 +1,15 @@
+class ITerm < Project
+  def initialize(dir)
+    @appscript = Appscript.app('iTerm').current_terminal
+    super(dir)
+  end
+  
+  def create_tab
+    @appscript.launch_(:session => "Default Session")
+    yield ITermSession.new(@appscript.sessions.last) if block_given?
+  end
+
+  def this_tab
+    yield ITermSession.new(@appscript.current_session) if block_given?
+  end
+end

data/lib/hurl/iterm_session.rb

@@ -0,0 +1,5 @@
+class ITermSession < Session
+  def hurl(cmd)
+    session.write(:text => cmd)
+  end
+end

data/lib/hurl/project.rb

@@ -0,0 +1,7 @@
+class Project
+  attr_accessor :dir, :appscript
+
+  def initialize(directory)
+    @dir = directory
+  end
+end

data/lib/hurl/session.rb

@@ -0,0 +1,15 @@
+class Session
+  attr_reader :session
+
+  def initialize(sesh)
+    @session = sesh
+  end
+
+  def method_missing(command, *args)
+    cmd = command.to_s + args.inject('') do |opts, arg| opts += ' ' + arg.to_s end
+    hurl(cmd)
+  end
+
+  def hurl(cmd)
+  end
+end

data/lib/hurl/terminal.rb

@@ -0,0 +1,17 @@
+class Terminal < Project
+  def initialize(dir)
+    @appscript = Appscript.app('Terminal').windows[0]
+    super(dir)
+  end
+
+  def create_tab
+    @appscript.activate
+    Appscript.app("System Events").keystroke("t", :using => :command_down)
+    yield TerminalSession.new(@appscript.tabs.last) if block_given?
+  end
+
+  def this_tab
+    @appscript.activate
+    yield TerminalSession.new(@appscript.tabs.first) if block_given?
+  end
+end

data/lib/hurl/terminal_session.rb

@@ -0,0 +1,5 @@
+class TerminalSession < Session
+  def hurl(cmd)
+    session.do_script(cmd, :in => session)
+  end
+end

data/lib/hurl.rb

@@ -0,0 +1,27 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'appscript'
+require 'hurl/project'
+require 'hurl/session'
+require 'hurl/iterm_session'
+require 'hurl/terminal_session'
+require 'hurl/terminal'
+require 'hurl/iterm'
+
+module Hurl
+  VERSION = '0.0.3'
+
+  attr_accessor :dir
+
+  def using(klass)
+    @wrapper = klass.new(@dir)
+  end
+
+  def create_tab(&block)
+    @wrapper.create_tab(&block)
+  end
+
+  def this_tab(&block)
+    @wrapper.this_tab(&block)
+  end
+end

data/spec/hurl_spec.rb

@@ -0,0 +1,8 @@
+# $Id$
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Hurl do
+end
+
+# EOF

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# $Id$
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib hurl]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+
+# EOF

data/tasks/ann.rake

@@ -0,0 +1,76 @@
+# $Id$
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  file PROJ.ann_file do
+    puts "Generating #{PROJ.ann_file}"
+    File.open(PROJ.ann_file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      PROJ.ann_paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts PROJ.ann_text if PROJ.ann_text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => PROJ.ann_file
+
+  desc "Send an email announcement"
+  task :email => PROJ.ann_file do
+    from = PROJ.ann_email[:from] || PROJ.email
+    to   = Array(PROJ.ann_email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{PROJ.ann_email[:domain]}>\n\n"
+    rfc822msg << File.read(PROJ.ann_file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      PROJ.ann_email[key]
+    end
+
+    params[3] = PROJ.email if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann_file
+
+# EOF

data/tasks/annotations.rake

@@ -0,0 +1,22 @@
+# $Id$
+
+if HAVE_BONES
+
+desc "Enumerate all annotations"
+task :notes do
+  Bones::AnnotationExtractor.enumerate(
+      PROJ, PROJ.annotation_tags.join('|'), :tag => true)
+end
+
+namespace :notes do
+  PROJ.annotation_tags.each do |tag|
+    desc "Enumerate all #{tag} annotations"
+    task tag.downcase.to_sym do
+      Bones::AnnotationExtractor.enumerate(PROJ, tag)
+    end
+  end
+end
+
+end  # if HAVE_BONES
+
+# EOF

data/tasks/bones.rake

@@ -0,0 +1,40 @@
+# $Id$
+
+require 'pp'
+require 'stringio'
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if ARGV.length == 2
+      t.application.top_level_tasks.pop
+    end
+    sio = StringIO.new
+    sep = "\n" + ' '*27
+    fmt = "%23s => %s"
+
+    if atr
+      PP.pp(PROJ.send(atr.to_sym), sio, 49)
+      sio.seek 0
+      val = sio.read
+      val = val.split("\n").join(sep)
+
+      puts fmt % [atr, val]
+    else
+      h = PROJ.instance_variable_get(:@table)
+      h.keys.map {|k| k.to_s}.sort.each do |k|
+        sio.truncate 0
+        PP.pp(h[k.to_sym], sio, 49)
+        sio.seek 0
+        val = sio.read
+        val = val.split("\n").join(sep)
+
+        puts fmt % [k, val]
+      end
+    end
+  end
+
+end  # namespace :bones
+
+# EOF

data/tasks/doc.rake

@@ -0,0 +1,48 @@
+# $Id$
+
+require 'rake/rdoctask'
+
+namespace :doc do
+
+  desc 'Generate RDoc documentation'
+  Rake::RDocTask.new do |rd|
+    rd.main = PROJ.rdoc_main
+    rd.rdoc_dir = PROJ.rdoc_dir
+
+    incl = Regexp.new(PROJ.rdoc_include.join('|'))
+    excl = Regexp.new(PROJ.rdoc_exclude.join('|'))
+    files = PROJ.files.find_all do |fn|
+              case fn
+              when excl; false
+              when incl; true
+              else false end
+            end
+    rd.rdoc_files.push(*files)
+
+    title = "#{PROJ.name}-#{PROJ.version} Documentation"
+    title = "#{PROJ.rubyforge_name}'s " + title if PROJ.rubyforge_name != title
+
+    rd.options << "-t #{title}"
+    rd.options.concat(PROJ.rdoc_opts)
+  end
+
+  desc 'Generate ri locally for testing'
+  task :ri => :clobber_ri do
+    sh "#{RDOC} --ri -o ri ."
+  end
+
+  task :clobber_ri do
+    rm_r 'ri' rescue nil
+  end
+
+end  # namespace :doc
+
+desc 'Alias to doc:rdoc'
+task :doc => 'doc:rdoc'
+
+desc 'Remove all build products'
+task :clobber => %w(doc:clobber_rdoc doc:clobber_ri)
+
+remove_desc_for_task %w(doc:clobber_rdoc)
+
+# EOF