deployml 0.4.2 → 0.5.0

data/ChangeLog.md

@@ -1,3 +1,24 @@
+### 0.5.0 / 2011-04-22
+
+* Added support for specifying multiple `dest` URIs.
+* Added support for specifying `before` and `after` commands.
+* Added {DeploYML::Configuration#each_dest}.
+* Added {DeploYML::Configuration#normalize}.
+* Added {DeploYML::Configuration#normalize_array}.
+* Added {DeploYML::Configuration#parse_address}.
+* Added {DeploYML::Configuration#parse_dest}.
+* Added {DeploYML::Configuration#parse_commands}.
+* Added {DeploYML::Environment#invoke_task}.
+* Added {DeploYML::Environment#config}.
+* Added {DeploYML::Environment#start}.
+* Added {DeploYML::Environment#stop}.
+* Added {DeploYML::Environment#restart}.
+* Added {DeploYML::Shell#uri}.
+* Added {DeploYML::Shell#exec}.
+* Converted {DeploYML::Shell} into a Class.
+* Raise an exception in {DeploYML::RemoteShell#ssh_uri} if the Shell URI
+  does not have a host component.
+
 ### 0.4.2 / 2011-04-11
 
 * Require rprogram ~> 0.2.
@@ -29,7 +50,7 @@
   * `start!`
   * `stop!`
 * Added {DeploYML::Shell#status} for printing ANSI colored status messages.
-* Added {DeploYML::RemoteShell#uri}.
+* Added `DeploYML::RemoteShell#uri`.
 * Added {DeploYML::RemoteShell#history}.
 * Added missing documentation.
 * Give the root directory passed to {DeploYML::Project#initialize} the

data/README.md

@@ -13,8 +13,9 @@ Git and SSH.
 ## Features
 
 * Requires only **one YAML file** (`config/deploy.yml`) with a minimum of
-  **two** things (`source` and `dest`).
+  **two** settings (`source` and `dest`).
 * Supports multiple deployment environments (`config/deploy/staging.yml`).
+* Supports multiple deployment destinations.
 * Supports [Git](http://www.git-scm.com/).
 * Can deploy Ruby web applications or static sites.
 * Supports common Web Servers:
@@ -31,7 +32,7 @@ Git and SSH.
 * Supports any Operating System that supports Ruby and SSH.
 * Provides a simple command-line interface using Thor.
 
-## Examples
+## Configuration Examples
 
 Specifying `source` and `dest` URIs as Strings:
 
@@ -46,6 +47,14 @@ Specifying `dest` URI as a Hash:
       host: www.example.com
       path: /var/www/site
 
+Specify multiple `dest` URIs:
+
+    source: git@github.com:user/project.git
+    dest:
+      - deploy@www1.example.com/var/www/site
+      - deploy@www2.example.com/var/www/site
+      - deploy@www3.example.com/var/www/site
+
 Specifying a `server` option:
 
     source: git@github.com:user/project.git
@@ -60,9 +69,9 @@ Specifying a `server` with options:
       name: thin
       options:
         servers: 4
-	deamonize: true
-	socket: /var/run/thin.sock
-	rackup: true
+    deamonize: true
+    socket: /var/run/thin.sock
+    rackup: true
 
 Multiple environments:
 
@@ -87,6 +96,18 @@ Multiple environments:
         config: /etc/thin/example.yml
         socket: /tmp/thin.example.sock
 
+Specifying before/after commands:
+
+    before:
+      restart: rm public/some/file
+    
+    after:
+      install:
+        - mkdir tmp
+        - mkdir tmp/pids
+        - mkdir log
+      update: rake post_deploy
+
 ## Synopsis
 
 Cold-Deploy a new project:

data/lib/deployml/configuration.rb

@@ -1,4 +1,5 @@
 require 'deployml/exceptions/missing_option'
+require 'deployml/exceptions/invalid_config'
 
 require 'addressable/uri'
 
@@ -12,6 +13,18 @@ module DeploYML
     # Default SCM to use
     DEFAULT_SCM = :rsync
 
+    # Valid task names
+    TASKS = [
+      :setup,
+      :update,
+      :install,
+      :migrate,
+      :config,
+      :start,
+      :stop,
+      :restart
+    ]
+
     # The server run the deployed project under
     attr_reader :server_name
 
@@ -39,6 +52,12 @@ module DeploYML
     # Specifies whether to enable debugging.
     attr_accessor :debug
 
+    # The arbitrary commands to run before various tasks
+    attr_reader :before
+
+    # The arbitrary commands to run after various tasks
+    attr_reader :after
+
     #
     # Creates a new {Configuration} using the given configuration.
     #
@@ -48,8 +67,8 @@ module DeploYML
     # @option config [String] :source
     #   The source URI of the project Git repository.
     #
-    # @option config [String, Hash] :dest
-    #   The destination URI to upload the project to.
+    # @option config [Array<String, Hash>, String, Hash] :dest
+    #   The destination URI(s) to upload the project to.
     #
     # @option config [Boolean] :bundler
     #   Specifies whether the projects dependencies are controlled by
@@ -71,67 +90,86 @@ module DeploYML
     #   The `server` option Hash did not contain a `name` option.
     #
     def initialize(config={})
-      @source = nil
-      @dest = nil
+      config = normalize_hash(config)
 
-      @server_name = nil
-      @server_options = {}
+      @bundler = config.fetch(:bundler,false)
 
-      @bundler = false
-      @framework = nil
-      @orm = nil
+      @framework = if config[:framework]
+                     config[:framework].to_sym
+                   end
 
-      @environment = nil
-      @debug = false
+      @orm = if config[:orm]
+               config[:orm].to_sym
+             end
 
-      config = normalize_hash(config)
+      @server_name, @server_options = parse_server(config[:server])
 
-      @bundler = config[:bundler]
+      @source = config[:source]
+      @dest = if config[:dest]
+                parse_dest(config[:dest])
+              end
 
-      if config[:framework]
-        @framework = config[:framework].to_sym
-      end
+      @environment = if config[:environment]
+                       config[:environment].to_sym
+                     end
 
-      if config[:orm]
-        @orm = config[:orm].to_sym
-      end
+      @debug = config.fetch(:debug,false)
 
-      case config[:server]
-      when Symbol, String
-        @server_name = config[:server].to_sym
-      when Hash
-        unless config[:server].has_key?(:name)
-          raise(MissingOption,"the 'server' option must contain a 'name' option for which server to use",caller)
-        end
+      @before = {}
+      @after = {}
 
-        if config[:server].has_key?(:name)
-          @server_name = config[:server][:name].to_sym
+      TASKS.each do |task|
+        if (config.has_key?(:before) && config[:before].has_key?(task))
+          @before[task] = parse_commands(config[:before][task])
         end
 
-        if config[:server].has_key?(:options)
-          @server_options.merge!(config[:server][:options])
+        if (config.has_key?(:after) && config[:after].has_key?(task))
+          @after[task] = parse_commands(config[:after][task])
         end
       end
+    end
 
-      @source = config[:source]
-      @dest = case config[:dest]
-              when Hash
-                Addressable::URI.new(config[:dest])
-              when String
-                Addressable::URI.parse(config[:dest])
-              end
-
-      if config[:environment]
-        @environment = config[:environment].to_sym
-      end
+    #
+    # Iterates over each destination.
+    #
+    # @yield [dest]
+    #   The given block will be passed each destination URI.
+    #
+    # @yieldparam [Addressable::URI] dest
+    #   A destination URI.
+    #
+    # @return [Enumerator]
+    #   If no block is given, an Enumerator object will be returned.
+    #
+    # @since 0.5.0
+    #
+    def each_dest(&block)
+      return enum_for(:each_dest) unless block_given?
 
-      if config[:debug]
-        @debug = config[:debug]
+      if @dest.kind_of?(Array)
+        @dest.each(&block)
+      elsif @dest
+        yield @dest
       end
     end
 
     protected
 
+    #
+    # Normalizes an Array.
+    #
+    # @param [Array] array
+    #   The Array to normalize.
+    #
+    # @return [Array]
+    #   The normalized Array.
+    #
+    # @since 0.5.0
+    #
+    def normalize_array(array)
+      array.map { |value| normalize(value) }
+    end
+
     #
     # Converts all the keys of a Hash to Symbols.
     #
@@ -145,15 +183,132 @@ module DeploYML
       new_hash = {}
 
       hash.each do |key,value|
-        new_hash[key.to_sym] = if value.kind_of?(Hash)
-                                 normalize_hash(value)
-                               else
-                                 value
-                               end
+        new_hash[key.to_sym] = normalize(value)
       end
 
       return new_hash
     end
 
+    #
+    # Normalizes a value.
+    #
+    # @param [Hash, Array, Object] value
+    #   The value to normalize.
+    #
+    # @return [Hash, Array, Object]
+    #   The normalized value.
+    #
+    # @since 0.5.0
+    #
+    def normalize(value)
+      case value
+      when Hash
+        normalize_hash(value)
+      when Array
+        normalize_array(value)
+      else
+        value
+      end
+    end
+
+    #
+    # Parses the value for the `server` setting.
+    #
+    # @return [Array<Symbol, Hash>]
+    #   The name of the server and additional options.
+    #
+    # @since 0.5.0
+    #
+    def parse_server(server)
+      name = nil
+      options = {}
+
+      case server
+      when Symbol, String
+        name = server.to_sym
+      when Hash
+        unless server.has_key?(:name)
+          raise(MissingOption,"the 'server' option must contain a 'name' option for which server to use",caller)
+        end
+
+        if server.has_key?(:name)
+          name = server[:name].to_sym
+        end
+
+        if server.has_key?(:options)
+          options.merge!(server[:options])
+        end
+      end
+
+      return [name, options]
+    end
+
+    #
+    # Parses an address.
+    #
+    # @param [Hash, String] address
+    #   The address to parse.
+    #
+    # @return [Addressable::URI]
+    #   The parsed address.
+    #
+    # @since 0.5.0
+    #
+    def parse_address(address)
+      case address
+      when Hash
+        Addressable::URI.new(address)
+      when String
+        Addressable::URI.parse(address)
+      else
+        raise(InvalidConfig,"invalid address: #{address.inspect}",caller)
+      end
+    end
+
+    #
+    # Parses the value for the `dest` setting.
+    #
+    # @param [Array, Hash, String] dest
+    #   The value of the `dest` setting.
+    #
+    # @return [Array<Addressable::URI>, Addressable::URI]
+    #   The parsed `dest` value.
+    #
+    # @since 0.5.0
+    #
+    def parse_dest(dest)
+      case dest
+      when Array
+        dest.map { |address| parse_address(address) }
+      else
+        parse_address(dest)
+      end
+    end
+
+    #
+    # Parses a command.
+    #
+    # @param [Array, String] command
+    #   The command or commands to parse.
+    #
+    # @return [Array<String>]
+    #   The individual commands.
+    #
+    # @raise [InvalidConfig]
+    #   The command must be either an Array of a String.
+    #
+    # @since 0.5.0
+    #
+    def parse_commands(command)
+      case command
+      when Array
+        command.map { |line| line.to_s }
+      when String
+        command.enum_for(:each_line).map { |line| line.chomp }
+      else
+        raise(InvalidConfig,"commands must be an Array or a String")
+      end
+    end
+
   end
 end

data/lib/deployml/environment.rb

@@ -46,11 +46,11 @@ module DeploYML
       super(config)
 
       unless @source
-        raise(MissingOption,":source option is missing for the #{@name} environment")
+        raise(MissingOption,":source option is missing for the #{@name} environment",caller)
       end
 
       unless @dest
-        raise(MissingOption,":dest option is missing for the #{@name} environment")
+        raise(MissingOption,":dest option is missing for the #{@name} environment",caller)
       end
 
       @environment ||= name.to_sym
@@ -68,13 +68,13 @@ module DeploYML
     # @yieldparam [LocalShell] shell
     #   The remote shell session.
     #
-    # @return [LocalShell]
+    # @return [Array<LocalShell>]
     #   The local shell.
     #
     # @since 0.3.0
     #
     def local_shell(&block)
-      LocalShell.new(&block)
+      each_dest.map { |dest| LocalShell.new(dest,&block) }
     end
 
     #
@@ -83,20 +83,24 @@ module DeploYML
     # @yield [shell]
     #   If a block is given, it will be passed the new remote shell.
     #
-    # @yieldparam [RemoteShell] shell
+    # @yieldparam [LocalShell, RemoteShell] shell
     #   The remote shell.
     #
-    # @return [RemoteShell, LocalShell]
+    # @return [Array<RemoteShell, LocalShell>]
     #   The remote shell. If the destination is a local `file://` URI,
     #   a local shell will be returned instead.
     #
     # @since 0.3.0
     #
     def remote_shell(&block)
-      unless @dest.scheme == 'file'
-        RemoteShell.new(@dest,&block)
-      else
-        LocalShell.new(&block)
+      each_dest.map do |dest|
+        shell = if dest.scheme == 'file'
+                  LocalShell
+                else
+                  RemoteShell
+                end
+
+        shell.new(dest,&block)
       end
     end
 
@@ -110,8 +114,8 @@ module DeploYML
     #
     def exec(command)
       remote_shell do |shell|
-        shell.cd(@dest.path)
-        shell.run(command)
+        shell.cd(shell.uri.path)
+        shell.exec(command)
       end
 
       return true
@@ -125,10 +129,10 @@ module DeploYML
     #
     # @since 0.3.0
     #
-    def rake(task,*args)
+    def rake(task,*arguments)
       remote_shell do |shell|
-        shell.cd(@dest.path)
-        shell.rake(task,*args)
+        shell.cd(shell.uri.path)
+        shell.rake(task,*arguments)
       end
 
       return true
@@ -137,22 +141,25 @@ module DeploYML
     #
     # Starts an SSH session with the destination server.
     #
-    # @param [Array] args
+    # @param [Array] arguments
     #   Additional arguments to pass to SSH.
     #
     # @return [true]
     #
     # @since 0.3.0
     #
-    def ssh(*args)
-      RemoteShell.new(@dest).ssh(*args)
+    def ssh(*arguments)
+      each_dest do |dest|
+        RemoteShell.new(dest).ssh(*arguments)
+      end
+
       return true
     end
 
     #
     # Sets up the deployment repository for the project.
     #
-    # @param [RemoteShell] shell
+    # @param [Shell] shell
     #   The remote shell to execute commands through.
     #
     # @since 0.3.0
@@ -160,21 +167,21 @@ module DeploYML
     def setup(shell)
       shell.status "Cloning #{@source} ..."
 
-      shell.run 'git', 'clone', '--depth', 1, @source, @dest.path
+      shell.run 'git', 'clone', '--depth', 1, @source, shell.uri.path
 
-      shell.status "Cloned."
+      shell.status "Cloned #{@source}."
     end
 
     #
     # Updates the deployed repository for the project.
     #
-    # @param [RemoteShell] shell
+    # @param [Shell] shell
     #   The remote shell to execute commands through.
     #
     # @since 0.3.0
     #
     def update(shell)
-      shell.status "Updating #{@dest.path} ..."
+      shell.status "Updating ..."
 
       shell.run 'git', 'reset', '--hard', 'HEAD'
       shell.run 'git', 'pull', '-f'
@@ -185,7 +192,7 @@ module DeploYML
     #
     # Installs any additional dependencies.
     #
-    # @param [RemoteShell] shell
+    # @param [Shell] shell
     #   The remote shell to execute commands through.
     #
     # @since 0.3.0
@@ -203,7 +210,7 @@ module DeploYML
     #
     # Place-holder method.
     #
-    # @param [RemoteShell] shell
+    # @param [Shell] shell
     #   The remote shell to execute commands through.
     #
     # @since 0.3.0
@@ -214,7 +221,7 @@ module DeploYML
     #
     # Place-holder method.
     #
-    # @param [RemoteShell] shell
+    # @param [Shell] shell
     #   The remote shell to execute commands through.
     #
     # @since 0.3.0
@@ -225,7 +232,7 @@ module DeploYML
     #
     # Place-holder method.
     #
-    # @param [RemoteShell] shell
+    # @param [Shell] shell
     #   The remote shell to execute commands through.
     #
     # @since 0.3.0
@@ -236,7 +243,7 @@ module DeploYML
     #
     # Place-holder method.
     #
-    # @param [RemoteShell] shell
+    # @param [Shell] shell
     #   The remote shell to execute commands through.
     #
     # @since 0.3.0
@@ -247,7 +254,7 @@ module DeploYML
     #
     # Place-holder method.
     #
-    # @param [RemoteShell] shell
+    # @param [Shell] shell
     #   The remote shell to execute commands through.
     #
     # @since 0.3.0
@@ -255,6 +262,84 @@ module DeploYML
     def server_restart(shell)
     end
 
+    #
+    # Place-holder method.
+    #
+    # @param [Shell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.5.0
+    #
+    def config(shell)
+      server_config(shell)
+    end
+
+    #
+    # Place-holder method.
+    #
+    # @param [Shell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.5.0
+    #
+    def start(shell)
+      server_start(shell)
+    end
+
+    #
+    # Place-holder method.
+    #
+    # @param [Shell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.5.0
+    #
+    def stop(shell)
+      server_stop(shell)
+    end
+
+    #
+    # Place-holder method.
+    #
+    # @param [Shell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.5.0
+    #
+    def restart(shell)
+      server_restart(shell)
+    end
+
+    #
+    # Invokes a task.
+    #
+    # @param [Symbol] task
+    #   The name of the task to run.
+    #
+    # @param [Shell] shell
+    #   The shell to run the task in.
+    #
+    # @raise [RuntimeError]
+    #   The task name was not known.
+    #
+    # @since 0.5.0
+    #
+    def invoke_task(task,shell)
+      unless TASKS.include?(task)
+        raise("invalid task: #{task}")
+      end
+
+      if @before.has_key?(task)
+        @before[task].each { |command| shell.exec(command) }
+      end
+
+      send(task,shell) if respond_to?(task)
+
+      if @after.has_key?(task)
+        @after[task].each { |command| shell.exec(command) }
+      end
+    end
+
     #
     # Deploys the project.
     #
@@ -269,28 +354,27 @@ module DeploYML
     def invoke(tasks)
       remote_shell do |shell|
         # setup the deployment repository
-        setup(shell) if tasks.include?(:setup)
+        invoke_task(:setup,shell) if tasks.include?(:setup)
 
         # cd into the deployment repository
-        shell.cd @dest.path
+        shell.cd(shell.uri.path)
 
         # update the deployment repository
-        update(shell) if tasks.include?(:update)
+        invoke_task(:update,shell) if tasks.include?(:update)
 
         # framework tasks
-        install(shell) if tasks.include?(:install)
-
-        migrate(shell) if tasks.include?(:migrate)
+        invoke_task(:install,shell) if tasks.include?(:install)
+        ivoke_task(:migrate,shell) if tasks.include?(:migrate)
 
         # server tasks
         if tasks.include?(:config)
-          server_config(shell)
+          invoke_task(:config,shell)
         elsif tasks.include?(:start)
-          server_start(shell)
+          invoke_task(:start,shell)
         elsif tasks.include?(:stop)
-          server_stop(shell)
+          invoke_task(:stop,shell)
         elsif tasks.include?(:restart)
-          server_restart(shell)
+          invoke_task(:restart,shell)
         end
       end
 
@@ -427,12 +511,12 @@ module DeploYML
     def load_framework!
       if @orm
         unless FRAMEWORKS.has_key?(@framework)
-          raise(UnknownFramework,"Unknown framework #{@framework}")
+          raise(UnknownFramework,"Unknown framework #{@framework}",caller)
         end
 
         extend FRAMEWORKS[@framework]
 
-        initialize_framework() if self.respond_to?(:initialize_framework)
+        initialize_framework if respond_to?(:initialize_framework)
       end
     end
 
@@ -446,12 +530,12 @@ module DeploYML
     def load_server!
       if @server_name
         unless SERVERS.has_key?(@server_name)
-          raise(UnknownServer,"Unknown server name #{@server_name}")
+          raise(UnknownServer,"Unknown server name #{@server_name}",caller)
         end
 
         extend SERVERS[@server_name]
 
-        initialize_server() if self.respond_to?(:initialize_server)
+        initialize_server if respond_to?(:initialize_server)
       end
     end
 

data/lib/deployml/frameworks/rails.rb

@@ -10,10 +10,10 @@ module DeploYML
       #
       # @see {Environment#rake}
       #
-      def rake(task,*args)
-        args += ["RAILS_ENV=#{@environment}"]
+      def rake(task,*arguments)
+        arguments += ["RAILS_ENV=#{@environment}"]
 
-        super(task,*args)
+        super(task,*arguments)
       end
     end
   end

data/lib/deployml/local_shell.rb

@@ -4,9 +4,7 @@ module DeploYML
   #
   # Represents a shell running on the local system.
   #
-  class LocalShell
-
-    include Shell
+  class LocalShell < Shell
 
     #
     # Runs a program locally.
@@ -14,14 +12,14 @@ module DeploYML
     # @param [String] program
     #   The name or path of the program to run.
     #
-    # @param [Array<String>] args
+    # @param [Array<String>] arguments
     #   Additional arguments for the program.
     #
-    def run(program,*args)
+    def run(program,*arguments)
       program = program.to_s
-      args = args.map { |arg| arg.to_s }
+      arguments = arguments.map { |arg| arg.to_s }
 
-      system(program,*args)
+      system(program,*arguments)
     end
 
     #

data/lib/deployml/project.rb

@@ -43,7 +43,7 @@ module DeploYML
       @environments_dir = File.join(@root,CONFIG_DIR,ENVIRONMENTS_DIR)
 
       unless (File.file?(@config_file) || File.directory?(@environments_dir))
-        raise(ConfigNotFound,"could not find '#{CONFIG_FILE}' or '#{ENVIRONMENTS_DIR}' in #{root}")
+        raise(ConfigNotFound,"could not find '#{CONFIG_FILE}' or '#{ENVIRONMENTS_DIR}' in #{root}",caller)
       end
 
       load_environments!
@@ -65,7 +65,7 @@ module DeploYML
       name = name.to_sym
 
       unless @environments[name]
-        raise(UnknownEnvironment,"unknown environment: #{name}")
+        raise(UnknownEnvironment,"unknown environment: #{name}",caller)
       end
 
       return @environments[name]
@@ -298,7 +298,7 @@ module DeploYML
       config = YAML.load_file(path)
 
       unless config.kind_of?(Hash)
-        raise(InvalidConfig,"DeploYML file #{path.dump} does not contain a Hash")
+        raise(InvalidConfig,"DeploYML file #{path.dump} does not contain a Hash",caller)
       end
 
       return config

data/lib/deployml/remote_shell.rb

@@ -1,3 +1,4 @@
+require 'deployml/exceptions/invalid_config'
 require 'deployml/shell'
 
 require 'addressable/uri'
@@ -6,12 +7,7 @@ module DeploYML
   #
   # Represents a shell running on a remote server.
   #
-  class RemoteShell
-
-    include Shell
-
-    # The URI of the remote shell
-    attr_reader :uri
+  class RemoteShell < Shell
 
     # The history of the Remote Shell
     attr_reader :history
@@ -29,16 +25,9 @@ module DeploYML
     #   The remote shell session.
     #
     def initialize(uri,&block)
-      case uri
-      when Addressable::URI
-        @uri = uri
-      else
-        @uri = Addressable::URI.parse(uri.to_s)
-      end
-
       @history = []
 
-      super(&block)
+      super(uri,&block)
 
       replay if block
     end
@@ -49,11 +38,11 @@ module DeploYML
     # @param [String] program
     #   The name or path of the program to run.
     #
-    # @param [Array<String>] args
+    # @param [Array<String>] arguments
     #   Additional arguments for the program.
     #
-    def run(program,*args)
-      @history << [program, *args]
+    def run(program,*arguments)
+      @history << [program, *arguments]
     end
 
     #
@@ -104,7 +93,14 @@ module DeploYML
     # @return [String]
     #   The SSH compatible URI.
     #
+    # @raise [InvalidConfig]
+    #   The URI of the shell does not have a host component.
+    #
     def ssh_uri
+      unless @uri.host
+        raise(InvalidConfig,"URI does not have a host: #{@uri}",caller)
+      end
+
       new_uri = @uri.host
       new_uri = "#{@uri.user}@#{new_uri}" if @uri.user
 
@@ -114,10 +110,10 @@ module DeploYML
     #
     # Starts a SSH session with the destination server.
     #
-    # @param [Array] args
+    # @param [Array] arguments
     #   Additional arguments to pass to SSH.
     #
-    def ssh(*args)
+    def ssh(*arguments)
       options = []
 
       # Add the -p option if an alternate destination port is given
@@ -129,7 +125,7 @@ module DeploYML
       options << ssh_uri
 
       # append the additional arguments
-      args.each { |arg| options << arg.to_s }
+      arguments.each { |arg| options << arg.to_s }
 
       return system('ssh',*options)
     end

data/lib/deployml/servers/mongrel.rb

@@ -22,11 +22,11 @@ module DeploYML
       # @param [LocalShell, RemoteShell] shell
       #   The shell to execute commands in.
       #
-      # @param [Array] args
+      # @param [Array] arguments
       #   Additional arguments to call `mongrel_rails` with.
       #
-      def mongrel_cluster(shell,*args)
-        options = args + ['-c', @mongrel.config]
+      def mongrel_cluster(shell,*arguments)
+        options = arguments + ['-c', @mongrel.config]
 
         shell.run 'mongrel_rails', *options
       end
@@ -48,7 +48,7 @@ module DeploYML
 
         shell.status "Configuring Mongrel ..."
 
-        options = ['-c', dest.path] + @mongrel.arguments
+        options = ['-c', shell.uri.path] + @mongrel.arguments
         shell.run 'mongrel_rails', 'cluster::configure', *options
 
         shell.status "Mongrel configured."

data/lib/deployml/servers/thin.rb

@@ -22,11 +22,11 @@ module DeploYML
       # @param [LocalShell, RemoteShell] shell
       #   The shell to execute commands in.
       #
-      # @param [Array] args
+      # @param [Array] arguments
       #   Additional arguments to call `thin` with.
       #
-      def thin(shell,*args)
-        options = args + ['-C', @thin.config, '-s', @thin.servers]
+      def thin(shell,*arguments)
+        options = arguments + ['-C', @thin.config, '-s', @thin.servers]
 
         shell.run 'thin', *options
       end
@@ -48,7 +48,7 @@ module DeploYML
 
         shell.status "Configuring Thin ..."
 
-        options = ['-c', dest.path] + @thin.arguments
+        options = ['-c', shell.uri.path] + @thin.arguments
         shell.run 'thin', 'config', *options
 
         shell.status "Thin configured."

data/lib/deployml/shell.rb

@@ -1,15 +1,68 @@
 require 'thor/shell/color'
+require 'shellwords'
 
 module DeploYML
   #
   # Provides common methods used by both {LocalShell} and {RemoteShell}.
   #
-  module Shell
+  class Shell
 
     include Thor::Shell
+    include Shellwords
 
-    def initialize
-      yield self if block_given?
+    # The URI of the Shell.
+    attr_reader :uri
+
+    #
+    # Initializes a shell session.
+    #
+    # @param [Addressable::URI, String] uri
+    #   The URI of the shell.
+    #
+    # @yield [session]
+    #   If a block is given, it will be passed the new shell session.
+    #
+    # @yieldparam [ShellSession] session
+    #   The shell session.
+    #
+    def initialize(uri)
+      @uri = uri
+
+      if block_given?
+        status "Entered #{@uri}."
+        yield self
+        status "Leaving #{@uri} ..."
+      end
+    end
+
+    #
+    # Place holder method.
+    #
+    # @since 0.5.0
+    #
+    def run(program,*arguments)
+    end
+
+    #
+    # Runs a command in the shell.
+    #
+    # @param [String] command
+    #   The command to run.
+    #
+    # @see #run
+    #
+    # @since 0.5.0
+    #
+    def exec(command)
+      run(*shellwords(command))
+    end
+
+    #
+    # Place holder method.
+    #
+    # @since 0.5.0
+    #
+    def echo(message)
     end
 
     #
@@ -18,11 +71,11 @@ module DeploYML
     # @param [Symbol, String] task
     #   Name of the Rake task to run.
     #
-    # @param [Array<String>] args
+    # @param [Array<String>] arguments
     #   Additional arguments for the Rake task.
     #
-    def rake(task,*args)
-      run 'rake', rake_task(task,*args)
+    def rake(task,*arguments)
+      run 'rake', rake_task(task,*arguments)
     end
 
     #
@@ -45,17 +98,17 @@ module DeploYML
     # @param [String, Symbol] name
     #   The name of the `rake` task.
     #
-    # @param [Array] args
+    # @param [Array] arguments
     #   Additional arguments to pass to the `rake` task.
     #
     # @param [String]
     #   The `rake` task name to be called.
     #
-    def rake_task(name,*args)
+    def rake_task(name,*arguments)
       name = name.to_s
 
-      unless args.empty?
-        name += ('[' + args.join(',') + ']')
+      unless arguments.empty?
+        name += ('[' + arguments.join(',') + ']')
       end
 
       return name

data/lib/deployml/version.rb

@@ -1,4 +1,4 @@
 module DeploYML
   # deploYML version
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

data/spec/configuration_spec.rb

@@ -19,11 +19,12 @@ describe Configuration do
     config = Configuration.new(
       :dest => 'ssh://user@www.example.com/srv/project'
     )
+    dest = config.dest
 
-    config.dest.scheme.should == 'ssh'
-    config.dest.user.should == 'user'
-    config.dest.host.should == 'www.example.com'
-    config.dest.path.should == '/srv/project'
+    dest.scheme.should == 'ssh'
+    dest.user.should == 'user'
+    dest.host.should == 'www.example.com'
+    dest.path.should == '/srv/project'
   end
 
   it "should parse 'dest' Hash URIs" do
@@ -33,11 +34,25 @@ describe Configuration do
         'host' => 'www.example.com',
         'path' => '/srv/project'
     })
+    dest = config.dest
 
-    config.dest.scheme.should == 'ssh'
-    config.dest.user.should == 'user'
-    config.dest.host.should == 'www.example.com'
-    config.dest.path.should == '/srv/project'
+    dest.scheme.should == 'ssh'
+    dest.user.should == 'user'
+    dest.host.should == 'www.example.com'
+    dest.path.should == '/srv/project'
+  end
+
+  it "should parse 'dest' Arrays of URIs" do
+    config = Configuration.new(:dest => %w[
+      ssh://deploy@dev1.example.com/var/www/project1
+      ssh://deploy@dev2.example.com/var/www/project1
+      ssh://deploy@dev3.example.com/var/www/project1
+    ])
+    dest = config.dest
+
+    dest[0].host.should == 'dev1.example.com'
+    dest[1].host.should == 'dev2.example.com'
+    dest[2].host.should == 'dev3.example.com'
   end
 
   it "should default the 'debug' option to false" do
@@ -70,4 +85,32 @@ describe Configuration do
     config.server_name.should == :thin
     config.server_options.should == {:address => '127.0.0.1'}
   end
+
+  it "should parse 'before' / 'after' command strings" do
+    config = Configuration.new(
+      :before => {
+        :install => "command1\ncommand2\n",
+        :update => "command3\ncommand4\n"
+      }
+    )
+
+    config.before[:install][0].should == 'command1'
+    config.before[:install][1].should == 'command2'
+    config.before[:update][0].should == 'command3'
+    config.before[:update][1].should == 'command4'
+  end
+
+  it "should parse 'before' / 'after' commands" do
+    config = Configuration.new(
+      :before => {
+        :install => %w[command1 command2],
+        :update => %w[command3 command4]
+      }
+    )
+
+    config.before[:install][0].should == 'command1'
+    config.before[:install][1].should == 'command2'
+    config.before[:update][0].should == 'command3'
+    config.before[:update][1].should == 'command4'
+  end
 end

data/spec/remote_shell_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'deployml/remote_shell'
 
 describe RemoteShell do
-  let(:uri) { 'ssh://deploy@www.example.com/path' }
+  let(:uri) { Addressable::URI.parse('ssh://deploy@www.example.com/path') }
 
   subject { RemoteShell.new(uri) }
 
@@ -14,8 +14,19 @@ describe RemoteShell do
     subject.uri.path.should == '/path'
   end
 
-  it "should convert normal URIs to SSH URIs" do
-    subject.ssh_uri.should == 'deploy@www.example.com'
+  describe "#ssh_uri" do
+    it "should convert normal URIs to SSH URIs" do
+      subject.ssh_uri.should == 'deploy@www.example.com'
+    end
+
+    it "must require a URI with a host component" do
+      bad_uri = Addressable::URI.parse('deploy@www.example.com:/var/www')
+      shell = RemoteShell.new(bad_uri)
+
+      lambda {
+        shell.ssh_uri
+      }.should raise_error(InvalidConfig)
+    end
   end
 
   it "should enqueue programs to run" do

metadata

@@ -2,7 +2,7 @@
 name: deployml
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors: 
 - Postmodern
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-11 00:00:00 Z
+date: 2011-04-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: addressable