capistrano 3.0.1 → 3.1.0

data/lib/capistrano/configuration.rb

@@ -9,6 +9,10 @@ module Capistrano
       def env
         @env ||= new
       end
+
+      def reset!
+        @env = new
+      end
     end
 
     def ask(key, default=nil)
@@ -34,6 +38,10 @@ module Capistrano
     end
 
     def role(name, hosts, options={})
+      if name == :all
+        raise ArgumentError.new("#{name} reserved name for role. Please choose another name")
+      end
+
       servers.add_role(name, hosts, options)
     end
 

data/lib/capistrano/configuration/server.rb

@@ -5,6 +5,10 @@ module Capistrano
       extend Forwardable
       def_delegators :properties, :roles, :fetch, :set
 
+      def self.[](host)
+        host.is_a?(Server) ? host : new(host)
+      end
+
       def add_roles(roles)
         Array(roles).each { |role| add_role(role) }
       end
@@ -18,12 +22,8 @@ module Capistrano
         roles.include? role.to_sym
       end
 
-      def matches?(host)
-        hostname == Server.new(host).hostname
-      end
-
       def select?(options)
-        selector = Selector.new(options)
+        selector = Selector.for(options)
         selector.call(self)
       end
 
@@ -50,6 +50,10 @@ module Capistrano
         roles.to_a
       end
 
+      def matches?(other)
+        hostname == other.hostname && port == other.port
+      end
+
       private
 
       def add_property(key, value)
@@ -103,6 +107,14 @@ module Capistrano
           @options = options
         end
 
+        def self.for(options)
+          if options.has_key?(:exclude)
+            Exclusive
+          else
+            self
+          end.new(options)
+        end
+
         def callable
           if key.respond_to?(:call)
             key
@@ -126,6 +138,17 @@ module Capistrano
           ->(server) { :all }
         end
 
+        class Exclusive < Selector
+
+          def key
+            options[:exclude]
+          end
+
+          def call(server)
+            !callable.call(server)
+          end
+        end
+
       end
 
     end

data/lib/capistrano/configuration/servers.rb

@@ -1,5 +1,6 @@
 require 'set'
 require_relative 'servers/role_filter'
+require_relative 'servers/host_filter'
 module Capistrano
   class Configuration
     class Servers
@@ -30,11 +31,7 @@ module Capistrano
       private
 
       def server(host)
-        if host.is_a? Server
-          host
-        else
-          servers.find { |server| server.matches?(host) } || Server.new(host)
-        end
+        servers.find { |server| server.matches? Server[host] } || Server[host]
       end
 
       def fetch(role)
@@ -43,7 +40,7 @@ module Capistrano
 
       def fetch_roles(required, options)
         filter_roles = RoleFilter.for(required, available_roles)
-        select(servers_with_roles(filter_roles), options)
+        HostFilter.for(select(servers_with_roles(filter_roles), options))
       end
 
       def servers_with_roles(roles)

data/lib/capistrano/configuration/servers/host_filter.rb

@@ -0,0 +1,82 @@
+module Capistrano
+  class Configuration
+    class Servers
+      class HostFilter
+
+        def initialize(available)
+          @available = available
+        end
+
+        def self.for(available)
+          new(available).hosts
+        end
+
+        def hosts
+          if host_filter.any?
+            @available.select { |server| host_filter.include? server.hostname }
+          else
+            @available
+          end
+        end
+
+        private
+
+        def filter
+          if host_filter.any?
+            host_filter
+          else
+            @available
+          end
+        end
+
+        def host_filter
+          env_filter | configuration_filter
+        end
+
+        def configuration_filter
+          ConfigurationFilter.new.hosts
+        end
+
+        def env_filter
+          EnvFilter.new.hosts
+        end
+
+        class ConfigurationFilter
+
+          def hosts
+            if filter
+              Array(filter.fetch(:hosts, []))
+            else
+              []
+            end
+          end
+
+          def config
+            Configuration.env
+          end
+
+          def filter
+            config.fetch(:filter) || config.fetch(:select)
+          end
+        end
+
+
+        class EnvFilter
+
+          def hosts
+            if filter
+              filter.split(',')
+            else
+              []
+            end
+          end
+
+          def filter
+            ENV['HOSTS']
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/capistrano/dsl.rb

@@ -26,9 +26,20 @@ module Capistrano
       execute :sudo, *args
     end
 
