netlinx-src 0.1.0 → 0.2.0

data/doc/_index.html

@@ -64,13 +64,10 @@
   <ul id="files" class="index_inline_list">
   
   
-    <li class="r1"><a href="index.html" title="README.md">README.md</a></li>
+    <li class="r1"><a href="index.html" title="README">README</a></li>
     
   
-    <li class="r2"><a href="file.README.html" title="README">README</a></li>
-    
-  
-    <li class="r1"><a href="file.license.html" title="license">license</a></li>
+    <li class="r2"><a href="file.license.html" title="license">license</a></li>
     
   
   </ul>
@@ -86,6 +83,36 @@
     <td valign='top' width="33%">
       
         
+        <ul id="alpha_D" class="alpha">
+          <li class="letter">D</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="NetLinx/Rake/DelZip.html" title="NetLinx::Rake::DelZip (class)">DelZip</a></span>
+                
+                  <small>(NetLinx::Rake)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
+        <ul id="alpha_M" class="alpha">
+          <li class="letter">M</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="NetLinx/Rake/MkZip.html" title="NetLinx::Rake::MkZip (class)">MkZip</a></span>
+                
+                  <small>(NetLinx::Rake)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
         <ul id="alpha_N" class="alpha">
           <li class="letter">N</li>
           <ul>
@@ -104,12 +131,71 @@
           <ul>
             
               <li>
-                <span class='object_link'><a href="NetLinx/ProjectPackage.html" title="NetLinx::ProjectPackage (class)">ProjectPackage</a></span>
+                <span class='object_link'><a href="NetLinx/Rake/Pack.html" title="NetLinx::Rake::Pack (class)">Pack</a></span>
+                
+                  <small>(NetLinx::Rake)</small>
+                
+              </li>
+            
+              <li>
+                <span class='object_link'><a href="NetLinx/SRC/Package.html" title="NetLinx::SRC::Package (class)">Package</a></span>
+                
+                  <small>(NetLinx::SRC)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
+        <ul id="alpha_R" class="alpha">
+          <li class="letter">R</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="NetLinx/Rake.html" title="NetLinx::Rake (module)">Rake</a></span>
+                
+                  <small>(NetLinx)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
+        <ul id="alpha_S" class="alpha">
+          <li class="letter">S</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="NetLinx/SRC.html" title="NetLinx::SRC (module)">SRC</a></span>
                 
                   <small>(NetLinx)</small>
                 
               </li>
             
+              <li>
+                <span class='object_link'><a href="NetLinx/Rake/SrcIgnore.html" title="NetLinx::Rake::SrcIgnore (class)">SrcIgnore</a></span>
+                
+                  <small>(NetLinx::Rake)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
+        <ul id="alpha_U" class="alpha">
+          <li class="letter">U</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="NetLinx/Rake/Unpack.html" title="NetLinx::Rake::Unpack (class)">Unpack</a></span>
+                
+                  <small>(NetLinx::Rake)</small>
+                
+              </li>
+            
           </ul>
         </ul>
       
@@ -122,9 +208,9 @@
 </div>
 
     <div id="footer">
-  Generated on Wed May  7 18:13:49 2014 by
+  Generated on Mon May 12 11:49:56 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.4 (ruby-2.1.1).
+  0.8.7.4 (ruby-2.0.0).
 </div>
 
   </body>

data/doc/class_list.html

@@ -46,7 +46,7 @@
 
       <ul id="full_list" class="class">
         <li><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></li>
