mucgly 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dfea2d4d0a44528b05456bbd1704cbbd449a232
-  data.tar.gz: e663a7a7e3815a9dc63b9564730ae738b51a9e87
+  metadata.gz: 5cfa79d284e275ab42157047bc80f2fcf41698a9
+  data.tar.gz: c24ba9a87c3c465d7694a2cd46e4169d362a943b
 SHA512:
-  metadata.gz: 18654eba88520a6ffed3f834a28916caa5e17df680e4f90b359794f34e199d162d11fdeb25cccf337cf5be3ff8431fa364254fcbf9dac20e76b82be8b4a32b17
-  data.tar.gz: 013cd857f5d0c5003d86cc2d2f82ea42dea9642ec0c3f2b8a05277b0f3ce974e05e586b1ee5cf542d8c8ab42c514661ba65c2c3ad1773ebc558e63f3094c1417
+  metadata.gz: 656bb80bac123cce4fb236aeb374dddfd11961732c8a59b00a190804f4117453163af9d988b1e472f9577891a60a7ef53fa67568bab6beda041dc23616581466
+  data.tar.gz: a91653486da910a3a38a6961962d7391a0e2947365e1e0448186afb107937130c9e30049722b36a7bdfe0bd49ee69070b52e8026270429060e33d90eb88c981c

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
 = Version history
 
+[0.2.0] Multihook feature.
+        Remote escape feature.
+        Block output feature.
+        Fix for hook at EOF parsing.
+
 [0.1.1] Documentation updates.
         Tiny code cleanups.
         Better test coverage for Mugcly module.

data/README.rdoc

@@ -61,6 +61,8 @@ For all command line options, see:
 * User settable hooks to define macro boundaries. Can be set from
   command line, configuration files, or from macro input file.
 
+* Multiple, concurrent macro start and end limiters (multihook).
+
 * Multiple sources for configuration: default config, environment
   variable, command line.
 
@@ -99,8 +101,8 @@ For all command line options, see:
 === Hooks
 
 Hooks start and end the macro definition. By default hookbeg is "-<"
-and hookend is ">-". These values are not easily conflicting with
-typical macro file body text.
+and hookend is ">-". These values don't conflict easily with typical
+macro file body text.
 
 If literal hook string is required in the output, the hookesc sequence
 should be place before the hook. For example "\\-<" will produce
@@ -118,6 +120,20 @@ hooks, cancel space (" ") output, and cancel newline ("\\n") output.
 
 User can set the escape sequence to any character(s).
 
+=== Remote escape
+
+hookesc can be used to cancel the newline following the macro. However
+it is sometimes convenient to have "clean" line ending, but still
+cancel the newline. This holds true for example if language sensitive
+editor mode should be respected.
+
+If the first character is "+" in the macro body, the character
+following the macro is cancelled from output. "+" is removed silently
+and the rest of the macro body is handled normally.
+
+Remote escape is typically used to cancel a newline, since other use
+cases can be handeled by other means.
+
 === Single char hooks and escape
 
 If all hooks are single character (including hookesc) and have the
@@ -134,6 +150,20 @@ Hookbeg is detected at "|" if outside macro. Hookend is detected at
 is not possible, since hookbeg is never detected within macro. The
 default hook values can be used for nested macros (if desired).
 
+=== Multiple hooks
+
+Mucgly allows the user to define multiple hookbeg and hookend
+pairs. This can be done from command line or from Mucgly module
+methods.
+
+Any of the possible hookbegs will start an macro, and the
+corresponding hookend pair will terminate the macro. Multiple hooks
+are used as a replacement for single hookbeg and hookend.
+
+Multihook mode is entered when first multihook pair is added. This can
+happen multiple times. If a single hook set is performed (again),
+singlehook mode is entered. This can also be used as method for
+resetting the current set of multihooks.
 
 
 == Special commands
@@ -170,6 +200,10 @@ List of ":" style special commands:
 [comment] Comment is used to add comments into the macro file. No
           output is produced from comment macros.
 
+[block] Block output starting with this command, see unblock.
+
+[unblock] Unblock output starting with this command, see block.
+
 [source] Source reads a plain Ruby file into the Execution Environment.
 
 [hook] Sets both hookbeg and hookend to values separated by
@@ -252,6 +286,9 @@ Complete list of Mucgly module methods:
 
 [sethookesc] Set hookesc value.
 
+[multihook] Define a set of hookbeg/hookend pairs (even number of
+            strings in array).
+
 [ifilename] Input file name as String.
 
 [ilinenumber] Input file line number.
@@ -262,7 +299,8 @@ Complete list of Mucgly module methods:
 
 [pushinput] Makes given file as current input stream. When this stream
             is runs out (EOF) or is closed (with closeinput), the