+    def capturing_revisions(&block)
+      set :previous_revision, fetch_revision
+      block.call
+      set :current_revision, fetch_revision
+    end
+
     def revision_log_message
       fetch(:revision_log_message,
-            t(:revision_log_message, branch: fetch(:branch), user: local_user, release: release_timestamp))
+        t(:revision_log_message,
+          branch: fetch(:branch),
+          user: local_user,
+          sha: fetch(:current_revision),
+          release: release_timestamp)
+       )
     end
 
     def rollback_log_message
@@ -43,6 +54,10 @@ module Capistrano
       VersionValidator.new(locked_version).verify
     end
 
+    private
+    def fetch_revision
+      capture("cd #{repo_path} && git rev-parse --short HEAD")
+    end
   end
 end
 self.extend Capistrano::DSL

data/lib/capistrano/dsl/env.rb

@@ -40,7 +40,17 @@ module Capistrano
       end
 
       def roles(*names)
-        env.roles_for(names)
+        env.roles_for(names.flatten)
+      end
+
+      def release_roles(*names)
+        options = { exclude: :no_release }
+        if names.last.is_a? Hash
+          names.last.merge(options)
+        else
+          names << options
+        end
+        roles(*names)
       end
 
       def primary(role)

data/lib/capistrano/dsl/paths.rb

@@ -27,6 +27,14 @@ module Capistrano
         set(:release_path, releases_path.join(timestamp))
       end
 
+      def stage_config_path
+        Pathname.new fetch(:stage_config_path, 'config/deploy')
+      end
+
+      def deploy_config_path
+        Pathname.new fetch(:deploy_config_path, 'config/deploy.rb')
+      end
+
       def repo_url
         require 'cgi'
         require 'uri'

data/lib/capistrano/dsl/stages.rb

@@ -3,7 +3,14 @@ module Capistrano
     module Stages
 
       def stages
-        Dir['config/deploy/*.rb'].map { |f| File.basename(f, '.rb') }
+        Dir[stage_definitions].map { |f| File.basename(f, '.rb') }
+      end
+
+      def infer_stages_from_stage_files
+      end
+
+      def stage_definitions
+        stage_config_path.join('*.rb')
       end
 
       def stage_set?

data/lib/capistrano/dsl/task_enhancements.rb

@@ -6,9 +6,10 @@ module Capistrano
     end
 
     def after(task, post_task, *args, &block)
-      post_task = Rake::Task.define_task(post_task, *args, &block) if block_given?
+      Rake::Task.define_task(post_task, *args, &block) if block_given?
+      post_task = Rake::Task[post_task]
       Rake::Task[task].enhance do
-        invoke(post_task)
+        post_task.invoke
       end
     end
 
@@ -49,5 +50,15 @@ module Capistrano
       %w{install}
     end
 
+    def exit_deploy_because_of_exception(ex)
+      warn t(:deploy_failed, ex: ex.inspect)
+      invoke 'deploy:failed'
+      exit(false)
+    end
+
+    def deploying?
+      fetch(:deploying, false)
+    end
+
   end
 end

data/lib/capistrano/git.rb

@@ -1 +1,36 @@
 load File.expand_path("../tasks/git.rake", __FILE__)
+
+require 'capistrano/scm'
+
+class Capistrano::Git < Capistrano::SCM
+
+  # execute git with argument in the context
+  #
+  def git(*args)
+    args.unshift :git
+    context.execute *args
+  end
+
+  # The Capistrano default strategy for git. You should want to use this.
+  module DefaultStrategy
+    def test
+      test! " [ -f #{repo_path}/HEAD ] "
+    end
+
+    def check
+      test! :git, :'ls-remote', repo_url
+    end
+
+    def clone
+      git :clone, '--mirror', repo_url, repo_path
+    end
+
+    def update
+      git :remote, :update
+    end
+
+    def release
+      git :archive, fetch(:branch), '| tar -x -C', release_path
+    end
+  end
+end

data/lib/capistrano/hg.rb

@@ -1 +1,33 @@
 load File.expand_path("../tasks/hg.rake", __FILE__)
