deployml 0.5.1 → 0.5.2

data/.document

@@ -1,3 +1,3 @@
 - 
 LICENSE.txt
-ChangeLog.*
+ChangeLog.md

data/ChangeLog.md

@@ -1,3 +1,15 @@
+### 0.5.2 / 2011-06-21
+
+* Added {DeploYML::Shell#ruby}.
+* Override {DeploYML::LocalShell#exec} and {DeploYML::RemoteShell#exec}
+  to prevent full commands from being escaped.
+* Ensure that {DeploYML::Shell#ruby} and {DeploYML::Shell#rake} will
+  prefix commands with `bundle exec`, if Bundler is enabled.
+  * All `thin` and `mongrel_cluster` commands now support running under
+    `bundle exec`.
+* Merged `DeploYML::Frameworks::Rails2` and `DeploYML::Frameworks::Rails3`
+  into {DeploYML::Frameworks::Rails}.
+
 ### 0.5.1 / 2011-04-25
 
 * Emergency typo fix for {DeploYML::Environment#invoke}.

data/README.md

@@ -77,7 +77,7 @@ Multiple environments:
 
     # config/deploy.yml
     source: git@github.com:user/project.git
-    framework: rails3
+    framework: rails
     orm: datamapper
 
     # config/deploy/staging.yml

data/Rakefile

@@ -25,7 +25,7 @@ task :test => :spec
 task :default => :spec
 
 begin
-  gem 'yard', '~> 0.6.0'
+  gem 'yard', '~> 0.7.0'
   require 'yard'
 
   YARD::Rake::YardocTask.new  

data/deployml.gemspec

@@ -1,15 +1,127 @@
-# -*- encoding: utf-8 -*-
-
-begin
-  Ore::Specification.new do |gemspec|
-    # custom logic here
-  end
-rescue NameError
-  begin
-    require 'ore/specification'
-    retry
-  rescue LoadError
-    STDERR.puts "The 'deployml.gemspec' file requires Ore."
-    STDERR.puts "Run `gem install ore-core` to install Ore."
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gemspec|
+  files = if File.directory?('.git')
+            `git ls-files`.split($/)
+          elsif File.directory?('.hg')
+            `hg manifest`.split($/)
+          elsif File.directory?('.svn')
+            `svn ls -R`.split($/).select { |path| File.file?(path) }
+          else
+            Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+          end
+
+  filter_files = lambda { |paths|
+    case paths
+    when Array
+      (files & paths)
+    when String
+      (files & Dir[paths])
+    end
+  }
+
+  version = {
+    :file => 'lib/deployml/version.rb',
+    :constant => 'DeploYML::VERSION'
+  }
+
+  defaults = {
+    'name' => File.basename(File.dirname(__FILE__)),
+    'files' => files,
+    'executables' => filter_files['bin/*'].map { |path| File.basename(path) },
+    'test_files' => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
+    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
+  }
+
+  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
+
+  gemspec.name = metadata.fetch('name',defaults[:name])
+  gemspec.version = if metadata['version']
+                      metadata['version']
+                    elsif File.file?(version[:file])
+                      require File.join('.',version[:file])
+                      eval(version[:constant])
+                    end
+
+  gemspec.summary = metadata.fetch('summary',metadata['description'])
+  gemspec.description = metadata.fetch('description',metadata['summary'])
+
+  case metadata['license']
+  when Array
+    gemspec.licenses = metadata['license']
+  when String
+    gemspec.license = metadata['license']
+  end
+
+  case metadata['authors']
+  when Array
+    gemspec.authors = metadata['authors']
+  when String
+    gemspec.author = metadata['authors']
+  end
+
+  gemspec.email = metadata['email']
+  gemspec.homepage = metadata['homepage']
+
+  case metadata['require_paths']
+  when Array
+    gemspec.require_paths = metadata['require_paths']
+  when String
+    gemspec.require_path = metadata['require_paths']
+  end
+
+  gemspec.files = filter_files[metadata['files']]
+
+  gemspec.executables = metadata['executables']
+  gemspec.extensions = metadata['extensions']
+
+  if Gem::VERSION < '1.7.'
+    gemspec.default_executable = gemspec.executables.first
+  end
+
+  gemspec.test_files = filter_files[metadata['test_files']]
+
+  unless gemspec.files.include?('.document')
+    gemspec.extra_rdoc_files = metadata['extra_doc_files']
+  end
+
+  gemspec.post_install_message = metadata['post_install_message']
+  gemspec.requirements = metadata['requirements']
+
+  if gemspec.respond_to?(:required_ruby_version=)
+    gemspec.required_ruby_version = metadata['required_ruby_version']
+  end
+
+  if gemspec.respond_to?(:required_rubygems_version=)
+    gemspec.required_rubygems_version = metadata['required_ruby_version']
+  end
+
+  parse_versions = lambda { |versions|
+    case versions
+    when Array
+      versions.map { |v| v.to_s }
+    when String
+      versions.split(/,\s*/)
+    end
+  }
+
+  if metadata['dependencies']
+    metadata['dependencies'].each do |name,versions|
+      gemspec.add_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['runtime_dependencies']
+    metadata['runtime_dependencies'].each do |name,versions|
+      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['development_dependencies']
+    metadata['development_dependencies'].each do |name,versions|
+      gemspec.add_development_dependency(name,parse_versions[versions])  
+    end
   end
 end

data/gemspec.yml

@@ -20,4 +20,4 @@ dependencies:
 development_dependencies:
   ore-tasks: ~> 0.4
   rspec: ~> 2.4
-  yard: ~> 0.6.0
+  yard: ~> 0.7.0

data/lib/deployml/configuration.rb

@@ -94,7 +94,10 @@ module DeploYML
 
       @bundler = config.fetch(:bundler,false)
 
-      @framework = if config[:framework]
+      @framework = case config[:framework]
+                   when 'rails', 'rails2', 'rails3'
+                     :rails
+                   when String, Symbol
                      config[:framework].to_sym
                    end
 

data/lib/deployml/environment.rb

@@ -23,8 +23,7 @@ module DeploYML
 
     # Mapping of possible 'framework' names to their mixins.
     FRAMEWORKS = {
-      :rails2 => Frameworks::Rails2,
-      :rails3 => Frameworks::Rails3
+      :rails => Frameworks::Rails
     }
 
     #
@@ -74,7 +73,7 @@ module DeploYML
     # @since 0.3.0
     #
     def local_shell(&block)
-      each_dest.map { |dest| LocalShell.new(dest,&block) }
+      each_dest.map { |dest| LocalShell.new(dest,self,&block) }
     end
 
     #
@@ -100,7 +99,7 @@ module DeploYML
                   RemoteShell
                 end
 
-        shell.new(dest,&block)
+        shell.new(dest,self,&block)
       end
     end
 

data/lib/deployml/frameworks/rails.rb

@@ -1,7 +1,7 @@
 module DeploYML
   module Frameworks
     #
-    # Provides common methods needed to deploy Rails 2 and 3 projects.
+    # Provides methods for deploying Rails projects.
     #
     module Rails
       #
@@ -15,6 +15,27 @@ module DeploYML
 
         super(task,*arguments)
       end
+
+      #
+      # Migrates the database using the `db:autoupgrade` if
+      # [DataMapper](http://datamapper.org) is being used, or the typical
+      # `db:migrate` task.
+      #
+      # @param [LocalShell, RemoteShell] shell
+      #   The shell to execute commands in.
+      #
+      def migrate(shell)
+        case @orm
+        when :datamapper
+          shell.status "Running DataMapper auto-upgrades ..."
+          shell.ruby 'rake', 'db:autoupgrade', "RAILS_ENV=#{@environment}"
+        else
+          shell.status "Running ActiveRecord migrations ..."
+          shell.ruby 'rake', 'db:migrate', "RAILS_ENV=#{@environment}"
+        end
+
+        shell.status "Database migrated."
+      end
     end
   end
 end

data/lib/deployml/frameworks.rb

@@ -1,2 +1 @@
-require 'deployml/frameworks/rails2'
-require 'deployml/frameworks/rails3'
+require 'deployml/frameworks/rails'

data/lib/deployml/local_shell.rb

@@ -22,6 +22,18 @@ module DeploYML
       system(program,*arguments)
     end
 
+    #
+    # Executes a command.
+    #
+    # @param [String] command
+    #   The command to be executed.
+    #
+    # @since 0.5.2
+    #
+    def exec(command)
+      system(command)
+    end
+
     #
     # Prints out a message.
     #

data/lib/deployml/remote_shell.rb

@@ -18,16 +18,19 @@ module DeploYML
     # @param [Addressable::URI, String] uri
     #   The URI of the host to connect to.
     #
+    # @param [Environment] environment
+    #   The environment the shell is connected to.
+    #
     # @yield [session]
     #   If a block is given, it will be passed the new remote shell session.
     #
     # @yieldparam [ShellSession] session
     #   The remote shell session.
     #
-    def initialize(uri,&block)
+    def initialize(uri,environment=nil,&block)
       @history = []
 
-      super(uri,&block)
+      super(uri,environment,&block)
 
       replay if block
     end
@@ -45,6 +48,18 @@ module DeploYML
       @history << [program, *arguments]
     end
 
+    #
+    # Adds a command to be executed.
+    #
+    # @param [String] command
+    #   The command string.
+    #
+    # @since 0.5.2
+    #
+    def exec(command)
+      @history << [command]
+    end
+
     #
     # Enqueues an `echo` command to be ran in the session.
     #
@@ -82,9 +97,16 @@ module DeploYML
     #   A single command string.
     #
     def join
-      @history.map { |command|
-        command.map { |word| shellescape(word.to_s) }.join(' ')
-      }.join(' && ')
+      commands = []
+
+      @history.each do |command|
+        program = command[0]
+        arguments = command[1..-1].map { |word| shellescape(word.to_s) }
+
+        commands << [program, *arguments].join(' ')
+      end
+
+      return commands.join(' && ')
     end
 
     #
@@ -137,44 +159,5 @@ 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/mongrel.rb

@@ -28,7 +28,7 @@ module DeploYML
       def mongrel_cluster(shell,*arguments)
         options = arguments + ['-c', @mongrel.config]
 
-        shell.run 'mongrel_rails', *options
+        shell.ruby 'mongrel_rails', *options
       end
 
       #
@@ -49,7 +49,7 @@ module DeploYML
         shell.status "Configuring Mongrel ..."
 
         options = ['-c', shell.uri.path] + @mongrel.arguments
-        shell.run 'mongrel_rails', 'cluster::configure', *options
+        shell.ruby 'mongrel_rails', 'cluster::configure', *options
 
         shell.status "Mongrel configured."
       end

data/lib/deployml/servers/thin.rb

@@ -28,7 +28,7 @@ module DeploYML
       def thin(shell,*arguments)
         options = arguments + ['-C', @thin.config, '-s', @thin.servers]
 
-        shell.run 'thin', *options
+        shell.ruby 'thin', *options
       end
 
       #
@@ -49,7 +49,7 @@ module DeploYML
         shell.status "Configuring Thin ..."
 
         options = ['-c', shell.uri.path] + @thin.arguments
-        shell.run 'thin', 'config', *options
+        shell.ruby 'thin', 'config', *options
 
         shell.status "Thin configured."
       end

data/lib/deployml/shell.rb

@@ -19,14 +19,18 @@ module DeploYML
     # @param [Addressable::URI, String] uri
     #   The URI of the shell.
     #
+    # @param [Environment] environment
+    #   The environment the shell is connected to.
+    #
     # @yield [session]
     #   If a block is given, it will be passed the new shell session.
     #
     # @yieldparam [ShellSession] session
     #   The shell session.
     #
-    def initialize(uri)
+    def initialize(uri,environment=nil)
       @uri = uri
+      @environment = environment
 
       if block_given?
         status "Entered #{@uri}."
@@ -44,17 +48,14 @@ module DeploYML
     end
 
     #
-    # Runs a command in the shell.
+    # Place holder method.
     #
     # @param [String] command
-    #   The command to run.
-    #
-    # @see #run
+    #   The command to execute.
     #
     # @since 0.5.0
     #
     def exec(command)
-      run(*shellwords(command))
     end
 
     #
@@ -65,6 +66,30 @@ module DeploYML
     def echo(message)
     end
 
+    #
+    # Executes a Ruby program.
+    #
+    # @param [Symbol, String] program
+    #   Name of the Ruby program to run.
+    #
+    # @param [Array<String>] arguments
+    #   Additional arguments for the Ruby program.
+    #
+    # @since 0.5.2
+    #
+    def ruby(program,*arguments)
+      command = [program, *arguments]
+
+      # assume that `.rb` scripts do not have a `#!/usr/bin/env ruby`
+      command.unshift('ruby') if program[-3,3] == '.rb'
+
+      if (@environment && @environment.bundler)
+        command.unshift('bundle','exec')
+      end
+
+      run(*command)
+    end
+
     #
     # Executes a Rake task.
     #
@@ -75,7 +100,7 @@ module DeploYML
     #   Additional arguments for the Rake task.
     #
     def rake(task,*arguments)
-      run 'rake', rake_task(task,*arguments)
+      ruby('rake', rake_task(task,*arguments))
     end
 
     #
@@ -92,6 +117,43 @@ module DeploYML
 
     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
+
     #
     # Builds a `rake` task name.
     #

data/lib/deployml/version.rb

@@ -1,4 +1,4 @@
 module DeploYML
   # deploYML version
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

data/spec/environment_spec.rb

@@ -8,7 +8,7 @@ describe Environment do
     Environment.new(name, {
       'source' => 'git@github.com:user/project.git',
       'dest' => 'ssh://user@www.example.com/srv/project',
-      'framework' => 'rails3',
+      'framework' => 'rails',
       'orm' => 'datamapper',
       'server' => {
         'name' => 'thin',
@@ -25,7 +25,7 @@ describe Environment do
   end
 
   it "should include the framework mixin" do
-    subject.should be_kind_of(Frameworks::Rails3)
+    subject.should be_kind_of(Frameworks::Rails)
   end
 
   it "should include the server mixin" do

data/spec/helpers/projects/rails/config/deploy.yml

@@ -1,3 +1,3 @@
 source: git@github.com:user/project.git
-framework: rails3
+framework: rails
 orm: datamapper

data/spec/project_spec.rb

@@ -59,7 +59,7 @@ describe Project do
       project = Project.new(project_dir(:rails))
 
       project.environments.all? { |name,env|
-        env.framework == :rails3 && env.orm == :datamapper
+        env.framework == :rails && env.orm == :datamapper
       }.should == true
     end
   end

data/spec/remote_shell_spec.rb

@@ -69,9 +69,9 @@ describe RemoteShell do
   end
 
   it "should escape all command arguments" do
-    subject.run 'the program'
+    subject.run 'program arg1 arg2'
     subject.run 'echo', '>>> status'
 
-    subject.join.should == "the\\ program && echo \\>\\>\\>\\ status"
+    subject.join.should == "program arg1 arg2 && echo \\>\\>\\>\\ status"
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: deployml
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Postmodern
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-25 00:00:00 Z
+date: 2011-06-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: addressable
@@ -75,7 +75,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.6.0
+        version: 0.7.0
   type: :development
   version_requirements: *id006
 description: DeploYML is a simple deployment solution that uses a single YAML file, Git and SSH.
@@ -113,8 +113,6 @@ files:
 - lib/deployml/exceptions/unknown_server.rb
 - lib/deployml/frameworks.rb
 - lib/deployml/frameworks/rails.rb
-- lib/deployml/frameworks/rails2.rb
-- lib/deployml/frameworks/rails3.rb
 - lib/deployml/local_shell.rb
 - lib/deployml/options.rb
 - lib/deployml/options/mongrel.rb
@@ -166,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: deployml
-rubygems_version: 1.7.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: A simple deployment solution that works.

data/lib/deployml/frameworks/rails2.rb

@@ -1,26 +0,0 @@
-require 'deployml/frameworks/rails'
-
-module DeploYML
-  module Frameworks
-    #
-    # Provides methods for deploying Rails 2 projects.
-    #
-    module Rails2
-      include Rails
-
-      #
-      # Migrates the database using the `db:migrate` task.
-      #
-      # @param [LocalShell, RemoteShell] shell
-      #   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
-end

data/lib/deployml/frameworks/rails3.rb

@@ -1,33 +0,0 @@
-require 'deployml/frameworks/rails'
-
-module DeploYML
-  module Frameworks
-    #
-    # Provides methods for deploying Rails 3 projects.
-    #
-    module Rails3
-      include Rails
-
-      #
-      # Migrates the database using the `db:autoupgrade` if
-      # [DataMapper](http://datamapper.org) is being used, or the typical
-      # `db:migrate` task.
-      #
-      # @param [LocalShell, RemoteShell] shell
-      #   The shell to execute commands in.
-      #
-      def migrate(shell)
-        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.status "Database migrated."
-      end
-    end
-  end
-end