netlinx-compile 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40eff70a5a7d76ea472329d1a8d496169a2cf936
-  data.tar.gz: ac5119802f76f715a2cf26ff01be83885c1cb6f2
+  metadata.gz: a68682a96264aa1b8cd13c169e2a511bda4411f5
+  data.tar.gz: 7808b8c41e423d711ba54b3ef6a0d9a498eaf49c
 SHA512:
-  metadata.gz: 43f2dae249ddd91c9778a09d9b0e2f31e0fe505761ec2f66662b3a536677104bc3c7c8d50c75077afe135d1ef668b33b5512e8326f98eeae36a3d3992dfa28e0
-  data.tar.gz: 37bbb8b34db000fc5c376af99ec05ea0dd1c168f7b013b2237ea152abd7c31ba0810757b71ea13a8b4dc5440703c0dec8867db2782edac53b20018f27fa3dd00
+  metadata.gz: a2e2566897936aaabf4aaa05f8e50e3bbc6bef17a0d63a48c8b31890d3acad796a68c1840af8247b7c88062b4122360a85aec3cdadb0dd323324dfc892475ec2
+  data.tar.gz: ff51291769c11aaceb750fad129bd7cc0da78312186e85fab9c1ae41d66266255f1f1f9b49ce74878cf081a920b2e32d07c975519e9d8c7a11bf1562e999babf

data/README.md

