rubu 0.0.4 → 0.0.5

data/doc/index.html

@@ -64,33 +64,34 @@
     <div id="content"><div id='filecontents'>
 <h1 id="label-Rubu">Rubu</h1>
 
-<p><span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> (Re-Usable Build Utility) is a library for building programs. <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span>
-is in practice a replacement for Make and Rake type of tools. <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> is
+<p><span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> (Re-Usable Build Utility) is a library for building programs. <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span>
+is in practice a replacement for Make and Rake type of tools. <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> is
 targeted to provide means for creating flexible build environments.</p>
 
 <p>Make and Rake are rule and recipe based, and they are very effective when
 the build process can be captured to these rules and is fairly fixed.
-<span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> includes declarations which correspond to rules, but the
+<span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> includes declarations which correspond to rules, but the
 declarations are lower level and provide more control over the behavior.
-<span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> also provides direct control over when the rules are executed.</p>
+<span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> also provides direct control over when the rules are executed.</p>
 
 <p>Make and Rake are more compact for the simplest build environments, but
-there is a break-even point where <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> becomes more convenient. This is
+there is a break-even point where <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> becomes more convenient. This is
 likely to happen when the user needs many exceptions to basic rules, also
 when other tasks than just build tasks are needed.</p>
 
-<p><span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> library can be used from any Ruby program, since it is just a
+<p><span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> library can be used from any Ruby program, since it is just a
 library. It can also be part of a larger program as less significant part
 of the overall functionality. From maintenance point of view this can be a
 win in many cases.</p>
 
-<p>The easiest way to get started with <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> is to study examples (See:
+<p>The easiest way to get started with <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> is to study examples (See:
 “Example” chapter below). However for longer term the main concepts are
 important as well (See: “Concepts” chapter below).</p>
 
 <h2 id="label-Example">Example</h2>
 
-<p>Example of <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> build program is placed in:</p>
+<p>Example of <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> build program is placed in (relative to your installation
+directory), which you should copy over somewhere to execute:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_example'>example</span><span class='op'>/</span><span class='id identifier rubyid_bin'>bin</span><span class='op'>/</span><span class='id identifier rubyid_rubu_example'>rubu_example</span>
 </code></pre>
@@ -118,7 +119,7 @@ script. File generation is part of the build program.</p>
 
 <p>There are comments which highlight purpose of the build program content.</p>
 
-<p>Sometimes it is useful to run <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> automatically whenever a file changes.
+<p>Sometimes it is useful to run <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> automatically whenever a file changes.
 Linux provides a facility called <strong>inotify</strong>, which can be
 used in Ruby through “rb-inotify” gem. Automatic update example program is
 in:</p>
@@ -126,11 +127,11 @@ in:</p>
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_example'>example</span><span class='op'>/</span><span class='id identifier rubyid_up'>up</span><span class='op'>-</span><span class='id identifier rubyid_to'>to</span><span class='op'>-</span><span class='id identifier rubyid_date'>date</span>
 </code></pre>
 
-<p>This program runs <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> each time there is a change in “src” or in “bin”
+<p>This program runs <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> each time there is a change in “src” or in “bin”
 directory. It compiles and generates C files if necessary. If there are new
 compilation requirements coming, before all previous have been completed,
 it will continue compilation. When all compilations are done (i.e. none
-pending), it will call <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> to perform linking. “up-to-date” displays
+pending), it will call <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> to perform linking. “up-to-date” displays
 status messages in red and green on the screen. If it is started with “-v”
 option the compile commands are visible, and if it is started with “-d”
 option, there is extra delay in compilation command.</p>
@@ -145,13 +146,13 @@ you started “up-to-date”.</p>
 
 <h2 id="label-Concepts">Concepts</h2>
 
-<p><span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> Build Program, RBP, is a Ruby program that uses the <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> library.
+<p><span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> Build Program, RBP, is a Ruby program that uses the <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> library.
 Typically command line options are accepted to give options for the build
 process.</p>
 
 <p>Build programs are about collecting source files and transforming them into
-targets. This process is explicit in <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span>. Each file, whether it&#39;s
-source or target, is collected within the <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> build program. The files
+targets. This process is explicit in <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span>. Each file, whether it&#39;s
+source or target, is collected within the <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> build program. The files
 are converted into <strong>Mark</strong> objects. Basically
 <strong>Mark</strong> corresponds to a file, but it includes methods that
 make the build process convenient.</p>
@@ -188,14 +189,14 @@ parallel. For example, C source to object compilation can be done in
 parallel, but linking of objects to executable must occur after all objects
 have been created.</p>
 
-<p><span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> Build Program includes all of the above, and the last step is to
+<p><span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> Build Program includes all of the above, and the last step is to
 select which <strong>Trail</strong> is executed. There should be at least
 “default” <strong>Trail</strong>, and typically there is also a “clean”
 <strong>Trail</strong>.</p>
 
-<p><span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> supports the configuration spaces: <strong>Order</strong>,
+<p><span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> supports the configuration spaces: <strong>Order</strong>,
 <strong>Var</strong>, and <strong>Info</strong>. <strong>Order</strong> is
