2010-09-25 05:36:30 +02:00
<?xml version="1.0" encoding="utf-8"?>
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" / >
2010-12-07 04:11:19 +01:00
< title > Class: Bundler::Deployment< / title >
2010-09-25 05:36:30 +02:00
< link rel = "stylesheet" href = "../rdoc.css" type = "text/css" media = "screen" / >
< script src = "../js/jquery.js" type = "text/javascript"
charset="utf-8">< / script >
< script src = "../js/thickbox-compressed.js" type = "text/javascript"
charset="utf-8">< / script >
< script src = "../js/quicksearch.js" type = "text/javascript"
charset="utf-8">< / script >
< script src = "../js/darkfish.js" type = "text/javascript"
charset="utf-8">< / script >
< / head >
< body class = "class" >
< div id = "metadata" >
< div id = "home-metadata" >
< div id = "home-section" class = "section" >
< h3 class = "section-header" >
< a href = "../index.html" > Home< / a >
< a href = "../index.html#classes" > Classes< / a >
< a href = "../index.html#methods" > Methods< / a >
< / h3 >
< / div >
< / div >
< div id = "file-metadata" >
< div id = "file-list-section" class = "section" >
< h3 class = "section-header" > In Files< / h3 >
< div class = "section-body" >
< ul >
2010-12-07 04:11:19 +01:00
< li > < a href = "../lib/bundler/deployment_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/bundler/deployment.rb">lib/bundler/deployment.rb< / a > < / li >
2010-09-25 05:36:30 +02:00
< / ul >
< / div >
< / div >
< / div >
< div id = "class-metadata" >
<!-- Parent Class -->
< div id = "parent-class-section" class = "section" >
< h3 class = "section-header" > Parent< / h3 >
< p class = "link" > Object< / p >
< / div >
<!-- Namespace Contents -->
<!-- Method Quickref -->
< div id = "method-list-section" class = "section" >
< h3 class = "section-header" > Methods< / h3 >
< ul class = "link-list" >
2010-12-07 04:11:19 +01:00
< li > < a href = "#method-c-define_task" > ::define_task< / a > < / li >
2010-09-25 05:36:30 +02:00
< / ul >
< / div >
<!-- Included Modules -->
< / div >
< div id = "project-metadata" >
< div id = "fileindex-section" class = "section project-section" >
< h3 class = "section-header" > Files< / h3 >
< ul >
< li class = "file" > < a href = "../lib/bundler/man/bundle.html" > bundle< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/bundle-config.html" > bundle-config< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/bundle-config_txt.html" > bundle-config.txt< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/bundle-exec.html" > bundle-exec< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/bundle-exec_txt.html" > bundle-exec.txt< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/bundle-install.html" > bundle-install< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/bundle-install_txt.html" > bundle-install.txt< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/bundle-package.html" > bundle-package< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/bundle-package_txt.html" > bundle-package.txt< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/bundle-update.html" > bundle-update< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/bundle-update_txt.html" > bundle-update.txt< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/bundle_txt.html" > bundle.txt< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/man/gemfile_5_txt.html" > gemfile.5.txt< / a > < / li >
< li class = "file" > < a href = "../lib/bundler/templates/Gemfile.html" > Gemfile< / a > < / li >
< / ul >
< / div >
< div id = "classindex-section" class = "section project-section" >
< h3 class = "section-header" > Class Index
< span class = "search-toggle" > < img src = "../images/find.png"
height="16" width="16" alt="[+]"
title="show/hide quicksearch" />< / span > < / h3 >
< form action = "#" method = "get" accept-charset = "utf-8" class = "initially-hidden" >
< fieldset >
< legend > Quicksearch< / legend >
< input type = "text" name = "quicksearch" value = ""
class="quicksearch-field" />
< / fieldset >
< / form >
< ul class = "link-list" >
< li > < a href = "../Bundler.html" > Bundler< / a > < / li >
< li > < a href = "../Bundler/BundlerError.html" > Bundler::BundlerError< / a > < / li >
< li > < a href = "../Bundler/CLI.html" > Bundler::CLI< / a > < / li >
< li > < a href = "../Bundler/Definition.html" > Bundler::Definition< / a > < / li >
< li > < a href = "../Bundler/DepProxy.html" > Bundler::DepProxy< / a > < / li >
< li > < a href = "../Bundler/Dependency.html" > Bundler::Dependency< / a > < / li >
2010-12-07 04:11:19 +01:00
< li > < a href = "../Bundler/Deployment.html" > Bundler::Deployment< / a > < / li >
2010-09-25 05:36:30 +02:00
< li > < a href = "../Bundler/DeprecatedError.html" > Bundler::DeprecatedError< / a > < / li >
< li > < a href = "../Bundler/Dsl.html" > Bundler::Dsl< / a > < / li >
< li > < a href = "../Bundler/DslError.html" > Bundler::DslError< / a > < / li >
< li > < a href = "../Bundler/Environment.html" > Bundler::Environment< / a > < / li >
< li > < a href = "../Bundler/GemHelper.html" > Bundler::GemHelper< / a > < / li >
< li > < a href = "../Bundler/GemHelpers.html" > Bundler::GemHelpers< / a > < / li >
< li > < a href = "../Bundler/GemNotFound.html" > Bundler::GemNotFound< / a > < / li >
< li > < a href = "../Bundler/GemfileError.html" > Bundler::GemfileError< / a > < / li >
< li > < a href = "../Bundler/GemfileNotFound.html" > Bundler::GemfileNotFound< / a > < / li >
< li > < a href = "../Bundler/GemspecError.html" > Bundler::GemspecError< / a > < / li >
< li > < a href = "../Bundler/GitError.html" > Bundler::GitError< / a > < / li >
< li > < a href = "../Bundler/Graph.html" > Bundler::Graph< / a > < / li >
< li > < a href = "../Bundler/GraphNode.html" > Bundler::GraphNode< / a > < / li >
< li > < a href = "../Bundler/Index.html" > Bundler::Index< / a > < / li >
< li > < a href = "../Bundler/Installer.html" > Bundler::Installer< / a > < / li >
< li > < a href = "../Bundler/InvalidOption.html" > Bundler::InvalidOption< / a > < / li >
< li > < a href = "../Bundler/InvalidSpecSet.html" > Bundler::InvalidSpecSet< / a > < / li >
< li > < a href = "../Bundler/LazySpecification.html" > Bundler::LazySpecification< / a > < / li >
< li > < a href = "../Bundler/LockfileParser.html" > Bundler::LockfileParser< / a > < / li >
< li > < a href = "../Bundler/MatchPlatform.html" > Bundler::MatchPlatform< / a > < / li >
< li > < a href = "../Bundler/PathError.html" > Bundler::PathError< / a > < / li >
< li > < a href = "../Bundler/ProductionError.html" > Bundler::ProductionError< / a > < / li >
< li > < a href = "../Bundler/RemoteSpecification.html" > Bundler::RemoteSpecification< / a > < / li >
< li > < a href = "../Bundler/Resolver.html" > Bundler::Resolver< / a > < / li >
< li > < a href = "../Bundler/Resolver/SpecGroup.html" > Bundler::Resolver::SpecGroup< / a > < / li >
< li > < a href = "../Bundler/Runtime.html" > Bundler::Runtime< / a > < / li >
< li > < a href = "../Bundler/Settings.html" > Bundler::Settings< / a > < / li >
< li > < a href = "../Bundler/SharedHelpers.html" > Bundler::SharedHelpers< / a > < / li >
< li > < a href = "../Bundler/SharedHelpers/Gem.html" > Bundler::SharedHelpers::Gem< / a > < / li >
< li > < a href = "../Bundler/SharedHelpers/Gem/SourceIndex.html" > Bundler::SharedHelpers::Gem::SourceIndex< / a > < / li >
< li > < a href = "../Bundler/Source.html" > Bundler::Source< / a > < / li >
< li > < a href = "../Bundler/Source/Git.html" > Bundler::Source::Git< / a > < / li >
< li > < a href = "../Bundler/Source/Path.html" > Bundler::Source::Path< / a > < / li >
< li > < a href = "../Bundler/Source/Path/Installer.html" > Bundler::Source::Path::Installer< / a > < / li >
< li > < a href = "../Bundler/Source/Rubygems.html" > Bundler::Source::Rubygems< / a > < / li >
< li > < a href = "../Bundler/SpecSet.html" > Bundler::SpecSet< / a > < / li >
< li > < a href = "../Bundler/UI.html" > Bundler::UI< / a > < / li >
< li > < a href = "../Bundler/UI/RGProxy.html" > Bundler::UI::RGProxy< / a > < / li >
< li > < a href = "../Bundler/UI/Shell.html" > Bundler::UI::Shell< / a > < / li >
< li > < a href = "../Bundler/VersionConflict.html" > Bundler::VersionConflict< / a > < / li >
< li > < a href = "../Thor.html" > Thor< / a > < / li >
< li > < a href = "../Thor/Actions.html" > Thor::Actions< / a > < / li >
< li > < a href = "../Thor/Actions/ClassMethods.html" > Thor::Actions::ClassMethods< / a > < / li >
< li > < a href = "../Thor/Base.html" > Thor::Base< / a > < / li >
< li > < a href = "../Thor/Base/ClassMethods.html" > Thor::Base::ClassMethods< / a > < / li >
< li > < a href = "../Thor/DynamicTask.html" > Thor::DynamicTask< / a > < / li >
< li > < a href = "../Thor/Error.html" > Thor::Error< / a > < / li >
< li > < a href = "../Thor/HiddenTask.html" > Thor::HiddenTask< / a > < / li >
< li > < a href = "../Thor/Invocation.html" > Thor::Invocation< / a > < / li >
< li > < a href = "../Thor/Invocation/ClassMethods.html" > Thor::Invocation::ClassMethods< / a > < / li >
< li > < a href = "../Thor/InvocationError.html" > Thor::InvocationError< / a > < / li >
< li > < a href = "../Thor/MalformattedArgumentError.html" > Thor::MalformattedArgumentError< / a > < / li >
< li > < a href = "../Thor/RequiredArgumentMissingError.html" > Thor::RequiredArgumentMissingError< / a > < / li >
< li > < a href = "../Thor/Shell.html" > Thor::Shell< / a > < / li >
< li > < a href = "../Thor/Shell/Basic.html" > Thor::Shell::Basic< / a > < / li >
< li > < a href = "../Thor/Shell/Color.html" > Thor::Shell::Color< / a > < / li >
< li > < a href = "../Thor/Shell/HTML.html" > Thor::Shell::HTML< / a > < / li >
< li > < a href = "../Thor/Task.html" > Thor::Task< / a > < / li >
< li > < a href = "../Thor/UndefinedTaskError.html" > Thor::UndefinedTaskError< / a > < / li >
< li > < a href = "../Thor/UnknownArgumentError.html" > Thor::UnknownArgumentError< / a > < / li >
< li > < a href = "../Thor/Util.html" > Thor::Util< / a > < / li >
< li > < a href = "../Gem.html" > Gem< / a > < / li >
< li > < a href = "../Gem/Dependency.html" > Gem::Dependency< / a > < / li >
< li > < a href = "../Gem/Platform.html" > Gem::Platform< / a > < / li >
2010-12-07 04:11:19 +01:00
< li > < a href = "../Gem/Requirement.html" > Gem::Requirement< / a > < / li >
2010-09-25 05:36:30 +02:00
< li > < a href = "../Gem/Specification.html" > Gem::Specification< / a > < / li >
< / ul >
< div id = "no-class-search-results" style = "display: none;" > No matching classes.< / div >
< / div >
< / div >
< / div >
< div id = "documentation" >
2010-12-07 04:11:19 +01:00
< h1 class = "class" > Bundler::Deployment< / h1 >
2010-09-25 05:36:30 +02:00
< div id = "description" >
2010-12-07 04:11:19 +01:00
2010-09-25 05:36:30 +02:00
< / div >
<!-- Constants -->
<!-- Attributes -->
<!-- Methods -->
< div id = "public-class-method-details" class = "method-section section" >
< h3 class = "section-header" > Public Class Methods< / h3 >
2010-12-07 04:11:19 +01:00
< div id = "define-task-method" class = "method-detail " >
< a name = "method-c-define_task" > < / a >
2010-09-25 05:36:30 +02:00
< div class = "method-heading" >
2010-12-07 04:11:19 +01:00
< span class = "method-name" > define_task< / span > < span
class="method-args">(context, task_method = :task, opts = {})< / span >
2010-09-25 05:36:30 +02:00
< span class = "method-click-advice" > click to toggle source< / span >
< / div >
< div class = "method-description" >
< div class = "method-source-code"
2010-12-07 04:11:19 +01:00
id="define-task-source">
2010-09-25 05:36:30 +02:00
< pre >
2010-12-07 04:11:19 +01:00
< span class = "ruby-comment cmt" > # File lib/bundler/deployment.rb, line 3< / span >
3: < span class = "ruby-keyword kw" > def< / span > < span class = "ruby-keyword kw" > self< / span > .< span class = "ruby-identifier" > define_task< / span > (< span class = "ruby-identifier" > context< / span > , < span class = "ruby-identifier" > task_method< / span > = < span class = "ruby-value" > :task< / span > , < span class = "ruby-identifier" > opts< / span > = {})
4: < span class = "ruby-keyword kw" > if< / span > < span class = "ruby-identifier" > context< / span > .< span class = "ruby-identifier" > is_a?< / span > (< span class = "ruby-constant" > Capistrano< / span > < span class = "ruby-operator" > ::< / span > < span class = "ruby-constant" > Configuration< / span > )
5: < span class = "ruby-identifier" > context_name< / span > = < span class = "ruby-value str" > " capistrano" < / span >
6: < span class = "ruby-identifier" > role_default< / span > = < span class = "ruby-value str" > " {:except => {:no_release => true}}" < / span >
7: < span class = "ruby-keyword kw" > else< / span >
8: < span class = "ruby-identifier" > context_name< / span > = < span class = "ruby-value str" > " vlad" < / span >
9: < span class = "ruby-identifier" > role_default< / span > = < span class = "ruby-value str" > " [:app]" < / span >
10: < span class = "ruby-keyword kw" > end< / span >
11:
12: < span class = "ruby-identifier" > roles< / span > = < span class = "ruby-identifier" > context< / span > .< span class = "ruby-identifier" > fetch< / span > (< span class = "ruby-value" > :bundle_roles< / span > , < span class = "ruby-keyword kw" > nil< / span > )
13: < span class = "ruby-identifier" > opts< / span > [< span class = "ruby-value" > :roles< / span > ] = < span class = "ruby-identifier" > roles< / span > < span class = "ruby-keyword kw" > if< / span > < span class = "ruby-identifier" > roles< / span >
14:
15: < span class = "ruby-identifier" > context< / span > .< span class = "ruby-identifier" > send< / span > < span class = "ruby-value" > :namespace< / span > , < span class = "ruby-value" > :bundle< / span > < span class = "ruby-keyword kw" > do< / span >
16: < span class = "ruby-identifier" > send< / span > < span class = "ruby-value" > :desc< / span > , < span class = "ruby-value str" > Install the current Bundler environment. By default, gems will be \ installed to the shared/bundle path. Gems in the development and \ test group will not be installed. The install command is executed \ with the --deployment and --quiet flags. If the bundle cmd cannot \ be found then you can override the bundle_cmd variable to specifiy \ which one it should use. You can override any of these defaults by setting the variables shown below. N.B. bundle_roles must be defined before you require 'bundler/#{context_name}' \ in your deploy.rb file. set :bundle_gemfile, " Gemfile" set :bundle_dir, File.join(fetch(:shared_path), 'bundle') set :bundle_flags, " --deployment --quiet" set :bundle_without, [:development, :test] set :bundle_cmd, " bundle" # e.g. " /opt/ruby/bin/bundle" set :bundle_roles, #{role_default} # e.g. [:app, :batch]< / span >
17: < span class = "ruby-identifier" > send< / span > < span class = "ruby-identifier" > task_method< / span > , < span class = "ruby-value" > :install< / span > , < span class = "ruby-identifier" > opts< / span > < span class = "ruby-keyword kw" > do< / span >
18: < span class = "ruby-identifier" > bundle_cmd< / span > = < span class = "ruby-identifier" > context< / span > .< span class = "ruby-identifier" > fetch< / span > (< span class = "ruby-value" > :bundle_cmd< / span > , < span class = "ruby-value str" > " bundle" < / span > )
19: < span class = "ruby-identifier" > bundle_flags< / span > = < span class = "ruby-identifier" > context< / span > .< span class = "ruby-identifier" > fetch< / span > (< span class = "ruby-value" > :bundle_flags< / span > , < span class = "ruby-value str" > " --deployment --quiet" < / span > )
20: < span class = "ruby-identifier" > bundle_dir< / span > = < span class = "ruby-identifier" > context< / span > .< span class = "ruby-identifier" > fetch< / span > (< span class = "ruby-value" > :bundle_dir< / span > , < span class = "ruby-constant" > File< / span > .< span class = "ruby-identifier" > join< / span > (< span class = "ruby-identifier" > context< / span > .< span class = "ruby-identifier" > fetch< / span > (< span class = "ruby-value" > :shared_path< / span > ), < span class = "ruby-value str" > 'bundle'< / span > ))
21: < span class = "ruby-identifier" > bundle_gemfile< / span > = < span class = "ruby-identifier" > context< / span > .< span class = "ruby-identifier" > fetch< / span > (< span class = "ruby-value" > :bundle_gemfile< / span > , < span class = "ruby-value str" > " Gemfile" < / span > )
22: < span class = "ruby-identifier" > bundle_without< / span > = [*< span class = "ruby-identifier" > context< / span > .< span class = "ruby-identifier" > fetch< / span > (< span class = "ruby-value" > :bundle_without< / span > , [< span class = "ruby-value" > :development< / span > , < span class = "ruby-value" > :test< / span > ])].< span class = "ruby-identifier" > compact< / span >
23:
24: < span class = "ruby-identifier" > args< / span > = [< span class = "ruby-node" > " --gemfile #{File.join(context.fetch(:current_release), bundle_gemfile)}" < / span > ]
25: < span class = "ruby-identifier" > args< / span > < span class = "ruby-operator" > < < < / span > < span class = "ruby-node" > " --path #{bundle_dir}" < / span > < span class = "ruby-keyword kw" > unless< / span > < span class = "ruby-identifier" > bundle_dir< / span > .< span class = "ruby-identifier" > to_s< / span > .< span class = "ruby-identifier" > empty?< / span >
26: < span class = "ruby-identifier" > args< / span > < span class = "ruby-operator" > < < < / span > < span class = "ruby-identifier" > bundle_flags< / span > .< span class = "ruby-identifier" > to_s< / span >
27: < span class = "ruby-identifier" > args< / span > < span class = "ruby-operator" > < < < / span > < span class = "ruby-node" > " --without #{bundle_without.join(" " )}" < / span > < span class = "ruby-keyword kw" > unless< / span > < span class = "ruby-identifier" > bundle_without< / span > .< span class = "ruby-identifier" > empty?< / span >
28:
29: < span class = "ruby-identifier" > run< / span > < span class = "ruby-node" > " #{bundle_cmd} install #{args.join(' ')}" < / span >
30: < span class = "ruby-keyword kw" > end< / span >
31: < span class = "ruby-keyword kw" > end< / span >
32: < span class = "ruby-keyword kw" > end< / span > < / pre >
2010-09-25 05:36:30 +02:00
< / div >
< / div >
< / div >
< / div >
< / div >
< div id = "rdoc-debugging-section-dump" class = "debugging-section" >
< p > Disabled; run with --debug to generate this.< / p >
< / div >
< div id = "validator-badges" >
< p > < small > < a href = "http://validator.w3.org/check/referer" > [Validate]< / a > < / small > < / p >
< p > < small > Generated with the < a href = "http://deveiate.org/projects/Darkfish-Rdoc/" > Darkfish
Rdoc Generator< / a > 1.1.6< / small > .< / p >
< / div >
< / body >
< / html >