-            input stream is reverted to previous input file.
+            input stream is reverted to previous input file. Pushinput
+            is same as ":include" command.
 
 [closeinput] Close output stream (before EOF is encountered).
 
@@ -272,6 +310,9 @@ Complete list of Mucgly module methods:
 
 [closeoutput] Close output stream.
 
+[block] Block output starting with this command, see unblock.
+
+[unblock] Unblock output starting with this command, see block.
 
 
 == Command line interface
@@ -281,6 +322,9 @@ Please execute:
 
 for an overview of the command line options.
 
+The user must use the same option multiple times in order to enter
+multiple args of the same class.
+
 
 === Input and Output files
 
@@ -290,7 +334,8 @@ Mucgly is STDIN.
 Output file can be defined with "-o" option. The default output stream
 for Mucgly is STDOUT.
 
-If "-g" option is given, the output file list is created by extracting "-g" option argument value from each input file name.
+If "-g" option is given, the output file list is created by extracting
+"-g" option argument value from each input file name.
 
 For example with:
    mucgly -f foo.rx.txt -f bar.rx.txt -g .rx

data/bin/mucgly

@@ -4,4 +4,4 @@ require_relative '../lib/mucgly/mucgly'
 require_relative '../lib/version'
 
 # Send ARGV and add program name as first entry.
-Mucgly.run_mucgly( [ __FILE__] + ARGV )
+Mucgly.run_mucgly( [ __FILE__ ] + ARGV )

data/doc/Mucgly.html

@@ -92,7 +92,7 @@
         <dt id="VERSION-constant" class="">VERSION =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.2.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
       
     </dl>
   
@@ -177,7 +177,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sun Apr  5 20:11:53 2015 by
+  Generated on Sun Apr 24 19:00:00 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>

data/doc/_index.html

@@ -104,7 +104,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sun Apr  5 20:11:53 2015 by
+  Generated on Sun Apr 24 19:00:00 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>

data/doc/file.CHANGELOG.html

@@ -63,7 +63,11 @@
 
     <div id="content"><div id='filecontents'>
 <h1 id="label-Version+history">Version history</h1>
-<dl class="rdoc-list label-list"><dt>0.1.1
+<dl class="rdoc-list label-list"><dt>0.2.0
+<dd>
+<p>Multihook feature. Remote escape feature. Block output feature. Fix for
+hook at EOF parsing.</p>
+</dd><dt>0.1.1
 <dd>
 <p>Documentation updates. Tiny code cleanups. Better test coverage for Mugcly
 module.</p>
@@ -85,7 +89,7 @@ compatible with older versions.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Sun Apr  5 20:11:53 2015 by
+  Generated on Sun Apr 24 19:00:00 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>

data/doc/file.README.html

@@ -120,13 +120,16 @@ result. Mucgly module is part of Mucgly.</p>
 
 <p>For all command line options, see:</p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_mucgly'>mucgly</span> <span class='op'>-</span><span class='id identifier rubyid_h'>h</span></code></pre>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_mucgly'>mucgly</span> <span class='op'>-</span><span class='id identifier rubyid_h'>h</span>
+</code></pre>
 
 <h2 id="label-Features">Features</h2>
 <ul><li>
 <p>User settable hooks to define macro boundaries. Can be set from command
 line, configuration files, or from macro input file.</p>
 </li><li>
+<p>Multiple, concurrent macro start and end limiters (multihook).</p>
+</li><li>
 <p>Multiple sources for configuration: default config, environment variable,
 command line.</p>
 </li><li>
@@ -163,7 +166,7 @@ command line.</p>
 <h3 id="label-Hooks">Hooks</h3>
 
 <p>Hooks start and end the macro definition. By default hookbeg is “-&lt;” and
-hookend is “&gt;-”. These values are not easily conflicting with typical
+hookend is “&gt;-”. These values don&#39;t conflict easily with typical
 macro file body text.</p>
 
 <p>If literal hook string is required in the output, the hookesc sequence
@@ -182,6 +185,20 @@ cancel space (“ ”) output, and cancel newline (“\n”) output.</p>
 
 <p>User can set the escape sequence to any character(s).</p>
 
+<h3 id="label-Remote+escape">Remote escape</h3>
+
+<p>hookesc can be used to cancel the newline following the macro. However it
+is sometimes convenient to have “clean” line ending, but still cancel the
+newline. This holds true for example if language sensitive editor mode
+should be respected.</p>
+
+<p>If the first character is “+” in the macro body, the character following
+the macro is cancelled from output. “+” is removed silently and the rest of
+the macro body is handled normally.</p>
+
+<p>Remote escape is typically used to cancel a newline, since other use cases
+can be handeled by other means.</p>
+
 <h3 id="label-Single+char+hooks+and+escape">Single char hooks and escape</h3>
 
 <p>If all hooks are single character (including hookesc) and have the same