-meant to be used for controlling <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> itself. For example if user wants
+meant to be used for controlling <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> itself. For example if user wants
 to see all executed command, then “verbose” option should be selected.</p>
 
 <p><strong>Var</strong> is used to control how <strong>Steps</strong> behave
@@ -207,7 +208,7 @@ example.</p>
 <p>To summarize and highlight the relationships between concepts, see the
 diagram below:</p>
 
-<pre class="code ruby"><code class="ruby">RBP =&gt; Trial+ =&gt; Step+ [s/p] =&gt; Move+ [s/p] =&gt; Source*, Target*
+<pre class="code ruby"><code class="ruby">RBP =&gt; Trail+ =&gt; Step+ [s/p] =&gt; Move+ [s/p] =&gt; SourceMark*, TargetMark*
     =&gt; Order+
     =&gt; Var*
     =&gt; Info*
@@ -217,17 +218,17 @@ diagram below:</p>
 s = Serial
 p = Parallel</code></pre>
 
-<p>RBP includes <strong>Trials</strong>, <strong>Orders</strong>, and possibly
-<strong>Vars</strong> and <strong>Infos</strong>. <strong>Trial</strong>
+<p>RBP includes <strong>Trails</strong>, <strong>Orders</strong>, and possibly
+<strong>Vars</strong> and <strong>Infos</strong>. <strong>Trail</strong>
 includes one or more <strong>Steps</strong>, which can be executed in
 sequence or in parallel.</p>
 
 <p><strong>Step</strong> includes one or more <strong>Moves</strong>, and they
 can also be sequential or parallel. <strong>Move</strong> has typically at
-least one <strong>Source</strong> and at least one <strong>Target</strong>.
-However, there are exceptions as well.</p>
+least one <strong>SourceMark</strong> and at least one
+<strong>TargetMark</strong>. However, there are exceptions as well.</p>
 
-<p>The suggested ordering within <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> Build Program is:</p>
+<p>The suggested ordering within <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> Build Program is:</p>
 <dl class="rdoc-list label-list"><dt>configuration
 <dd>
 <p>Process command line arguments and assign options that are used to control
@@ -254,7 +255,7 @@ execute.</p>
 
 <h2 id="label-Configuration">Configuration</h2>
 
-<p><strong>Order</strong> space default are set by the <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> library and user
+<p><strong>Order</strong> space default are set by the <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> library and user
 can override the default based on command line parameters if needed.</p>
 
 <p>Set default values for <strong>Var</strong> space. After default setting,
@@ -288,7 +289,7 @@ also the “basename” of the file is changed. This is achieved by giving the
 
 <h2 id="label-Step+definition">Step definition</h2>
 
-<p><strong>Step</strong> is defined by inheriting of the <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span>
+<p><strong>Step</strong> is defined by inheriting of the <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span>
 <strong>Step</strong> classes and defining the custom “step” method. If a
 specific setup for the <strong>Step</strong> is required, then an
 additional “setup” method can be defined as well.</p>
@@ -302,7 +303,7 @@ additional “setup” method can be defined as well.</p>
 
 <p>“setup” method is typically used to change the command according to user
 configuration. “step” method is the action for <strong>Step</strong>.
-<span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> executes it, if necessary. For example, if <strong>Step</strong> is
+<span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> executes it, if necessary. For example, if <strong>Step</strong> is
 a <strong>StepAged</strong> class, then the “step” method is only called if
 the source <strong>Mark</strong> is newer than the target
 <strong>Mark</strong>.</p>
@@ -378,7 +379,7 @@ above definition (from previous section) is executed with:</p>
 
 <h2 id="label-Final+notes">Final notes</h2>
 
-<p><span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> treats single <strong>Mark</strong> objects and Array of
+<p><span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> treats single <strong>Mark</strong> objects and Array of
 <strong>Mark</strong> objects the “same” way. In practice this means that
 the most common methods for <strong>Mark</strong> objects are implemented
 for Array as well. Hence, you can call a <strong>Mark</strong> method for
@@ -396,7 +397,7 @@ refer to the source, i.e. the only existing source, you can use the
 </div></div>
 
     <div id="footer">
-  Generated on Thu Aug 30 16:05:51 2018 by
+  Generated on Fri Aug 31 09:32:06 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.3).
 </div>

data/doc/method_list.html