+
+require 'capistrano/scm'
+
+class Capistrano::Hg < Capistrano::SCM
+  # execute hg in context with arguments
+  def hg(*args)
+    args.unshift(:hg)
+    context.execute *args
+  end
+
+  module DefaultStrategy
+    def test
+      test! " [ -d #{repo_path}/.hg ] "
+    end
+
+    def check
+      hg "id", repo_url
+    end
+
+    def clone
+      hg "clone", "--noupdate", repo_url, repo_path
+    end
+
+    def update
+      hg "pull"
+    end
+
+    def release
+      hg "archive", release_path, "--rev", fetch(:branch)
+    end
+  end
+end

data/lib/capistrano/i18n.rb

@@ -7,7 +7,6 @@ en = {
   start:                       'Start',
   update:                      'Update',
   finalize:                    'Finalise',
-  restart:                     'Restart',
   finishing:                   'Finishing',
   finished:                    'Finished',
   stage_not_set:               'Stage not set, please call something such as `cap production deploy`, where production is a stage you have defined.',
@@ -17,8 +16,9 @@ en = {
   no_old_releases:             'No old releases (keeping newest %{keep_releases}) on %{host}',
   linked_file_does_not_exist:  'linked file %{file} does not exist on %{host}',
   mirror_exists:               "The repository mirror is at %{at}",
-  revision_log_message:        'Branch %{branch} deployed as release %{release} by %{user}',
+  revision_log_message:        'Branch %{branch} (at %{sha}) deployed as release %{release} by %{user}',
   rollback_log_message:        '%{user} rolled back to release %{release}',
+  deploy_failed:               'The deploy has failed with an error: %{ex}',
   console: {
     welcome:  'capistrano console - enter command to execute on %{stage}',
     bye:      'bye'
@@ -32,3 +32,7 @@ en = {
 }
 
 I18n.backend.store_translations(:en, { capistrano: en })
+
+if I18n.respond_to?(:enforce_available_locales=)
+  I18n.enforce_available_locales = true
+end

data/lib/capistrano/scm.rb

@@ -0,0 +1,116 @@
+module Capistrano
+
+  # Base class for SCM strategy providers.
+  #
+  # @abstract
+  #
+  # @attr_reader [Rake] context
+  #
+  # @author Hartog de Mik
+  #
+  class SCM
+    attr_reader :context
+
+    # Provide a wrapper for the SCM that loads a strategy for the user.
+    #
+    # @param [Rake] context     The context in which the strategy should run
+    # @param [Module] strategy  A module to include into the SCM instance. The
+    #    module should provide the abstract methods of Capistrano::SCM
+    #
+    def initialize(context, strategy)
+      @context = context
+      singleton = class << self; self; end
+      singleton.send(:include, strategy)
+    end
+
+    # Call test in context
+    def test!(*args)
+      context.test *args
+    end
+
+    # The repository URL accoriding to the context
+    def repo_url
+      context.repo_url
+    end
+
+    # The repository path accoriding to the context
+    def repo_path
+      context.repo_path
+    end
+
+    # The release path accoriding to the context
+    def release_path
+      context.release_path
+    end
+
+    # Fetch a var from the context
+    # @param [Symbol] variable The variable to fetch
+    # @param [Object] default  The default value if not found
+    #
+    def fetch(*args)
+      context.fetch(*args)
+    end
+
+    # @abstract
+    #
+    # Your implementation should check the existance of a cache repository on
+    # the deployment target
+    #
+    # @return [Boolean]
+    #
+    def test
+      raise NotImplementedError.new(
+        "Your SCM strategy module should provide a #test method"
+      )
+    end
+
+    # @abstract
+    #
+    # Your implementation should check if the specified remote-repository is
+    # available.
+    #
+    # @return [Boolean]
+    #
+    def check
+      raise NotImplementedError.new(
+        "Your SCM strategy module should provide a #check method"
+      )
+    end
+
+    # @abstract
+    #
+    # Create a (new) clone of the remote-repository on the deployment target
+    #
+    # @return void
+    #
+    def clone
+      raise NotImplementedError.new(
+        "Your SCM strategy module should provide a #clone method"
+      )
+    end
+
+    # @abstract
+    #
+    # Update the clone on the deployment target
+    #
+    # @return void
+    #
+    def update
+      raise NotImplementedError.new(
+        "Your SCM strategy module should provide a #update method"
+      )
+    end
+
+    # @abstract
+    #
+    # Copy the contents of the cache-repository onto the release path
+    #
+    # @return void
+    #
+    def release
+      raise NotImplementedError.new(
+        "Your SCM strategy module should provide a #release method"
+      )
+    end
+  end
+end