capistrano 3.4.1 → 3.5.0

data/lib/capistrano/configuration/filter.rb

@@ -1,55 +1,26 @@
-require 'capistrano/configuration'
+require "capistrano/configuration"
+require "capistrano/configuration/empty_filter"
+require "capistrano/configuration/host_filter"
+require "capistrano/configuration/null_filter"
+require "capistrano/configuration/role_filter"
 
 module Capistrano
   class Configuration
     class Filter
-      def initialize type, values = nil
-        raise "Invalid filter type #{type}" unless [:host,:role].include? type
-        av = Array(values).dup
-        @mode = case
-                when av.size == 0 then :none
-                when av.include?(:all) then :all
-                else type
-                end
-        @rex = case @mode
-          when :host
-            av.map!{|v| (v.is_a?(String) && v =~ /^(?<name>[-A-Za-z0-9.]+)(,\g<name>)*$/) ? v.split(',') : v }
-            av.flatten!
-            av.map! do |v|
-              case v
-              when Regexp then v
-              else
-                vs = v.to_s
-                vs =~ /^[-A-Za-z0-9.]+$/ ? vs : Regexp.new(vs)
-              end
-            end
-            Regexp.union av
-          when :role
-            av.map!{|v| v.is_a?(String) ? v.split(',') : v }
-            av.flatten!
-            av.map! do |v|
-              case v
-              when Regexp then v
-              else
-                vs = v.to_s
-                vs =~ %r{^/(.+)/$} ? Regexp.new($1) : %r{^#{vs}$}
-              end
-            end
-            Regexp.union av
-          else
-            nil
-          end
+      def initialize(type, values=nil)
+        raise "Invalid filter type #{type}" unless [:host, :role].include? type
+        av = Array(values)
+        @strategy = case
+                    when av.empty? then EmptyFilter.new
+                    when av.include?(:all), av.include?("all") then NullFilter.new
+                    when type == :host then HostFilter.new(values)
+                    when type == :role then RoleFilter.new(values)
+                    else NullFilter.new
+                    end
       end
-      def filter servers
-        as = Array(servers)
-        case @mode
-        when :none then return []
-        when :all  then return servers
-        when :host
-          as.select {|s| @rex.match s.hostname}
-        when :role
-          as.select {|s| s.roles.any? {|r| @rex.match r} }
-        end
+
+      def filter(servers)
+        @strategy.filter servers
       end
     end
   end

data/lib/capistrano/configuration/host_filter.rb

@@ -0,0 +1,30 @@
+module Capistrano
+  class Configuration
+    class HostFilter
+      def initialize(values)
+        av = Array(values).dup
+        av.map! { |v| (v.is_a?(String) && v =~ /^(?<name>[-A-Za-z0-9.]+)(,\g<name>)*$/) ? v.split(",") : v }
+        av.flatten!
+        @rex = regex_matcher(av)
+      end
+
+      def filter(servers)
+        Array(servers).select { |s| @rex.match s.to_s }
+      end
+
+      private
+
+      def regex_matcher(values)
+        values.map! do |v|
+          case v
+          when Regexp then v
+          else
+            vs = v.to_s
+            vs =~ /^[-A-Za-z0-9.]+$/ ? vs : Regexp.new(vs)
+          end
+        end
+        Regexp.union values
+      end
+    end
+  end
+end

data/lib/capistrano/configuration/null_filter.rb

@@ -0,0 +1,9 @@
+module Capistrano
+  class Configuration
+    class NullFilter
+      def filter(servers)
+        servers
+      end
+    end
+  end
+end

data/lib/capistrano/configuration/plugin_installer.rb

@@ -0,0 +1,33 @@
+# Encapsulates the logic for installing plugins into Capistrano. Plugins must
+# simply conform to a basic API; the PluginInstaller takes care of invoking the
+# API at appropriate times.
+#
+# This class is not used directly; instead it is typically accessed via the
+# `install_plugin` method of the Capistrano DSL.
+#
+module Capistrano
+  class Configuration
+    class PluginInstaller
+      # "Installs" a Plugin into Capistrano by loading its tasks, hooks, and
+      # defaults at the appropriate time. The hooks in particular can be
+      # skipped, if you want full control over when and how the plugin's tasks
+      # are executed. Simply pass `load_hooks:false` to opt out.
+      #
+      # The plugin class or instance may be provided. These are equivalent:
+      #
+      # install(Capistrano::SCM::Git)
+      # install(Capistrano::SCM::Git.new)
+      #
+      def install(plugin, load_hooks:true)
+        plugin = plugin.is_a?(Class) ? plugin.new : plugin
+
+        plugin.define_tasks
+        plugin.register_hooks if load_hooks
+
+        Rake::Task.define_task("load:defaults") do
+          plugin.set_defaults
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/configuration/question.rb

@@ -1,9 +1,10 @@
 module Capistrano
   class Configuration
     class Question
-
-      def initialize(key, default, options = {})
-        @key, @default, @options = key, default, options
+      def initialize(key, default, options={})
+        @key = key
+        @default = default
+        @options = options
       end
 
       def call
@@ -12,6 +13,7 @@ module Capistrano
       end
 
       private
+
       attr_reader :key, :default, :options
 
       def ask_question
@@ -28,20 +30,21 @@ module Capistrano
 
       def response
         return @response if defined? @response
-        
+
         @response = (gets || "").chomp
       end
-      
+
       def gets
         if echo?
           $stdin.gets
         else
-          $stdin.noecho(&:gets).tap{ $stdout.print "\n" }
+          $stdin.noecho(&:gets).tap { $stdout.print "\n" }
         end
       rescue Errno::EIO
         # when stdio gets closed
+        return
       end
-        
+
       def question
         I18n.t(:question, key: key, default_value: default, scope: :capistrano)
       end

data/lib/capistrano/configuration/role_filter.rb

@@ -0,0 +1,30 @@
+module Capistrano
+  class Configuration
+    class RoleFilter
+      def initialize(values)
+        av = Array(values).dup
+        av.map! { |v| v.is_a?(String) ? v.split(",") : v }
+        av.flatten!
+        @rex = regex_matcher(av)
+      end
+
+      def filter(servers)
+        Array(servers).select { |s| s.is_a?(String) ? false : s.roles.any? { |r| @rex.match r } }
+      end
+
+      private
+
+      def regex_matcher(values)
+        values.map! do |v|
+          case v
+          when Regexp then v
+          else
+            vs = v.to_s
+            vs =~ %r{^/(.+)/$} ? Regexp.new($1) : /^#{vs}$/
+          end
+        end
+        Regexp.union values
+      end
+    end
+  end
+end

data/lib/capistrano/configuration/server.rb

@@ -1,4 +1,4 @@
-require 'set'
+require "set"
 module Capistrano
   class Configuration
     class Server < SSHKit::Host
@@ -25,19 +25,21 @@ module Capistrano
       end
 
       def select?(options)
-        options.each do |k,v|
-          callable = v.respond_to?(:call) ? v: ->(server){server.fetch(v)}
-          result = case k
-          when :filter, :select
-            callable.call(self)
-          when :exclude
-            !callable.call(self)
-          else
-            self.fetch(k) == v
-          end
+        options.each do |k, v|
+          callable = v.respond_to?(:call) ? v : ->(server) { server.fetch(v) }
+          result = \
+            case k
+            when :filter, :select
+              callable.call(self)
+            when :exclude
+              !callable.call(self)
+            else
+              fetch(k) == v
+            end
           return false unless result
         end
-        return true
+
+        true
       end
 
       def primary
@@ -54,7 +56,7 @@ module Capistrano
       end
 
       def netssh_options
-        @netssh_options ||= super.merge( fetch(:ssh_options) || {} )
+        @netssh_options ||= super.merge(fetch(:ssh_options) || {})
       end
 
       def roles_array
@@ -62,7 +64,7 @@ module Capistrano
       end
 
       def matches?(other)
-        hostname == other.hostname
+        hostname == other.hostname && port == other.port
       end
 
       private
@@ -76,18 +78,17 @@ module Capistrano
       end
 
       class Properties
-
         def initialize
           @properties = {}
         end
 
         def set(key, value)
           pval = @properties[key]
-          if pval.is_a? Hash and value.is_a? Hash
+          if pval.is_a?(Hash) && value.is_a?(Hash)
             pval.merge!(value)
-          elsif pval.is_a? Set and value.is_a? Set
+          elsif pval.is_a?(Set) && value.is_a?(Set)
             pval.merge(value)
-          elsif pval.is_a? Array and value.is_a? Array
+          elsif pval.is_a?(Array) && value.is_a?(Array)
             pval.concat value
           else
             @properties[key] = value
@@ -98,8 +99,8 @@ module Capistrano
           @properties[key]
         end
 
-        def respond_to?(method, include_all=false)
-          @properties.has_key?(method)
+        def respond_to?(method, _include_all=false)
+          @properties.key?(method)
         end
 
         def roles
@@ -121,11 +122,9 @@ module Capistrano
         private
 
         def lvalue(key)
-          key.to_s.chomp('=').to_sym
+          key.to_s.chomp("=").to_sym
         end
-
       end
-
     end
   end
 end

data/lib/capistrano/configuration/servers.rb

@@ -1,6 +1,6 @@
-require 'set'
-require 'capistrano/configuration'
-require 'capistrano/configuration/filter'
+require "set"
+require "capistrano/configuration"
+require "capistrano/configuration/filter"
 
 module Capistrano
   class Configuration
@@ -9,9 +9,8 @@ module Capistrano
 
       def add_host(host, properties={})
         new_host = Server[host]
-        if server = servers.find { |s| s.matches? new_host }
+        if (server = servers.find { |s| s.matches? new_host })
           server.user = new_host.user if new_host.user
-          server.port = new_host.port if new_host.port
           server.with(properties)
         else
           servers << new_host.with(properties)
@@ -38,12 +37,12 @@ module Capistrano
               if block_given?
                 yield host, role, props
               else
-                rps << (props || {}).merge( role: role, hostname: host.hostname )
+                rps << (props || {}).merge(role: role, hostname: host.hostname)
               end
             end
           end
         end
-        block_given? ? nil: rps
+        block_given? ? nil : rps
       end
 
       def fetch_primary(role)

data/lib/capistrano/configuration/variables.rb

@@ -0,0 +1,136 @@
+module Capistrano
+  class Configuration
+    # Holds the variables assigned at Capistrano runtime via `set` and retrieved
+    # with `fetch`. Does internal bookkeeping to help identify user mistakes
+    # like spelling errors or unused variables that may lead to unexpected
+    # behavior. Also allows validation rules to be registered with `validate`.
+    class Variables
+      CAPISTRANO_LOCATION = File.expand_path("../..", __FILE__).freeze
+      IGNORED_LOCATIONS = [
+        "#{CAPISTRANO_LOCATION}/configuration/variables.rb:",
+        "#{CAPISTRANO_LOCATION}/configuration.rb:",
+        "#{CAPISTRANO_LOCATION}/dsl/env.rb:",
+        "/dsl.rb:",
+        "/forwardable.rb:"
+      ].freeze
+      private_constant :CAPISTRANO_LOCATION, :IGNORED_LOCATIONS
+
+      def initialize(values={})
+        @trusted_keys = []
+        @fetched_keys = []
+        @locations = {}
+        @values = values
+        @trusted = true
+      end
+
+      def untrusted!
+        @trusted = false
+        yield
+      ensure
+        @trusted = true
+      end
+
+      def set(key, value=nil, &block)
+        invoke_validations(key, value, &block)
+        @trusted_keys << key if trusted?
+        remember_location(key)
+        values[key] = block || value
+        trace_set(key)
+        values[key]
+      end
+
+      def fetch(key, default=nil, &block)
+        fetched_keys << key
+        peek(key, default, &block)
+      end
+
+      # Internal use only.
+      def peek(key, default=nil, &block)
+        value = fetch_for(key, default, &block)
+        while callable_without_parameters?(value)
+          value = (values[key] = value.call)
+        end
+        value
+      end
+
+      def fetch_for(key, default, &block)
+        block ? values.fetch(key, &block) : values.fetch(key, default)
+      end
+
+      def delete(key)
+        values.delete(key)
+      end
+
+      def validate(key, &validator)
+        vs = (validators[key] || [])
+        vs << validator
+        validators[key] = vs
+      end
+
+      def trusted_keys
+        @trusted_keys.dup
+      end
+
+      def untrusted_keys
+        keys - @trusted_keys
+      end
+
+      def keys
+        values.keys
+      end
+
+      # Keys that have been set, but which have never been fetched.
+      def unused_keys
+        keys - fetched_keys
+      end
+
+      # Returns an array of source file location(s) where the given key was
+      # assigned (i.e. where `set` was called). If the key was never assigned,
+      # returns `nil`.
+      def source_locations(key)
+        locations[key]
+      end
+
+      private
+
+      attr_reader :locations, :values, :fetched_keys
+
+      def trusted?
+        @trusted
+      end
+
+      def remember_location(key)
+        location = caller.find do |line|
+          IGNORED_LOCATIONS.none? { |i| line.include?(i) }
+        end
+        (locations[key] ||= []) << location
+      end
+
+      def callable_without_parameters?(x)
+        x.respond_to?(:call) && (!x.respond_to?(:arity) || x.arity == 0)
+      end
+
+      def validators
+        @validators ||= {}
+      end
+
+      def invoke_validations(key, value, &block)
+        unless value.nil? || block.nil?
+          raise Capistrano::ValidationError,
+                "Value and block both passed to Configuration#set"
+        end
+
+        return unless validators.key? key
+
+        validators[key].each do |validator|
+          validator.call(key, block || value)
+        end
+      end
+
+      def trace_set(key)
+        return unless fetch(:print_config_variables, false)
+        puts "Config variable set: #{key.inspect} => #{values[key].inspect}"
+      end
+    end
+  end
+end