RubyGems - sprout - Versions diffs - 1.0.35.pre → 1.1.2.pre - Mend

sprout 1.0.35.pre → 1.1.2.pre

Potentially problematic release.

This version of sprout might be problematic. Click here for more details.

Files changed (234) hide show

data/Gemfile +1 -1
data/Gemfile.lock +0 -2
data/README.textile +1 -1
data/VERSION +1 -1
data/lib/sprout/concern.rb +5 -7
data/lib/sprout/daemon.rb +183 -143
data/lib/sprout/executable/base.rb +564 -0
data/lib/sprout/executable.rb +1 -550
data/lib/sprout/generator/base.rb +2 -3
data/lib/sprout/generator.rb +2 -1
data/lib/sprout/generators/ruby/templates/ruby_base.rb +1 -2
data/lib/sprout/library.rb +3 -3
data/lib/sprout/output_buffer.rb +35 -0
data/lib/sprout/process_runner.rb +68 -17
data/lib/sprout/progress_bar.rb +5 -5
data/lib/sprout/remote_file_target.rb +1 -1
data/lib/sprout/system/base_system.rb +3 -3
data/lib/sprout/system/unix_system.rb +1 -1
data/lib/sprout/{test/sprout_test_case.rb → test_helper.rb} +214 -14
data/lib/sprout/version.rb +1 -1
data/lib/sprout.rb +133 -2
data/rakefile.rb +2 -0
data/test/fixtures/examples/echo_inputs.rb +1 -2
data/test/fixtures/executable/fdb.rb +7 -9
data/test/fixtures/executable/flex3sdk_gem/fdb +49 -18
data/test/fixtures/executable/mxmlc.rb +1 -2
data/test/fixtures/executable/subclass/executable_subclass.rb +0 -1
data/test/fixtures/executable/subclass/executable_superclass.rb +1 -2
data/test/fixtures/specification/flex4sdk.rb +35 -24
data/test/unit/archive_unpacker_test.rb +1 -1
data/test/unit/boolean_param_test.rb +1 -1
data/test/unit/daemon_test.rb +35 -3
data/test/unit/executable_option_parser_test.rb +2 -3
data/test/unit/executable_param_test.rb +1 -1
data/test/unit/executable_test.rb +8 -15
data/test/unit/fake_other_executable.rb +1 -2
data/test/unit/file_param_test.rb +1 -1
data/test/unit/file_target_test.rb +1 -1
data/test/unit/files_param_test.rb +1 -1
data/test/unit/generator_generator_test.rb +1 -1
data/test/unit/generator_test.rb +1 -1
data/test/unit/library_generator_test.rb +1 -1
data/test/unit/library_test.rb +1 -1
data/test/unit/osx_system_test.rb +1 -1
data/test/unit/path_param_test.rb +1 -1
data/test/unit/paths_param_test.rb +1 -1
data/test/unit/platform_test.rb +1 -1
data/test/unit/process_runner_test.rb +1 -1
data/test/unit/rdoc_parser_test.rb +1 -1
data/test/unit/remote_file_loader_test.rb +1 -1
data/test/unit/remote_file_target_test.rb +1 -1
data/test/unit/ruby_feature_test.rb +1 -1
data/test/unit/ruby_generator_test.rb +1 -1
data/test/unit/specification_test.rb +8 -1
data/test/unit/sprout_test.rb +2 -2
data/test/unit/string_param_test.rb +1 -1
data/test/unit/string_test.rb +1 -1
data/test/unit/strings_param_test.rb +1 -1
data/test/unit/test_helper.rb +33 -1
data/test/unit/tool_generator_test.rb +1 -1
data/test/unit/unix_system_test.rb +1 -1
data/test/unit/user_test.rb +1 -1
data/test/unit/vista_system_test.rb +1 -1
data/test/unit/win_nix_system_test.rb +1 -1
data/test/unit/win_system_test.rb +1 -1
data/test-stderr.log +1 -0
data/test-stdout.log +237 -0
metadata +15 -190
data/doc/Dir.html +0 -288
data/doc/Rake/Task.html +0 -184
data/doc/Sprout/ArchiveUnpacker.html +0 -1246
data/doc/Sprout/Base/ClassMethods.html +0 -434
data/doc/Sprout/Base.html +0 -126
data/doc/Sprout/Concern.html +0 -353
data/doc/Sprout/Daemon/ClassMethods.html +0 -244
data/doc/Sprout/Daemon/InstanceMethods.html +0 -601
data/doc/Sprout/Daemon.html +0 -166
data/doc/Sprout/Errors/ArchiveUnpackerError.html +0 -125
data/doc/Sprout/Errors/DestinationExistsError.html +0 -133
data/doc/Sprout/Errors/DuplicateMemberError.html +0 -132
data/doc/Sprout/Errors/ExecutableError.html +0 -125
data/doc/Sprout/Errors/ExecutableRegistrationError.html +0 -132
data/doc/Sprout/Errors/ExecutionError.html +0 -121
data/doc/Sprout/Errors/GeneratorError.html +0 -125
data/doc/Sprout/Errors/InvalidArgumentError.html +0 -132
data/doc/Sprout/Errors/LoadError.html +0 -121
data/doc/Sprout/Errors/MissingArgumentError.html +0 -132
data/doc/Sprout/Errors/MissingExecutableError.html +0 -132
data/doc/Sprout/Errors/MissingGeneratorError.html +0 -132
data/doc/Sprout/Errors/MissingTemplateError.html +0 -132
data/doc/Sprout/Errors/ProcessRunnerError.html +0 -121
data/doc/Sprout/Errors/RemoteFileLoaderError.html +0 -110
data/doc/Sprout/Errors/SproutError.html +0 -114
data/doc/Sprout/Errors/UnknownArchiveType.html +0 -122
data/doc/Sprout/Errors/UsageError.html +0 -121
data/doc/Sprout/Errors/ValidationError.html +0 -121
data/doc/Sprout/Errors/VersionRequirementNotMetError.html +0 -121
data/doc/Sprout/Errors.html +0 -101
data/doc/Sprout/Executable/Boolean.html +0 -483
data/doc/Sprout/Executable/ClassMethods.html +0 -417
data/doc/Sprout/Executable/CollectionParam.html +0 -483
data/doc/Sprout/Executable/FileParam.html +0 -484
data/doc/Sprout/Executable/Files.html +0 -292
data/doc/Sprout/Executable/InstanceMethods.html +0 -2006
data/doc/Sprout/Executable/Number.html +0 -141
data/doc/Sprout/Executable/Param.html +0 -2818
data/doc/Sprout/Executable/ParameterFactory.html +0 -232
data/doc/Sprout/Executable/Path.html +0 -223
data/doc/Sprout/Executable/Paths.html +0 -253
data/doc/Sprout/Executable/StringParam.html +0 -213
data/doc/Sprout/Executable/Strings.html +0 -167
data/doc/Sprout/Executable/Url.html +0 -160
data/doc/Sprout/Executable/Urls.html +0 -170
data/doc/Sprout/Executable.html +0 -173
data/doc/Sprout/FileTarget.html +0 -1109
data/doc/Sprout/Generator/Base.html +0 -1626
data/doc/Sprout/Generator/Command.html +0 -690
data/doc/Sprout/Generator/DirectoryManifest.html +0 -476
data/doc/Sprout/Generator/FileManifest.html +0 -572
data/doc/Sprout/Generator/Manifest.html +0 -377
data/doc/Sprout/Generator/TemplateManifest.html +0 -196
data/doc/Sprout/Generator.html +0 -689
data/doc/Sprout/GeneratorGenerator.html +0 -1018
data/doc/Sprout/Library.html +0 -1141
data/doc/Sprout/LibraryGenerator.html +0 -309
data/doc/Sprout/Log.html +0 -496
data/doc/Sprout/MXMLC.html +0 -6373
data/doc/Sprout/Platform.html +0 -714
data/doc/Sprout/ProcessRunner.html +0 -1352
data/doc/Sprout/ProgressBar.html +0 -376
data/doc/Sprout/ProgressBarImpl.html +0 -2119
data/doc/Sprout/ProgressBarManager.html +0 -434
data/doc/Sprout/ProgressBarOutputStream.html +0 -416
data/doc/Sprout/RDocParser.html +0 -211
data/doc/Sprout/RemoteFileLoader.html +0 -172
data/doc/Sprout/RemoteFileTarget.html +0 -679
data/doc/Sprout/ReversedProgressBar.html +0 -194
data/doc/Sprout/RubyFeature/ClassMethods.html +0 -1065
data/doc/Sprout/RubyFeature.html +0 -155
data/doc/Sprout/RubyGenerator.html +0 -764
data/doc/Sprout/Specification.html +0 -767
data/doc/Sprout/System/BaseSystem.html +0 -1455
data/doc/Sprout/System/JavaSystem.html +0 -122
data/doc/Sprout/System/OSXSystem.html +0 -335
data/doc/Sprout/System/ThreadMock.html +0 -193
data/doc/Sprout/System/UnixSystem.html +0 -584
data/doc/Sprout/System/VistaSystem.html +0 -251
data/doc/Sprout/System/WinNixSystem.html +0 -325
data/doc/Sprout/System/WinSystem.html +0 -571
data/doc/Sprout/System.html +0 -191
data/doc/Sprout/ToolGenerator.html +0 -931
data/doc/Sprout/VERSION.html +0 -128
data/doc/Sprout.html +0 -144
data/doc/SproutTestCase.html +0 -1412
data/doc/String.html +0 -286
data/doc/_index.html +0 -1035
data/doc/class_list.html +0 -36
data/doc/css/common.css +0 -1
data/doc/css/full_list.css +0 -53
data/doc/css/style.css +0 -310
data/doc/file.README.html +0 -96
data/doc/file.archive_unpacker.html +0 -288
data/doc/file.base.html +0 -208
data/doc/file.base_system.html +0 -278
data/doc/file.boolean.html +0 -135
data/doc/file.collection_param.html +0 -139
data/doc/file.command.html +0 -126
data/doc/file.concern.html +0 -136
data/doc/file.daemon.html +0 -309
data/doc/file.dir.html +0 -76
data/doc/file.directory_manifest.html +0 -122
data/doc/file.errors.html +0 -147
data/doc/file.executable.html +0 -638
data/doc/file.file_manifest.html +0 -109
data/doc/file.file_param.html +0 -120
data/doc/file.file_target.html +0 -140
data/doc/file.files.html +0 -85
data/doc/file.generator.html +0 -296
data/doc/file.generator_class.html +0 -72
data/doc/file.generator_generator.html +0 -137
data/doc/file.generator_test.html +0 -92
data/doc/file.generator_test_helper.html +0 -67
data/doc/file.java_system.html +0 -62
data/doc/file.library.html +0 -291
data/doc/file.library_generator.html +0 -74
data/doc/file.log.html +0 -100
data/doc/file.manifest.html +0 -67
data/doc/file.mxmlc.html +0 -740
data/doc/file.number.html +0 -67
data/doc/file.osx_system.html +0 -79
data/doc/file.param.html +0 -491
data/doc/file.parameter_factory.html +0 -119
data/doc/file.path.html +0 -81
data/doc/file.paths.html +0 -80
data/doc/file.platform.html +0 -124
data/doc/file.process_runner.html +0 -224
data/doc/file.progress_bar.html +0 -390
data/doc/file.rdoc_parser.html +0 -145
data/doc/file.remote_file_loader.html +0 -117
data/doc/file.remote_file_target.html +0 -176
data/doc/file.ruby_base.html +0 -64
data/doc/file.ruby_feature.html +0 -244
data/doc/file.ruby_generator.html +0 -118
data/doc/file.ruby_input.html +0 -62
data/doc/file.ruby_test_case.html +0 -78
data/doc/file.ruby_test_helper.html +0 -61
data/doc/file.specification.html +0 -248
data/doc/file.sprout.html +0 -64
data/doc/file.sprout_test_case.html +0 -280
data/doc/file.string.html +0 -72
data/doc/file.string_param.html +0 -76
data/doc/file.strings.html +0 -71
data/doc/file.system.html +0 -86
data/doc/file.template_manifest.html +0 -67
data/doc/file.tool.html +0 -92
data/doc/file.tool_generator.html +0 -90
data/doc/file.unix_system.html +0 -128
data/doc/file.url.html +0 -71
data/doc/file.urls.html +0 -70
data/doc/file.version.html +0 -71
data/doc/file.vista_system.html +0 -69
data/doc/file.win_nix_system.html +0 -88
data/doc/file.win_system.html +0 -129
data/doc/file_list.html +0 -230
data/doc/frames.html +0 -13
data/doc/index.html +0 -96
data/doc/js/app.js +0 -202
data/doc/js/full_list.js +0 -149
data/doc/js/jquery.js +0 -154
data/doc/method_list.html +0 -3355
data/doc/top-level-namespace.html +0 -192
data/lib/sprout/base.rb +0 -121
data/lib/sprout/log.rb +0 -46
data/test/unit/sprout_test_helper.rb +0 -33

