RubyGems - netlinx-compile - Versions diffs - 1.0.0 → 2.0.0 - Mend

netlinx-compile 1.0.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (73) hide show

checksums.yaml +4 -4
data/README.md +14 -0
data/bin/netlinx-compile +0 -0
data/doc/NetLinx.html +119 -151
data/doc/NetLinx/Compile.html +119 -148
data/doc/NetLinx/Compile/Extension.html +115 -145
data/doc/NetLinx/Compile/Extension/AXS.html +217 -154
data/doc/NetLinx/Compile/ExtensionDiscovery.html +479 -321
data/doc/NetLinx/Compile/ExtensionHandler.html +703 -396
data/doc/NetLinx/Compile/Script.html +390 -282
data/doc/NetLinx/Compiler.html +375 -288
data/doc/NetLinx/CompilerResult.html +1102 -498
data/doc/NetLinx/NoCompilerError.html +135 -155
data/doc/NetLinx/SourceFile.html +608 -423
data/doc/_index.html +215 -0
data/doc/class_list.html +58 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +339 -0
data/doc/file.README.html +94 -0
data/doc/file.license.html +73 -0
data/doc/file_list.html +63 -0
data/doc/frames.html +26 -0
data/doc/index.html +94 -103
data/doc/js/app.js +219 -0
data/doc/js/full_list.js +181 -0
data/doc/js/jquery.js +4 -18
data/doc/method_list.html +261 -0
data/doc/top-level-namespace.html +112 -0
data/lib/test/netlinx/compilable.rb +13 -48
data/lib/test/netlinx/compile/discoverable.rb +3 -14
data/lib/test/netlinx/compile/invokable.rb +3 -15
metadata +98 -67
data/README.txt +0 -2
data/doc/Test.html +0 -147
data/doc/Test/NetLinx.html +0 -147
data/doc/Test/NetLinx/Compilable.html +0 -148
data/doc/Test/NetLinx/Compile.html +0 -146
data/doc/Test/NetLinx/Compile/Discoverable.html +0 -148
data/doc/Test/NetLinx/Compile/Invokable.html +0 -149
data/doc/created.rid +0 -12
data/doc/images/add.png +0 -0
data/doc/images/arrow_up.png +0 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/js/darkfish.js +0 -155
data/doc/js/navigation.js +0 -142
data/doc/js/search.js +0 -94
data/doc/js/search_index.js +0 -1
data/doc/js/searcher.js +0 -228
data/doc/rdoc.css +0 -595
data/doc/table_of_contents.html +0 -138

data/doc/NetLinx/Compile/ExtensionHandler.html CHANGED