@@ -406,156 +406,150 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Rubu/Move.html#set_show_shell_warning-instance_method" title="Rubu::Move#set_show_shell_warning (method)">#set_show_shell_warning</a></span>
-    <small>Rubu::Move</small>
-  </li>
-  
-
-  <li class="r1 ">
     <span class='object_link'><a href="Rubu/Step.html#setup-instance_method" title="Rubu::Step#setup (method)">#setup</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Rubu/Trail.html#setup-class_method" title="Rubu::Trail.setup (method)">setup</a></span>
     <small>Rubu::Trail</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/Step.html#shrun-instance_method" title="Rubu::Step#shrun (method)">#shrun</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Rubu/Step.html#shuse-instance_method" title="Rubu::Step#shuse (method)">#shuse</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/Mark.html#skip-instance_method" title="Rubu::Mark#skip (method)">#skip</a></span>
     <small>Rubu::Mark</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Rubu/Step.html#source-instance_method" title="Rubu::Step#source (method)">#source</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/Step.html#sources-instance_method" title="Rubu::Step#sources (method)">#sources</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Rubu/Move.html#status-instance_method" title="Rubu::Move#status (method)">#status</a></span>
     <small>Rubu::Move</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/Step.html#step-instance_method" title="Rubu::Step#step (method)">#step</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Rubu/Move.html#subs-instance_method" title="Rubu::Move#subs (method)">#subs</a></span>
     <small>Rubu::Move</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/Step.html#target-instance_method" title="Rubu::Step#target (method)">#target</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Rubu/Step.html#targets-instance_method" title="Rubu::Step#targets (method)">#targets</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/Mark.html#time-instance_method" title="Rubu::Mark#time (method)">#time</a></span>
     <small>Rubu::Mark</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Rubu/Step.html#update%3F-instance_method" title="Rubu::Step#update? (method)">#update?</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/StepAlways.html#update%3F-instance_method" title="Rubu::StepAlways#update? (method)">#update?</a></span>
     <small>Rubu::StepAlways</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Rubu/StepAged.html#update%3F-instance_method" title="Rubu::StepAged#update? (method)">#update?</a></span>
     <small>Rubu::StepAged</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/StepMark.html#update%3F-instance_method" title="Rubu::StepMark#update? (method)">#update?</a></span>
     <small>Rubu::StepMark</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Rubu/Move.html#use-instance_method" title="Rubu::Move#use (method)">#use</a></span>
     <small>Rubu::Move</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/Step.html#use-class_method" title="Rubu::Step.use (method)">use</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Array.html#use-instance_method" title="Array#use (method)">#use</a></span>
     <small>Array</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/Step.html#usezip-class_method" title="Rubu::Step.usezip (method)">usezip</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Rubu.html#version-class_method" title="Rubu.version (method)">version</a></span>
     <small>Rubu</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/Step.html#walk-instance_method" title="Rubu::Step#walk (method)">#walk</a></span>
     <small>Rubu::Step</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Rubu/Move.html#warn-instance_method" title="Rubu::Move#warn (method)">#warn</a></span>
     <small>Rubu::Move</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Rubu/Step.html#zip-class_method" title="Rubu::Step.zip (method)">zip</a></span>
     <small>Rubu::Step</small>
   </li>

data/doc/top-level-namespace.html

@@ -105,7 +105,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 30 16:05:51 2018 by
+  Generated on Fri Aug 31 09:32:06 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.3).
 </div>

data/example/bin/rubu_example

@@ -2,7 +2,6 @@
 
 require 'como'
 include Como
-#require 'rubu'
 require_relative '../../lib/rubu.rb'
 include Rubu
 

data/lib/rubu.rb

@@ -1,6 +1,8 @@
 require 'open3'
 require 'yaml'
 require 'digest/md5'
+require_relative './version.rb'
+
 
 module Rubu
 
@@ -58,7 +60,6 @@ module Rubu
     class Move
 
         @@host = []
-        @@show_shell_warning = true
 
         # Status after execution.
         attr_reader :status
@@ -118,10 +119,6 @@ module Rubu
             STDOUT.puts @output
         end
 
-        def set_show_shell_warning( value = true )
-            @@show_shell_warning = value
-        end
-
     end
 
 
@@ -143,7 +140,7 @@ module Rubu
                 end
 
                 if status.exitstatus == 0
-                    if @@show_shell_warning && not( stderr.empty? )
+                    if Order[ :sh_warn ] && not( stderr.empty? )
                         warn( stderr )
                     end
                     @status = :success
@@ -403,10 +400,11 @@ module Rubu
     # Configuration space for Rubu.
     #
     # Options:
-    # * serial   - Force parallel executions to serial.
-    # * parmax   - Limit the number of parallel executions.
-    # * verbose  - Show command executions.
-    # * force    - Force Step updates.
+    # * serial   - Force parallel executions to serial (default: parallel).
+    # * parmax   - Limit the number of parallel executions (default: 0).
+    # * verbose  - Show command executions (default: false).
+    # * force    - Force Step updates (default: false).
+    # * sh_warn  - Show shell warnings (default: true).
     class Order
 
         @@order = {}
@@ -433,6 +431,12 @@ module Rubu
         # Verbose execution.
         Order[ :verbose ] = false
 
+        # Force Step updates.
+        Order[ :force ] = false
+
+        # Show warnings (for shell commands).
+        Order[ :sh_warn ] = true
+
     end
 
 

data/lib/version.rb

@@ -1,5 +1,5 @@
-class Rubu
-    VERSION = "0.0.4"
+module Rubu
+    VERSION = "0.0.5"
     def Rubu.version
         Rubu::VERSION
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubu
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Tero Isannainen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Rubu (Re-Usable Build Utility) is a library for building