capistrano 3.4.1 → 3.5.0

data/lib/capistrano/defaults.rb

@@ -1,14 +1,24 @@
+validate :application do |_key, value|
+  changed_value = value.gsub(/[^A-Z0-9\.\-]/i, "_")
+  if value != changed_value
+    warn %Q(The :application value "#{value}" is invalid!)
+    warn "Use only letters, numbers, hyphens, dots, and underscores. For example:"
+    warn "  set :application, '#{changed_value}'"
+    raise Capistrano::ValidationError
+  end
+end
+
 set_if_empty :scm, :git
-set_if_empty :branch, :master
+set_if_empty :branch, "master"
 set_if_empty :deploy_to, -> { "/var/www/#{fetch(:application)}" }
 set_if_empty :tmp_dir, "/tmp"
 
 set_if_empty :default_env, {}
 set_if_empty :keep_releases, 5
 
-set_if_empty :format, :pretty
+set_if_empty :format, :airbrussh
 set_if_empty :log_level, :debug
 
 set_if_empty :pty, false
 
-set_if_empty :local_user, -> { Etc.getlogin }
+set_if_empty :local_user, -> { ENV["USER"] || ENV["LOGNAME"] || ENV["USERNAME"] }

data/lib/capistrano/deploy.rb

@@ -1,3 +1,3 @@
-require 'capistrano/framework'
+require "capistrano/framework"
 
 load File.expand_path("../tasks/deploy.rake", __FILE__)

data/lib/capistrano/doctor.rb

@@ -0,0 +1,5 @@
+require "capistrano/doctor/environment_doctor"
+require "capistrano/doctor/gems_doctor"
+require "capistrano/doctor/variables_doctor"
+
+load File.expand_path("../tasks/doctor.rake", __FILE__)

data/lib/capistrano/doctor/environment_doctor.rb

@@ -0,0 +1,19 @@
+require "capistrano/doctor/output_helpers"
+
+module Capistrano
+  module Doctor
+    class EnvironmentDoctor
+      include Capistrano::Doctor::OutputHelpers
+
+      def call
+        title("Environment")
+        puts <<-OUT.gsub(/^\s+/, "")
+          Ruby     #{RUBY_DESCRIPTION}
+          Rubygems #{Gem::VERSION}
+          Bundler  #{defined?(Bundler::VERSION) ? Bundler::VERSION : 'N/A'}
+          Command  #{$PROGRAM_NAME} #{ARGV.join(' ')}
+        OUT
+      end
+    end
+  end
+end

data/lib/capistrano/doctor/gems_doctor.rb

@@ -0,0 +1,45 @@
+require "capistrano/doctor/output_helpers"
+
+module Capistrano
+  module Doctor
+    # Prints table of all Capistrano-related gems and their version numbers. If
+    # there is a newer version of a gem available, call attention to it.
+    class GemsDoctor
+      include Capistrano::Doctor::OutputHelpers
+
+      def call
+        title("Gems")
+        table(all_gem_names) do |gem, row|
+          row.yellow if update_available?(gem)
+          row << gem
+          row << installed_gem_version(gem)
+          row << "(update available)" if update_available?(gem)
+        end
+      end
+
+      private
+
+      def installed_gem_version(gem_name)
+        Gem.loaded_specs[gem_name].version
+      end
+
+      def update_available?(gem_name)
+        latest = Gem.latest_version_for(gem_name)
+        return false if latest.nil?
+        latest > installed_gem_version(gem_name)
+      end
+
+      def all_gem_names
+        core_gem_names + plugin_gem_names
+      end
+
+      def core_gem_names
+        %w(capistrano airbrussh rake sshkit) & Gem.loaded_specs.keys
+      end
+
+      def plugin_gem_names
+        (Gem.loaded_specs.keys - ["capistrano"]).grep(/capistrano/).sort
+      end
+    end
+  end
+end

data/lib/capistrano/doctor/output_helpers.rb