@@ -198,6 +215,20 @@ used. Also expressing multilevel macros (macro in macro) is not possible,
 since hookbeg is never detected within macro. The default hook values can
 be used for nested macros (if desired).</p>
 
+<h3 id="label-Multiple+hooks">Multiple hooks</h3>
+
+<p>Mucgly allows the user to define multiple hookbeg and hookend pairs. This
+can be done from command line or from Mucgly module methods.</p>
+
+<p>Any of the possible hookbegs will start an macro, and the corresponding
+hookend pair will terminate the macro. Multiple hooks are used as a
+replacement for single hookbeg and hookend.</p>
+
+<p>Multihook mode is entered when first multihook pair is added. This can
+happen multiple times. If a single hook set is performed (again),
+singlehook mode is entered. This can also be used as method for resetting
+the current set of multihooks.</p>
+
 <h2 id="label-Special+commands">Special commands</h2>
 
 <p>In addition to regular Ruby code the macros are allowed to include so
@@ -232,6 +263,12 @@ can be used for example to multiplex multiple files into one (example:
 <dd>
 <p>Comment is used to add comments into the macro file. No output is produced
 from comment macros.</p>
+</dd><dt>block
+<dd>
+<p>Block output starting with this command, see unblock.</p>
+</dd><dt>unblock
+<dd>
+<p>Unblock output starting with this command, see block.</p>
 </dd><dt>source
 <dd>
 <p>Source reads a plain Ruby file into the Execution Environment.</p>
@@ -327,6 +364,9 @@ Hook-commands change the current hook values.</p>
 </dd><dt>sethookesc
 <dd>
 <p>Set hookesc value.</p>
+</dd><dt>multihook
+<dd>
+<p>Define a set of hookbeg/hookend pairs (even number of strings in array).</p>
 </dd><dt>ifilename
 <dd>
 <p>Input file name as String.</p>
@@ -343,7 +383,7 @@ Hook-commands change the current hook values.</p>
 <dd>
 <p>Makes given file as current input stream. When this stream is runs out
 (EOF) or is closed (with closeinput), the input stream is reverted to
-previous input file.</p>
+previous input file. Pushinput is same as “:include” command.</p>
 </dd><dt>closeinput
 <dd>
 <p>Close output stream (before EOF is encountered).</p>
@@ -354,16 +394,26 @@ closeoutput), the output stream is reverted to previous output file.</p>
 </dd><dt>closeoutput
 <dd>
 <p>Close output stream.</p>
+</dd><dt>block
+<dd>
+<p>Block output starting with this command, see unblock.</p>
+</dd><dt>unblock
+<dd>
+<p>Unblock output starting with this command, see block.</p>
 </dd></dl>
 
 <h2 id="label-Command+line+interface">Command line interface</h2>
 
 <p>Please execute:</p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_mucgly'>mucgly</span> <span class='op'>-</span><span class='id identifier rubyid_h'>h</span></code></pre>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_mucgly'>mucgly</span> <span class='op'>-</span><span class='id identifier rubyid_h'>h</span>
+</code></pre>
 
 <p>for an overview of the command line options.</p>
 
+<p>The user must use the same option multiple times in order to enter multiple
+args of the same class.</p>
+
 <h3 id="label-Input+and+Output+files">Input and Output files</h3>
 
 <p>Input files can be listed to “-f” option. The default input stream for
@@ -416,7 +466,7 @@ GEM executable (i.e. same command line options).</p>
 </div></div>
 
     <div id="footer">
-  Generated on Sun Apr  5 20:11:53 2015 by
+  Generated on Sun Apr 24 19:00:00 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>

data/doc/index.html

@@ -120,13 +120,16 @@ result. Mucgly module is part of Mucgly.</p>
 
 <p>For all command line options, see:</p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_mucgly'>mucgly</span> <span class='op'>-</span><span class='id identifier rubyid_h'>h</span></code></pre>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_mucgly'>mucgly</span> <span class='op'>-</span><span class='id identifier rubyid_h'>h</span>
+</code></pre>
 
 <h2 id="label-Features">Features</h2>
 <ul><li>
 <p>User settable hooks to define macro boundaries. Can be set from command
 line, configuration files, or from macro input file.</p>
 </li><li>
+<p>Multiple, concurrent macro start and end limiters (multihook).</p>
+</li><li>
 <p>Multiple sources for configuration: default config, environment variable,
 command line.</p>
 </li><li>
@@ -163,7 +166,7 @@ command line.</p>
 <h3 id="label-Hooks">Hooks</h3>
 
 <p>Hooks start and end the macro definition. By default hookbeg is “-&lt;” and
