Sha256: fbdbd792ed32b4efd4c5513d4c58353ed65453e06206a2fc0eab43eeec80f54c

Contents?: true

Size: 927 Bytes

Versions: 12

Compression:

Stored size: 927 Bytes

Contents

module Capistrano
  # This module extends a Rake::Task to freeze it to prevent it from being
  # enhanced. This is used to prevent users from enhancing a task at the wrong
  # point of Capistrano's boot process, which can happen if a Capistrano plugin
  # is loaded in deploy.rb by mistake (instead of in the Capfile).
  #
  # Usage:
  #
  # task = Rake.application["load:defaults"]
  # task.invoke
  # task.extend(Capistrano::ImmutableTask) # prevent further modifications
  #
  module ImmutableTask
    def self.extended(task)
      task.freeze
    end

    def enhance(*args, &block)
      $stderr.puts <<-MESSAGE
WARNING: #{name} has already been invoked and can no longer be modified.
Check that you haven't loaded a Capistrano plugin in deploy.rb by mistake.
Plugins must be loaded in the Capfile to initialize properly.
MESSAGE

      # This will raise a frozen object error
      super(*args, &block)
    end
  end
end

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
capistrano-3.9.1 lib/capistrano/immutable_task.rb
capistrano-3.9.0 lib/capistrano/immutable_task.rb
capistrano-3.8.2 lib/capistrano/immutable_task.rb
capistrano-3.8.1 lib/capistrano/immutable_task.rb
capistrano-3.8.0 lib/capistrano/immutable_task.rb
capistrano-3.7.2 lib/capistrano/immutable_task.rb
capistrano-3.7.1 lib/capistrano/immutable_task.rb
capistrano-3.7.0 lib/capistrano/immutable_task.rb
capistrano-3.7.0.beta1 lib/capistrano/immutable_task.rb
capistrano-3.6.1 lib/capistrano/immutable_task.rb
capistrano-3.6.0 lib/capistrano/immutable_task.rb
capistrano-3.5.0 lib/capistrano/immutable_task.rb