@@ -0,0 +1,79 @@
+module Capistrano
+  module Doctor
+    # Helper methods for pretty-printing doctor output to stdout. All output
+    # (other than `title`) is indented by four spaces to facilitate copying and
+    # pasting this output into e.g. GitHub or Stack Overflow to achieve code
+    # formatting.
+    module OutputHelpers
+      class Row
+        attr_reader :color
+        attr_reader :values
+
+        def initialize
+          @values = []
+        end
+
+        def <<(value)
+          values << value
+        end
+
+        def yellow
+          @color = :yellow
+        end
+      end
+
+      # Prints a table for a given array of records. For each record, the block
+      # is yielded two arguments: the record and a Row object. To print values
+      # for that record, add values using `row << "some value"`. A row can
+      # optionally be highlighted in yellow using `row.yellow`.
+      def table(records, &block)
+        return if records.empty?
+        rows = collect_rows(records, &block)
+        col_widths = calculate_column_widths(rows)
+
+        rows.each do |row|
+          line = row.values.each_with_index.map do |value, col|
+            value.to_s.ljust(col_widths[col])
+          end.join(" ").rstrip
+          line = color.colorize(line, row.color) if row.color
+          puts line
+        end
+      end
+
+      # Prints a title in blue with surrounding newlines.
+      def title(text)
+        # Use $stdout directly to bypass the indentation that our `puts` does.
+        $stdout.puts(color.colorize("\n#{text}\n", :blue))
+      end
+
+      # Prints text in yellow.
+      def warning(text)
+        puts color.colorize(text, :yellow)
+      end
+
+      # Override `Kernel#puts` to prepend four spaces to each line.
+      def puts(string=nil)
+        $stdout.puts(string.to_s.gsub(/^/, "    "))
+      end
+
+      private
+
+      def collect_rows(records)
+        records.map do |rec|
+          Row.new.tap { |row| yield(rec, row) }
+        end
+      end
+
+      def calculate_column_widths(rows)
+        num_columns = rows.map { |row| row.values.length }.max
+        Array.new(num_columns) do |col|
+          rows.map { |row| row.values[col].to_s.length }.max
+        end
+      end
+
+      def color
+        @color ||= SSHKit::Color.new($stdout)
+      end
+    end
+  end
+end

data/lib/capistrano/doctor/variables_doctor.rb

@@ -0,0 +1,66 @@
+require "capistrano/doctor/output_helpers"
+
+module Capistrano
+  module Doctor
+    # Prints a table of all Capistrano variables and their current values. If
+    # there are unrecognized variables, print warnings for them.
+    class VariablesDoctor
+      # These are keys that have no default values in Capistrano, but are
+      # nonetheless expected to be set.
+      WHITELIST = [:application, :repo_url].freeze
+      private_constant :WHITELIST
+
+      include Capistrano::Doctor::OutputHelpers
+
+      def initialize(env=Capistrano::Configuration.env)
+        @env = env
+      end
+
+      def call
+        title("Variables")
+        values = inspect_all_values
+
+        table(variables.keys.sort) do |key, row|
+          row.yellow if suspicious_keys.include?(key)
+          row << ":#{key}"
+          row << values[key]
+        end
+
+        puts if suspicious_keys.any?
+
+        suspicious_keys.sort.each do |key|
+          warning(
+            ":#{key} is not a recognized Capistrano setting (#{location(key)})"
+          )
+        end
+      end
+
+      private
+
+      attr_reader :env
+
+      def variables
+        env.variables
+      end
+
+      def inspect_all_values
+        variables.keys.each_with_object({}) do |key, inspected|
+          inspected[key] = if env.is_question?(key)
+                             "<ask>"
+                           else
+                             variables.peek(key).inspect
+                           end
+        end
+      end
+
+      def suspicious_keys
+        (variables.untrusted_keys & variables.unused_keys) - WHITELIST
+      end
+
+      def location(key)
+        loc = variables.source_locations(key).first
+        loc && loc.sub(/^#{Regexp.quote(Dir.pwd)}/, "").sub(/:in.*/, "")
+      end
+    end
+  end
+end

data/lib/capistrano/dotfile.rb

@@ -1,3 +1,2 @@
-dotfile = Pathname.new(File.join(Dir.home, '.capfile'))
+dotfile = Pathname.new(File.join(Dir.home, ".capfile"))
 load dotfile if dotfile.file?
-

data/lib/capistrano/dsl.rb

@@ -1,9 +1,8 @@
-require 'etc'
-require 'capistrano/dsl/task_enhancements'
-require 'capistrano/dsl/paths'
-require 'capistrano/dsl/stages'
-require 'capistrano/dsl/env'
-require 'capistrano/configuration/filter'
+require "capistrano/dsl/task_enhancements"
+require "capistrano/dsl/paths"
+require "capistrano/dsl/stages"
+require "capistrano/dsl/env"
+require "capistrano/configuration/filter"
 
 module Capistrano
   module DSL
@@ -30,12 +29,12 @@ module Capistrano
 
     def revision_log_message
       fetch(:revision_log_message,
-        t(:revision_log_message,
-          branch: fetch(:branch),
-          user: local_user,
-          sha: fetch(:current_revision),
-          release: fetch(:release_timestamp))
-       )
+            t(:revision_log_message,
+              branch: fetch(:branch),
+              user: local_user,
+              sha: fetch(:current_revision),
+              release: fetch(:release_timestamp))
+           )
     end
 
     def rollback_log_message