-<li><a class='toggle'></a> <span class='object_link'><a href="NetLinx.html" title="NetLinx (module)">NetLinx</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="NetLinx/ProjectPackage.html" title="NetLinx::ProjectPackage (class)">ProjectPackage</a></span> &lt; Object<small class='search_info'>NetLinx</small></li></ul>
+<li><a class='toggle'></a> <span class='object_link'><a href="NetLinx.html" title="NetLinx (module)">NetLinx</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="NetLinx/Rake.html" title="NetLinx::Rake (module)">Rake</a></span><small class='search_info'>NetLinx</small></li><ul><li><span class='object_link'><a href="NetLinx/Rake/DelZip.html" title="NetLinx::Rake::DelZip (class)">DelZip</a></span> &lt; TaskLib<small class='search_info'>NetLinx::Rake</small></li><li><span class='object_link'><a href="NetLinx/Rake/MkZip.html" title="NetLinx::Rake::MkZip (class)">MkZip</a></span> &lt; TaskLib<small class='search_info'>NetLinx::Rake</small></li><li><span class='object_link'><a href="NetLinx/Rake/Pack.html" title="NetLinx::Rake::Pack (class)">Pack</a></span> &lt; TaskLib<small class='search_info'>NetLinx::Rake</small></li><li><span class='object_link'><a href="NetLinx/Rake/SrcIgnore.html" title="NetLinx::Rake::SrcIgnore (class)">SrcIgnore</a></span> &lt; TaskLib<small class='search_info'>NetLinx::Rake</small></li><li><span class='object_link'><a href="NetLinx/Rake/Unpack.html" title="NetLinx::Rake::Unpack (class)">Unpack</a></span> &lt; TaskLib<small class='search_info'>NetLinx::Rake</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="NetLinx/SRC.html" title="NetLinx::SRC (module)">SRC</a></span><small class='search_info'>NetLinx</small></li><ul><li><span class='object_link'><a href="NetLinx/SRC/Package.html" title="NetLinx::SRC::Package (class)">Package</a></span> &lt; Object<small class='search_info'>NetLinx::SRC</small></li></ul></ul>
 
       </ul>
     </div>

data/doc/file.README.html

@@ -61,19 +61,65 @@
 
     <iframe id="search_frame"></iframe>
 
-    <div id="content"><div id='filecontents'><h1>NetLinx Source File Utility</h1>
+    <div id="content"><div id='filecontents'>
+<h1 id="label-NetLinx+Source+File+Utility">NetLinx Source File Utility</h1>
 
-<p>Package and unpackage NetLinx <code>.src</code> source code bundles.</p>
+<p>A toolset for working with NetLinx <code>.src</code> source code packages.</p>
 
-<h2>Documentation</h2>
+<p><a href="https://badge.fury.io/rb/netlinx-src.svg">{Gem Version</a>]</p>
 
-<p><a href="https://sourceforge.net/p/netlinx-src/wiki/Home/">https://sourceforge.net/p/netlinx-src/wiki/Home/</a></p>
+<h2 id="label-Installation">Installation</h2>
+
+<p>Install Ruby <code>&gt;= 2.0.0</code> for <a
+href="http://rubyinstaller.org/downloads/">Windows</a> or <a
+href="https://github.com/sstephenson/rbenv#basic-github-checkout">Linux</a>.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_netlinx'>netlinx</span><span class='op'>-</span><span class='id identifier rubyid_src'>src</span></code></pre>
+
+<h2 id="label-Rake+Tasks">Rake Tasks</h2>
+
+<p>Commands are executed with</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_rake'>rake</span> <span class='lbracket'>[</span><span class='id identifier rubyid_task'>task</span><span class='rbracket'>]</span></code></pre>
+
+<h4 id="label-pack">pack</h4>
+
+<p>Create a NetLinx <code>.src</code> source code package, excluding any files
+specified in <code>.srcignore</code>.
+This command will look for a
+<code>.apw</code> NetLinx Workspace file in the directory <code>rake
+pack</code> was executed in to determine the file name.</p>
+
+<h4 id="label-unpack">unpack</h4>
+
+<p>Unpack a NetLinx <code>.src</code> file into a directory named
+<code>extracted</code>.</p>
+
+<h4 id="label-srcignore">srcignore</h4>
+
+<p>Generate a default <code>.srcignore</code> file in the working directory.</p>
+
+<h4 id="label-mkzip">mkzip</h4>
+
+<p>Create a copy of the <code>.src</code> file and append <code>.zip</code> so
+it can be opened in any standard file compression utility.</p>
+
+<h4 id="label-delzip">delzip</h4>
+
+<p>Delete any <code>.src.zip</code> files in the working directory.</p>
+
+<h2 id="label-Rakefile">Rakefile</h2>
+
+<p>To add the default Rake tasks to a project&#39;s <code>Rakefile</code>:</p>
+
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;netlinx/rake/src&#39;</span>
+</pre>
 </div></div>
 
     <div id="footer">
