Skip to content

Commit

Permalink
Bumped version of docker and adapted the tests
Browse files Browse the repository at this point in the history
  • Loading branch information
Prevole committed Apr 25, 2013
1 parent f0251c3 commit 780761c
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 43 deletions.
1 change: 0 additions & 1 deletion Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ module.exports = function (grunt) {
app:{
options: {
extras: ["fileSearch", "goToLine"],
lineNums: true,
colourScheme: "friendly"
},
src: ["tasks/*.js"]
Expand Down
3 changes: 2 additions & 1 deletion doc/doc-style.css
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,8 @@ pre, tt, code {
line-height: 18px;
font-family: Menlo, Monaco, Consolas, "Lucida Console", monospace;
margin: 0;
padding: 0; }
padding: 0;
white-space: pre-wrap; }

.line-num {
display: inline-block;
Expand Down
98 changes: 61 additions & 37 deletions doc/tasks/docker.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="stylesheet" media="all" href="../doc-style.css" />
<script src="../doc-filelist.js"></script>
<script>
var relativeDir = '../', thisFile = 'tasks/docker.js', defaultSidebar = true;
var relativeDir = "../", thisFile = "tasks/docker.js", defaultSidebar = true;
</script>
<script src="../doc-script.js"></script>
<script src="../fileSearch.js"></script>
Expand Down Expand Up @@ -45,12 +45,15 @@ <h1>docker.js</h1>
<p>Copyright (c) 2012 Prevole
Licensed under the MIT license.</p>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-6" id="line-6">6</a> <span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">grunt</span><span class="p">)</span> <span class="p">{</span>
<a class="line-num" href="#line-7" id="line-7">7</a> <span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
<a class="line-num" href="#line-8" id="line-8">8</a> <span class="kd">var</span> <span class="nx">Docker</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;docker&#39;</span><span class="p">);</span>
<a class="line-num" href="#line-9" id="line-9">9</a>
<a class="line-num" href="#line-10" id="line-10">10</a> <span class="nx">grunt</span><span class="p">.</span><span class="nx">registerMultiTask</span><span class="p">(</span><span class="s1">&#39;docker&#39;</span><span class="p">,</span> <span class="s1">&#39;Docker processor.&#39;</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
<a class="line-num" href="#line-11" id="line-11">11</a> <span class="kd">var</span> <span class="nx">options</span><span class="p">;</span></pre></div>
<td class="code highlight"><div class="highlight"><pre><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">grunt</span><span class="p">)</span> <span class="p">{</span>
<span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">Docker</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;docker&#39;</span><span class="p">);</span>

<span class="nx">grunt</span><span class="p">.</span><span class="nx">registerMultiTask</span><span class="p">(</span><span class="s1">&#39;docker&#39;</span><span class="p">,</span> <span class="s1">&#39;Docker processor.&#39;</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">options</span><span class="p">;</span>


</pre></div>
</td>
</tr>
<tr>
Expand All @@ -60,8 +63,12 @@ <h1>docker.js</h1>
</div>
<p>Retrieve the configuration options according to the Docker documentation</p>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-14" id="line-14">14</a> <span class="nx">options</span> <span class="o">=</span> <span class="nx">grunt</span><span class="p">.</span><span class="nx">config</span><span class="p">([</span><span class="s1">&#39;docker&#39;</span><span class="p">,</span> <span class="k">this</span><span class="p">.</span><span class="nx">target</span><span class="p">,</span> <span class="s1">&#39;options&#39;</span><span class="p">])</span> <span class="o">||</span> <span class="p">{};</span>
<a class="line-num" href="#line-15" id="line-15">15</a> <span class="nx">grunt</span><span class="p">.</span><span class="nx">verbose</span><span class="p">.</span><span class="nx">writeflags</span><span class="p">(</span><span class="nx">options</span><span class="p">,</span> <span class="s1">&#39;Options&#39;</span><span class="p">);</span></pre></div>
<td class="code highlight"><div class="highlight"><pre>
<span class="nx">options</span> <span class="o">=</span> <span class="nx">grunt</span><span class="p">.</span><span class="nx">config</span><span class="p">([</span><span class="s1">&#39;docker&#39;</span><span class="p">,</span> <span class="k">this</span><span class="p">.</span><span class="nx">target</span><span class="p">,</span> <span class="s1">&#39;options&#39;</span><span class="p">])</span> <span class="o">||</span> <span class="p">{};</span>
<span class="nx">grunt</span><span class="p">.</span><span class="nx">verbose</span><span class="p">.</span><span class="nx">writeflags</span><span class="p">(</span><span class="nx">options</span><span class="p">,</span> <span class="s1">&#39;Options&#39;</span><span class="p">);</span>


</pre></div>
</td>
</tr>
<tr>
Expand All @@ -71,13 +78,17 @@ <h1>docker.js</h1>
</div>
<p>Getting the source directory or file</p>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-18" id="line-18">18</a> <span class="kd">var</span> <span class="nx">src</span> <span class="o">=</span> <span class="p">[];</span>
<a class="line-num" href="#line-19" id="line-19">19</a> <span class="k">this</span><span class="p">.</span><span class="nx">files</span><span class="p">.</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">f</span><span class="p">)</span> <span class="p">{</span>
<a class="line-num" href="#line-20" id="line-20">20</a> <span class="k">for</span><span class="p">(</span> <span class="kd">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">i</span> <span class="o">&lt;</span> <span class="nx">f</span><span class="p">.</span><span class="nx">src</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span> <span class="p">){</span>
<a class="line-num" href="#line-21" id="line-21">21</a> <span class="nx">src</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span> <span class="nx">f</span><span class="p">.</span><span class="nx">src</span><span class="p">[</span> <span class="nx">i</span> <span class="p">]</span> <span class="p">);</span>
<a class="line-num" href="#line-22" id="line-22">22</a> <span class="p">}</span>
<a class="line-num" href="#line-23" id="line-23">23</a> <span class="nx">grunt</span><span class="p">.</span><span class="nx">verbose</span><span class="p">.</span><span class="nx">writeflags</span><span class="p">([</span><span class="nx">f</span><span class="p">.</span><span class="nx">dest</span><span class="p">],</span> <span class="s1">&#39;Destination&#39;</span><span class="p">);</span>
<a class="line-num" href="#line-24" id="line-24">24</a> <span class="p">});</span></pre></div>
<td class="code highlight"><div class="highlight"><pre>
<span class="kd">var</span> <span class="nx">src</span> <span class="o">=</span> <span class="p">[];</span>
<span class="k">this</span><span class="p">.</span><span class="nx">files</span><span class="p">.</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">f</span><span class="p">)</span> <span class="p">{</span>
<span class="k">for</span><span class="p">(</span> <span class="kd">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">i</span> <span class="o">&lt;</span> <span class="nx">f</span><span class="p">.</span><span class="nx">src</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span> <span class="p">){</span>
<span class="nx">src</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span> <span class="nx">f</span><span class="p">.</span><span class="nx">src</span><span class="p">[</span> <span class="nx">i</span> <span class="p">]</span> <span class="p">);</span>
<span class="p">}</span>
<span class="nx">grunt</span><span class="p">.</span><span class="nx">verbose</span><span class="p">.</span><span class="nx">writeflags</span><span class="p">([</span><span class="nx">f</span><span class="p">.</span><span class="nx">dest</span><span class="p">],</span> <span class="s1">&#39;Destination&#39;</span><span class="p">);</span>
<span class="p">});</span>


</pre></div>
</td>
</tr>
<tr>
Expand All @@ -87,12 +98,16 @@ <h1>docker.js</h1>
</div>
<p>Getting the destination directory or file</p>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-27" id="line-27">27</a> <span class="kd">var</span> <span class="nx">_dest</span> <span class="o">=</span> <span class="nx">grunt</span><span class="p">.</span><span class="nx">config</span><span class="p">([</span><span class="s1">&#39;docker&#39;</span><span class="p">,</span> <span class="k">this</span><span class="p">.</span><span class="nx">target</span><span class="p">,</span> <span class="s1">&#39;dest&#39;</span><span class="p">]);</span>
<a class="line-num" href="#line-28" id="line-28">28</a> <span class="k">if</span> <span class="p">(</span><span class="nx">_dest</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<a class="line-num" href="#line-29" id="line-29">29</a> <span class="nx">options</span><span class="p">.</span><span class="nx">outDir</span> <span class="o">=</span> <span class="nx">_dest</span><span class="p">;</span>
<a class="line-num" href="#line-30" id="line-30">30</a> <span class="p">}</span>
<a class="line-num" href="#line-31" id="line-31">31</a>
<a class="line-num" href="#line-32" id="line-32">32</a> <span class="kd">var</span> <span class="nx">done</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">async</span><span class="p">();</span></pre></div>
<td class="code highlight"><div class="highlight"><pre>
<span class="kd">var</span> <span class="nx">_dest</span> <span class="o">=</span> <span class="nx">grunt</span><span class="p">.</span><span class="nx">config</span><span class="p">([</span><span class="s1">&#39;docker&#39;</span><span class="p">,</span> <span class="k">this</span><span class="p">.</span><span class="nx">target</span><span class="p">,</span> <span class="s1">&#39;dest&#39;</span><span class="p">]);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">_dest</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">options</span><span class="p">.</span><span class="nx">outDir</span> <span class="o">=</span> <span class="nx">_dest</span><span class="p">;</span>
<span class="p">}</span>

<span class="kd">var</span> <span class="nx">done</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">async</span><span class="p">();</span>


</pre></div>
</td>
</tr>
<tr>
Expand All @@ -102,11 +117,15 @@ <h1>docker.js</h1>
</div>
<p>Hack docker to call the done callback when the documentation generation is finished</p>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-35" id="line-35">35</a> <span class="kd">var</span> <span class="nx">dockerFinished</span> <span class="o">=</span> <span class="nx">Docker</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">finished</span><span class="p">;</span>
<a class="line-num" href="#line-36" id="line-36">36</a> <span class="nx">Docker</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">finished</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
<a class="line-num" href="#line-37" id="line-37">37</a> <span class="nx">dockerFinished</span><span class="p">();</span>
<a class="line-num" href="#line-38" id="line-38">38</a> <span class="nx">done</span><span class="p">();</span>
<a class="line-num" href="#line-39" id="line-39">39</a> <span class="p">};</span></pre></div>
<td class="code highlight"><div class="highlight"><pre>
<span class="kd">var</span> <span class="nx">dockerFinished</span> <span class="o">=</span> <span class="nx">Docker</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">finished</span><span class="p">;</span>
<span class="nx">Docker</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">finished</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
<span class="nx">dockerFinished</span><span class="p">();</span>
<span class="nx">done</span><span class="p">();</span>
<span class="p">};</span>


</pre></div>
</td>
</tr>
<tr>
Expand All @@ -116,7 +135,11 @@ <h1>docker.js</h1>
</div>
<p>Create the Docker instance</p>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-42" id="line-42">42</a> <span class="kd">var</span> <span class="nx">docker</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Docker</span><span class="p">(</span><span class="nx">options</span><span class="p">);</span></pre></div>
<td class="code highlight"><div class="highlight"><pre>
<span class="kd">var</span> <span class="nx">docker</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Docker</span><span class="p">(</span><span class="nx">options</span><span class="p">);</span>


</pre></div>
</td>
</tr>
<tr>
Expand All @@ -126,15 +149,16 @@ <h1>docker.js</h1>
</div>
<p>Generate the documentation</p>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-45" id="line-45">45</a> <span class="k">if</span> <span class="p">(</span><span class="nx">src</span> <span class="o">===</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<a class="line-num" href="#line-46" id="line-46">46</a> <span class="nx">docker</span><span class="p">.</span><span class="nx">doc</span><span class="p">();</span>
<a class="line-num" href="#line-47" id="line-47">47</a> <span class="p">}</span>
<a class="line-num" href="#line-48" id="line-48">48</a> <span class="k">else</span> <span class="p">{</span>
<a class="line-num" href="#line-49" id="line-49">49</a> <span class="nx">docker</span><span class="p">.</span><span class="nx">doc</span><span class="p">(</span><span class="nx">src</span><span class="p">);</span>
<a class="line-num" href="#line-50" id="line-50">50</a> <span class="p">}</span>
<a class="line-num" href="#line-51" id="line-51">51</a> <span class="p">});</span>
<a class="line-num" href="#line-52" id="line-52">52</a> <span class="p">};</span>
<a class="line-num" href="#line-53" id="line-53">53</a> </pre></div>
<td class="code highlight"><div class="highlight"><pre>
<span class="k">if</span> <span class="p">(</span><span class="nx">src</span> <span class="o">===</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">docker</span><span class="p">.</span><span class="nx">doc</span><span class="p">();</span>
<span class="p">}</span>
<span class="k">else</span> <span class="p">{</span>
<span class="nx">docker</span><span class="p">.</span><span class="nx">doc</span><span class="p">(</span><span class="nx">src</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">});</span>
<span class="p">};</span>
</pre></div>
</td>
</tr>
</tbody>
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "grunt-docker",
"description": "Grunt Docker plugin.",
"version": "0.0.4",
"version": "0.0.5",
"homepage": "https://github.com/Prevole/grunt-docker",
"author": {
"name": "Prevole",
Expand Down Expand Up @@ -29,7 +29,7 @@
},
"dependencies": {
"grunt": "~0.4.0",
"docker": "~0.2.4"
"docker": "~0.2.8"
},
"devDependencies": {
"grunt": "~0.4.0",
Expand Down
4 changes: 2 additions & 2 deletions test/docker_test.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ exports.docker = {
var fileScript = grunt.file.read("test/docs/doc-script.js");

test.expect(4);
test.equal(css.length, 10856, "Should create CSS.");
test.equal(html.length, 1986, "Should create HTML.");
test.equal(css.length, 10881, "Should create CSS.");
test.equal(html.length, 1989, "Should create HTML.");
test.equal(fileList.length, 93, "Should create doc-filelist.js");
test.equal(fileScript.length, 7461, "Should create doc-script.js");
test.done();
Expand Down

0 comments on commit 780761c

Please sign in to comment.