@@ -6,7 +6,30 @@ A wrapper utility for the AMX NetLinx compiler.
 
 [![Gem Version](https://badge.fury.io/rb/netlinx-compile.png)](http://badge.fury.io/rb/netlinx-compile)
 
-This library provides an executable, `netlinx-compile`, that wraps the `nlrc.exe` NetLinx compiler provided by AMX. It is designed for easier command line access, as well as for integration with third-party tools with source code build support, like text editors and IDE's. Also provided in this library is a Ruby API for invoking the NetLinx compiler.
+This library provides an executable, `netlinx-compile`, that wraps the `nlrc.exe`
+NetLinx compiler provided by AMX. It is designed for easier command line access,
+as well as for integration with third-party tools with source code build support,
+like text editors and IDE's. Also provided in this library is a Ruby API for
+invoking the NetLinx compiler.
+
+
+## Upgrade Notice
+
+AMX has broken NetLinx compilier functionality between NLRC.exe v1.0
+(distributed with NetLinx Studio v3.x) and NLRC.exe v2.1 (distributed with
+NetLinx Studio 4). NLRC.exe v2.x was distributed with NetLinx Studio 4 versions
+less than 4.1.1204, and has major problems. It is recommended to *avoid*
+NLRC.exe v2.x. NLRC.exe v3.x started being distributed in NetLinx Studio
+v4.1.1204 and appears to have fixed the problems when compiling include and Duet
+files. Due to the major changes in the NetLinx compiler, it may be necessary
+to use version 1.x of netlinx-compile when working with projects created with
+NetLinx Studio v3.x or earlier.
+
+* Version 1.x of netlinx-compile targets NLRC.exe v1.x.
+* NLRC.exe v2.x is considered broken and is unsupported by netlinx-compile.
+* Version 3.x of netlinx-compile targets NLRC.exe v3.x.
+
+[AMX NetLinx Compiler Bug List](https://github.com/amclain/netlinx-compile/labels/amx%20bug%20-%20can't%20fix)
 
 
 ## Documentation

data/doc/NetLinx.html

@@ -110,7 +110,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/NetLinx/Compile.html

@@ -110,7 +110,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/NetLinx/Compile/Extension.html

@@ -106,7 +106,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/NetLinx/Compile/Extension/AXS.html

@@ -208,7 +208,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:29 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/NetLinx/Compile/ExtensionDiscovery.html

@@ -473,7 +473,7 @@ extensions.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:29 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/NetLinx/Compile/ExtensionHandler.html

@@ -694,7 +694,7 @@ should be considered a better match than discovering a source code file.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:29 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/NetLinx/Compile/Script.html

@@ -392,7 +392,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/NetLinx/Compiler.html

@@ -326,7 +326,13 @@ Test::NetLinx::Compilable.</p>
 65
 66
 67
-68</pre>
+68
+69
+70
+71
+72
+73
+74</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/netlinx/compiler.rb', line 37</span>
@@ -347,7 +353,13 @@ Test::NetLinx::Compilable.</p>
       <span class='id identifier rubyid_compilable'>compilable</span><span class='period'>.</span><span class='id identifier rubyid_compiler_library_paths'>compiler_library_paths</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
     
     <span class='comment'># Run the NetLinx compiler.
-</span>    <span class='id identifier rubyid_io'>io</span> <span class='op'>=</span> <span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_popen'>popen</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_compiler'>compiler</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot; \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_target_file'>target_file</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot; \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_include_paths'>include_paths</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot; \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_module_paths'>module_paths</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot; \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_library_paths'>library_paths</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span>
+</span>    <span class='comment'># Note: NLRC.exe v2.1 freaks out if empty arguments (&quot;&quot;) are in the command.
+</span>    <span class='id identifier rubyid_cmd'>cmd</span>  <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_compiler'>compiler</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot; \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_target_file'>target_file</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span>
+    <span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_include_paths'>include_paths</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_include_paths'>include_paths</span>
+    <span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_module_paths'>module_paths</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span>  <span class='kw'>if</span> <span class='id identifier rubyid_module_paths'>module_paths</span>
+    <span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_library_paths'>library_paths</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_library_paths'>library_paths</span>
+    
+    <span class='id identifier rubyid_io'>io</span> <span class='op'>=</span> <span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_popen'>popen</span> <span class='id identifier rubyid_cmd'>cmd</span>
     <span class='id identifier rubyid_stream'>stream</span> <span class='op'>=</span> <span class='id identifier rubyid_io'>io</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span>
     <span class='id identifier rubyid_io'>io</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
     
@@ -373,7 +385,7 @@ Test::NetLinx::Compilable.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/NetLinx/CompilerResult.html

@@ -1096,7 +1096,7 @@ compiler_library_paths -- See Compilable interface.</code></pre>
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:29 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/NetLinx/NoCompilerError.html

@@ -126,7 +126,7 @@ See NetLinx::Compiler.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/NetLinx/SourceFile.html

@@ -606,7 +606,7 @@ compiler_module_paths: Array of additional paths for the compiler to find module
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/_index.html

@@ -206,7 +206,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:57 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/file.README.html

@@ -78,6 +78,29 @@ third-party tools with source code build support, like text editors and
 IDE's. Also provided in this library is a Ruby API for invoking the
 NetLinx compiler.</p>
 
+<h2 id="label-Upgrade+Notice">Upgrade Notice</h2>
+
+<p>AMX has broken NetLinx compilier functionality between NLRC.exe v1.0
+(distributed with NetLinx Studio v3.x) and NLRC.exe v2.1 (distributed with
+NetLinx Studio 4). NLRC.exe v2.x was distributed with NetLinx Studio 4
+versions less than 4.1.1204, and has major problems. It is recommended to
+<em>avoid</em> NLRC.exe v2.x. NLRC.exe v3.x started being distributed in
+NetLinx Studio v4.1.1204 and appears to have fixed the problems when
+compiling include and Duet files. Due to the major changes in the NetLinx
+compiler, it may be necessary to use version 1.x of netlinx-compile when
+working with projects created with NetLinx Studio v3.x or earlier.</p>
+<ul><li>
+<p>Version 1.x of netlinx-compile targets NLRC.exe v1.x.</p>
+</li><li>
+<p>NLRC.exe v2.x is considered broken and is unsupported by netlinx-compile.</p>
+</li><li>
+<p>Version 3.x of netlinx-compile targets NLRC.exe v3.x.</p>
+</li></ul>
+
+<p><a
+href="https://github.com/amclain/netlinx-compile/labels/amx%20bug%20-%20can't%20fix">AMX
+NetLinx Compiler Bug List</a></p>
+
 <h2 id="label-Documentation">Documentation</h2>
 
 <p><a
@@ -85,7 +108,7 @@ href="https://sourceforge.net/p/netlinx-compile/wiki/Home/">sourceforge.net/p/ne
 </div></div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/file.license.html

@@ -64,7 +64,7 @@
     <div id="content"><div id='filecontents'>Copyright 2013 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 Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/index.html

@@ -78,6 +78,29 @@ third-party tools with source code build support, like text editors and
 IDE's. Also provided in this library is a Ruby API for invoking the
 NetLinx compiler.</p>
 
+<h2 id="label-Upgrade+Notice">Upgrade Notice</h2>
+
+<p>AMX has broken NetLinx compilier functionality between NLRC.exe v1.0
+(distributed with NetLinx Studio v3.x) and NLRC.exe v2.1 (distributed with
+NetLinx Studio 4). NLRC.exe v2.x was distributed with NetLinx Studio 4
+versions less than 4.1.1204, and has major problems. It is recommended to
+<em>avoid</em> NLRC.exe v2.x. NLRC.exe v3.x started being distributed in
+NetLinx Studio v4.1.1204 and appears to have fixed the problems when
+compiling include and Duet files. Due to the major changes in the NetLinx
+compiler, it may be necessary to use version 1.x of netlinx-compile when
+working with projects created with NetLinx Studio v3.x or earlier.</p>
+<ul><li>
+<p>Version 1.x of netlinx-compile targets NLRC.exe v1.x.</p>
+</li><li>
+<p>NLRC.exe v2.x is considered broken and is unsupported by netlinx-compile.</p>
+</li><li>
+<p>Version 3.x of netlinx-compile targets NLRC.exe v3.x.</p>
+</li></ul>
+
+<p><a
+href="https://github.com/amclain/netlinx-compile/labels/amx%20bug%20-%20can't%20fix">AMX
+NetLinx Compiler Bug List</a></p>
+
 <h2 id="label-Documentation">Documentation</h2>
 
 <p><a
@@ -85,7 +108,7 @@ href="https://sourceforge.net/p/netlinx-compile/wiki/Home/">sourceforge.net/p/ne
 </div></div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:28 2015 by
+  Generated on Mon Jan 26 15:35:58 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/lib/netlinx/compiler.rb

@@ -50,7 +50,13 @@ module NetLinx
           compilable.compiler_library_paths.empty?
         
         # Run the NetLinx compiler.
-        io = IO.popen "\"#{compiler}\" \"#{target_file}\" \"#{include_paths}\" \"#{module_paths}\" \"#{library_paths}\""
+        # Note: NLRC.exe v2.1 freaks out if empty arguments ("") are in the command.
+        cmd  = "\"#{compiler}\" \"#{target_file}\""
+        cmd += " \"#{include_paths}\"" if include_paths
+        cmd += " \"#{module_paths}\""  if module_paths
+        cmd += " \"#{library_paths}\"" if library_paths
+        
+        io = IO.popen cmd
         stream = io.read
         io.close
         

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netlinx-compile
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Alex McLain