-  Generated on Wed May  7 18:13:49 2014 by
+  Generated on Mon May 12 11:49:57 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.4 (ruby-2.1.1).
+  0.8.7.4 (ruby-2.0.0).
 </div>
 
   </body>

data/doc/file.license.html

@@ -64,9 +64,9 @@
     <div id="content"><div id='filecontents'>Copyright 2013-2014 Alex McLain<br/><br/>Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<br/>you may not use this file except in compliance with the License.<br/>You may obtain a copy of the License at<br/><br/> http://www.apache.org/licenses/LICENSE-2.0<br/><br/>Unless required by applicable law or agreed to in writing, software<br/>distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<br/>WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br/>See the License for the specific language governing permissions and<br/>limitations under the License.</div></div>
 
     <div id="footer">
-  Generated on Wed May  7 18:13:49 2014 by
+  Generated on Mon May 12 11:49:57 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.4 (ruby-2.1.1).
+  0.8.7.4 (ruby-2.0.0).
 </div>
 
   </body>

data/doc/file_list.html

@@ -47,13 +47,10 @@
       <ul id="full_list" class="file">
         
 
-  <li class="r1"><span class="object_link"><a href="index.html" title="README.md">README.md</a></a></li>
+  <li class="r1"><span class="object_link"><a href="index.html" title="README">README</a></a></li>
   
 
-  <li class="r2"><span class="object_link"><a href="file.README.html" title="README">README</a></a></li>
-  
-
-  <li class="r1"><span class="object_link"><a href="file.license.html" title="license">license</a></a></li>
+  <li class="r2"><span class="object_link"><a href="file.license.html" title="license">license</a></a></li>
   
 
       </ul>

data/doc/index.html

@@ -4,7 +4,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <title>
-  File: README.md
+  File: README
   
     &mdash; Documentation by YARD 0.8.7.4
   
@@ -17,7 +17,7 @@
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '';
-  framesUrl = "frames.html#!file.README.md.html";
+  framesUrl = "frames.html#!file.README.html";
 </script>
 
 
@@ -32,7 +32,7 @@
       <div id="menu">
   
     <a href="_index.html">Index</a> &raquo; 
-    <span class="title">File: README.md</span>
+    <span class="title">File: README</span>
   
 
   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
@@ -62,20 +62,64 @@
     <iframe id="search_frame"></iframe>
 
     <div id="content"><div id='filecontents'>
-<p>&lt;&lt;&lt;&lt;&lt;&lt;&lt; local # NetLinx Source File Utility</p>
+<h1 id="label-NetLinx+Source+File+Utility">NetLinx Source File Utility</h1>
 
-<p>Package and unpackage NetLinx `.src` source code bundles.</p>
+<p>A toolset for working with NetLinx <code>.src</code> source code packages.</p>
 
-<h6 id="label-"></h6>
+<p><a href="https://badge.fury.io/rb/netlinx-src.svg">{Gem Version</a>]</p>
 