@@ -1,396 +1,703 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
-<title>class NetLinx::Compile::ExtensionHandler - RDoc Documentation</title>
-<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">
-<script type="text/javascript">
-  var rdoc_rel_prefix = "../../";
-</script>
-<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script>
-<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script>
-<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script>
-<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script>
-<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script>
-<body id="top" class="class">
-<nav id="metadata">
-  <nav id="home-section" class="section">
-  <h3 class="section-header">
-    <a href="../../index.html">Home</a>
-    <a href="../../table_of_contents.html#classes">Classes</a>
-    <a href="../../table_of_contents.html#methods">Methods</a>
-  </h3>
-</nav>
-  <nav id="search-section" class="section project-section" class="initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <h3 class="section-header">
-      <input type="text" name="search" placeholder="Search" id="search-field"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </h3>
-  </form>
-  <ul id="search-results" class="initially-hidden"></ul>
-</nav>
-  <div id="file-metadata">
-    <nav id="file-list-section" class="section">
-  <h3 class="section-header">Defined In</h3>
-  <ul>
-    <li>lib/netlinx/compile/extension_handler.rb
-  </ul>
-</nav>
-  </div>
-  <div id="class-metadata">
-    <nav id="parent-class-section" class="section">
-  <h3 class="section-header">Parent</h3>
-  <p class="link">Object
-</nav>
-    <!-- Method Quickref -->
-<nav id="method-list-section" class="section">
-  <h3 class="section-header">Methods</h3>
-  <ul class="link-list">
-    <li ><a href="#method-c-new">::new</a>
-    <li ><a href="#method-i-3C-3C">#&lt;&lt;</a>
-    <li ><a href="#method-i-include-3F">#include?</a>
-    <li ><a href="#method-i-is_a_workspace-3F">#is_a_workspace?</a>
-  </ul>
-</nav>
-  </div>
-  <div id="project-metadata">
-    <nav id="classindex-section" class="section project-section">
-  <h3 class="section-header">Class and Module Index</h3>
-  <ul class="link-list">
-    <li><a href="../../NetLinx.html">NetLinx</a>
-    <li><a href="../../NetLinx/Compile.html">NetLinx::Compile</a>
-    <li><a href="../../NetLinx/Compile/Extension.html">NetLinx::Compile::Extension</a>
-    <li><a href="../../NetLinx/Compile/Extension/AXS.html">NetLinx::Compile::Extension::AXS</a>
-    <li><a href="../../NetLinx/Compile/ExtensionDiscovery.html">NetLinx::Compile::ExtensionDiscovery</a>
-    <li><a href="../../NetLinx/Compile/ExtensionHandler.html">NetLinx::Compile::ExtensionHandler</a>
-    <li><a href="../../NetLinx/Compile/Script.html">NetLinx::Compile::Script</a>
-    <li><a href="../../NetLinx/Compiler.html">NetLinx::Compiler</a>
-    <li><a href="../../NetLinx/CompilerResult.html">NetLinx::CompilerResult</a>
-    <li><a href="../../NetLinx/NoCompilerError.html">NetLinx::NoCompilerError</a>
-    <li><a href="../../NetLinx/SourceFile.html">NetLinx::SourceFile</a>
-    <li><a href="../../Test.html">Test</a>
-    <li><a href="../../Test/NetLinx.html">Test::NetLinx</a>
-    <li><a href="../../Test/NetLinx/Compilable.html">Test::NetLinx::Compilable</a>
-    <li><a href="../../Test/NetLinx/Compile.html">Test::NetLinx::Compile</a>
-    <li><a href="../../Test/NetLinx/Compile/Discoverable.html">Test::NetLinx::Compile::Discoverable</a>
-    <li><a href="../../Test/NetLinx/Compile/Invokable.html">Test::NetLinx::Compile::Invokable</a>
-  </ul>
-</nav>
-  </div>
-</nav>
-<div id="documentation">
-  <h1 class="class">class NetLinx::Compile::ExtensionHandler</h1>
-  <div id="description" class="description">
-<p>Tells netlinx-compile which class handles the compiling of a set of file
-extensions.</p>
-  </div><!-- description -->
-  <section id="5Buntitled-5D" class="documentation-section">
-    <!-- Attributes -->
-    <section id="attribute-method-details" class="method-section section">
-      <h3 class="section-header">Attributes</h3>
-      <div id="attribute-i-extensions" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">extensions</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-        <div class="method-description">
-        <p>A list of file extensions that this <a
-href="ExtensionHandler.html">ExtensionHandler</a> handles.</p>
-        </div>
-      </div>
-      <div id="attribute-i-handler_class" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">handler_class</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The class to invoke to handle compiling a file extension specified in this
-<a href="ExtensionHandler.html">ExtensionHandler</a>.</p>
-        </div>
-      </div>
-      <div id="attribute-i-usurps" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">usurps</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-        <div class="method-description">
-        <p>A list of file extensions that this <a
-href="ExtensionHandler.html">ExtensionHandler</a> usurps. For example,
-third-party workspace extensions would probably usurp the .apw workspace
-extension.</p>
-        </div>
-      </div>
-    </section><!-- attribute-method-details -->
-    <!-- Methods -->
-     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
-      <h3 class="section-header">Public Class Methods</h3>
-      <div id="method-c-new" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">new</span><span
-            class="method-args">(**kvargs)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Parameters:</p>
-<pre class="ruby"><span class="ruby-identifier">extensions</span><span class="ruby-operator">:</span> <span class="ruby-constant">An</span> <span class="ruby-identifier">array</span> <span class="ruby-identifier">of</span> <span class="ruby-identifier">file</span> <span class="ruby-identifier">extensions</span> (<span class="ruby-identifier">without</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">leading</span> <span class="ruby-identifier">dot</span>)
-            <span class="ruby-identifier">that</span> <span class="ruby-identifier">this</span> <span class="ruby-constant">ExtensionHandler</span> <span class="ruby-identifier">supports</span>.
-<span class="ruby-identifier">usurps</span><span class="ruby-operator">:</span>     <span class="ruby-constant">Future</span>.
-            <span class="ruby-constant">Lets</span> <span class="ruby-identifier">this</span> <span class="ruby-constant">ExtensionHandler</span> <span class="ruby-identifier">take</span> <span class="ruby-identifier">priority</span> <span class="ruby-identifier">over</span> <span class="ruby-identifier">other</span>
-            <span class="ruby-identifier">ones</span>. <span class="ruby-constant">For</span> <span class="ruby-identifier">example</span>, <span class="ruby-identifier">most</span> <span class="ruby-identifier">third</span><span class="ruby-operator">-</span><span class="ruby-identifier">party</span> <span class="ruby-identifier">handlers</span> <span class="ruby-identifier">would</span>
-            <span class="ruby-identifier">probably</span> <span class="ruby-identifier">usurp</span> <span class="ruby-identifier">the</span> .<span class="ruby-identifier">apw</span> <span class="ruby-constant">NetLinx</span> <span class="ruby-constant">Studio</span> <span class="ruby-identifier">workspace</span>
-            <span class="ruby-identifier">extension</span>.
-<span class="ruby-identifier">is_a_workspace</span><span class="ruby-operator">:</span> <span class="ruby-constant">Set</span> <span class="ruby-identifier">to</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">this</span> <span class="ruby-constant">ExtensionHandler</span> <span class="ruby-identifier">is</span> <span class="ruby-keyword">for</span>
-            <span class="ruby-identifier">compiling</span> <span class="ruby-identifier">a</span> <span class="ruby-identifier">workspace</span>. <span class="ruby-constant">False</span> <span class="ruby-identifier">by</span> <span class="ruby-identifier">default</span>. <span class="ruby-constant">This</span>
-            <span class="ruby-identifier">parameter</span> <span class="ruby-identifier">assists</span> <span class="ruby-identifier">with</span> <span class="ruby-identifier">smart</span> <span class="ruby-identifier">compiling</span>, <span class="ruby-identifier">as</span>
-            <span class="ruby-constant">ExtensionDiscovery</span> <span class="ruby-identifier">can</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">all</span> <span class="ruby-identifier">workspace_handlers</span>.
-<span class="ruby-identifier">handler_class</span><span class="ruby-operator">:</span> <span class="ruby-constant">A</span> <span class="ruby-identifier">reference</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">the</span> <span class="ruby-keyword">class</span> <span class="ruby-identifier">that</span> <span class="ruby-identifier">should</span> <span class="ruby-identifier">be</span> <span class="ruby-identifier">instantiated</span>
-            <span class="ruby-keyword">if</span> <span class="ruby-identifier">this</span> <span class="ruby-identifier">handler</span> <span class="ruby-identifier">is</span> <span class="ruby-identifier">selected</span>. <span class="ruby-constant">For</span> <span class="ruby-identifier">example</span>,
-            <span class="ruby-constant">NetLinx</span><span class="ruby-operator">::</span><span class="ruby-constant">SourceFile</span> <span class="ruby-identifier">is</span> <span class="ruby-identifier">the</span> <span class="ruby-keyword">class</span> <span class="ruby-identifier">that</span> <span class="ruby-identifier">handles</span> <span class="ruby-identifier">files</span>
-            <span class="ruby-identifier">with</span> <span class="ruby-identifier">the</span> .<span class="ruby-identifier">axs</span> <span class="ruby-identifier">extension</span>.
-</pre>
-          <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/netlinx/compile/extension_handler.rb, line 37</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>)
-  <span class="ruby-ivar">@extensions</span>     = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:extensions</span>,     []
-  <span class="ruby-ivar">@usurps</span>         = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:usurps</span>,         []
-  <span class="ruby-ivar">@is_a_workspace</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:is_a_workspace</span>, <span class="ruby-keyword">false</span>
-  <span class="ruby-ivar">@handler_class</span>  = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:handler_class</span>,  <span class="ruby-keyword">nil</span>
-<span class="ruby-keyword">end</span></pre>
-          </div><!-- new-source -->
-        </div>
-      </div><!-- new-method -->
-    </section><!-- public-class-method-details -->
-     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
-      <h3 class="section-header">Public Instance Methods</h3>
-      <div id="method-i-3C-3C" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">&lt;&lt;</span><span
-            class="method-args">(file_extension)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Alias to add a file extension.</p>
-          <div class="method-source-code" id="3C-3C-source">
-            <pre><span class="ruby-comment"># File lib/netlinx/compile/extension_handler.rb, line 45</span>
-<span class="ruby-keyword">def</span> <span class="ruby-operator">&lt;&lt;</span>(<span class="ruby-identifier">file_extension</span>)
-  <span class="ruby-ivar">@extensions</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">parse_extension</span>(<span class="ruby-identifier">file_extension</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div><!-- 3C-3C-source -->
-        </div>
-      </div><!-- 3C-3C-method -->
-      <div id="method-i-include-3F" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">include?</span><span
-            class="method-args">(file_extension)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Returns true if this <a href="ExtensionHandler.html">ExtensionHandler</a>
-can handle the specified file extension.</p>
-          <div class="method-source-code" id="include-3F-source">
-            <pre><span class="ruby-comment"># File lib/netlinx/compile/extension_handler.rb, line 64</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">file_extension</span>)
-  <span class="ruby-ivar">@extensions</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">parse_extension</span>(<span class="ruby-identifier">file_extension</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div><!-- include-3F-source -->
-        </div>
-      </div><!-- include-3F-method -->
-      <div id="method-i-is_a_workspace-3F" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">is_a_workspace?</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Returns true if the <a href="ExtensionHandler.html">ExtensionHandler</a>
-handles a workspace file (as opposed to a source code file).</p>
-<p>Workspace files are significant because they contain information about a
-project, connection settings for a master, and possibly multiple systems
-that need to be compiled. Therefore, when smart-compiling, workspaces need
-to be distinguished from source code files because discovering a workspace
-should be considered a better match than discovering a source code file.</p>
-          <div class="method-source-code" id="is_a_workspace-3F-source">
-            <pre><span class="ruby-comment"># File lib/netlinx/compile/extension_handler.rb, line 58</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_a_workspace?</span>
-  <span class="ruby-ivar">@is_a_workspace</span>
-<span class="ruby-keyword">end</span></pre>
-          </div><!-- is_a_workspace-3F-source -->
-        </div>
-      </div><!-- is_a_workspace-3F-method -->
-    </section><!-- public-instance-method-details -->
-  </section><!-- 5Buntitled-5D -->
-</div><!-- documentation -->
-<footer id="validator-badges">
-  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
-  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
-  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
-</footer>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: NetLinx::Compile::ExtensionHandler
+    &mdash; Documentation by YARD 0.8.7.6
+</title>
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../../';
+  framesUrl = "../../frames.html#!NetLinx/Compile/ExtensionHandler.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../../_index.html">Index (E)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../NetLinx.html" title="NetLinx (module)">NetLinx</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Compile.html" title="NetLinx::Compile (module)">Compile</a></span></span>
+     &raquo;
+    <span class="title">ExtensionHandler</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: NetLinx::Compile::ExtensionHandler
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">NetLinx::Compile::ExtensionHandler</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/netlinx/compile/extension_handler.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Tells netlinx-compile which class handles the compiling of a set of file
+extensions.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#extensions-instance_method" title="#extensions (instance method)">- (Object) <strong>extensions</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>A list of file extensions that this ExtensionHandler handles.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#handler_class-instance_method" title="#handler_class (instance method)">- (Object) <strong>handler_class</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>The class to invoke to handle compiling a file extension specified in this
+ExtensionHandler.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#usurps-instance_method" title="#usurps (instance method)">- (Object) <strong>usurps</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>A list of file extensions that this ExtensionHandler usurps.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#%3C%3C-instance_method" title="#&lt;&lt; (instance method)">- (Object) <strong>&lt;&lt;</strong>(file_extension) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Alias to add a file extension.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#include%3F-instance_method" title="#include? (instance method)">- (Boolean) <strong>include?</strong>(file_extension) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns true if this ExtensionHandler can handle the specified file
+extension.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (ExtensionHandler) <strong>initialize</strong>(**kvargs) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Parameters:   extensions: An array of file extensions (without the leading
+dot)               that this ExtensionHandler supports.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#is_a_workspace%3F-instance_method" title="#is_a_workspace? (instance method)">- (Boolean) <strong>is_a_workspace?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns true if the ExtensionHandler handles a workspace file (as opposed
+to a source code file).</p>
+</div></span>
+</li>
+    </ul>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="NetLinx::Compile::ExtensionHandler (class)">ExtensionHandler</a></span></tt>) <strong>initialize</strong>(**kvargs)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Parameters:</p>
+<pre class="code ruby"><code class="ruby">extensions: An array of file extensions (without the leading dot)
+            that this ExtensionHandler supports.
+usurps:     Future.
+            Lets this ExtensionHandler take priority over other
+            ones. For example, most third-party handlers would
+            probably usurp the .apw NetLinx Studio workspace
+            extension.
+is_a_workspace: Set to true if this ExtensionHandler is for
+            compiling a workspace. False by default. This
+            parameter assists with smart compiling, as
+            ExtensionDiscovery can return all workspace_handlers.
+handler_class: A reference to the class that should be instantiated
+            if this handler is selected. For example,
+            NetLinx::SourceFile is the class that handles files
+            with the .axs extension.</code></pre>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+37
+38
+39
+40
+41
+42</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 37</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_kvargs'>kvargs</span><span class='rparen'>)</span>
+  <span class='ivar'>@extensions</span>     <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:extensions</span><span class='comma'>,</span>     <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='ivar'>@usurps</span>         <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:usurps</span><span class='comma'>,</span>         <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='ivar'>@is_a_workspace</span> <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:is_a_workspace</span><span class='comma'>,</span> <span class='kw'>false</span>
+  <span class='ivar'>@handler_class</span>  <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:handler_class</span><span class='comma'>,</span>  <span class='kw'>nil</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id="extensions=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="extensions-instance_method">
+    - (<tt>Object</tt>) <strong>extensions</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>A list of file extensions that this ExtensionHandler handles.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_extensions'>extensions</span>
+  <span class='ivar'>@extensions</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="handler_class-instance_method">
+    - (<tt>Object</tt>) <strong>handler_class</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>The class to invoke to handle compiling a file extension specified in this
+ExtensionHandler.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+16
+17
+18</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 16</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_handler_class'>handler_class</span>
+  <span class='ivar'>@handler_class</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="usurps=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="usurps-instance_method">
+    - (<tt>Object</tt>) <strong>usurps</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>A list of file extensions that this ExtensionHandler usurps. For example,
+third-party workspace extensions would probably usurp the .apw workspace
+extension.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+12
+13
+14</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 12</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_usurps'>usurps</span>
+  <span class='ivar'>@usurps</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="<<-instance_method">
+    - (<tt>Object</tt>) <strong>&lt;&lt;</strong>(file_extension)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Alias to add a file extension.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+45
+46
+47</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 45</span>
+<span class='kw'>def</span> <span class='op'>&lt;&lt;</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
+  <span class='ivar'>@extensions</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_parse_extension'>parse_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="include?-instance_method">
+    - (<tt>Boolean</tt>) <strong>include?</strong>(file_extension)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns true if this ExtensionHandler can handle the specified file
+extension.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+64
+65
+66</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 64</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
+  <span class='ivar'>@extensions</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_parse_extension'>parse_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="is_a_workspace?-instance_method">
+    - (<tt>Boolean</tt>) <strong>is_a_workspace?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns true if the ExtensionHandler handles a workspace file (as opposed
+to a source code file).</p>
+<p>Workspace files are significant because they contain information about a
+project, connection settings for a master, and possibly multiple systems
+that need to be compiled. Therefore, when smart-compiling, workspaces need
+to be distinguished from source code files because discovering a workspace
+should be considered a better match than discovering a source code file.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+58
+59
+60</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 58</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_is_a_workspace?'>is_a_workspace?</span>
+  <span class='ivar'>@is_a_workspace</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Mon Jan 26 15:35:29 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>
+  </body>
+</html>