delano-drydock 0.3.2 → 0.3.3

data/CHANGES.txt

@@ -1,5 +1,16 @@
 DRYDOCK, CHANGES
 
+TODO:
+* Fix '-' '_' ambiguity for option names
+* Calls valid? method (if present) before calling command block.
+
+
+#### 0.3.3 (2009-02-14) ###############################
+
+* NEW: init method hook for subclasses of Drydock::Command
+* UPDATED: Rdocs
+
+
 #### 0.3 (2009-02-05) ###############################
 
 * Added support for custom Drydock::Commands objects
@@ -10,6 +21,7 @@ DRYDOCK, CHANGES
 * Started adding tests
 * Improved documentation
 
+
 #### 0.2 (2008-12-27) ###############################
 
 * Initial release

data/README.rdoc

@@ -62,7 +62,9 @@ See bin/example for more.
   
 == More Information
 
-http://www.youtube.com/watch?v=m_wFEB4Oxlo
+* http://github.com/delano/drydock
+* http://drydock.rubyforge.org/ (rdocs)
+* http://www.youtube.com/watch?v=m_wFEB4Oxlo
 
 == Credits
 

data/Rakefile

@@ -11,7 +11,12 @@ task :default => :test
  
 desc 'Run specs with unit test style output'
 task :test do |t|
-  sh "ruby tests/*_test.rb"
+  sh "ruby test/*_test.rb"
+end
+
+desc 'Run bin/example and tryouts'
+task :tryouts do |t|
+  sh "ruby bin/example"
 end
 
 # PACKAGE =============================================================
@@ -40,20 +45,20 @@ end
 
 desc 'Publish website to rubyforge'
 task 'publish:doc' => 'doc/index.html' do
-  sh 'scp -rp doc/* rubyforge.org:/var/www/gforge-projects/drydock/'
+  sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
 end
-puts "rubyforge add_release drydock drydock #{@spec.version} pkg/drydock-#{@spec.version}.gem "
+
 task 'publish:gem' => [:package] do |t|
   sh <<-end
-    rubyforge add_release -o Any -a CHANGES.txt -f -n README.rdoc drydock drydock #{@spec.version} pkg/drydock-#{@spec.version}.gem &&
-    rubyforge add_file -o Any -a CHANGES.txt -f -n README.rdoc drydock drydock #{@spec.version} pkg/drydock-#{@spec.version}.tgz 
+    rubyforge add_release -o Any -a CHANGES.txt -f -n README.rdoc #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
+    rubyforge add_file -o Any -a CHANGES.txt -f -n README.rdoc #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
   end
 end
 
 
 Rake::RDocTask.new do |t|
 	t.rdoc_dir = 'doc'
-	t.title    = "Drydock, A seaworthy DSL for command-line apps."
+	t.title    = @spec.summary
 	t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
 	t.options << '--charset' << 'utf-8'
 	t.rdoc_files.include('LICENSE.txt')

data/bin/example

@@ -1,5 +1,15 @@
 #!/usr/bin/env ruby
 
+# Seafaring Drydock Examples
+# 
+# This is a functioning script so you can copy it, run it, 
+# and just generally be a longshoreman about things. This is
+# a Drydock after all. 
+#
+# If you're reading this via the Rdocs you won't see the code. Try:
+#
+# http://github.com/delano/drydock/blob/master/bin/example
+
 $:.unshift File.expand_path(File.join(File.dirname(__FILE__), '..')), 'lib'
 
 require 'drydock'
@@ -17,9 +27,8 @@ end
 
 command :welcome do
 # Example: ruby bin/example
-
-  puts "Meatwad: Science is a mystery to man, isn't it Frylock?"
-  print "Frylock: At least we have some commands: "
+  
+  puts "Welcome to Drydock. You have the following commands:"
   
   # The commands method returns a hash of Drydock::Command objects
   puts commands.keys.inject([]) { |list, command| list << command.to_s }.sort.join(', ')
@@ -142,7 +151,7 @@ end
 # return the HTTP response code for the given URI
 # +uri+ A valid HTTP URI
 # +duration+ The timeout threshold (in seconds) for the request. 
-def response_code(uri_str, duration=5)
+def response_code(uri_str, duration=5) #:nodoc:
   response = :unavailable
   begin 
     uri = (uri_str.kind_of? URI::HTTP) ? uri_str : URI.parse(uri_str) 

data/drydock.gemspec

@@ -1,6 +1,6 @@
 @spec = Gem::Specification.new do |s|
   s.name = %q{drydock}
-  s.version = "0.3.2"
+  s.version = "0.3.3"
   s.specification_version = 1 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 

data/lib/drydock.rb

@@ -24,6 +24,12 @@ module Drydock
   #
   class Command
     attr_reader :cmd, :alias
+    
+    # The default constructor sets the short name of the command
+    # and stores a reference to the block (if supplied).
+    # You don't need to override this method to add functionality 
+    # to your custom Command classes. Define an +init+ method instead.
+    # It will be called just before the block is executed. 
     # +cmd+ is the short name of this command.
     # +b+ is the block associated to this command.
     def initialize(cmd, &b)
@@ -33,6 +39,8 @@ module Drydock
     
     # Execute the block.
     # 
+    # Calls self.init before calling the block. Implement this method when 
+    #
     # +cmd_str+ is the short name used to evoke this command. It will equal @cmd
     # unless an alias was used used to evoke this command.
     # +argv+ an array of unnamed arguments. If ignore :options was declared this
@@ -45,6 +53,9 @@ module Drydock
       global_options.merge(options).each_pair do |n,v|
         self.send("#{n}=", v)
       end
+      
+      self.init if respond_to? :init
+      
       block_args = [self, argv, stdin] # TODO: review order
       @b.call(*block_args[0..(@b.arity-1)]) # send only as many args as defined
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: delano-drydock
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Delano Mandelbaum