@@ -58,7 +57,6 @@ module Capistrano
     def run_locally(&block)
       SSHKit::Backend::Local.new(&block).run
     end
-
   end
 end
-self.extend Capistrano::DSL
+extend Capistrano::DSL

data/lib/capistrano/dsl/env.rb

@@ -1,46 +1,20 @@
+require "forwardable"
+
 module Capistrano
   module DSL
     module Env
+      extend Forwardable
+      def_delegators :env,
+                     :configure_backend, :fetch, :set, :set_if_empty, :delete,
+                     :ask, :role, :server, :primary, :validate, :append,
+                     :remove, :dry_run?, :install_plugin
 
-      def configure_backend
-        env.configure_backend
-      end
-
-      def fetch(key, default=nil, &block)
-        env.fetch(key, default, &block)
+      def is_question?(key)
+        env.is_question?(key)
       end
 
       def any?(key)
-        value = fetch(key)
-        if value && value.respond_to?(:any?)
-          value.any?
-        else
-          !fetch(key).nil?
-        end
-      end
-
-      def set(key, value)
-        env.set(key, value)
-      end
-
-      def set_if_empty(key, value)
-        env.set_if_empty(key, value)
-      end
-
-      def delete(key)
-        env.delete(key)
-      end
-
-      def ask(key, value, options={})
-        env.ask(key, value, options)
-      end
-
-      def role(name, servers, options={})
-        env.role(name, servers, options)
-      end
-
-      def server(name, properties={})
-        env.server(name, properties)
+        env.any?(key)
       end
 
       def roles(*names)
@@ -53,17 +27,13 @@ module Capistrano
 
       def release_roles(*names)
         if names.last.is_a? Hash
-          names.last.merge!({ :exclude => :no_release })
+          names.last[:exclude] = :no_release
         else
           names << { exclude: :no_release }
         end
         roles(*names)
       end
 
-      def primary(role)
-        env.primary(role)
-      end
-
       def env
         Configuration.env
       end
@@ -75,7 +45,6 @@ module Capistrano
       def asset_timestamp
         env.timestamp.strftime("%Y%m%d%H%M.%S")
       end
-
     end
   end
 end

data/lib/capistrano/dsl/paths.rb

@@ -1,8 +1,7 @@
-require 'pathname'
+require "pathname"
 module Capistrano
   module DSL
     module Paths
-
       def deploy_to
         fetch(:deploy_to)
       end
@@ -12,11 +11,11 @@ module Capistrano
       end
 
       def current_path
-        deploy_path.join('current')
+        deploy_path.join("current")
       end
 
       def releases_path
-        deploy_path.join('releases')
+        deploy_path.join("releases")
       end
 
       def release_path
@@ -29,17 +28,17 @@ module Capistrano
       end
 
       def stage_config_path
-        Pathname.new fetch(:stage_config_path, 'config/deploy')
+        Pathname.new fetch(:stage_config_path, "config/deploy")
       end
 
       def deploy_config_path
-        Pathname.new fetch(:deploy_config_path, 'config/deploy.rb')
+        Pathname.new fetch(:deploy_config_path, "config/deploy.rb")
       end
 
       def repo_url
-        require 'cgi'
-        require 'uri'
-        if fetch(:git_http_username) and fetch(:git_http_password)
+        require "cgi"
+        require "uri"
+        if fetch(:git_http_username) && fetch(:git_http_password)
           URI.parse(fetch(:repo_url)).tap do |repo_uri|
             repo_uri.user     = fetch(:git_http_username)
             repo_uri.password = CGI.escape(fetch(:git_http_password))
@@ -54,15 +53,15 @@ module Capistrano
       end
 
       def repo_path
-        Pathname.new(fetch(:repo_path, ->(){deploy_path.join('repo')}))
+        Pathname.new(fetch(:repo_path, ->() { deploy_path.join("repo") }))
       end
 
       def shared_path
-        deploy_path.join('shared')
+        deploy_path.join("shared")
       end
 
       def revision_log
-        deploy_path.join('revisions.log')
+        deploy_path.join("revisions.log")
       end
 
       def now
@@ -96,7 +95,7 @@ module Capistrano
       end
 
       def map_dirnames(paths)
-        paths.map { |path| path.dirname }
+        paths.map(&:dirname).uniq
       end
     end
   end