-<p>&gt;&gt;&gt;&gt;&gt;&gt;&gt; other ## Documentation [<a
-href="https://sourceforge.net/p/netlinx-src/wiki/Home/](https://sourceforge.net/p/netlinx-src/wiki/Home">sourceforge.net/p/netlinx-src/wiki/Home/](https://sourceforge.net/p/netlinx-src/wiki/Home</a>/)</p>
+<h2 id="label-Installation">Installation</h2>
+
+<p>Install Ruby <code>&gt;= 2.0.0</code> for <a
+href="http://rubyinstaller.org/downloads/">Windows</a> or <a
+href="https://github.com/sstephenson/rbenv#basic-github-checkout">Linux</a>.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_netlinx'>netlinx</span><span class='op'>-</span><span class='id identifier rubyid_src'>src</span></code></pre>
+
+<h2 id="label-Rake+Tasks">Rake Tasks</h2>
+
+<p>Commands are executed with</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_rake'>rake</span> <span class='lbracket'>[</span><span class='id identifier rubyid_task'>task</span><span class='rbracket'>]</span></code></pre>
+
+<h4 id="label-pack">pack</h4>
+
+<p>Create a NetLinx <code>.src</code> source code package, excluding any files
+specified in <code>.srcignore</code>.
+This command will look for a
+<code>.apw</code> NetLinx Workspace file in the directory <code>rake
+pack</code> was executed in to determine the file name.</p>
+
+<h4 id="label-unpack">unpack</h4>
+
+<p>Unpack a NetLinx <code>.src</code> file into a directory named
+<code>extracted</code>.</p>
+
+<h4 id="label-srcignore">srcignore</h4>
+
+<p>Generate a default <code>.srcignore</code> file in the working directory.</p>
+
+<h4 id="label-mkzip">mkzip</h4>
+
+<p>Create a copy of the <code>.src</code> file and append <code>.zip</code> so
+it can be opened in any standard file compression utility.</p>
+
+<h4 id="label-delzip">delzip</h4>
+
+<p>Delete any <code>.src.zip</code> files in the working directory.</p>
+
+<h2 id="label-Rakefile">Rakefile</h2>
+
+<p>To add the default Rake tasks to a project&#39;s <code>Rakefile</code>:</p>
+
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;netlinx/rake/src&#39;</span>
+</pre>
 </div></div>
 
     <div id="footer">
-  Generated on Wed May  7 18:13:49 2014 by
+  Generated on Mon May 12 11:49:56 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.4 (ruby-2.1.1).
+  0.8.7.4 (ruby-2.0.0).
 </div>
 
   </body>

data/doc/method_list.html

@@ -48,32 +48,110 @@
         
 
   <li class="r1 ">
-    <span class='object_link'><a href="NetLinx/ProjectPackage.html#copy_to_zip-instance_method" title="NetLinx::ProjectPackage#copy_to_zip (method)">#copy_to_zip</a></span>
-    <small>NetLinx::ProjectPackage</small>
+    <span class='object_link'><a href="NetLinx/SRC/Package.html#copy_to_zip-instance_method" title="NetLinx::SRC::Package#copy_to_zip (method)">#copy_to_zip</a></span>
+    <small>NetLinx::SRC::Package</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="NetLinx/ProjectPackage.html#initialize-instance_method" title="NetLinx::ProjectPackage#initialize (method)">#initialize</a></span>
-    <small>NetLinx::ProjectPackage</small>
+    <span class='object_link'><a href="NetLinx/Rake/Unpack.html#initialize-instance_method" title="NetLinx::Rake::Unpack#initialize (method)">#initialize</a></span>
+    <small>NetLinx::Rake::Unpack</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="NetLinx/ProjectPackage.html#pack-instance_method" title="NetLinx::ProjectPackage#pack (method)">#pack</a></span>
-    <small>NetLinx::ProjectPackage</small>
+    <span class='object_link'><a href="NetLinx/Rake/DelZip.html#initialize-instance_method" title="NetLinx::Rake::DelZip#initialize (method)">#initialize</a></span>
+    <small>NetLinx::Rake::DelZip</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="NetLinx/ProjectPackage.html#remove_zip-instance_method" title="NetLinx::ProjectPackage#remove_zip (method)">#remove_zip</a></span>
-    <small>NetLinx::ProjectPackage</small>
+    <span class='object_link'><a href="NetLinx/Rake/SrcIgnore.html#initialize-instance_method" title="NetLinx::Rake::SrcIgnore#initialize (method)">#initialize</a></span>
+    <small>NetLinx::Rake::SrcIgnore</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="NetLinx/ProjectPackage.html#unpack-instance_method" title="NetLinx::ProjectPackage#unpack (method)">#unpack</a></span>
-    <small>NetLinx::ProjectPackage</small>
+    <span class='object_link'><a href="NetLinx/SRC/Package.html#initialize-instance_method" title="NetLinx::SRC::Package#initialize (method)">#initialize</a></span>
+    <small>NetLinx::SRC::Package</small>
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="NetLinx/Rake/MkZip.html#initialize-instance_method" title="NetLinx::Rake::MkZip#initialize (method)">#initialize</a></span>
+    <small>NetLinx::Rake::MkZip</small>
+  </li>
+  
+
+  <li class="r1 ">
+    <span class='object_link'><a href="NetLinx/Rake/Pack.html#initialize-instance_method" title="NetLinx::Rake::Pack#initialize (method)">#initialize</a></span>
+    <small>NetLinx::Rake::Pack</small>
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="NetLinx/SRC/Package.html#load_exclusions-instance_method" title="NetLinx::SRC::Package#load_exclusions (method)">#load_exclusions</a></span>
+    <small>NetLinx::SRC::Package</small>
+  </li>
+  
+
+  <li class="r1 ">
+    <span class='object_link'><a href="NetLinx/SRC/Package.html#make_srcignore-instance_method" title="NetLinx::SRC::Package#make_srcignore (method)">#make_srcignore</a></span>
+    <small>NetLinx::SRC::Package</small>
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="NetLinx/SRC/Package.html#make_warning_file-instance_method" title="NetLinx::SRC::Package#make_warning_file (method)">#make_warning_file</a></span>
+    <small>NetLinx::SRC::Package</small>
+  </li>
+  
+
+  <li class="r1 ">
+    <span class='object_link'><a href="NetLinx/Rake/Pack.html#name-instance_method" title="NetLinx::Rake::Pack#name (method)">#name</a></span>
+    <small>NetLinx::Rake::Pack</small>
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="NetLinx/Rake/SrcIgnore.html#name-instance_method" title="NetLinx::Rake::SrcIgnore#name (method)">#name</a></span>
+    <small>NetLinx::Rake::SrcIgnore</small>
+  </li>
+  
+
+  <li class="r1 ">
+    <span class='object_link'><a href="NetLinx/Rake/DelZip.html#name-instance_method" title="NetLinx::Rake::DelZip#name (method)">#name</a></span>
+    <small>NetLinx::Rake::DelZip</small>
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="NetLinx/Rake/MkZip.html#name-instance_method" title="NetLinx::Rake::MkZip#name (method)">#name</a></span>
+    <small>NetLinx::Rake::MkZip</small>
+  </li>
+  
+
+  <li class="r1 ">
+    <span class='object_link'><a href="NetLinx/Rake/Unpack.html#name-instance_method" title="NetLinx::Rake::Unpack#name (method)">#name</a></span>
+    <small>NetLinx::Rake::Unpack</small>
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="NetLinx/SRC/Package.html#pack-instance_method" title="NetLinx::SRC::Package#pack (method)">#pack</a></span>
+    <small>NetLinx::SRC::Package</small>
+  </li>
+  
+
+  <li class="r1 ">
+    <span class='object_link'><a href="NetLinx/SRC/Package.html#remove_zip-instance_method" title="NetLinx::SRC::Package#remove_zip (method)">#remove_zip</a></span>
+    <small>NetLinx::SRC::Package</small>
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="NetLinx/SRC/Package.html#unpack-instance_method" title="NetLinx::SRC::Package#unpack (method)">#unpack</a></span>
+    <small>NetLinx::SRC::Package</small>
   </li>