data/doc/Sprout/Generator.html DELETED Viewed

@@ -1,689 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta name="Content-Type" content="text/html; charset=utf-8" />
-<title>Module: Sprout::Generator</title>
-<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  relpath = '..';
-  if (relpath != '') relpath += '/';
-</script>
-<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-  </head>
-  <body>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    <div id="header">
-      <div id="menu">
-    <a href="../_index.html">Index (G)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Sprout.html" title="Sprout (module)">Sprout</a></span></span>
-     &raquo;
-    <span class="title">Generator</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-  <a id="class_list_link" href="#">Class List</a>
-  <a id="method_list_link" href="#">Method List</a>
-  <a id ="file_list_link" href="#">File List</a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Module: Sprout::Generator
-</h1>
-<dl class="box">
-      <dt class="r1">Includes:</dt>
-      <dd class="r1"><span class='object_link'><a href="RubyFeature.html" title="Sprout::RubyFeature (module)">RubyFeature</a></span></dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/sprout/generator.rb<span class="defines">,<br />
-  lib/sprout/generator/base.rb,<br /> lib/sprout/generator/command.rb,<br /> lib/sprout/generator/manifest.rb,<br /> lib/sprout/generator/file_manifest.rb,<br /> lib/sprout/generator/template_manifest.rb,<br /> lib/sprout/generator/directory_manifest.rb</span>
-</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<h1>Introduction</h1>
-<p>Sprout Generators are command line applications that are  installed by
-RubyGems and should universally provide the  following features:</p>
-<ul><li>
-<p>Terminal tab completion to discover generators</p>
-</li><li>
-<p>Call with no arguments to see help output</p>
-</li><li>
-<p>Call with an <tt>--input</tt> (or trailing) argument to create</p>
-</li><li>
-<p>Call with a collection of arguments given on a previous run  plus
-<tt>--delete</tt> to undo a previous <tt>create</tt></p>
-</li></ul>
-<h1>Usage</h1>
-<h2>Discovery</h2>
-<p>Sprout generators should be installed by RubyGems as command line
-applications on your system. After installing the flashsdk gem, you  should
-have access to a variety of generators. You can find out what  generators
-are available by typing: sprout- followed by pressing the  &lt;TAB&gt; key.</p>
-<p>Your terminal should list out all available applications that match  this
-name.</p>
-<p>Some generators are expected to create new projects, others expect to  run
-within existing projects. You should be able to infer the kind of
-generator you're looking at by the name, but if you can't just run the
-generator with no arguments to see it's usage guidelines.</p>
-<p>Generators that expect to be run from within a project will usually  expect
-a file named <tt>Gemfile</tt> to exist in the project root. If you're
-trying to run Sprout generators in a project that wasn't created using
-Sprouts, create this file and add the Rubygems that include the  generators
-that you want to use.</p>
-<h2>Execution</h2>
-<p>Generators are created by human beings and sometimes they have  different
-assumptions than you do. If you're running a generator  within a project
-(especially for the first time - or since updating a  gem), be sure to get
-your project checked into version control before  running anything.</p>
-<p>Non-application generators should always be executed at the project  root
-(where you store your Rakefile, Gemfile or build.xml).</p>
-<h2>Deletion</h2>
-<p>Any generator that inherits from the provided Sprout::Generators::Base
-includes support for deletion. If you run a generator and realize that  you
-don't want the files that it created, you can always run the same
-generator again with the same arguments, but add the --delete (or -d)
-argument.</p>
-<h2>Templates</h2>
-<p>Each time a generator is asked to locate a template, it begins a lookup
-process. This process is designed to make it easy for you to modify any
-template at the scope you desire.</p>
-<p>The lookup process will end at the first location where the expected  file
-is found.</p>
-<p>The search will begin with the location specified by the
-<tt>-templates</tt>  option (if provided) and will continue by adding
-'/templates' to the  end of each location specified by the listing for
-Sprout::Generator#search_paths .</p>
-<h1>Creation</h1>
-<p>The core Sprout gem comes with a Sprout::GeneratorGenerator. This command
-line  application is intended to be executed within a project and given the
-name  of a generator that you'd like to create.</p>
-<p>Try experimenting with this, and please  <a
-href="http://groups.google.com/group/projectsprouts/">suggest</a> any
-improvements to  the Google Group.</p>
-<hr style="height: 1px">
-<p>Back to Home: <a href="../index.html" title="README.textile">README.textile</a></p>
-<p>Next Topic: <span class='object_link'><a href="Library.html" title="Sprout::Library (class)">Library</a></span></p>
-<hr style="height: 1px">
-  </div>
-</div>
-<div class="tags">
-  <h3>See Also:</h3>
-  <ul class="see">
-      <li><span class='object_link'><a href="GeneratorGenerator.html" title="Sprout::GeneratorGenerator (class)">GeneratorGenerator</a></span></li>
-      <li><span class='object_link'><a href="Library.html" title="Sprout::Library (class)">Library</a></span></li>
-      <li><span class='object_link'><a href="Executable.html" title="Sprout::Executable (module)">Executable</a></span></li>
-      <li><span class='object_link'><a href="Specification.html" title="Sprout::Specification (class)">Specification</a></span></li>
-      <li><span class='object_link'><a href="RubyFeature.html" title="Sprout::RubyFeature (module)">RubyFeature</a></span></li>
-      <li><span class='object_link'><a href="System.html" title="Sprout::System (module)">System</a></span></li>
-  </ul>
-</div><h2>Defined Under Namespace</h2>
-<p class="children">
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Generator/Base.html" title="Sprout::Generator::Base (class)">Base</a></span>, <span class='object_link'><a href="Generator/Command.html" title="Sprout::Generator::Command (class)">Command</a></span>, <span class='object_link'><a href="Generator/DirectoryManifest.html" title="Sprout::Generator::DirectoryManifest (class)">DirectoryManifest</a></span>, <span class='object_link'><a href="Generator/FileManifest.html" title="Sprout::Generator::FileManifest (class)">FileManifest</a></span>, <span class='object_link'><a href="Generator/Manifest.html" title="Sprout::Generator::Manifest (class)">Manifest</a></span>, <span class='object_link'><a href="Generator/TemplateManifest.html" title="Sprout::Generator::TemplateManifest (class)">TemplateManifest</a></span>
-</p>
-    <h2>
-      Class Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#create_instance-class_method" title="create_instance (class method)">+ (Object) <strong>create_instance</strong>(type, options = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Create an instance of a concrete Generator using a <tt>type</tt> argument.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#register-class_method" title="register (class method)">+ (Hash) <strong>register</strong>(generator_class, templates_path = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Register a generator class and template path for future use.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#search_paths-class_method" title="search_paths (class method)">+ (Array) <strong>search_paths</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Returns a new collection of paths to search within for generator
-declarations and more importantly, folders named, 'templates'.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#template_folder_for-class_method" title="template_folder_for (class method)">+ (Object) <strong>template_folder_for</strong>(clazz) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Retrieve the root template folder for the provided Class.</p>
-</div></span>
-</li>
-    </ul>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="Concern.html" title="Sprout::Concern (module)">Concern</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Concern.html#append_features-instance_method" title="Sprout::Concern#append_features (method)">#append_features</a></span>, <span class='object_link'><a href="Concern.html#extended-class_method" title="Sprout::Concern.extended (method)">extended</a></span>, <span class='object_link'><a href="Concern.html#included-instance_method" title="Sprout::Concern#included (method)">#included</a></span></p>
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <p class="signature first" id="create_instance-class_method">
-    + (<tt>Object</tt>) <strong>create_instance</strong>(type, options = nil)
-</p><div class="docstring">
-  <div class="discussion">
-<p>Create an instance of a concrete Generator using a <tt>type</tt> argument.</p>
-<p>The idea is that libraries may register a generator class named,</p>
-<pre class="code">+TestGenerator+, and other generators can instantiate it without
-including it's Class by reference with:
-Sprout::Generator.create_instance :test</pre>
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='type'>(<tt>Symbol</tt>)</span>
-        <span class='name'>type</span>
-        &mdash;
-        <div class='inline'>
-<p>A snake-cased name of the class without the Generator suffix. for example,
-to instantiate a generator named, <tt>TestSuiteGenerator</tt>, this
-argument would be <tt>:test_suite</tt></p>
-</div>
-    </li>
-    <li>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <span class='name'>options</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>deprecated - please remove this argument wherever it's found.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-148
-149
-150
-151
-152
-153
-154
-155
-156</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/sprout/generator.rb', line 148</span>
-<span class='kw'>def</span> <span class='id create_instance'>create_instance</span> <span class='id type'>type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='kw'>nil</span>
-  <span class='id class_name'>class_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id type'>type</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='period'>.</span><span class='id camel_case'>camel_case</span><span class='rbrace'>}</span><span class='tstring_content'>Generator</span><span class='tstring_end'>&quot;</span></span>
-  <span class='id registered_entities'>registered_entities</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id entity'>entity</span><span class='op'>|</span>
-    <span class='kw'>if</span><span class='lparen'>(</span><span class='id entity'>entity</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='period'>.</span><span class='id match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>::</span><span class='embexpr_beg'>#{</span><span class='id class_name'>class_name</span><span class='rbrace'>}</span><span class='tstring_content'>$</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id entity'>entity</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='period'>.</span><span class='id match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^</span><span class='embexpr_beg'>#{</span><span class='id class_name'>class_name</span><span class='rbrace'>}</span><span class='tstring_content'>$</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
-      <span class='kw'>return</span> <span class='id entity'>entity</span><span class='period'>.</span><span class='id new'>new</span>
-    <span class='kw'>end</span>
-  <span class='kw'>end</span>
-  <span class='id raise'>raise</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Errors</span><span class='op'>::</span><span class='const'>MissingGeneratorError</span><span class='period'>.</span><span class='id new'>new</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Could not find any generator named: (</span><span class='embexpr_beg'>#{</span><span class='id class_name'>class_name</span><span class='rbrace'>}</span><span class='tstring_content'>). Perhaps you need to add a RubyGem to your Gemfile?</span><span class='tstring_end'>&quot;</span></span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="register-class_method">
-    + (<tt>Hash</tt>) <strong>register</strong>(generator_class, templates_path = nil)
-</p><div class="docstring">
-  <div class="discussion">
-<p>Register a generator class and template path for future use. Generator
-class names must end with "Generator", and everything to the left will be
-used for future lookups.</p>
-<p>The following example will register a TestGenerator that can be retrieved
-as <tt>:test</tt>.</p>
-<pre class="code"><span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Generator</span><span class='period'>.</span><span class='id register'>register</span> <span class='const'>TestGenerator</span></pre>
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='type'>(<tt>Class</tt>)</span>
-        <span class='name'>generator_class</span>
-        &mdash;
-        <div class='inline'>
-<p>A reference to the concrete Generator class. Usually these classes extend
-Sprout::Generator::Base.</p>
-</div>
-    </li>
-    <li>
-        <span class='type'>(<tt>Directory</tt>)</span>
-        <span class='name'>templates_path</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>The path to the default templates that should  be used for this generator.
-By default, a folder named <tt>templates</tt> relative to  the class
-definition will be used. Templates will also be searched for in a variety
-of locations depending on the user system. This path is simply the final
-searching point.</p>
-</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>the entity that was stored to represent the provided Generator. The entity
-will  generally have the keys, :class and :templates.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-130
-131
-132
-133</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/sprout/generator.rb', line 130</span>
-<span class='kw'>def</span> <span class='id register'>register</span> <span class='id generator_class'>generator_class</span><span class='comma'>,</span> <span class='id templates_path'>templates_path</span><span class='op'>=</span><span class='kw'>nil</span>
-  <span class='id generator_paths'>generator_paths</span> <span class='op'>&lt;&lt;</span> <span class='lbrace'>{</span> <span class='symbol'>:class</span> <span class='op'>=&gt;</span> <span class='id generator_class'>generator_class</span><span class='comma'>,</span> <span class='symbol'>:templates</span> <span class='op'>=&gt;</span> <span class='id templates_path'>templates_path</span> <span class='rbrace'>}</span> <span class='kw'>unless</span> <span class='id templates_path'>templates_path</span><span class='period'>.</span><span class='id nil?'>nil?</span>
-  <span class='kw'>super</span><span class='lparen'>(</span><span class='id generator_class'>generator_class</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="search_paths-class_method">
-    + (<tt>Array</tt>) <strong>search_paths</strong>
-</p><div class="docstring">
-  <div class="discussion">
-<p>Returns a new collection of paths to search within for generator
-declarations and more importantly, folders named, 'templates'.</p>
-<p>The collection of search_paths will be a subset of the following that will
-include only those directories that exist:</p>
-<pre class="code">./config/generators
-./vendor/generators
-~/Library/Sprouts/1.0/generators                          # OS X only
-~/.sprouts/1.0/generators                                 # Unix only
-[USER_HOME]/Application Data/Sprouts/cache/1.0/generators # Windows only
-ENV['SPROUT_GENERATORS']                                  # Only if defined
-[Generator Declaration __FILE__]
-[Generator SUPER-class declaration __FILE__]
-[Repeat step above until there is no super-class]</pre>
-<p>When the generators attempt to resolve templates, each of the preceding
-folders will be scanned for a child directory named 'templates'. Within
-that directory, the requested template name will be scanned and the first
-found template file will be used. This process will be repeated for each
-template file that is requested.</p>
-<p>The results of this search are not cached, so you can override a single
-template and leave the rest wherever the generator has defined them.</p>
-  </div>
-</div>
-<div class="tags">
-  <h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>of paths</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-205
-206
-207
-208
-209</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/sprout/generator.rb', line 205</span>
-<span class='kw'>def</span> <span class='id search_paths'>search_paths</span>
-  <span class='comment'># NOTE: Do not cache this list, specific generators
-</span>  <span class='comment'># will modify it with their own lookups
-</span>  <span class='id create_search_paths'>create_search_paths</span><span class='period'>.</span><span class='id select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id path'>path</span><span class='op'>|</span> <span class='const'>File</span><span class='period'>.</span><span class='id directory?'>directory?</span><span class='lparen'>(</span><span class='id path'>path</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="template_folder_for-class_method">
-    + (<tt>Object</tt>) <strong>template_folder_for</strong>(clazz)
-</p><div class="docstring">
-  <div class="discussion">
-<p>Retrieve the root template folder for the provided Class.</p>
-<p>This method will look for a templates folder next to each superclass in the
-inheritance chain.</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-164
-165
-166
-167
-168
-169
-170
-171
-172
-173
-174
-175</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/sprout/generator.rb', line 164</span>
-<span class='kw'>def</span> <span class='id template_folder_for'>template_folder_for</span> <span class='id clazz'>clazz</span>
-  <span class='comment'># Search the potential matches in reverse order
-</span>  <span class='comment'># because subclasses have registered AFTER their
-</span>  <span class='comment'># superclasses and superclasses match the ===
-</span>  <span class='comment'># check...
-</span>  <span class='id generator_paths'>generator_paths</span><span class='period'>.</span><span class='id reverse'>reverse</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id options'>options</span><span class='op'>|</span>
-    <span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:class</span><span class='rbracket'>]</span> <span class='op'>===</span> <span class='id clazz'>clazz</span>
-      <span class='kw'>return</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:templates</span><span class='rbracket'>]</span>
-    <span class='kw'>end</span>
-  <span class='kw'>end</span>
-  <span class='kw'>nil</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Wed Dec 22 11:58:33 2010 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.6.3 (ruby-1.9.2).
-</div>
-  </body>
-</html>