deployml 0.4.0 → 0.4.1

data/ChangeLog.md

@@ -1,3 +1,13 @@
+### 0.4.1 / 2010-12-08
+
+* Added support for Ruby 1.8.6.
+* Added {DeploYML::Configuration#bundler}.
+* Auto-detect usage of [Bundler](http://gembundler.com/) by checking for a
+  `Gemfile` in project directories.
+* Fixed a Ruby 1.8.x specific bug where non-Strings were being passed to
+  `Kernel.system`.
+* Only print status messages if the mixin is enabled.
+
 ### 0.4.0 / 2010-11-29
 
 * Require addressable ~> 2.2.0.

data/README.md

@@ -115,6 +115,7 @@ List available tasks:
 
 ## Requirements
 
+* [ruby](http://www.ruby-lang.org/) >= 1.8.6
 * [addressable](http://addressable.rubyforge.org/) ~> 2.2.0
 * [rprogram](http://github.com/postmodern/rprogram) ~> 0.2.0
 * [thor](http://github.com/wycats/thor) ~> 0.14.3

data/Rakefile

@@ -12,7 +12,7 @@ rescue LoadError => e
 end
 
 begin
-  gem 'rspec', '~> 2.1.0'
+  gem 'rspec', '~> 2.2.0'
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new

data/gemspec.yml

@@ -10,6 +10,8 @@ email: postmodern.mod3@gmail.com
 homepage: http://github.com/postmodern/deployml
 has_yard: true
 
+required_ruby_version: >= 1.8.6
+
 dependencies:
   addressable: ~> 2.2.0
   rprogram: ~> 0.2.0
@@ -17,5 +19,5 @@ dependencies:
 
 development_dependencies:
   ore-tasks: ~> 0.3.0
-  rspec: ~> 2.1.0
+  rspec: ~> 2.2.0
   yard: ~> 0.6.0

data/lib/deployml/configuration.rb

@@ -24,6 +24,9 @@ module DeploYML
     # The destination URI to upload the project to.
     attr_reader :dest
 
+    # Whether the project uses Bundler.
+    attr_reader :bundler
+
     # The framework used by the project
     attr_reader :framework
 
@@ -48,6 +51,10 @@ module DeploYML
     # @option config [String, Hash] :dest
     #   The destination URI to upload the project to.
     #
+    # @option config [Boolean] :bundler
+    #   Specifies whether the projects dependencies are controlled by
+    #   [Bundler](http://gembundler.com).
+    #
     # @option config [Symbol] :framework
     #   The framework used by the project.
     #
@@ -70,6 +77,7 @@ module DeploYML
       @server_name = nil
       @server_options = {}
 
+      @bundler = false
       @framework = nil
       @orm = nil
 
@@ -78,6 +86,8 @@ module DeploYML
 
       config = normalize_hash(config)
 
+      @bundler = config[:bundler]
+
       if config[:framework]
         @framework = config[:framework].to_sym
       end

data/lib/deployml/environment.rb

@@ -158,7 +158,11 @@ module DeploYML
     # @since 0.3.0
     #
     def setup(shell)
+      shell.status "Cloning #{@source} ..."
+
       shell.run 'git', 'clone', '--depth', 1, @source, @dest.path
+
+      shell.status "Cloned."
     end
 
     #
@@ -170,12 +174,16 @@ module DeploYML
     # @since 0.3.0
     #
     def update(shell)
+      shell.status "Updating #{@dest.path} ..."
+
       shell.run 'git', 'reset', '--hard', 'HEAD'
       shell.run 'git', 'pull', '-f'
+
+      shell.status "Updated."
     end
 
     #
-    # Place-holder method.
+    # Installs any additional dependencies.
     #
     # @param [RemoteShell] shell
     #   The remote shell to execute commands through.
@@ -183,6 +191,13 @@ module DeploYML
     # @since 0.3.0
     #
     def install(shell)
+      if @bundler
+        shell.status "Bundling dependencies ..."
+
+        shell.run 'bundle', 'install', '--deployment'
+
+        shell.status "Dependencies bundled."
+      end
     end
 
     #
@@ -254,52 +269,28 @@ module DeploYML
     def invoke(tasks)
       remote_shell do |shell|
         # setup the deployment repository
-        if tasks.include?(:setup)
-          shell.status "Cloning #{@source} ..."
-          setup(shell)
-          shell.status "Cloned."
-        end
+        setup(shell) if tasks.include?(:setup)
 
         # cd into the deployment repository
         shell.cd @dest.path
 
         # update the deployment repository
-        if tasks.include?(:update)
-          shell.status "Updating #{@dest.path} ..."
-          update(shell)
-          shell.status "Updated."
-        end
+        update(shell) if tasks.include?(:update)
 
         # framework tasks
-        if tasks.include?(:install)
-          shell.status "Installing additional dependencies ..."
-          install(shell)
-          shell.status "Dependencies installed."
-        end
+        install(shell) if tasks.include?(:install)
 
-        if tasks.include?(:migrate)
-          shell.status "Migrating database ..."
-          migrate(shell)
-          shell.status "Database migrated."
-        end
+        migrate(shell) if tasks.include?(:migrate)
 
         # server tasks
         if tasks.include?(:config)
-          shell.status "Configuring server ..."
           server_config(shell)
-          shell.status "Server configured."
         elsif tasks.include?(:start)
-          shell.status "Starting server ..."
           server_start(shell)
-          shell.status "Server started."
         elsif tasks.include?(:stop)
-          shell.status "Stopping server ..."
           server_stop(shell)
-          shell.status "Server stopped."
         elsif tasks.include?(:restart)
-          shell.status "Restarting server ..."
           server_restart(shell)
-          shell.status "Server restarted."
         end
       end
 

data/lib/deployml/frameworks/rails2.rb

@@ -15,7 +15,11 @@ module DeploYML
       #   The shell to execute commands in.
       #
       def migrate(shell)
+        shell.status "Migrating the ActiveRecord Database ..."
+
         shell.run 'rake', 'db:migrate', "RAILS_ENV=#{@environment}"
+
+        shell.status "ActiveRecord Database migrated."
       end
     end
   end

data/lib/deployml/frameworks/rails3.rb

@@ -8,16 +8,6 @@ module DeploYML
     module Rails3
       include Rails
 
-      #
-      # Installs any dependencies using `bundle install --deployment`.
-      #
-      # @param [LocalShell, RemoteShell] shell
-      #   The shell to execute commands in.
-      #
-      def install(shell)
-        shell.run 'bundle', 'install', '--deployment'
-      end
-
       #
       # Migrates the database using the `db:autoupgrade` if
       # [DataMapper](http://datamapper.org) is being used, or the typical
@@ -27,14 +17,16 @@ module DeploYML
       #   The shell to execute commands in.
       #
       def migrate(shell)
-        task = case @orm
-               when :datamapper
-                 'db:autoupgrade'
-               else
-                 'db:migrate'
-               end
+        case @orm
+        when :datamapper
+          shell.status "Running DataMapper auto-upgrades ..."
+          shell.run 'rake', 'db:autoupgrade', "RAILS_ENV=#{@environment}"
+        else
+          shell.status "Running ActiveRecord migrations ..."
+          shell.run 'rake', 'db:migrate', "RAILS_ENV=#{@environment}"
+        end
 
-        shell.run 'rake', task, "RAILS_ENV=#{@environment}"
+        shell.status "Database migrated."
       end
     end
   end

data/lib/deployml/local_shell.rb

@@ -18,6 +18,9 @@ module DeploYML
     #   Additional arguments for the program.
     #
     def run(program,*args)
+      program = program.to_s
+      args = args.map { |arg| arg.to_s }
+
       system(program,*args)
     end
 

data/lib/deployml/project.rb

@@ -262,41 +262,68 @@ module DeploYML
     protected
 
     #
-    # Loads the project configuration.
+    # Infers the configuration from the project root directory.
     #
-    # @raise [InvalidConfig]
-    #   The YAML configuration file did not contain a Hash.
+    # @return [Hash{Symbol => Object}]
+    #   The infered configuration.
     #
-    # @raise [MissingOption]
-    #   The `source` or `dest` options were not specified.
+    # @since 0.4.1
     #
-    # @since 0.3.0
+    def infer_configuration
+      config = {}
+
+      # check for Bundler
+      if File.file?(File.join(@root,'Gemfile'))
+        config[:bundler] = true
+      end
+
+      return config
+    end
+
     #
-    def load_environments!
-      base_config = {}
+    # Loads configuration from a YAML file.
+    #
+    # @param [String] path
+    #   The path to the configuration file.
+    #
+    # @return [Hash]
+    #   The loaded configuration.
+    #
+    # @raise [InvalidConfig]
+    #   The configuration file did not contain a YAML Hash.
+    #
+    # @since 0.4.1
+    #
+    def load_configuration(path)
+      config = YAML.load_file(path)
 
-      load_config_data = lambda { |path|
-        config_data = YAML.load_file(path)
+      unless config.kind_of?(Hash)
+        raise(InvalidConfig,"DeploYML file #{path.dump} does not contain a Hash")
+      end
 
-        unless config_data.kind_of?(Hash)
-          raise(InvalidConfig,"DeploYML file '#{path}' does not contain a Hash")
-        end
+      return config
+    end
 
-        config_data
-      }
+    #
+    # Loads the project configuration.
+    #
+    # @since 0.3.0
+    #
+    def load_environments!
+      base_config = infer_configuration
 
       if File.file?(@config_file)
-        base_config.merge!(load_config_data[@config_file])
+        base_config.merge!(load_configuration(@config_file))
       end
 
       @environments = {}
 
       if File.directory?(@environments_dir)
         Dir.glob(File.join(@environments_dir,'*.yml')) do |path|
-          config_data = base_config.merge(load_config_data[path])
+          config = base_config.merge(load_configuration(path))
           name = File.basename(path).sub(/\.yml$/,'').to_sym
 
-          @environments[name] = Environment.new(name,config_data)
+          @environments[name] = Environment.new(name,config)
         end
       else
         @environments[:production] = Environment.new(:production,base_config)

data/lib/deployml/remote_shell.rb

@@ -1,7 +1,6 @@
 require 'deployml/shell'
 
 require 'addressable/uri'
-require 'shellwords'
 
 module DeploYML
   #
@@ -10,7 +9,6 @@ module DeploYML
   class RemoteShell
 
     include Shell
-    include Shellwords
 
     # The URI of the remote shell
     attr_reader :uri
@@ -96,7 +94,7 @@ module DeploYML
     #
     def join
       @history.map { |command|
-        command.map { |word| shellescape(word) }.join(' ')
+        command.map { |word| shellescape(word.to_s) }.join(' ')
       }.join(' && ')
     end
 
@@ -127,8 +125,11 @@ module DeploYML
         options += ['-p', @uri.port.to_s]
       end
 
+      # append the SSH URI
       options << ssh_uri
-      options += args
+
+      # append the additional arguments
+      args.each { |arg| options << arg.to_s }
 
       return system('ssh',*options)
     end
@@ -140,5 +141,44 @@ module DeploYML
       ssh(self.join) unless @history.empty?
     end
 
+    protected
+
+    #
+    # Escapes a string so that it can be safely used in a Bourne shell
+    # command line.
+    #
+    # Note that a resulted string should be used unquoted and is not
+    # intended for use in double quotes nor in single quotes.
+    #
+    # @param [String] str
+    #   The string to escape.
+    #
+    # @return [String]
+    #   The shell-escaped string.
+    #
+    # @example
+    #   open("| grep #{Shellwords.escape(pattern)} file") { |pipe|
+    #     # ...
+    #   }
+    #
+    # @note Vendored from `shellwords.rb` line 72 from Ruby 1.9.2.
+    #
+    def shellescape(str)
+      # An empty argument will be skipped, so return empty quotes.
+      return "''" if str.empty?
+
+      str = str.dup
+
+      # Process as a single byte sequence because not all shell
+      # implementations are multibyte aware.
+      str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/n, "\\\\\\1")
+
+      # A LF cannot be escaped with a backslash because a backslash + LF
+      # combo is regarded as line continuation and simply ignored.
+      str.gsub!(/\n/, "'\n'")
+
+      return str
+    end
+
   end
 end

data/lib/deployml/servers/apache.rb

@@ -14,7 +14,11 @@ module DeploYML
       #   The shell to execute commands in.
       #
       def server_start(shell)
+        shell.status "Starting Apache ..."
+
         shell.run 'apachectl', 'start'
+
+        shell.status "Apache started."
       end
 
       #
@@ -24,7 +28,11 @@ module DeploYML
       #   The shell to execute commands in.
       #
       def server_restart(shell)
+        shell.status "Restarting Apache ..."
+
         shell.run 'apachectl', 'restart'
+
+        shell.status "Apache restarted."
       end
 
       #
@@ -34,7 +42,11 @@ module DeploYML
       #   The shell to execute commands in.
       #
       def server_stop(shell)
+        shell.status "Stopping Apache ..."
+
         shell.run 'apachectl', 'stop'
+
+        shell.status "Apache stoped."
       end
     end
   end

data/lib/deployml/servers/mongrel.rb

@@ -46,9 +46,12 @@ module DeploYML
           raise(MissingOption,"No 'config' option specified under server options",caller)
         end
 
-        options = ['-c', dest.path] + @mongrel.arguments
+        shell.status "Configuring Mongrel ..."
 
+        options = ['-c', dest.path] + @mongrel.arguments
         shell.run 'mongrel_rails', 'cluster::configure', *options
+
+        shell.status "Mongrel configured."
       end
 
       #
@@ -58,7 +61,11 @@ module DeploYML
       #   The shell to execute commands in.
       #
       def server_start(shell)
+        shell.status "Starting Mongrel(s) ..."
+
         mongrel_cluster 'cluster::start'
+
+        shell.status "Mongrel(s) started."
       end
 
       #
@@ -68,7 +75,11 @@ module DeploYML
       #   The shell to execute commands in.
       #
       def server_stop(shell)
+        shell.status "Stopping Mongrel(s) ..."
+
         mongrel_cluster 'cluster::stop'
+
+        shell.status "Mongrel(s) stopped."
       end
 
       #
@@ -78,7 +89,11 @@ module DeploYML
       #   The shell to execute commands in.
       #
       def server_restart(shell)
+        shell.status "Restarting Mongrel(s) ..."
+
         mongrel_cluster 'cluster::restart'
+
+        shell.status "Mongrel(s) restarted."
       end
     end
   end

data/lib/deployml/servers/thin.rb

@@ -46,9 +46,12 @@ module DeploYML
           raise(MissingOption,"No 'config' option specified under the server options",caller)
         end
 
-        options = ['-c', dest.path] + @thin.arguments
+        shell.status "Configuring Thin ..."
 
+        options = ['-c', dest.path] + @thin.arguments
         shell.run 'thin', 'config', *options
+
+        shell.status "Thin configured."
       end
 
       #
@@ -58,7 +61,11 @@ module DeploYML
       #   The shell to execute commands in.
       #
       def server_start(shell)
+        shell.status "Starting Thin ..."
+
         thin shell, 'start'
+
+        shell.status "Thin started."
       end
 
       #
@@ -68,7 +75,11 @@ module DeploYML
       #   The shell to execute commands in.
       #
       def server_stop(shell)
+        shell.status "Stopping Thin ..."
+
         thin shell, 'stop'
+
+        shell.status "Thin stopped."
       end
 
       #
@@ -78,7 +89,11 @@ module DeploYML
       #   The shell to execute commands in.
       #
       def server_restart(shell)
+        shell.status "Restarting Thin ..."
+
         thin shell, 'restart'
+
+        shell.status "Thin restarted."
       end
     end
   end

data/lib/deployml/version.rb

@@ -1,4 +1,4 @@
 module DeploYML
   # deploYML version
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
-
-gem 'rspec', '~> 2.1.0'
+gem 'rspec', '~> 2.2.0'
 require 'rspec'
 
 require 'deployml/version'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-29 00:00:00 -08:00
+date: 2010-12-08 00:00:00 -08:00
 default_executable: deployml
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,9 +87,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 2
-        - 1
+        - 2
         - 0
-        version: 2.1.0
+        version: 2.2.0
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -185,8 +185,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 8
+      - 6
+      version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: