drydock 0.5.1 → 0.5.2

data/CHANGES.txt

@@ -4,32 +4,37 @@ DRYDOCK, CHANGES
 
 * Support putting descriptions into resource file (or __END__)
 * Define aliases with "command [:name, :alias]"
-* Add Drydock::Console, Drydock::Window, Drydock::Cursor
-* Generate scripts in the form: script-action
-  * globals can be configured with env vars.
-  * Motivation to stick to a single environment (just stage)
-* Add convenience methods for system calls: sh, write, read 
+
+
+#### 0.5.2 (2009-04-05) #############################
+
+* ADDED: before and after blocks now receive a primed reference to the 
+command object (which gives them access to the globals and options)
+* CHANGE: The prep stuff in Drydock::Command#call is now split into a
+separate method: prepare so call no longer takes arguments. 
+* FIXED: Drydock#capture_io was using yield. It now accepts a block instead. 
+
 
 #### 0.5.1 (2009-03-15) #############################
 
-* FIX: Prevent calling default command in at_exit when there's a LoadError.
-* FIX: Exit gracefully when the application exits. 
-* FIX: Print command names with dashes rather than underscores
+* FIXED: Prevent calling default command in at_exit when there's a LoadError.
+* FIXED: Exit gracefully when the application exits. 
+* FIXED: Print command names with dashes rather than underscores
 
 
 #### 0.5 (2009-03-11) ###############################
 
-* NEW: Checks that the command class is a subclass of Drydock::Command
+* ADDED: Checks that the command class is a subclass of Drydock::Command
 * CHANGE: Cleaned up show-commands screen
 * FIXED: Help didn't work when using command alias
-* NEW: Named argv values.
+* ADDED: Named argv values.
 * CHANGE: argv are now part of the Command class (not passed to command blocks)
 * CHANGE: "project" now automatically requires the lowercase name of the project
 and gracefully continues if the require failed. 
 * CHANGE: Drydock will look for different validation method, based on the method 
 being executed. If a validation method is found it's executed and
 must return a true valid (it can also raise its own exceptions).
-* NEW: command actions. These are boolean switches with a twist. Drydock looks
+* ADDED: command actions. These are boolean switches with a twist. Drydock looks
 for command_action or action_command methods. Saves checking the switches
 and sending to other methods manually.
 
@@ -37,26 +42,26 @@ and sending to other methods manually.
 #### 0.4 (2009-02-28) ###############################
 
 * FIXED: "interning empty string" error when bare "option" is used
-* NEW: Calls valid? method (if present) before calling command block.
-* NEW: "capture" method. Auto capture STDOUT to obj.stdout etc...
-* NEW: Automatically calls init and print_header methods before the command
+* ADDED: Calls valid? method (if present) before calling command block.
+* ADDED: "capture" method. Auto capture STDOUT to obj.stdout etc...
+* ADDED: Automatically calls init and print_header methods before the command
        and print_footer after the command (if available)
-* NEW: Tries to call obj.command if available when no block is supplied
-* NEW: "show_commands" command built-in. Displays commands with descriptions
-* NEW: A default usage help msg for every command: "#{$0} command-name"
-* NEW: "usage" work multiple times for the same command. 
-* NEW: "desc" method for per command descriptions
+* ADDED: Tries to call obj.command if available when no block is supplied
+* ADDED: "show_commands" command built-in. Displays commands with descriptions
+* ADDED: A default usage help msg for every command: "#{$0} command-name"
+* ADDED: "usage" work multiple times for the same command. 
+* ADDED: "desc" method for per command descriptions
 * CHANGE: options are now stored as obj.option.name instead of obj.name
 * CHANGE: global options are now stored as obj.globals.name
 * CHANGE: removed auto importing methods
     OLD: require 'drydock'
-    NEW: require 'drydock'
+    ADDED: require 'drydock'
          extend Drydock
 
 
 #### 0.3.3 (2009-02-14) ###############################
 
-* NEW: init method hook for subclasses of Drydock::Command
+* ADDED: init method hook for subclasses of Drydock::Command
 * UPDATED: Rdocs
 * CHANGE: added method command_aliaz to mirror aliaz_command
 

data/bin/example

@@ -26,16 +26,6 @@ default :welcome   # The welcome command will be run if no command is given
 capture :stderr    # Drydock will capture STDERR and keep it in the hold.
                    # You can use this to suppress errors. 
 
-project "Drydock Example"  # An optional name
-
-before do
-# You can execute a block before the requests command is executed. Instance
-# variables defined here will be available to all commands.
-end
-
-after do
-# And this will be called after the command. 
-end
 
 desc "A friendly welcome to the Drydock"
 command :welcome do
@@ -65,6 +55,15 @@ global :v, :verbose, "Verbosity level (i.e. -vvv is greater than -v)" do |v|
   @val += 1
 end
 
+before do |obj|
+# You can execute a block before the requests command is executed. Instance
+# variables defined here will be available to all commands. 
+# +obj+ is a reference to the command object, just like in command blocks. 
+end
+
+after do |obj|
+# And this will be called after the command. 
+end
 
 usage "#{$0} [-s] [-vv] date"
 desc "Display the current date"

data/drydock.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = %q{drydock}
-  s.version = "0.5.1"
-  s.date = %q{2009-03-15}
+  s.version = "0.5.2"
+  s.date = %q{2009-04-05}
   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

@@ -110,9 +110,11 @@ module Drydock
       @cmd
     end
     
-    # Execute the block.
+    # Prepare this command object to be called. 
     # 
-    # Calls self.init before calling the block. Implement this method when 
+    # Calls self.init after setting attributes (if the method exists). You can 
+    # implement an init method in your subclasses of Drydock::Command to handle
+    # your own initialization stuff.
     #
     # <li>+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.</li>
