1220 lines
50 KiB
HTML
1220 lines
50 KiB
HTML
|
<?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" />
|
||
|
|
|
||
|
|
<title>Class: Thor</title>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/actions/create_file_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/actions/create_file.rb">lib/bundler/vendor/thor/actions/create_file.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/actions/directory_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/actions/directory.rb">lib/bundler/vendor/thor/actions/directory.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/actions/empty_directory_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/actions/empty_directory.rb">lib/bundler/vendor/thor/actions/empty_directory.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/actions/file_manipulation_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/actions/file_manipulation.rb">lib/bundler/vendor/thor/actions/file_manipulation.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/actions/inject_into_file_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/actions/inject_into_file.rb">lib/bundler/vendor/thor/actions/inject_into_file.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/actions_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/actions.rb">lib/bundler/vendor/thor/actions.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/base_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/base.rb">lib/bundler/vendor/thor/base.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/core_ext/hash_with_indifferent_access_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/core_ext/hash_with_indifferent_access.rb">lib/bundler/vendor/thor/core_ext/hash_with_indifferent_access.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/core_ext/ordered_hash_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/core_ext/ordered_hash.rb">lib/bundler/vendor/thor/core_ext/ordered_hash.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/error_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/error.rb">lib/bundler/vendor/thor/error.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/invocation_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/invocation.rb">lib/bundler/vendor/thor/invocation.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/parser/argument_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/parser/argument.rb">lib/bundler/vendor/thor/parser/argument.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/parser/arguments_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/parser/arguments.rb">lib/bundler/vendor/thor/parser/arguments.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/parser/option_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/parser/option.rb">lib/bundler/vendor/thor/parser/option.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/parser/options_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/parser/options.rb">lib/bundler/vendor/thor/parser/options.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/shell/basic_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/shell/basic.rb">lib/bundler/vendor/thor/shell/basic.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/shell/color_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/shell/color.rb">lib/bundler/vendor/thor/shell/color.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/shell/html_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/shell/html.rb">lib/bundler/vendor/thor/shell/html.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/shell_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/shell.rb">lib/bundler/vendor/thor/shell.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/task_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/task.rb">lib/bundler/vendor/thor/task.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/util_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/util.rb">lib/bundler/vendor/thor/util.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor/version_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor/version.rb">lib/bundler/vendor/thor/version.rb</a></li>
|
||
|
|
|
||
|
|
<li><a href="./lib/bundler/vendor/thor_rb.html?TB_iframe=true&height=550&width=785"
|
||
|
|
class="thickbox" title="lib/bundler/vendor/thor.rb">lib/bundler/vendor/thor.rb</a></li>
|
||
|
|
|
||
|
|
</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 -->
|
||
|
|
|
||
|
|
<div id="namespace-list-section" class="section">
|
||
|
|
<h3 class="section-header">Namespace</h3>
|
||
|
|
<ul class="link-list">
|
||
|
|
|
||
|
|
<li><span class="type">MODULE</span> <a href="Thor/Actions.html">Thor::Actions</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">MODULE</span> <a href="Thor/Base.html">Thor::Base</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">MODULE</span> <a href="Thor/CoreExt.html">Thor::CoreExt</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">MODULE</span> <a href="Thor/Invocation.html">Thor::Invocation</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">MODULE</span> <a href="Thor/Sandbox.html">Thor::Sandbox</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">MODULE</span> <a href="Thor/Shell.html">Thor::Shell</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">MODULE</span> <a href="Thor/Util.html">Thor::Util</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/Argument.html">Thor::Argument</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/Arguments.html">Thor::Arguments</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/DynamicTask.html">Thor::DynamicTask</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/Error.html">Thor::Error</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/HiddenTask.html">Thor::HiddenTask</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/InvocationError.html">Thor::InvocationError</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/MalformattedArgumentError.html">Thor::MalformattedArgumentError</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/Option.html">Thor::Option</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/Options.html">Thor::Options</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/RequiredArgumentMissingError.html">Thor::RequiredArgumentMissingError</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/Task.html">Thor::Task</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/UndefinedTaskError.html">Thor::UndefinedTaskError</a></li>
|
||
|
|
|
||
|
|
<li><span class="type">CLASS</span> <a href="Thor/UnknownArgumentError.html">Thor::UnknownArgumentError</a></li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Method Quickref -->
|
||
|
|
|
||
|
|
<div id="method-list-section" class="section">
|
||
|
|
<h3 class="section-header">Methods</h3>
|
||
|
|
<ul class="link-list">
|
||
|
|
|
||
|
|
<li><a href="#method-c-banner">::banner</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-check_unknown_options%21">::check_unknown_options!</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-default_task">::default_task</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-desc">::desc</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-help">::help</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-long_desc">::long_desc</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-map">::map</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-method_option">::method_option</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-method_options">::method_options</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-printable_tasks">::printable_tasks</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-subcommand">::subcommand</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-subcommand_help">::subcommand_help</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-subcommands">::subcommands</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-c-task_help">::task_help</a></li>
|
||
|
|
|
||
|
|
<li><a href="#method-i-help">#help</a></li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Included Modules -->
|
||
|
|
|
||
|
|
<div id="includes-section" class="section">
|
||
|
|
<h3 class="section-header">Included Modules</h3>
|
||
|
|
<ul class="link-list">
|
||
|
|
|
||
|
|
|
||
|
|
<li><a class="include" href="Thor/Base.html">Thor::Base</a></li>
|
||
|
|
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<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">
|
||
|
|
<h1 class="class">Thor</h1>
|
||
|
|
|
||
|
|
<div id="description">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- Constants -->
|
||
|
|
|
||
|
|
<div id="constants-list" class="section">
|
||
|
|
<h3 class="section-header">Constants</h3>
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt><a name="HELP_MAPPINGS">HELP_MAPPINGS</a></dt>
|
||
|
|
|
||
|
|
<dd class="description"><p>
|
||
|
|
Shortcuts for help.
|
||
|
|
</p></dd>
|
||
|
|
|
||
|
|
|
||
|
|
<dt><a name="THOR_RESERVED_WORDS">THOR_RESERVED_WORDS</a></dt>
|
||
|
|
|
||
|
|
<dd class="description"><p>
|
||
|
|
<a href="Thor.html">Thor</a> methods that should not be overwritten by the
|
||
|
|
user.
|
||
|
|
</p></dd>
|
||
|
|
|
||
|
|
|
||
|
|
<dt><a name="VERSION">VERSION</a></dt>
|
||
|
|
|
||
|
|
<dd class="description"></dd>
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Attributes -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Methods -->
|
||
|
|
|
||
|
|
<div id="public-class-method-details" class="method-section section">
|
||
|
|
<h3 class="section-header">Public Class Methods</h3>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="check-unknown-options--method" class="method-detail ">
|
||
|
|
<a name="method-c-check_unknown_options%21"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">check_unknown_options!</span><span
|
||
|
|
class="method-args">(options={})</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Extend check unknown options to accept a hash of conditions.
|
||
|
|
</p>
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
<p>
|
||
|
|
options<Hash>: A hash containing :only and/or :except keys
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="check-unknown-options--source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 195</span>
|
||
|
|
195: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check_unknown_options!</span>(<span class="ruby-identifier">options</span>={})
|
||
|
|
196: <span class="ruby-ivar">@check_unknown_options</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
|
||
|
|
197: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
||
|
|
198: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">value</span>
|
||
|
|
199: <span class="ruby-ivar">@check_unknown_options</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-constant">Array</span>(<span class="ruby-identifier">value</span>)
|
||
|
|
200: <span class="ruby-keyword kw">else</span>
|
||
|
|
201: <span class="ruby-ivar">@check_unknown_options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
|
||
|
|
202: <span class="ruby-keyword kw">end</span>
|
||
|
|
203: <span class="ruby-keyword kw">end</span>
|
||
|
|
204: <span class="ruby-ivar">@check_unknown_options</span>
|
||
|
|
205: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="default-task-method" class="method-detail ">
|
||
|
|
<a name="method-c-default_task"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">default_task</span><span
|
||
|
|
class="method-args">(meth=nil)</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Sets the default task when thor is executed without an explicit task to be
|
||
|
|
called.
|
||
|
|
</p>
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<table>
|
||
|
|
<tr><td valign="top">meth<Symbol></td><td><p>
|
||
|
|
name of the defaut task
|
||
|
|
</p>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="default-task-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 10</span>
|
||
|
|
10: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">default_task</span>(<span class="ruby-identifier">meth</span>=<span class="ruby-keyword kw">nil</span>)
|
||
|
|
11: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">meth</span>
|
||
|
|
12: <span class="ruby-keyword kw">when</span> <span class="ruby-value">:none</span>
|
||
|
|
13: <span class="ruby-ivar">@default_task</span> = <span class="ruby-value str">'help'</span>
|
||
|
|
14: <span class="ruby-keyword kw">when</span> <span class="ruby-keyword kw">nil</span>
|
||
|
|
15: <span class="ruby-ivar">@default_task</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">from_superclass</span>(<span class="ruby-value">:default_task</span>, <span class="ruby-value str">'help'</span>)
|
||
|
|
16: <span class="ruby-keyword kw">else</span>
|
||
|
|
17: <span class="ruby-ivar">@default_task</span> = <span class="ruby-identifier">meth</span>.<span class="ruby-identifier">to_s</span>
|
||
|
|
18: <span class="ruby-keyword kw">end</span>
|
||
|
|
19: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="desc-method" class="method-detail ">
|
||
|
|
<a name="method-c-desc"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">desc</span><span
|
||
|
|
class="method-args">(usage, description, options={})</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Defines the usage and the description of the next task.
|
||
|
|
</p>
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<p>
|
||
|
|
usage<String> description<String> options<String>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="desc-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 28</span>
|
||
|
|
28: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">desc</span>(<span class="ruby-identifier">usage</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">options</span>={})
|
||
|
|
29: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:for</span>]
|
||
|
|
30: <span class="ruby-identifier">task</span> = <span class="ruby-identifier">find_and_refresh_task</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:for</span>])
|
||
|
|
31: <span class="ruby-identifier">task</span>.<span class="ruby-identifier">usage</span> = <span class="ruby-identifier">usage</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">usage</span>
|
||
|
|
32: <span class="ruby-identifier">task</span>.<span class="ruby-identifier">description</span> = <span class="ruby-identifier">description</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">description</span>
|
||
|
|
33: <span class="ruby-keyword kw">else</span>
|
||
|
|
34: <span class="ruby-ivar">@usage</span>, <span class="ruby-ivar">@desc</span>, <span class="ruby-ivar">@hide</span> = <span class="ruby-identifier">usage</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:hide</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">false</span>
|
||
|
|
35: <span class="ruby-keyword kw">end</span>
|
||
|
|
36: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="help-method" class="method-detail ">
|
||
|
|
<a name="method-c-help"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">help</span><span
|
||
|
|
class="method-args">(shell, subcommand = false)</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Prints help information for this class.
|
||
|
|
</p>
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<p>
|
||
|
|
shell<Thor::Shell>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="help-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 157</span>
|
||
|
|
157: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">help</span>(<span class="ruby-identifier">shell</span>, <span class="ruby-identifier">subcommand</span> = <span class="ruby-keyword kw">false</span>)
|
||
|
|
158: <span class="ruby-identifier">list</span> = <span class="ruby-identifier">printable_tasks</span>(<span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">subcommand</span>)
|
||
|
|
159: <span class="ruby-constant">Thor</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">thor_classes_in</span>(<span class="ruby-keyword kw">self</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">klass</span><span class="ruby-operator">|</span>
|
||
|
|
160: <span class="ruby-identifier">list</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">printable_tasks</span>(<span class="ruby-keyword kw">false</span>)
|
||
|
|
161: <span class="ruby-keyword kw">end</span>
|
||
|
|
162: <span class="ruby-identifier">list</span>.<span class="ruby-identifier">sort!</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">a</span>,<span class="ruby-identifier">b</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>[<span class="ruby-value">0</span>] <span class="ruby-operator"><=></span> <span class="ruby-identifier">b</span>[<span class="ruby-value">0</span>] }
|
||
|
|
163:
|
||
|
|
164: <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">say</span> <span class="ruby-value str">"Tasks:"</span>
|
||
|
|
165: <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">print_table</span>(<span class="ruby-identifier">list</span>, <span class="ruby-value">:ident</span> =<span class="ruby-operator">></span> <span class="ruby-value">2</span>, <span class="ruby-value">:truncate</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>)
|
||
|
|
166: <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">say</span>
|
||
|
|
167: <span class="ruby-identifier">class_options_help</span>(<span class="ruby-identifier">shell</span>)
|
||
|
|
168: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="long-desc-method" class="method-detail ">
|
||
|
|
<a name="method-c-long_desc"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">long_desc</span><span
|
||
|
|
class="method-args">(long_description, options={})</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Defines the long description of the next task.
|
||
|
|
</p>
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<p>
|
||
|
|
long description<String>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="long-desc-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 43</span>
|
||
|
|
43: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">long_desc</span>(<span class="ruby-identifier">long_description</span>, <span class="ruby-identifier">options</span>={})
|
||
|
|
44: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:for</span>]
|
||
|
|
45: <span class="ruby-identifier">task</span> = <span class="ruby-identifier">find_and_refresh_task</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:for</span>])
|
||
|
|
46: <span class="ruby-identifier">task</span>.<span class="ruby-identifier">long_description</span> = <span class="ruby-identifier">long_description</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">long_description</span>
|
||
|
|
47: <span class="ruby-keyword kw">else</span>
|
||
|
|
48: <span class="ruby-ivar">@long_desc</span> = <span class="ruby-identifier">long_description</span>
|
||
|
|
49: <span class="ruby-keyword kw">end</span>
|
||
|
|
50: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="map-method" class="method-detail ">
|
||
|
|
<a name="method-c-map"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">map</span><span
|
||
|
|
class="method-args">(mappings=nil)</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Maps an input to a task. If you define:
|
||
|
|
</p>
|
||
|
|
<pre>
|
||
|
|
map "-T" => "list"
|
||
|
|
</pre>
|
||
|
|
<p>
|
||
|
|
Running:
|
||
|
|
</p>
|
||
|
|
<pre>
|
||
|
|
thor -T
|
||
|
|
</pre>
|
||
|
|
<p>
|
||
|
|
Will invoke the list task.
|
||
|
|
</p>
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<table>
|
||
|
|
<tr><td valign="top">Hash[String|Array => Symbol]</td><td><p>
|
||
|
|
Maps the string or the strings in the array to the given task.
|
||
|
|
</p>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="map-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 65</span>
|
||
|
|
65: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">map</span>(<span class="ruby-identifier">mappings</span>=<span class="ruby-keyword kw">nil</span>)
|
||
|
|
66: <span class="ruby-ivar">@map</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">from_superclass</span>(<span class="ruby-value">:map</span>, {})
|
||
|
|
67:
|
||
|
|
68: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">mappings</span>
|
||
|
|
69: <span class="ruby-identifier">mappings</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
||
|
|
70: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:each</span>)
|
||
|
|
71: <span class="ruby-identifier">key</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">subkey</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@map</span>[<span class="ruby-identifier">subkey</span>] = <span class="ruby-identifier">value</span>}
|
||
|
|
72: <span class="ruby-keyword kw">else</span>
|
||
|
|
73: <span class="ruby-ivar">@map</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>
|
||
|
|
74: <span class="ruby-keyword kw">end</span>
|
||
|
|
75: <span class="ruby-keyword kw">end</span>
|
||
|
|
76: <span class="ruby-keyword kw">end</span>
|
||
|
|
77:
|
||
|
|
78: <span class="ruby-ivar">@map</span>
|
||
|
|
79: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="method-option-method" class="method-detail ">
|
||
|
|
<a name="method-c-method_option"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">method_option</span><span
|
||
|
|
class="method-args">(name, options={})</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Adds an option to the set of method options. If :for is given as option, it
|
||
|
|
allows you to change the options from a previous defined task.
|
||
|
|
</p>
|
||
|
|
<pre>
|
||
|
|
def previous_task
|
||
|
|
# magic
|
||
|
|
end
|
||
|
|
|
||
|
|
method_option :foo => :bar, :for => :previous_task
|
||
|
|
|
||
|
|
def next_task
|
||
|
|
# magic
|
||
|
|
end
|
||
|
|
</pre>
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<table>
|
||
|
|
<tr><td valign="top">name<Symbol></td><td><p>
|
||
|
|
The name of the argument.
|
||
|
|
</p>
|
||
|
|
</td></tr>
|
||
|
|
<tr><td valign="top">options<Hash></td><td><p>
|
||
|
|
Described below.
|
||
|
|
</p>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
<h4>Options</h4>
|
||
|
|
<p>
|
||
|
|
:desc - Description for the argument. :required - If the argument is
|
||
|
|
required or not. :default - Default value for this argument. It cannot be
|
||
|
|
required and have default values. :aliases - Aliases for this option.
|
||
|
|
:type - The type of the argument, can be :string, :hash, :array,
|
||
|
|
:numeric or :boolean. :banner - String to show on usage notes.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="method-option-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 119</span>
|
||
|
|
119: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_option</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span>={})
|
||
|
|
120: <span class="ruby-identifier">scope</span> = <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:for</span>]
|
||
|
|
121: <span class="ruby-identifier">find_and_refresh_task</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:for</span>]).<span class="ruby-identifier">options</span>
|
||
|
|
122: <span class="ruby-keyword kw">else</span>
|
||
|
|
123: <span class="ruby-identifier">method_options</span>
|
||
|
|
124: <span class="ruby-keyword kw">end</span>
|
||
|
|
125:
|
||
|
|
126: <span class="ruby-identifier">build_option</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span>, <span class="ruby-identifier">scope</span>)
|
||
|
|
127: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="method-options-method" class="method-detail ">
|
||
|
|
<a name="method-c-method_options"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">method_options</span><span
|
||
|
|
class="method-args">(options=nil)</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Declares the options for the next task to be declared.
|
||
|
|
</p>
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<table>
|
||
|
|
<tr><td valign="top">Hash[Symbol => Object]</td><td><p>
|
||
|
|
The hash key is the name of the option and the value
|
||
|
|
</p>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
<p>
|
||
|
|
is the type of the option. Can be :string, :array, :hash, :boolean,
|
||
|
|
:numeric or :required (string). If you give a value, the type of the value
|
||
|
|
is used.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="method-options-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 88</span>
|
||
|
|
88: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_options</span>(<span class="ruby-identifier">options</span>=<span class="ruby-keyword kw">nil</span>)
|
||
|
|
89: <span class="ruby-ivar">@method_options</span> <span class="ruby-operator">||=</span> {}
|
||
|
|
90: <span class="ruby-identifier">build_options</span>(<span class="ruby-identifier">options</span>, <span class="ruby-ivar">@method_options</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>
|
||
|
|
91: <span class="ruby-ivar">@method_options</span>
|
||
|
|
92: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="printable-tasks-method" class="method-detail ">
|
||
|
|
<a name="method-c-printable_tasks"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">printable_tasks</span><span
|
||
|
|
class="method-args">(all = true, subcommand = false)</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Returns tasks ready to be printed.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="printable-tasks-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 171</span>
|
||
|
|
171: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">printable_tasks</span>(<span class="ruby-identifier">all</span> = <span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">subcommand</span> = <span class="ruby-keyword kw">false</span>)
|
||
|
|
172: (<span class="ruby-identifier">all</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">all_tasks</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">tasks</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">_</span>, <span class="ruby-identifier">task</span><span class="ruby-operator">|</span>
|
||
|
|
173: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">task</span>.<span class="ruby-identifier">hidden?</span>
|
||
|
|
174: <span class="ruby-identifier">item</span> = []
|
||
|
|
175: <span class="ruby-identifier">item</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">banner</span>(<span class="ruby-identifier">task</span>, <span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">subcommand</span>)
|
||
|
|
176: <span class="ruby-identifier">item</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">task</span>.<span class="ruby-identifier">description</span> <span class="ruby-operator">?</span> <span class="ruby-node">"# #{task.description.gsub(/\s+/m,' ')}"</span> <span class="ruby-operator">:</span> <span class="ruby-value str">""</span>)
|
||
|
|
177: <span class="ruby-identifier">item</span>
|
||
|
|
178: <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">compact</span>
|
||
|
|
179: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="subcommand-method" class="method-detail ">
|
||
|
|
<a name="method-c-subcommand"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">subcommand</span><span
|
||
|
|
class="method-args">(subcommand, subcommand_class)</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="subcommand-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 185</span>
|
||
|
|
185: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">subcommand</span>(<span class="ruby-identifier">subcommand</span>, <span class="ruby-identifier">subcommand_class</span>)
|
||
|
|
186: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">subcommands</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">subcommand</span>.<span class="ruby-identifier">to_s</span>
|
||
|
|
187: <span class="ruby-identifier">subcommand_class</span>.<span class="ruby-identifier">subcommand_help</span> <span class="ruby-identifier">subcommand</span>
|
||
|
|
188: <span class="ruby-identifier">define_method</span>(<span class="ruby-identifier">subcommand</span>) { <span class="ruby-operator">|</span>*<span class="ruby-identifier">args</span><span class="ruby-operator">|</span> <span class="ruby-identifier">invoke</span> <span class="ruby-identifier">subcommand_class</span>, <span class="ruby-identifier">args</span> }
|
||
|
|
189: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="subcommands-method" class="method-detail ">
|
||
|
|
<a name="method-c-subcommands"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">subcommands</span><span
|
||
|
|
class="method-args">()</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="subcommands-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 181</span>
|
||
|
|
181: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">subcommands</span>
|
||
|
|
182: <span class="ruby-ivar">@subcommands</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">from_superclass</span>(<span class="ruby-value">:subcommands</span>, [])
|
||
|
|
183: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="task-help-method" class="method-detail ">
|
||
|
|
<a name="method-c-task_help"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">task_help</span><span
|
||
|
|
class="method-args">(shell, task_name)</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Prints help information for the given task.
|
||
|
|
</p>
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<p>
|
||
|
|
shell<Thor::Shell> task_name<String>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="task-help-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 135</span>
|
||
|
|
135: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">task_help</span>(<span class="ruby-identifier">shell</span>, <span class="ruby-identifier">task_name</span>)
|
||
|
|
136: <span class="ruby-identifier">meth</span> = <span class="ruby-identifier">normalize_task_name</span>(<span class="ruby-identifier">task_name</span>)
|
||
|
|
137: <span class="ruby-identifier">task</span> = <span class="ruby-identifier">all_tasks</span>[<span class="ruby-identifier">meth</span>]
|
||
|
|
138: <span class="ruby-identifier">handle_no_task_error</span>(<span class="ruby-identifier">meth</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">task</span>
|
||
|
|
139:
|
||
|
|
140: <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">say</span> <span class="ruby-value str">"Usage:"</span>
|
||
|
|
141: <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">say</span> <span class="ruby-node">" #{banner(task)}"</span>
|
||
|
|
142: <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">say</span>
|
||
|
|
143: <span class="ruby-identifier">class_options_help</span>(<span class="ruby-identifier">shell</span>, <span class="ruby-keyword kw">nil</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">task</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">_</span>, <span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">o</span> })
|
||
|
|
144: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">task</span>.<span class="ruby-identifier">long_description</span>
|
||
|
|
145: <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">say</span> <span class="ruby-value str">"Description:"</span>
|
||
|
|
146: <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">print_wrapped</span>(<span class="ruby-identifier">task</span>.<span class="ruby-identifier">long_description</span>, <span class="ruby-value">:ident</span> =<span class="ruby-operator">></span> <span class="ruby-value">2</span>)
|
||
|
|
147: <span class="ruby-keyword kw">else</span>
|
||
|
|
148: <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">say</span> <span class="ruby-identifier">task</span>.<span class="ruby-identifier">description</span>
|
||
|
|
149: <span class="ruby-keyword kw">end</span>
|
||
|
|
150: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="protected-class-method-details" class="method-section section">
|
||
|
|
<h3 class="section-header">Protected Class Methods</h3>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="banner-method" class="method-detail ">
|
||
|
|
<a name="method-c-banner"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">banner</span><span
|
||
|
|
class="method-args">(task, namespace = nil, subcommand = false)</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
The banner for this class. You can customize it if you are invoking the
|
||
|
|
thor class by another ways which is not the Thor::Runner. It receives the
|
||
|
|
task that is going to be invoked and a boolean which indicates if the
|
||
|
|
namespace should be displayed as arguments.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="banner-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 254</span>
|
||
|
|
254: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">banner</span>(<span class="ruby-identifier">task</span>, <span class="ruby-identifier">namespace</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">subcommand</span> = <span class="ruby-keyword kw">false</span>)
|
||
|
|
255: <span class="ruby-identifier">base</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">$0</span>).<span class="ruby-identifier">split</span>(<span class="ruby-value str">" "</span>).<span class="ruby-identifier">first</span>
|
||
|
|
256: <span class="ruby-node">"#{base} #{task.formatted_usage(self, $thor_runner, subcommand)}"</span>
|
||
|
|
257: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="subcommand-help-method" class="method-detail ">
|
||
|
|
<a name="method-c-subcommand_help"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">subcommand_help</span><span
|
||
|
|
class="method-args">(cmd)</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="subcommand-help-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 302</span>
|
||
|
|
302: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">subcommand_help</span>(<span class="ruby-identifier">cmd</span>)
|
||
|
|
303: <span class="ruby-identifier">desc</span> <span class="ruby-value str">"help [COMMAND]"</span>, <span class="ruby-value str">"Describe subcommands or one specific subcommand"</span>
|
||
|
|
304: <span class="ruby-identifier">class_eval</span> <span class="ruby-value str"> def help(task = nil, subcommand = true); super; end</span>
|
||
|
|
305: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="public-instance-method-details" class="method-section section">
|
||
|
|
<h3 class="section-header">Public Instance Methods</h3>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="help-method" class="method-detail ">
|
||
|
|
<a name="method-i-help"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
|
||
|
|
<span class="method-name">help</span><span
|
||
|
|
class="method-args">(task = nil, subcommand = false)</span>
|
||
|
|
<span class="method-click-advice">click to toggle source</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method-source-code"
|
||
|
|
id="help-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/bundler/vendor/thor.rb, line 316</span>
|
||
|
|
316: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">help</span>(<span class="ruby-identifier">task</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">subcommand</span> = <span class="ruby-keyword kw">false</span>)
|
||
|
|
317: <span class="ruby-identifier">task</span> <span class="ruby-operator">?</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">task_help</span>(<span class="ruby-identifier">shell</span>, <span class="ruby-identifier">task</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">help</span>(<span class="ruby-identifier">shell</span>, <span class="ruby-identifier">subcommand</span>)
|
||
|
|
318: <span class="ruby-keyword kw">end</span></pre>
|
||
|
|
</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>
|
||
|
|
|