Modified: buildr/site/rdoc/Buildr/Packaging/Java/EarTask.html URL: http://svn.apache.org/viewvc/buildr/site/rdoc/Buildr/Packaging/Java/EarTask.html?rev=1737027&r1=1737026&r2=1737027&view=diff ============================================================================== --- buildr/site/rdoc/Buildr/Packaging/Java/EarTask.html (original) +++ buildr/site/rdoc/Buildr/Packaging/Java/EarTask.html Tue Mar 29 17:54:49 2016 @@ -126,6 +126,8 @@ <li><a href="../../../Buildr/ArchiveTask/Merge.html">Buildr::ArchiveTask::Merge</a> + <li><a href="../../../Buildr/ArchiveTask/ZipEntryData.html">Buildr::ArchiveTask::ZipEntryData</a> + <li><a href="../../../Buildr/Artifact.html">Buildr::Artifact</a> <li><a href="../../../Buildr/ArtifactNamespace.html">Buildr::ArtifactNamespace</a> @@ -477,23 +479,23 @@ to paths within the EAR.</p> <pre>By default each component type is mapped to a directory with the same name, for example, EJBs are stored in the /ejb path. To customize: - package(:ear).map[:war] = 'web-applications' + package(:ear).map[:war] = 'web-applications' package(:ear).map[:lib] = nil # store shared libraries on root of archive</pre> </li></ul> <p>EAR components are added by means of the <a href="EarTask.html#method-i-add">#add</a>, EarTask#<<, <a href="EarTask.html#method-i-push">#push</a> methods Component type is -determined from the artifactâs type.</p> +determined from the artifact's type.</p> -<pre>package(:ear) << project('coolWebService').package(:war)</pre> +<pre>package(:ear) << project('coolWebService').package(:war)</pre> <p>The << method is just an alias for push, with the later you can add multiple components at the same time. For example..</p> -<pre>package(:ear).push 'org.springframework:spring:jar:2.6', - projects('reflectUtils', 'springUtils'), - project('coolerWebService').package(:war)</pre> +<pre>package(:ear).push 'org.springframework:spring:jar:2.6', + projects('reflectUtils', 'springUtils'), + project('coolerWebService').package(:war)</pre> <p>The add method takes a single component with an optional hash. You can use it to override some component attributes.</p> @@ -503,9 +505,9 @@ following example shows how you can tell href="EarTask.html">EarTask</a> to treat a JAR file as an EJB:</p> <pre class="ruby"><span class="ruby-comment"># will add an ejb entry for the-cool-ejb-2.5.jar in application.xml</span> -<span class="ruby-identifier">package</span>(:<span class="ruby-identifier">ear</span>).<span class="ruby-identifier">add</span> <span class="ruby-string">'org.coolguys:the-cool-ejb:jar:2.5'</span>, :<span class="ruby-identifier">type=</span><span class="ruby-operator">></span>:<span class="ruby-identifier">ejb</span> +<span class="ruby-identifier">package</span>(:<span class="ruby-identifier">ear</span>).<span class="ruby-identifier">add</span> <span class="ruby-string">'org.coolguys:the-cool-ejb:jar:2.5'</span>, :<span class="ruby-identifier">type=</span><span class="ruby-operator">></span>:<span class="ruby-identifier">ejb</span> <span class="ruby-comment"># A better syntax for this is:</span> -<span class="ruby-identifier">package</span>(:<span class="ruby-identifier">ear</span>).<span class="ruby-identifier">add</span> :<span class="ruby-identifier">ejb=</span><span class="ruby-operator">></span><span class="ruby-string">'org.coolguys:the-cool-ejb:jar:2.5'</span> +<span class="ruby-identifier">package</span>(:<span class="ruby-identifier">ear</span>).<span class="ruby-identifier">add</span> :<span class="ruby-identifier">ejb=</span><span class="ruby-operator">></span><span class="ruby-string">'org.coolguys:the-cool-ejb:jar:2.5'</span> </pre> <p>By default, every JAR package is assumed to be a library component, so you @@ -517,7 +519,7 @@ appears in application.xml. The followin different directory inside the EAR where to store the webapp.</p> <pre class="ruby"><span class="ruby-identifier">package</span>(:<span class="ruby-identifier">ear</span>).<span class="ruby-identifier">add</span> <span class="ruby-identifier">project</span>(:<span class="ruby-identifier">remoteService</span>).<span class="ruby-identifier">package</span>(:<span class="ruby-identifier">war</span>), - :<span class="ruby-identifier">path=</span><span class="ruby-operator">></span><span class="ruby-string">'web-services'</span>, :<span class="ruby-identifier">context_root=</span><span class="ruby-operator">></span><span class="ruby-string">'/Some/URL/Path'</span> + :<span class="ruby-identifier">path=</span><span class="ruby-operator">></span><span class="ruby-string">'web-services'</span>, :<span class="ruby-identifier">context_root=</span><span class="ruby-operator">></span><span class="ruby-string">'/Some/URL/Path'</span> </pre> <dl class="rdoc-list label-list"><dt>1 <dd> @@ -654,7 +656,7 @@ href="http://java.sun.com/j2ee/verified/ <span class="ruby-ivar">@components</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">component</span><span class="ruby-operator">|</span> <span class="ruby-identifier">path</span>(<span class="ruby-identifier">component</span>[<span class="ruby-value">:path</span>]).<span class="ruby-identifier">include</span>(<span class="ruby-identifier">component</span>[<span class="ruby-value">:clone</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">component</span>[<span class="ruby-value">:artifact</span>]) <span class="ruby-keyword">end</span> - <span class="ruby-identifier">path</span>(<span class="ruby-string">'META-INF'</span>).<span class="ruby-identifier">include</span>(<span class="ruby-identifier">descriptor</span>) + <span class="ruby-identifier">path</span>(<span class="ruby-string">'META-INF'</span>).<span class="ruby-identifier">include</span>(<span class="ruby-identifier">descriptor</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div><!-- new-source --> @@ -755,13 +757,13 @@ href="http://java.sun.com/j2ee/verified/ <span class="ruby-identifier">args</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">artifact</span><span class="ruby-operator">|</span> <span class="ruby-identifier">type</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:as</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:type</span>] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">type</span> - <span class="ruby-identifier">type</span> = <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:type</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%x'</span>).<span class="ruby-identifier">to_sym</span> + <span class="ruby-identifier">type</span> = <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:type</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%x'</span>).<span class="ruby-identifier">to_sym</span> <span class="ruby-identifier">type</span> = <span class="ruby-value">:lib</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value">:jar</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">raise</span> <span class="ruby-node">"Unknown EAR component type: #{type}. Perhaps you may explicity tell what component type to use."</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">SUPPORTED_TYPES</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">type</span>) <span class="ruby-identifier">component</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:artifact</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">artifact</span>, <span class="ruby-value">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type</span>, - <span class="ruby-value">:id=</span><span class="ruby-operator">></span><span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_spec</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">id</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%n'</span>), + <span class="ruby-value">:id=</span><span class="ruby-operator">></span><span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_spec</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">id</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%n'</span>), <span class="ruby-value">:path=</span><span class="ruby-operator">></span><span class="ruby-identifier">options</span>[<span class="ruby-value">:path</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">dirs</span>[<span class="ruby-identifier">type</span>].<span class="ruby-identifier">to_s</span>) <span class="ruby-identifier">component</span>[<span class="ruby-value">:clone</span>] = <span class="ruby-identifier">component_clone</span>(<span class="ruby-identifier">component</span>) <span class="ruby-keyword">unless</span> <span class="ruby-value">:lib</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">type</span> <span class="ruby-comment"># update_classpath(component) unless :lib == type || Artifact === artifact</span> @@ -876,18 +878,18 @@ href="http://java.sun.com/j2ee/verified/ <div class="method-source-code" id="component_clone-source"> <pre><span class="ruby-comment"># File lib/buildr/java/packaging.rb, line 465</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">component_clone</span>(<span class="ruby-identifier">component</span>) - <span class="ruby-identifier">file</span>(<span class="ruby-identifier">path_to</span>(<span class="ruby-identifier">component</span>[<span class="ruby-value">:path</span>], <span class="ruby-identifier">component</span>[<span class="ruby-value">:artifact</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%f'</span>)) =<span class="ruby-operator">></span> <span class="ruby-identifier">component</span>[<span class="ruby-value">:artifact</span>]) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> - <span class="ruby-identifier">mkpath</span> <span class="ruby-identifier">task</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%d'</span>) + <span class="ruby-identifier">file</span>(<span class="ruby-identifier">path_to</span>(<span class="ruby-identifier">component</span>[<span class="ruby-value">:path</span>], <span class="ruby-identifier">component</span>[<span class="ruby-value">:artifact</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%f'</span>)) =<span class="ruby-operator">></span> <span class="ruby-identifier">component</span>[<span class="ruby-value">:artifact</span>]) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">mkpath</span> <span class="ruby-identifier">task</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%d'</span>) <span class="ruby-identifier">cp</span> <span class="ruby-identifier">component</span>[<span class="ruby-value">:artifact</span>].<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">task</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-constant">Manifest</span>.<span class="ruby-identifier">update_manifest</span>(<span class="ruby-identifier">task</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">manifest</span><span class="ruby-operator">|</span> - <span class="ruby-identifier">class_path</span> = <span class="ruby-identifier">manifest</span>.<span class="ruby-identifier">main</span>[<span class="ruby-string">'Class-Path'</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span> - <span class="ruby-identifier">included_libs</span> = <span class="ruby-identifier">class_path</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">fn</span><span class="ruby-operator">|</span> <span class="ruby-identifier">fn</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%f'</span>) } + <span class="ruby-identifier">class_path</span> = <span class="ruby-identifier">manifest</span>.<span class="ruby-identifier">main</span>[<span class="ruby-string">'Class-Path'</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span> + <span class="ruby-identifier">included_libs</span> = <span class="ruby-identifier">class_path</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">fn</span><span class="ruby-operator">|</span> <span class="ruby-identifier">fn</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%f'</span>) } <span class="ruby-constant">Zip</span><span class="ruby-operator">::</span><span class="ruby-constant">ZipFile</span>.<span class="ruby-identifier">foreach</span>(<span class="ruby-identifier">task</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span> - <span class="ruby-identifier">included_libs</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%f'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">file?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^WEB-INF\/lib\/[^\/]+$/</span> + <span class="ruby-identifier">included_libs</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">pathmap</span>(<span class="ruby-string">'%f'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">file?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^WEB-INF\/lib\/[^\/]+$/</span> <span class="ruby-keyword">end</span> <span class="ruby-comment"># Include all other libraries in the classpath.</span> <span class="ruby-identifier">class_path</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">libs_classpath</span>(<span class="ruby-identifier">component</span>).<span class="ruby-identifier">reject</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span> <span class="ruby-identifier">included_libs</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">path</span>)) } - <span class="ruby-identifier">manifest</span>.<span class="ruby-identifier">main</span>[<span class="ruby-string">'Class-Path'</span>] = <span class="ruby-identifier">class_path</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">' '</span>) + <span class="ruby-identifier">manifest</span>.<span class="ruby-identifier">main</span>[<span class="ruby-string">'Class-Path'</span>] = <span class="ruby-identifier">class_path</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">' '</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> @@ -931,12 +933,12 @@ href="http://java.sun.com/j2ee/verified/ <span class="ruby-keyword">end</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">header</span> <span class="ruby-comment"># Determine which libraries are already included.</span> - <span class="ruby-identifier">class_path</span> = <span class="ruby-identifier">header</span>[<span class="ruby-string">'Class-Path'</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span> + <span class="ruby-identifier">class_path</span> = <span class="ruby-identifier">header</span>[<span class="ruby-string">'Class-Path'</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span> <span class="ruby-identifier">included_libs</span> = <span class="ruby-identifier">class_path</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">fn</span><span class="ruby-operator">|</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">fn</span>) } - <span class="ruby-identifier">included_libs</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">package</span>.<span class="ruby-identifier">path</span>(<span class="ruby-string">'WEB-INF/lib'</span>).<span class="ruby-identifier">sources</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">fn</span><span class="ruby-operator">|</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">fn</span>) } + <span class="ruby-identifier">included_libs</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">package</span>.<span class="ruby-identifier">path</span>(<span class="ruby-string">'WEB-INF/lib'</span>).<span class="ruby-identifier">sources</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">fn</span><span class="ruby-operator">|</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">fn</span>) } <span class="ruby-comment"># Include all other libraries in the classpath.</span> <span class="ruby-identifier">class_path</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">libs_classpath</span>(<span class="ruby-identifier">component</span>).<span class="ruby-identifier">reject</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span> <span class="ruby-identifier">included_libs</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">path</span>)) } - <span class="ruby-identifier">header</span>[<span class="ruby-string">'Class-Path'</span>] = <span class="ruby-identifier">class_path</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">' '</span>) + <span class="ruby-identifier">header</span>[<span class="ruby-string">'Class-Path'</span>] = <span class="ruby-identifier">class_path</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">' '</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre>
Modified: buildr/site/rdoc/Buildr/Packaging/Java/JarTask.html URL: http://svn.apache.org/viewvc/buildr/site/rdoc/Buildr/Packaging/Java/JarTask.html?rev=1737027&r1=1737026&r2=1737027&view=diff ============================================================================== --- buildr/site/rdoc/Buildr/Packaging/Java/JarTask.html (original) +++ buildr/site/rdoc/Buildr/Packaging/Java/JarTask.html Tue Mar 29 17:54:49 2016 @@ -114,6 +114,8 @@ <li><a href="../../../Buildr/ArchiveTask/Merge.html">Buildr::ArchiveTask::Merge</a> + <li><a href="../../../Buildr/ArchiveTask/ZipEntryData.html">Buildr::ArchiveTask::ZipEntryData</a> + <li><a href="../../../Buildr/Artifact.html">Buildr::Artifact</a> <li><a href="../../../Buildr/ArtifactNamespace.html">Buildr::ArtifactNamespace</a> @@ -455,8 +457,8 @@ the META-INF directory.</p> <p>For example:</p> -<pre class="ruby"><span class="ruby-identifier">package</span>(:<span class="ruby-identifier">jar</span>).<span class="ruby-identifier">with</span>(:<span class="ruby-identifier">manifest=</span><span class="ruby-operator">></span><span class="ruby-string">'src/MANIFEST.MF'</span>) -<span class="ruby-identifier">package</span>(:<span class="ruby-identifier">jar</span>).<span class="ruby-identifier">meta_inf</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">file</span>(<span class="ruby-string">'README'</span>) +<pre class="ruby"><span class="ruby-identifier">package</span>(:<span class="ruby-identifier">jar</span>).<span class="ruby-identifier">with</span>(:<span class="ruby-identifier">manifest=</span><span class="ruby-operator">></span><span class="ruby-string">'src/MANIFEST.MF'</span>) +<span class="ruby-identifier">package</span>(:<span class="ruby-identifier">jar</span>).<span class="ruby-identifier">meta_inf</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">file</span>(<span class="ruby-string">'README'</span>) </pre> </div><!-- description --> @@ -502,7 +504,7 @@ href="WarTask.html">WarTask</a>) do.</p> <p>For example:</p> -<pre class="ruby"><span class="ruby-identifier">package</span>(:<span class="ruby-identifier">jar</span>).<span class="ruby-identifier">with</span>(:<span class="ruby-identifier">manifest=</span><span class="ruby-operator">></span><span class="ruby-string">'MANIFEST_MF'</span>) +<pre class="ruby"><span class="ruby-identifier">package</span>(:<span class="ruby-identifier">jar</span>).<span class="ruby-identifier">with</span>(:<span class="ruby-identifier">manifest=</span><span class="ruby-operator">></span><span class="ruby-string">'MANIFEST_MF'</span>) </pre> Modified: buildr/site/rdoc/Buildr/Packaging/Java/Manifest.html URL: http://svn.apache.org/viewvc/buildr/site/rdoc/Buildr/Packaging/Java/Manifest.html?rev=1737027&r1=1737026&r2=1737027&view=diff ============================================================================== --- buildr/site/rdoc/Buildr/Packaging/Java/Manifest.html (original) +++ buildr/site/rdoc/Buildr/Packaging/Java/Manifest.html Tue Mar 29 17:54:49 2016 @@ -138,6 +138,8 @@ <li><a href="../../../Buildr/ArchiveTask/Merge.html">Buildr::ArchiveTask::Merge</a> + <li><a href="../../../Buildr/ArchiveTask/ZipEntryData.html">Buildr::ArchiveTask::ZipEntryData</a> + <li><a href="../../../Buildr/Artifact.html">Buildr::Artifact</a> <li><a href="../../../Buildr/ArtifactNamespace.html">Buildr::ArtifactNamespace</a> @@ -535,7 +537,7 @@ href="Manifest.html">Manifest</a>.</p> <span class="ruby-keyword">def</span> <span class="ruby-identifier">from_zip</span>(<span class="ruby-identifier">file</span>) <span class="ruby-constant">Zip</span><span class="ruby-operator">::</span><span class="ruby-constant">ZipInputStream</span><span class="ruby-operator">::</span><span class="ruby-identifier">open</span>(<span class="ruby-identifier">file</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">zip</span><span class="ruby-operator">|</span> <span class="ruby-keyword">while</span> (<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">zip</span>.<span class="ruby-identifier">get_next_entry</span>) - <span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">'META-INF/MANIFEST.MF'</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">'META-INF/MANIFEST.MF'</span> <span class="ruby-keyword">return</span> <span class="ruby-constant">Manifest</span>.<span class="ruby-identifier">parse</span> <span class="ruby-identifier">zip</span>.<span class="ruby-identifier">read</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> @@ -570,7 +572,7 @@ argument:</p> <ul><li> <p>nil â Empty <a href="Manifest.html">Manifest</a>.</p> </li><li> -<p><a href="../../../Hash.html">Hash</a> -- <a +<p><a href="../../../Hash.html">Hash</a> â <a href="Manifest.html">Manifest</a> with main section using the hash name/value pairs.</p> </li><li> @@ -595,7 +597,7 @@ calling proc/method.</p> <span class="ruby-keyword">when</span> <span class="ruby-constant">String</span> <span class="ruby-keyword">then</span> <span class="ruby-ivar">@sections</span> = <span class="ruby-constant">Manifest</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">arg</span>).<span class="ruby-identifier">sections</span> <span class="ruby-keyword">when</span> <span class="ruby-constant">Proc</span>, <span class="ruby-constant">Method</span> <span class="ruby-keyword">then</span> <span class="ruby-ivar">@sections</span> = <span class="ruby-constant">Manifest</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">call</span>).<span class="ruby-identifier">sections</span> <span class="ruby-keyword">else</span> - <span class="ruby-identifier">fail</span> <span class="ruby-string">'Invalid manifest, expecting Hash, Array, file name/task or proc/method.'</span> + <span class="ruby-identifier">fail</span> <span class="ruby-string">'Invalid manifest, expecting Hash, Array, file name/task or proc/method.'</span> <span class="ruby-keyword">end</span> <span class="ruby-comment"># Add Manifest-Version and Created-By, if not specified.</span> <span class="ruby-constant">STANDARD_HEADER</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span> @@ -640,7 +642,7 @@ href="Manifest.html">Manifest</a>.</p> <span class="ruby-identifier">sections</span> = <span class="ruby-identifier">str</span>.<span class="ruby-identifier">split</span>(<span class="ruby-constant">SECTION_SEPARATOR</span>).<span class="ruby-identifier">reject</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">empty?</span> } <span class="ruby-identifier">new</span> <span class="ruby-identifier">sections</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">section</span><span class="ruby-operator">|</span> <span class="ruby-identifier">lines</span> = <span class="ruby-identifier">section</span>.<span class="ruby-identifier">split</span>(<span class="ruby-constant">LINE_SEPARATOR</span>).<span class="ruby-identifier">inject</span>([]) { <span class="ruby-operator">|</span><span class="ruby-identifier">merged</span>, <span class="ruby-identifier">line</span><span class="ruby-operator">|</span> - <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>[<span class="ruby-regexp">/^ /</span>] <span class="ruby-operator">==</span> <span class="ruby-string">' '</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>[<span class="ruby-regexp">/^ /</span>] <span class="ruby-operator">==</span> <span class="ruby-string">' '</span> <span class="ruby-identifier">merged</span>.<span class="ruby-identifier">last</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">line</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>] <span class="ruby-keyword">else</span> <span class="ruby-identifier">merged</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">line</span> @@ -691,7 +693,7 @@ back to the file.</p> <span class="ruby-identifier">manifest</span> = <span class="ruby-identifier">from_zip</span>(<span class="ruby-identifier">file</span>) <span class="ruby-identifier">result</span> = <span class="ruby-keyword">yield</span> <span class="ruby-identifier">manifest</span> <span class="ruby-constant">Zip</span><span class="ruby-operator">::</span><span class="ruby-constant">ZipFile</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">file</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">zip</span><span class="ruby-operator">|</span> - <span class="ruby-identifier">zip</span>.<span class="ruby-identifier">get_output_stream</span>(<span class="ruby-string">'META-INF/MANIFEST.MF'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">out</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">zip</span>.<span class="ruby-identifier">get_output_stream</span>(<span class="ruby-string">'META-INF/MANIFEST.MF'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">out</span><span class="ruby-operator">|</span> <span class="ruby-identifier">out</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">manifest</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-identifier">out</span>.<span class="ruby-identifier">write</span> <span class="ruby-string">"\n"</span> <span class="ruby-keyword">end</span> @@ -803,9 +805,9 @@ back to the file.</p> <span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span> <span class="ruby-ivar">@sections</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">section</span><span class="ruby-operator">|</span> <span class="ruby-identifier">keys</span> = <span class="ruby-identifier">section</span>.<span class="ruby-identifier">keys</span> - <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-string">'Name'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">'Name'</span>) + <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-string">'Name'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">'Name'</span>) <span class="ruby-identifier">lines</span> = <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> <span class="ruby-identifier">manifest_wrap_at_72</span>(<span class="ruby-node">"#{key}: #{section[key]}"</span>) } - <span class="ruby-identifier">lines</span> <span class="ruby-operator">+</span> [<span class="ruby-string">''</span>] + <span class="ruby-identifier">lines</span> <span class="ruby-operator">+</span> [<span class="ruby-string">''</span>] }.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</span>) <span class="ruby-keyword">end</span></pre> </div><!-- to_s-source --> Modified: buildr/site/rdoc/Buildr/Packaging/Java/WarTask.html URL: http://svn.apache.org/viewvc/buildr/site/rdoc/Buildr/Packaging/Java/WarTask.html?rev=1737027&r1=1737026&r2=1737027&view=diff ============================================================================== --- buildr/site/rdoc/Buildr/Packaging/Java/WarTask.html (original) +++ buildr/site/rdoc/Buildr/Packaging/Java/WarTask.html Tue Mar 29 17:54:49 2016 @@ -116,6 +116,8 @@ <li><a href="../../../Buildr/ArchiveTask/Merge.html">Buildr::ArchiveTask::Merge</a> + <li><a href="../../../Buildr/ArchiveTask/ZipEntryData.html">Buildr::ArchiveTask::ZipEntryData</a> + <li><a href="../../../Buildr/Artifact.html">Buildr::Artifact</a> <li><a href="../../../Buildr/ArtifactNamespace.html">Buildr::ArtifactNamespace</a> @@ -447,7 +449,7 @@ WEB-INF/classes directory.</p> <p>For example:</p> -<pre class="ruby"><span class="ruby-identifier">package</span>(:<span class="ruby-identifier">war</span>).<span class="ruby-identifier">with</span>(:<span class="ruby-identifier">libs=</span><span class="ruby-operator">></span><span class="ruby-string">'log4j:log4j:jar:1.1'</span>) +<pre class="ruby"><span class="ruby-identifier">package</span>(:<span class="ruby-identifier">war</span>).<span class="ruby-identifier">with</span>(:<span class="ruby-identifier">libs=</span><span class="ruby-operator">></span><span class="ruby-string">'log4j:log4j:jar:1.1'</span>) </pre> </div><!-- description --> Modified: buildr/site/rdoc/Buildr/Packaging/Scala.html URL: http://svn.apache.org/viewvc/buildr/site/rdoc/Buildr/Packaging/Scala.html?rev=1737027&r1=1737026&r2=1737027&view=diff ============================================================================== --- buildr/site/rdoc/Buildr/Packaging/Scala.html (original) +++ buildr/site/rdoc/Buildr/Packaging/Scala.html Tue Mar 29 17:54:49 2016 @@ -98,6 +98,8 @@ <li><a href="../../Buildr/ArchiveTask/Merge.html">Buildr::ArchiveTask::Merge</a> + <li><a href="../../Buildr/ArchiveTask/ZipEntryData.html">Buildr::ArchiveTask::ZipEntryData</a> + <li><a href="../../Buildr/Artifact.html">Buildr::Artifact</a> <li><a href="../../Buildr/ArtifactNamespace.html">Buildr::ArtifactNamespace</a> Modified: buildr/site/rdoc/Buildr/ProcessStatus.html URL: http://svn.apache.org/viewvc/buildr/site/rdoc/Buildr/ProcessStatus.html?rev=1737027&r1=1737026&r2=1737027&view=diff ============================================================================== --- buildr/site/rdoc/Buildr/ProcessStatus.html (original) +++ buildr/site/rdoc/Buildr/ProcessStatus.html Tue Mar 29 17:54:49 2016 @@ -134,6 +134,8 @@ <li><a href="../Buildr/ArchiveTask/Merge.html">Buildr::ArchiveTask::Merge</a> + <li><a href="../Buildr/ArchiveTask/ZipEntryData.html">Buildr::ArchiveTask::ZipEntryData</a> + <li><a href="../Buildr/Artifact.html">Buildr::Artifact</a> <li><a href="../Buildr/ArtifactNamespace.html">Buildr::ArtifactNamespace</a> Modified: buildr/site/rdoc/Buildr/Project.html URL: http://svn.apache.org/viewvc/buildr/site/rdoc/Buildr/Project.html?rev=1737027&r1=1737026&r2=1737027&view=diff ============================================================================== --- buildr/site/rdoc/Buildr/Project.html (original) +++ buildr/site/rdoc/Buildr/Project.html Tue Mar 29 17:54:49 2016 @@ -233,6 +233,8 @@ <li><a href="../Buildr/ArchiveTask/Merge.html">Buildr::ArchiveTask::Merge</a> + <li><a href="../Buildr/ArchiveTask/ZipEntryData.html">Buildr::ArchiveTask::ZipEntryData</a> + <li><a href="../Buildr/Artifact.html">Buildr::Artifact</a> <li><a href="../Buildr/ArtifactNamespace.html">Buildr::ArtifactNamespace</a> @@ -551,7 +553,7 @@ <div id="description" class="description"> <p>A project definition is where you define all the tasks associated with the -project youâre building.</p> +project you're building.</p> <p>The project itself will define several life cycle tasks for you. For example, it automatically creates a compile task that will compile all the @@ -618,30 +620,30 @@ define projects is not important, projec you ask for them. Circular dependencies will not work. <a href="../Rake.html">Rake</a> tasks are only created after the project is evaluated, so if you need to access a task (e.g. compile) use -<code>project('foo').compile</code> instead of -<code>task('foo:compile')</code>.</p> +<code>project('foo').compile</code> instead of +<code>task('foo:compile')</code>.</p> <p>For example:</p> -<pre class="ruby"><span class="ruby-identifier">define</span> <span class="ruby-string">'myapp'</span>, :<span class="ruby-identifier">version=</span><span class="ruby-operator">></span><span class="ruby-string">'1.1'</span> <span class="ruby-keyword">do</span> +<pre class="ruby"><span class="ruby-identifier">define</span> <span class="ruby-string">'myapp'</span>, :<span class="ruby-identifier">version=</span><span class="ruby-operator">></span><span class="ruby-string">'1.1'</span> <span class="ruby-keyword">do</span> - <span class="ruby-identifier">define</span> <span class="ruby-string">'wepapp'</span> <span class="ruby-keyword">do</span> - <span class="ruby-identifier">compile</span>.<span class="ruby-identifier">with</span> <span class="ruby-identifier">project</span>(<span class="ruby-string">'myapp:beans'</span>) + <span class="ruby-identifier">define</span> <span class="ruby-string">'wepapp'</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">compile</span>.<span class="ruby-identifier">with</span> <span class="ruby-identifier">project</span>(<span class="ruby-string">'myapp:beans'</span>) <span class="ruby-identifier">package</span> :<span class="ruby-identifier">war</span> <span class="ruby-keyword">end</span> - <span class="ruby-identifier">define</span> <span class="ruby-string">'beans'</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">define</span> <span class="ruby-string">'beans'</span> <span class="ruby-keyword">do</span> <span class="ruby-identifier">compile</span>.<span class="ruby-identifier">with</span> <span class="ruby-constant">DEPENDS</span> <span class="ruby-identifier">package</span> :<span class="ruby-identifier">jar</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">puts</span> <span class="ruby-identifier">projects</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span>:<span class="ruby-identifier">name</span>) -=<span class="ruby-operator">></span> [ <span class="ruby-string">'myapp'</span>, <span class="ruby-string">'myapp:beans'</span>, <span class="ruby-string">'myapp:webapp'</span> ] -<span class="ruby-identifier">puts</span> <span class="ruby-identifier">project</span>(<span class="ruby-string">'myapp:webapp'</span>).<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">name</span> -=<span class="ruby-operator">></span> <span class="ruby-string">'myapp'</span> -<span class="ruby-identifier">puts</span> <span class="ruby-identifier">project</span>(<span class="ruby-string">'myapp:webapp'</span>).<span class="ruby-identifier">compile</span>.<span class="ruby-identifier">classpath</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span>:<span class="ruby-identifier">to_spec</span>) -=<span class="ruby-operator">></span> <span class="ruby-string">'myapp:myapp-beans:jar:1.1'</span> +=<span class="ruby-operator">></span> [ <span class="ruby-string">'myapp'</span>, <span class="ruby-string">'myapp:beans'</span>, <span class="ruby-string">'myapp:webapp'</span> ] +<span class="ruby-identifier">puts</span> <span class="ruby-identifier">project</span>(<span class="ruby-string">'myapp:webapp'</span>).<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">name</span> +=<span class="ruby-operator">></span> <span class="ruby-string">'myapp'</span> +<span class="ruby-identifier">puts</span> <span class="ruby-identifier">project</span>(<span class="ruby-string">'myapp:webapp'</span>).<span class="ruby-identifier">compile</span>.<span class="ruby-identifier">classpath</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span>:<span class="ruby-identifier">to_spec</span>) +=<span class="ruby-operator">></span> <span class="ruby-string">'myapp:myapp-beans:jar:1.1'</span> </pre> </div><!-- description --> @@ -670,8 +672,8 @@ evaluated, so if you need to access a ta <div class="method-description"> - <p>The project name. For example, âfooâ for the top-level project, and -âfoo:barâ for its sub-project.</p> + <p>The project name. For example, 'foo' for the top-level project, and +'foo:bar' for its sub-project.</p> </div> </div> @@ -720,7 +722,7 @@ evaluated, so if you need to access a ta <div class="method-source-code" id="clear-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 291</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 296</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">clear</span> <span class="ruby-ivar">@projects</span>.<span class="ruby-identifier">clear</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@projects</span> <span class="ruby-keyword">end</span></pre> @@ -760,8 +762,8 @@ evaluated, so if you need to access a ta <p>Defines a local task with an optional execution message.</p> <p>A local task is a task that executes a task with the same name, defined in -the current project, the projectâs with a base directory that is the same -as the current directory.</p> +the current project, the project's with a base directory that is the +same as the current directory.</p> <p>Complicated? Try this:</p> @@ -787,7 +789,7 @@ and returns a message that, for example <div class="method-source-code" id="local_task-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 317</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 322</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">local_task</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-identifier">task</span> <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">task</span>, <span class="ruby-identifier">args</span><span class="ruby-operator">|</span> <span class="ruby-identifier">args</span> = <span class="ruby-identifier">task</span>.<span class="ruby-identifier">arg_names</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">n</span><span class="ruby-operator">|</span> <span class="ruby-identifier">args</span>[<span class="ruby-identifier">n</span>]} @@ -828,9 +830,9 @@ handled.</p> <div class="method-source-code" id="on_define-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 328</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 333</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">on_define</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) - <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">deprecated</span> <span class="ruby-string">'This method is deprecated, see Extension'</span> + <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">deprecated</span> <span class="ruby-string">'This method is deprecated, see Extension'</span> (<span class="ruby-ivar">@on_define</span> <span class="ruby-operator">||=</span> []) <span class="ruby-operator"><<</span> <span class="ruby-identifier">block</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span> <span class="ruby-keyword">end</span></pre> </div><!-- on_define-source --> @@ -893,30 +895,30 @@ handled.</p> <div class="method-description"> - <p>Returns the projectâs base directory.</p> + <p>Returns the project's base directory.</p> -<p>The Buildfile defines top-level project, so itâs logical that the top-level -projectâs base directory is the one in which we find the Buildfile. And -each sub-project has a base directory that is one level down, with the same -name as the sub-project.</p> +<p>The Buildfile defines top-level project, so it's logical that the +top-level project's base directory is the one in which we find the +Buildfile. And each sub-project has a base directory that is one level +down, with the same name as the sub-project.</p> <p>For example:</p> -<pre>/home/foo/ <-- base_directory of project 'foo' -/home/foo/Buildfile <-- builds 'foo' -/home/foo/bar <-- sub-project 'foo:bar'</pre> +<pre>/home/foo/ <-- base_directory of project 'foo' +/home/foo/Buildfile <-- builds 'foo' +/home/foo/bar <-- sub-project 'foo:bar'</pre> <div class="method-source-code" id="base_dir-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 423</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 428</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">base_dir</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@base_dir</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">parent</span> - <span class="ruby-comment"># For sub-project, a good default is a directory in the parent's base_dir,</span> + <span class="ruby-comment"># For sub-project, a good default is a directory in the parent's base_dir,</span> <span class="ruby-comment"># using the same name as the project.</span> - <span class="ruby-ivar">@base_dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">':'</span>).<span class="ruby-identifier">last</span>, <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">base_dir</span>) + <span class="ruby-ivar">@base_dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">':'</span>).<span class="ruby-identifier">last</span>, <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">base_dir</span>) <span class="ruby-keyword">else</span> <span class="ruby-comment"># For top-level project, a good default is the directory where we found the Buildfile.</span> <span class="ruby-ivar">@base_dir</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span> @@ -965,26 +967,27 @@ name as the sub-project.</p> <div class="method-description"> <p>Creates and returns a new file task in the project. Similar to calling -Rakeâs file method, but the path is expanded relative to the projectâs base -directory, and the task executes in the projectâs base directory.</p> +Rake's file method, but the path is expanded relative to the +project's base directory, and the task executes in the project's +base directory.</p> <p>For example:</p> -<pre class="ruby"><span class="ruby-identifier">define</span> <span class="ruby-string">'foo'</span> <span class="ruby-keyword">do</span> - <span class="ruby-identifier">define</span> <span class="ruby-string">'bar'</span> <span class="ruby-keyword">do</span> - <span class="ruby-identifier">file</span>(<span class="ruby-string">'src'</span>) { <span class="ruby-operator">...</span> } +<pre class="ruby"><span class="ruby-identifier">define</span> <span class="ruby-string">'foo'</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">define</span> <span class="ruby-string">'bar'</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">file</span>(<span class="ruby-string">'src'</span>) { <span class="ruby-operator">...</span> } <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> -<span class="ruby-identifier">puts</span> <span class="ruby-identifier">project</span>(<span class="ruby-string">'foo:bar'</span>).<span class="ruby-identifier">file</span>(<span class="ruby-string">'src'</span>).<span class="ruby-identifier">to_s</span> -=<span class="ruby-operator">></span> <span class="ruby-string">'/home/foo/bar/src'</span> +<span class="ruby-identifier">puts</span> <span class="ruby-identifier">project</span>(<span class="ruby-string">'foo:bar'</span>).<span class="ruby-identifier">file</span>(<span class="ruby-string">'src'</span>).<span class="ruby-identifier">to_s</span> +=<span class="ruby-operator">></span> <span class="ruby-string">'/home/foo/bar/src'</span> </pre> <div class="method-source-code" id="file-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 485</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 490</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">file</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-identifier">task_name</span>, <span class="ruby-identifier">arg_names</span>, <span class="ruby-identifier">deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">resolve_args</span>(<span class="ruby-identifier">args</span>) <span class="ruby-identifier">task</span> = <span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">FileTask</span>.<span class="ruby-identifier">define_task</span>(<span class="ruby-identifier">path_to</span>(<span class="ruby-identifier">task_name</span>)) @@ -1020,7 +1023,7 @@ directory, and the task executes in the <div class="method-source-code" id="layout-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 438</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 443</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">layout</span> <span class="ruby-ivar">@layout</span> <span class="ruby-operator">||=</span> (<span class="ruby-identifier">parent</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">layout</span> <span class="ruby-operator">:</span> <span class="ruby-constant">Layout</span>.<span class="ruby-identifier">default</span>).<span class="ruby-identifier">clone</span> <span class="ruby-keyword">end</span></pre> @@ -1050,14 +1053,14 @@ directory, and the task executes in the <div class="method-description"> - <p>Returns a path from a combination of name, relative to the projectâs base -directory. Essentially, joins all the supplied names and expands the path -relative to <a href="Project.html#method-i-base_dir">base_dir</a>. Symbol -arguments are converted to paths based on the layout, so whenever possible -stick to these. For example:</p> + <p>Returns a path from a combination of name, relative to the project's +base directory. Essentially, joins all the supplied names and expands the +path relative to <a href="Project.html#method-i-base_dir">base_dir</a>. +Symbol arguments are converted to paths based on the layout, so whenever +possible stick to these. For example:</p> <pre class="ruby"><span class="ruby-identifier">path_to</span>(:<span class="ruby-identifier">source</span>, :<span class="ruby-identifier">main</span>, :<span class="ruby-identifier">java</span>) -=<span class="ruby-operator">></span> <span class="ruby-string">'src/main/java'</span> +=<span class="ruby-operator">></span> <span class="ruby-string">'src/main/java'</span> </pre> <p>Keep in mind that all tasks are defined and executed relative to the @@ -1067,11 +1070,11 @@ within the project as a matter of practi <p>For example:</p> -<pre class="ruby"><span class="ruby-identifier">path_to</span>(<span class="ruby-string">'foo'</span>, <span class="ruby-string">'bar'</span>) +<pre class="ruby"><span class="ruby-identifier">path_to</span>(<span class="ruby-string">'foo'</span>, <span class="ruby-string">'bar'</span>) =<span class="ruby-operator">></span> <span class="ruby-identifier">foo</span><span class="ruby-operator">/</span><span class="ruby-identifier">bar</span> -<span class="ruby-identifier">path_to</span>(<span class="ruby-string">'/tmp'</span>) +<span class="ruby-identifier">path_to</span>(<span class="ruby-string">'/tmp'</span>) =<span class="ruby-operator">></span> <span class="ruby-node">/tmp -path_to(:base_dir, 'foo') # same as path_to('foo") +path_to(:base_dir, 'foo') # same as path_to('foo") => /</span><span class="ruby-identifier">home</span><span class="ruby-operator">/</span><span class="ruby-identifier">project1</span><span class="ruby-operator">/</span><span class="ruby-identifier">foo</span> </pre> @@ -1079,7 +1082,7 @@ path_to(:base_dir, 'foo') # same as path <div class="method-source-code" id="path_to-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 462</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 467</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">path_to</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">names</span>) <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">layout</span>.<span class="ruby-identifier">expand</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">names</span>), <span class="ruby-identifier">base_dir</span>) <span class="ruby-keyword">end</span></pre> @@ -1126,15 +1129,15 @@ name is sufficient to find a sub-project <p>When called on a project without a name, returns the project itself. You can use that when setting project properties, for example:</p> -<pre>define 'foo' do - project.version = '1.0' +<pre>define 'foo' do + project.version = '1.0' end</pre> <div class="method-source-code" id="project-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 557</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 562</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">project</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span> <span class="ruby-identifier">options</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span> @@ -1180,7 +1183,7 @@ names are sufficient to find sub-project <div class="method-source-code" id="projects-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 575</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 580</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">projects</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span> <span class="ruby-identifier">options</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span> @@ -1222,7 +1225,7 @@ in all the sub-projects.</p> <div class="method-source-code" id="recursive_task-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 537</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 542</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">recursive_task</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-identifier">task_name</span>, <span class="ruby-identifier">arg_names</span>, <span class="ruby-identifier">deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">resolve_args</span>(<span class="ruby-identifier">args</span>) <span class="ruby-identifier">task</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">parallel</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">multitask</span>(<span class="ruby-identifier">task_name</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">task</span>(<span class="ruby-identifier">task_name</span>) @@ -1270,42 +1273,42 @@ in all the sub-projects.</p> <div class="method-description"> - <p>Creates and returns a new task in the project. Similar to calling Rakeâs -task method, but prefixes the task name with the project name and executes -the task in the projectâs base directory.</p> + <p>Creates and returns a new task in the project. Similar to calling +Rake's task method, but prefixes the task name with the project name +and executes the task in the project's base directory.</p> <p>For example:</p> -<pre class="ruby"><span class="ruby-identifier">define</span> <span class="ruby-string">'foo'</span> <span class="ruby-keyword">do</span> - <span class="ruby-identifier">task</span> <span class="ruby-string">'doda'</span> +<pre class="ruby"><span class="ruby-identifier">define</span> <span class="ruby-string">'foo'</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">task</span> <span class="ruby-string">'doda'</span> <span class="ruby-keyword">end</span> -<span class="ruby-identifier">puts</span> <span class="ruby-identifier">project</span>(<span class="ruby-string">'foo'</span>).<span class="ruby-identifier">task</span>(<span class="ruby-string">'doda'</span>).<span class="ruby-identifier">name</span> -=<span class="ruby-operator">></span> <span class="ruby-string">'foo:doda'</span> +<span class="ruby-identifier">puts</span> <span class="ruby-identifier">project</span>(<span class="ruby-string">'foo'</span>).<span class="ruby-identifier">task</span>(<span class="ruby-string">'doda'</span>).<span class="ruby-identifier">name</span> +=<span class="ruby-operator">></span> <span class="ruby-string">'foo:doda'</span> </pre> <p>When called from within the project definition, creates a new task if the task does not already exist. If called from outside the project definition, returns the named task and raises an exception if the task is not defined.</p> -<p>As with Rakeâs task method, calling this method enhances the task with the -prerequisites and optional block.</p> +<p>As with Rake's task method, calling this method enhances the task with +the prerequisites and optional block.</p> <div class="method-source-code" id="task-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 515</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 520</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">task</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-identifier">task_name</span>, <span class="ruby-identifier">arg_names</span>, <span class="ruby-identifier">deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">resolve_args</span>(<span class="ruby-identifier">args</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">task_name</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^:/</span> <span class="ruby-identifier">task</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">switch_to_namespace</span> [] <span class="ruby-keyword">do</span> <span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>.<span class="ruby-identifier">define_task</span>(<span class="ruby-identifier">task_name</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>]) <span class="ruby-keyword">end</span> - <span class="ruby-keyword">elsif</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">current_scope</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">':'</span>) + <span class="ruby-keyword">elsif</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">current_scope</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">':'</span>) <span class="ruby-identifier">task</span> = <span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>.<span class="ruby-identifier">define_task</span>(<span class="ruby-identifier">task_name</span>) <span class="ruby-keyword">else</span> - <span class="ruby-keyword">unless</span> <span class="ruby-identifier">task</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">lookup</span>(<span class="ruby-identifier">task_name</span>, <span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">':'</span>)) + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">task</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">lookup</span>(<span class="ruby-identifier">task_name</span>, <span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">':'</span>)) <span class="ruby-identifier">raise</span> <span class="ruby-node">"You cannot define a project task outside the project definition, and no task #{name}:#{task_name} defined in the project"</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> @@ -1344,9 +1347,9 @@ prerequisites and optional block.</p> <div class="method-description"> - <p>Sets the projectâs base directory. Allows you to specify a base directory -by calling this accessor, or with the :base_dir property when calling <a -href="Project.html#method-i-define">define</a>.</p> + <p>Sets the project's base directory. Allows you to specify a base +directory by calling this accessor, or with the :base_dir property when +calling <a href="Project.html#method-i-define">define</a>.</p> <p>You can only set the base directory once for a given project, and only before accessing the base directory (for example, by calling <a @@ -1361,9 +1364,9 @@ cannot be set again.</p> <div class="method-source-code" id="base_dir-3D-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 611</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 616</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">base_dir=</span>(<span class="ruby-identifier">dir</span>) - <span class="ruby-identifier">raise</span> <span class="ruby-string">'Cannot set base directory twice, or after reading its value'</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@base_dir</span> + <span class="ruby-identifier">raise</span> <span class="ruby-string">'Cannot set base directory twice, or after reading its value'</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@base_dir</span> <span class="ruby-ivar">@base_dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">dir</span>) <span class="ruby-keyword">end</span></pre> </div><!-- base_dir-3D-source --> @@ -1398,7 +1401,7 @@ cannot be set again.</p> <div class="method-source-code" id="define-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 627</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 632</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">define</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">properties</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-constant">Project</span>.<span class="ruby-identifier">define</span> <span class="ruby-node">"#{self.name}:#{name}"</span>, <span class="ruby-identifier">properties</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> <span class="ruby-keyword">end</span></pre> @@ -1432,9 +1435,9 @@ or class (or for that matter, anything t <div class="method-source-code" id="layout-3D-source"> - <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 618</span> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 623</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">layout=</span>(<span class="ruby-identifier">layout</span>) - <span class="ruby-identifier">raise</span> <span class="ruby-string">'Cannot set directory layout twice, or after reading its value'</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@layout</span> + <span class="ruby-identifier">raise</span> <span class="ruby-string">'Cannot set directory layout twice, or after reading its value'</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@layout</span> <span class="ruby-ivar">@layout</span> = <span class="ruby-identifier">layout</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Class</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">layout</span>.<span class="ruby-identifier">new</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">layout</span> <span class="ruby-keyword">end</span></pre> </div><!-- layout-3D-source --> Modified: buildr/site/rdoc/Buildr/RSpec.html URL: http://svn.apache.org/viewvc/buildr/site/rdoc/Buildr/RSpec.html?rev=1737027&r1=1737026&r2=1737027&view=diff ============================================================================== --- buildr/site/rdoc/Buildr/RSpec.html (original) +++ buildr/site/rdoc/Buildr/RSpec.html Tue Mar 29 17:54:49 2016 @@ -128,6 +128,8 @@ <li><a href="../Buildr/ArchiveTask/Merge.html">Buildr::ArchiveTask::Merge</a> + <li><a href="../Buildr/ArchiveTask/ZipEntryData.html">Buildr::ArchiveTask::ZipEntryData</a> + <li><a href="../Buildr/Artifact.html">Buildr::Artifact</a> <li><a href="../Buildr/ArtifactNamespace.html">Buildr::ArtifactNamespace</a> @@ -464,7 +466,7 @@ href="RSpec.html">RSpec</a> use:</p> </pre> </li><li> <p>:format â A list of valid Rspec âformat option values. (defaults to -âprogressâ)</p> +'progress')</p> </li><li> <p>:output â <a href="../File.html">File</a> path to output dump. @false@ to suppress output</p> @@ -542,8 +544,8 @@ test suite.</p> <pre><span class="ruby-comment"># File lib/buildr/java/bdd.rb, line 241</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">runner_config</span> <span class="ruby-identifier">runner</span> = <span class="ruby-keyword">super</span> - <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">gems</span>.<span class="ruby-identifier">update</span> <span class="ruby-string">'rspec'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'~> 2.9.0'</span> - <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">requires</span>.<span class="ruby-identifier">unshift</span> <span class="ruby-string">'rspec'</span> + <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">gems</span>.<span class="ruby-identifier">update</span> <span class="ruby-string">'rspec'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'~> 2.9.0'</span> + <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">requires</span>.<span class="ruby-identifier">unshift</span> <span class="ruby-string">'rspec'</span> <span class="ruby-identifier">runner</span> <span class="ruby-keyword">end</span></pre> </div><!-- runner_config-source --> @@ -585,7 +587,7 @@ test suite.</p> <% if runner.output == false %> output = StringIO.new <% elsif runner.output.kind_of?(String) %> - output = File.open(<%= result.output.inspect %>, 'w') + output = File.open(<%= result.output.inspect %>, 'w') <% else %> output = STDOUT <% end %> @@ -593,7 +595,7 @@ test suite.</p> argv = <%= runner.rspec.inspect %> || [] argv.push *<%= tests.inspect %> - Buildr::TestFramework::TestResult::Error.guard('<%= runner.result %>') do + Buildr::TestFramework::TestResult::Error.guard('<%= runner.result %>') do ::RSpec::Core::CommandLine.new(argv).run(output, output) end exit 0 # let buildr figure the result from the yaml file