-hookend is “&gt;-”. These values are not easily conflicting with typical
+hookend is “&gt;-”. These values don&#39;t conflict easily with typical
 macro file body text.</p>
 
 <p>If literal hook string is required in the output, the hookesc sequence
@@ -182,6 +185,20 @@ cancel space (“ ”) output, and cancel newline (“\n”) output.</p>
 
 <p>User can set the escape sequence to any character(s).</p>
 
+<h3 id="label-Remote+escape">Remote escape</h3>
+
+<p>hookesc can be used to cancel the newline following the macro. However it
+is sometimes convenient to have “clean” line ending, but still cancel the
+newline. This holds true for example if language sensitive editor mode
+should be respected.</p>
+
+<p>If the first character is “+” in the macro body, the character following
+the macro is cancelled from output. “+” is removed silently and the rest of
+the macro body is handled normally.</p>
+
+<p>Remote escape is typically used to cancel a newline, since other use cases
+can be handeled by other means.</p>
+
 <h3 id="label-Single+char+hooks+and+escape">Single char hooks and escape</h3>
 
 <p>If all hooks are single character (including hookesc) and have the same
@@ -198,6 +215,20 @@ used. Also expressing multilevel macros (macro in macro) is not possible,
 since hookbeg is never detected within macro. The default hook values can
 be used for nested macros (if desired).</p>
 
+<h3 id="label-Multiple+hooks">Multiple hooks</h3>
+
+<p>Mucgly allows the user to define multiple hookbeg and hookend pairs. This
+can be done from command line or from Mucgly module methods.</p>
+
+<p>Any of the possible hookbegs will start an macro, and the corresponding
+hookend pair will terminate the macro. Multiple hooks are used as a
+replacement for single hookbeg and hookend.</p>
+
+<p>Multihook mode is entered when first multihook pair is added. This can
+happen multiple times. If a single hook set is performed (again),
+singlehook mode is entered. This can also be used as method for resetting
+the current set of multihooks.</p>
+
 <h2 id="label-Special+commands">Special commands</h2>
 
 <p>In addition to regular Ruby code the macros are allowed to include so
@@ -232,6 +263,12 @@ can be used for example to multiplex multiple files into one (example:
 <dd>
 <p>Comment is used to add comments into the macro file. No output is produced
 from comment macros.</p>
+</dd><dt>block
+<dd>
+<p>Block output starting with this command, see unblock.</p>
+</dd><dt>unblock
+<dd>
+<p>Unblock output starting with this command, see block.</p>
 </dd><dt>source
 <dd>
 <p>Source reads a plain Ruby file into the Execution Environment.</p>
@@ -327,6 +364,9 @@ Hook-commands change the current hook values.</p>
 </dd><dt>sethookesc
 <dd>
 <p>Set hookesc value.</p>
+</dd><dt>multihook
+<dd>
+<p>Define a set of hookbeg/hookend pairs (even number of strings in array).</p>
 </dd><dt>ifilename
 <dd>
 <p>Input file name as String.</p>
@@ -343,7 +383,7 @@ Hook-commands change the current hook values.</p>
 <dd>
 <p>Makes given file as current input stream. When this stream is runs out
 (EOF) or is closed (with closeinput), the input stream is reverted to
-previous input file.</p>
+previous input file. Pushinput is same as “:include” command.</p>
 </dd><dt>closeinput
 <dd>
 <p>Close output stream (before EOF is encountered).</p>
@@ -354,16 +394,26 @@ closeoutput), the output stream is reverted to previous output file.</p>
 </dd><dt>closeoutput
 <dd>
 <p>Close output stream.</p>
+</dd><dt>block
+<dd>
+<p>Block output starting with this command, see unblock.</p>
+</dd><dt>unblock
+<dd>
+<p>Unblock output starting with this command, see block.</p>
 </dd></dl>
 
 <h2 id="label-Command+line+interface">Command line interface</h2>
 
 <p>Please execute:</p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_mucgly'>mucgly</span> <span class='op'>-</span><span class='id identifier rubyid_h'>h</span></code></pre>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_mucgly'>mucgly</span> <span class='op'>-</span><span class='id identifier rubyid_h'>h</span>
+</code></pre>
 
 <p>for an overview of the command line options.</p>
 
+<p>The user must use the same option multiple times in order to enter multiple
+args of the same class.</p>
+
 <h3 id="label-Input+and+Output+files">Input and Output files</h3>
 
 <p>Input files can be listed to “-f” option. The default input stream for
@@ -416,7 +466,7 @@ GEM executable (i.e. same command line options).</p>
 </div></div>
 
     <div id="footer">
-  Generated on Sun Apr  5 20:11:53 2015 by
+  Generated on Sun Apr 24 19:00:00 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sun Apr  5 20:11:53 2015 by
+  Generated on Sun Apr 24 19:00:00 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.2).
 </div>