@@ -121,7 +123,7 @@ module Drydock
     # <li>+stdin+ contains the output of stdin do; ...; end otherwise it's a STDIN IO handle.</li>
     # <li>+global_options+ a hash of the global options specified on the command-line</li>
     # <li>+options+ a hash of the command-specific options specific on the command-line.</li>
-    def call(cmd_str=nil, argv=[], stdin=[], global_options={}, options={})
+    def prepare(cmd_str=nil, argv=[], stdin=[], global_options={}, options={})
       @alias = cmd_str.nil? ? @cmd : cmd_str
 
       global_options.each_pair do |n,v|
@@ -132,19 +134,28 @@ module Drydock
         self.option.send("#{n}=", v)    # ... and also the command options
       end
       
-      
       @argv << argv    # TODO: Using += returns an Array instead of FancyArray
       @argv.flatten!   # NOTE: << creates @argv[[]]
       @stdin = stdin
       
       self.init         if self.respond_to? :init     # Must be called first!
-      self.print_header if self.respond_to? :print_header
       
+    end
+    
+    # Calls the command in the following order:
+    # 
+    # * print_header
+    # * validation (if methodname_valid? exists)
+    # * command block (@b)
+    # * print_footer
+    #
+    def call  
+      self.print_header if self.respond_to? :print_header
       if @b 
         run_validation
         @b.call(self) 
         
-      elsif !(chosen = find_action(options)).empty?
+      elsif !(chosen = find_action(self.option)).empty?
         raise "Only one action at a time please! I can't #{chosen.join(' AND ')}." if chosen.size > 1
         criteria = [[@cmd, chosen.first], [chosen.first, @cmd]]
         meth = name = nil
@@ -167,7 +178,6 @@ module Drydock
       end
       
       self.print_footer if respond_to? :print_footer
-      
     end
     
     # <li>+meth+ The method name used to determine the name of the validation method.
@@ -199,6 +209,7 @@ module Drydock
     # OptionParser#getopts)</li>
     # Returns an array of action names (empty if no action was supplied)
     def find_action(options)
+      options = options.marshal_dump if options.is_a?(OpenStruct)
       boolkeys = options.keys.select { |n| options[n] == true } || []
       (@actions || []) & boolkeys # an array of requested actions (or empty)
     end
@@ -341,19 +352,19 @@ module Drydock
     @@command_argv_names[@@command_index] += args.flatten
   end
   
-  # The project of the script. This is currently only used when printing
+  # The project name. This is currently only used when printing
   # list of commands (see: Drydock::Command#show_commands). It may be 
   # used elsewhere in the future. 
   def project(txt=nil)
     
     return @@project unless txt
     
-    begin
-      require txt.downcase
-    rescue LoadError => ex
-      Drydock.run = false  # Prevent execution at_exit
-      abort "Problem during require: #{ex.message}"
-    end
+    #begin
+    #  require txt.downcase
+    #rescue LoadError => ex
+    #  Drydock.run = false  # Prevent execution at_exit
+    #  abort "Problem during require: #{ex.message}"
+    #end
     @@project = txt
   end
   
@@ -509,7 +520,7 @@ module Drydock
   #     end
   #
   def command(*cmds, &b)
-    cmd = cmds.first
+    cmd = cmds.first # Should we accept aliases here?
     
     if cmd.is_a? Hash
       raise "#{cmd.values.first} is not a subclass of Drydock::Command" unless cmd.values.first.ancestors.member?(Drydock::Command)
@@ -616,13 +627,18 @@ module Drydock
     raise UnknownCommand.new(cmd_name) unless command?(cmd_name)
     
     stdin = (defined? @@stdin_block) ? @@stdin_block.call(stdin, []) : stdin
-    @@before_block.call if defined? @@before_block
     
-    command_portion = lambda { call_command(cmd_name, argv, stdin, global_options, command_options) }
-
-    capture? ? (@@captured = capture_io(@@capture, &command_portion)) : command_portion.call
+    command_obj = get_command(cmd_name)
+    command_obj.prepare(cmd_name, argv, stdin, global_options, command_options)
+    
+    # Execute before block
+    @@before_block.call(command_obj) if defined? @@before_block
     
-    @@after_block.call if defined? @@after_block
+    # Execute the requested command. We'll capture STDERR or STDOUT if desired. 
+    @@captured = capture? ? capture_io(@@capture) { command_obj.call } : command_obj.call
+        
+    # Execute after block
+    @@after_block.call(command_obj) if defined? @@after_block
     
   rescue OptionParser::InvalidOption => ex
     raise Drydock::InvalidArgument.new(ex.args)
@@ -669,11 +685,11 @@ module Drydock
   #      ...
   #    end
   #
-  def capture_io(stream)
+  def capture_io(stream, &block)
     raise "We can only capture STDOUT or STDERR" unless stream == :stdout || stream == :stderr
     begin
       eval "$#{stream} = StringIO.new"
-      yield
+      block.call
       eval("$#{stream}").rewind                  # Otherwise we'll get nil 
       result = eval("$#{stream}").read
     ensure
@@ -683,12 +699,6 @@ module Drydock
   
  private 
   
-  # Executes the block associated to +cmd+
-  def call_command(cmd, argv=[], stdin=nil, global_options={}, command_options={})
-    return unless command?(cmd)
-    get_command(cmd).call(cmd, argv, stdin, global_options || {}, command_options || {})
-  end
-  
   # Returns the Drydock::Command object with the name +cmd+
   def get_command(cmd)
     return unless command?(cmd)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: drydock
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-15 00:00:00 -04:00
+date: 2009-04-05 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -57,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: drydock
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 1
 summary: A seaworthy DSL for writing command line apps