RubyGems - machinegun - Versions diffs - 0.1.0 → 0.2.0 - Mend

machinegun 0.1.0 → 0.2.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 (12) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b524811b2c23d4a050e5473d1b53ae1777dd2a6
-  data.tar.gz: d616bd518cc62ab1ba3055bebca11ee5833b9fef
+  metadata.gz: 7137f868e393550a7ea7673c5b6ac8d794e9d878
+  data.tar.gz: f4a42b7b3a2f75f12ec4749b024015e2ab1e016c
 SHA512:
-  metadata.gz: 169fcc2a682b66388a492a614b3b0b58e96e0c7ce203e601faefe2a61d3da0e57d38e03c7e319fa2aca4b7d15b9f5a0ed223fa17ab67c28f6ace8e41c8aec646
-  data.tar.gz: 03b2e046e1e056728d91f2f7628d8dba0e1f6488de8655b6327aaaf52a6de803931cdc6add7810e87b4fea2704f6fdd9a87deea1f78ee86056d8fd06a074b190
+  metadata.gz: 1f903d783b3b56c81546ff11f5610c440c046ea9a19ef7cc89fc3764ce611b37cbea40f219e4e64a7fa56df18b5603e5233da8069e375d8995ce9da8428a01c2
+  data.tar.gz: 1e8c941cb8a7f8d51ffde2927571759d95f19f678025dd3d1de68cd681401ffaa1609904c446a7463b398b285d14ffc6b82ad52e51c62b0ad59b026afbdb5f2c

data/README.md CHANGED Viewed

@@ -1,6 +1,9 @@
 # machinegun
 [![Gem Version](https://badge.fury.io/rb/machinegun.svg)](https://badge.fury.io/rb/machinegun)
+[![Coverage Status](https://coveralls.io/repos/amclain/machinegun/badge.svg?branch=master&service=github)](https://coveralls.io/github/amclain/machinegun?branch=master)
+[![API Documentation](https://img.shields.io/badge/docs-api-blue.svg)](http://www.rubydoc.info/gems/machinegun)
+[![MIT License](https://img.shields.io/badge/license-MIT-yellowgreen.svg)](https://github.com/amclain/machinegun/blob/master/license.txt)
 An automatic reloading Rack development web server for Ruby.
@@ -21,3 +24,10 @@ For example, the following command will launch the web server on port 9393 and b
 ```text
 $ machinegun -p 9393 -o 0.0.0.0
 ```
+## Development
+To skip the integration tests during development, run the test suite with:
+```text
+$ SKIP_INTEGRATION_TESTS=true bundle exec rake
+```

data/bin/machinegun CHANGED Viewed

@@ -2,4 +2,4 @@
 require_relative '../lib/machinegun'
-MachineGun.run
+MachineGun.run interval: ENV["MACHINEGUN_INTERVAL"]

data/doc/MachineGun.html CHANGED Viewed

@@ -99,7 +99,18 @@
 </dl>
 <div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>An automatic reloading Rack development web server for Ruby.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
@@ -117,7 +128,114 @@
         <li class="public ">
   <span class="summary_signature">
-      <a href="#run-class_method" title="run (class method)">+ (Object) <strong>run</strong> </a>
+      <a href="#run-class_method" title="run (class method)">+ (Object) <strong>run</strong>(*args) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Helper method to instantiate a new object and run the server.</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="#initialize-instance_method" title="#initialize (instance method)">- (MachineGun) <strong>initialize</strong> </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of MachineGun.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#run-instance_method" title="#run (instance method)">- (Object) <strong>run</strong>(opts = {}) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Run the automatically-reloading web server.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#running%3F-instance_method" title="#running? (instance method)">- (Boolean) <strong>running?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>True if the server is running.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#stop-instance_method" title="#stop (instance method)">- (Object) <strong>stop</strong> </a>
@@ -131,7 +249,9 @@
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Stop watching for file changes and shutdown the web server.</p>
+</div></span>
 </li>
@@ -139,6 +259,51 @@
     </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="MachineGun (class)">MachineGun</a></span></tt>) <strong>initialize</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of MachineGun</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+13
+14
+15</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/machinegun.rb', line 13</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
+  <span class='ivar'>@running</span> <span class='op'>=</span> <span class='kw'>false</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
   <div id="class_method_details" class="method_details_list">
@@ -148,45 +313,271 @@
       <div class="method_details first">
   <h3 class="signature first" id="run-class_method">
-    + (<tt>Object</tt>) <strong>run</strong>
+    + (<tt>Object</tt>) <strong>run</strong>(*args)
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Helper method to instantiate a new object and run the server.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#run-instance_method" title="MachineGun#run (method)">#run</a></span></li>
+  </ul>
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
-6
-7
-8
 9
 10
-11
-12
-13
-14
-15</pre>
+11</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/machinegun.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/machinegun.rb', line 9</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span>
+  <span class='id identifier rubyid_new'>new</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</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="run-instance_method">
+    - (<tt>Object</tt>) <strong>run</strong>(opts = {})
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Run the automatically-reloading web server. This method blocks.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>opts</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>a customizable set of options</p>
+</div>
+    </li>
+</ul>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>
-  <span class='id identifier rubyid_pid'>pid</span> <span class='op'>=</span> <span class='id identifier rubyid_start_server'>start_server</span>
-  <span class='const'>FileWatcher</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>./**/*.rb</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_watch'>watch</span> <span class='kw'>do</span>
-    <span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_kill'>kill</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>INT</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_pid'>pid</span>
-    <span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span> <span class='id identifier rubyid_pid'>pid</span>
-    <span class='id identifier rubyid_pid'>pid</span> <span class='op'>=</span> <span class='id identifier rubyid_start_server'>start_server</span>
+    <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
+    <ul class="option">
+        <li>
+          <span class="name">:interval</span>
+          <span class="type">(<tt>Numeric</tt>)</span>
+          <span class="default">
+              &mdash; default:
+              <tt>0.5</tt>
+          </span>
+            &mdash; <div class='inline'>
+<p>Interval in seconds to scan the filesystem for changes.</p>
+</div>
+        </li>
+    </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/machinegun.rb', line 21</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+  <span class='ivar'>@running</span> <span class='op'>=</span> <span class='kw'>true</span>
+  <span class='id identifier rubyid_interval'>interval</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:interval</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='float'>0.5</span>
+  <span class='ivar'>@pid</span> <span class='op'>=</span> <span class='id identifier rubyid_start_server'>start_server</span>
+  <span class='ivar'>@watcher</span> <span class='op'>=</span> <span class='const'>FileWatcher</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>./**/*.rb</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+  <span class='ivar'>@watcher</span><span class='period'>.</span><span class='id identifier rubyid_watch'>watch</span> <span class='id identifier rubyid_interval'>interval</span> <span class='kw'>do</span>
+    <span class='id identifier rubyid_stop_server'>stop_server</span>
+    <span class='ivar'>@pid</span> <span class='op'>=</span> <span class='id identifier rubyid_start_server'>start_server</span>
   <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="running?-instance_method">
+    - (<tt>Boolean</tt>) <strong>running?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns true if the server is running.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>true if the server is running.</p>
+</div>
+    </li>
+</ul>
+</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/machinegun.rb', line 45</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_running?'>running?</span>
+  <span class='ivar'>@running</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="stop-instance_method">
+    - (<tt>Object</tt>) <strong>stop</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Stop watching for file changes and shutdown the web server.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+36
+37
+38
+39
+40
+41
+42</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/machinegun.rb', line 36</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_stop'>stop</span>
+  <span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@running</span>
+  <span class='ivar'>@watcher</span><span class='period'>.</span><span class='id identifier rubyid_stop'>stop</span>
+  <span class='id identifier rubyid_stop_server'>stop_server</span>
+  <span class='ivar'>@running</span> <span class='op'>=</span> <span class='kw'>false</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
   </div>
@@ -194,9 +585,9 @@
 </div>
     <div id="footer">
-  Generated on Fri Oct 23 11:08:57 2015 by
+  Generated on Sat Oct 24 18:31:28 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.6 (ruby-2.1.1).
+  0.8.7.6 (ruby-2.1.6).
 </div>
   </body>

data/doc/_index.html CHANGED Viewed

@@ -104,9 +104,9 @@
 </div>
     <div id="footer">
-  Generated on Fri Oct 23 11:08:57 2015 by
+  Generated on Sat Oct 24 18:31:28 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.6 (ruby-2.1.1).
+  0.8.7.6 (ruby-2.1.6).
 </div>
   </body>

data/doc/file.README.html CHANGED Viewed

@@ -61,33 +61,59 @@
     <iframe id="search_frame"></iframe>
-    <div id="content"><div id='filecontents'><h1>machinegun</h1>
-<p><a href="https://badge.fury.io/rb/machinegun"><img src="https://badge.fury.io/rb/machinegun.svg" alt="Gem Version"></a></p>
+    <div id="content"><div id='filecontents'>
+<h1 id="label-machinegun">machinegun</h1>
+<p><a href="https://badge.fury.io/rb/machinegun"><img
+src="https://badge.fury.io/rb/machinegun.svg"></a> <a
+href="https://coveralls.io/github/amclain/machinegun?branch=master"><img
+src="https://coveralls.io/repos/amclain/machinegun/badge.svg?branch=master&service=github"></a>
+<a href="http://www.rubydoc.info/gems/machinegun"><img
+src="https://img.shields.io/badge/docs-api-blue.svg"></a> <a
+href="https://github.com/amclain/machinegun/blob/master/license.txt"><img
+src="https://img.shields.io/badge/license-MIT-yellowgreen.svg"></a></p>
 <p>An automatic reloading Rack development web server for Ruby.</p>
-<p>This gem was inspired by <a href="https://github.com/rtomayko/shotgun">shotgun</a>, which reloads the application on every request to ensure that the latest code is running. However, reloading on request can cause performance problems for applications that consume a lot of memory and/or generate a lot of requests. machinegun solves this problem by reloading the application when there are changes to the filesystem, instead of reloading on each request. This allows for the best of both worlds: A web server that reloads when changes to the code are made, and also performs quickly when serving requests.</p>
+<p>This gem was inspired by <a
+href="https://github.com/rtomayko/shotgun">shotgun</a>, which reloads the
+application on every request to ensure that the latest code is running.
+However, reloading on request can cause performance problems for
+applications that consume a lot of memory and/or generate a lot of
+requests. machinegun solves this problem by reloading the application when
+there are changes to the filesystem, instead of reloading on each request.
+This allows for the best of both worlds: A web server that reloads when
+changes to the code are made, and also performs quickly when serving
+requests.</p>
+<h2 id="label-Installation">Installation</h2>
+<pre class="code ruby"><code class="ruby">$ gem install machinegun</code></pre>
-<h2>Installation</h2>
+<h2 id="label-Use">Use</h2>
-<pre class="code text"><code class="text">$ gem install machinegun
-</code></pre>
+<p>The <code>machinegun</code> command replaces <code>rackup</code>.
+rackup&#39;s command line options should be compatible with the machinegun
+executable. Since machinegun is a wrapper around Rack, your project also
+needs a <a
+href="https://github.com/rack/rack/wiki/(tutorial)-rackup-howto#config-file-syntax">Rack
+configuration file</a>, typically <code>config.ru</code>.</p>
-<h2>Use</h2>
+<p>For example, the following command will launch the web server on port 9393
+and bind it to all network adapters:</p>
-<p>The <code>machinegun</code> command replaces <code>rackup</code>. rackup&#39;s command line options should be compatible with the machinegun executable. Since machinegun is a wrapper around Rack, your project also needs a <a href="https://github.com/rack/rack/wiki/(tutorial)-rackup-howto#config-file-syntax">Rack configuration file</a>, typically <code>config.ru</code>.</p>
+<pre class="code ruby"><code class="ruby">$ machinegun -p 9393 -o 0.0.0.0</code></pre>
-<p>For example, the following command will launch the web server on port 9393 and bind it to all network adapters:</p>
+<h2 id="label-Development">Development</h2>
-<pre class="code text"><code class="text">$ machinegun -p 9393 -o 0.0.0.0
-</code></pre>
+<p>To skip the integration tests during development, run the test suite with:
+<code>text $ SKIP_INTEGRATION_TESTS=true bundle exec rake </code></p>
 </div></div>
     <div id="footer">
-  Generated on Fri Oct 23 11:08:57 2015 by
+  Generated on Sat Oct 24 18:31:28 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.6 (ruby-2.1.1).
+  0.8.7.6 (ruby-2.1.6).
 </div>
   </body>

data/doc/file.license.html CHANGED Viewed

@@ -64,9 +64,9 @@
     <div id="content"><div id='filecontents'>The MIT License (MIT)<br/><br/>Copyright (c) 2015 Alex McLain<br/><br/>Permission is hereby granted, free of charge, to any person obtaining a copy<br/>of this software and associated documentation files (the &quot;Software&quot;), to deal<br/>in the Software without restriction, including without limitation the rights<br/>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br/>copies of the Software, and to permit persons to whom the Software is<br/>furnished to do so, subject to the following conditions:<br/><br/>The above copyright notice and this permission notice shall be included in<br/>all copies or substantial portions of the Software.<br/><br/>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br/>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br/>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br/>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br/>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br/>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN<br/>THE SOFTWARE.</div></div>
     <div id="footer">
-  Generated on Fri Oct 23 11:08:57 2015 by
+  Generated on Sat Oct 24 18:31:28 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.6 (ruby-2.1.1).
+  0.8.7.6 (ruby-2.1.6).
 </div>
   </body>

data/doc/index.html CHANGED Viewed

@@ -61,33 +61,59 @@
     <iframe id="search_frame"></iframe>
-    <div id="content"><div id='filecontents'><h1>machinegun</h1>
-<p><a href="https://badge.fury.io/rb/machinegun"><img src="https://badge.fury.io/rb/machinegun.svg" alt="Gem Version"></a></p>
+    <div id="content"><div id='filecontents'>
+<h1 id="label-machinegun">machinegun</h1>
+<p><a href="https://badge.fury.io/rb/machinegun"><img
+src="https://badge.fury.io/rb/machinegun.svg"></a> <a
+href="https://coveralls.io/github/amclain/machinegun?branch=master"><img
+src="https://coveralls.io/repos/amclain/machinegun/badge.svg?branch=master&service=github"></a>
+<a href="http://www.rubydoc.info/gems/machinegun"><img
+src="https://img.shields.io/badge/docs-api-blue.svg"></a> <a
+href="https://github.com/amclain/machinegun/blob/master/license.txt"><img
+src="https://img.shields.io/badge/license-MIT-yellowgreen.svg"></a></p>
 <p>An automatic reloading Rack development web server for Ruby.</p>
-<p>This gem was inspired by <a href="https://github.com/rtomayko/shotgun">shotgun</a>, which reloads the application on every request to ensure that the latest code is running. However, reloading on request can cause performance problems for applications that consume a lot of memory and/or generate a lot of requests. machinegun solves this problem by reloading the application when there are changes to the filesystem, instead of reloading on each request. This allows for the best of both worlds: A web server that reloads when changes to the code are made, and also performs quickly when serving requests.</p>
+<p>This gem was inspired by <a
+href="https://github.com/rtomayko/shotgun">shotgun</a>, which reloads the
+application on every request to ensure that the latest code is running.
+However, reloading on request can cause performance problems for
+applications that consume a lot of memory and/or generate a lot of
+requests. machinegun solves this problem by reloading the application when
+there are changes to the filesystem, instead of reloading on each request.
+This allows for the best of both worlds: A web server that reloads when
+changes to the code are made, and also performs quickly when serving
+requests.</p>
+<h2 id="label-Installation">Installation</h2>
+<pre class="code ruby"><code class="ruby">$ gem install machinegun</code></pre>
-<h2>Installation</h2>
+<h2 id="label-Use">Use</h2>
-<pre class="code text"><code class="text">$ gem install machinegun
-</code></pre>
+<p>The <code>machinegun</code> command replaces <code>rackup</code>.
+rackup&#39;s command line options should be compatible with the machinegun
+executable. Since machinegun is a wrapper around Rack, your project also
+needs a <a
+href="https://github.com/rack/rack/wiki/(tutorial)-rackup-howto#config-file-syntax">Rack
+configuration file</a>, typically <code>config.ru</code>.</p>
-<h2>Use</h2>
+<p>For example, the following command will launch the web server on port 9393
+and bind it to all network adapters:</p>
-<p>The <code>machinegun</code> command replaces <code>rackup</code>. rackup&#39;s command line options should be compatible with the machinegun executable. Since machinegun is a wrapper around Rack, your project also needs a <a href="https://github.com/rack/rack/wiki/(tutorial)-rackup-howto#config-file-syntax">Rack configuration file</a>, typically <code>config.ru</code>.</p>
+<pre class="code ruby"><code class="ruby">$ machinegun -p 9393 -o 0.0.0.0</code></pre>
-<p>For example, the following command will launch the web server on port 9393 and bind it to all network adapters:</p>
+<h2 id="label-Development">Development</h2>
-<pre class="code text"><code class="text">$ machinegun -p 9393 -o 0.0.0.0
-</code></pre>
+<p>To skip the integration tests during development, run the test suite with:
+<code>text $ SKIP_INTEGRATION_TESTS=true bundle exec rake </code></p>
 </div></div>
     <div id="footer">
-  Generated on Fri Oct 23 11:08:57 2015 by
+  Generated on Sat Oct 24 18:31:28 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.6 (ruby-2.1.1).
+  0.8.7.6 (ruby-2.1.6).
 </div>
   </body>

data/doc/method_list.html CHANGED Viewed

@@ -52,11 +52,35 @@
   <li class="r1 ">
+    <span class='object_link'><a href="MachineGun.html#initialize-instance_method" title="MachineGun#initialize (method)">#initialize</a></span>
+    <small>MachineGun</small>
+  </li>
+  <li class="r2 ">
     <span class='object_link'><a href="MachineGun.html#run-class_method" title="MachineGun.run (method)">run</a></span>
     <small>MachineGun</small>
   </li>
+  <li class="r1 ">
+    <span class='object_link'><a href="MachineGun.html#run-instance_method" title="MachineGun#run (method)">#run</a></span>
+    <small>MachineGun</small>
+  </li>
+  <li class="r2 ">
+    <span class='object_link'><a href="MachineGun.html#running%3F-instance_method" title="MachineGun#running? (method)">#running?</a></span>
+    <small>MachineGun</small>
+  </li>
+  <li class="r1 ">
+    <span class='object_link'><a href="MachineGun.html#stop-instance_method" title="MachineGun#stop (method)">#stop</a></span>
+    <small>MachineGun</small>
+  </li>
       </ul>
     </div>
   </body>

data/doc/top-level-namespace.html CHANGED Viewed

@@ -103,9 +103,9 @@
 </div>
     <div id="footer">
-  Generated on Fri Oct 23 11:08:57 2015 by
+  Generated on Sat Oct 24 18:31:28 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.6 (ruby-2.1.1).
+  0.8.7.6 (ruby-2.1.6).
 </div>
   </body>

data/lib/machinegun.rb CHANGED Viewed

@@ -1,28 +1,66 @@
 require 'rack'
 require 'filewatcher'
+# An automatic reloading Rack development web server for Ruby.
 class MachineGun
-  def self.run
-    pid = start_server
+  # Helper method to instantiate a new object and run the server.
+  # @see #run
+  def self.run *args
+    new.run *args
+  end
+  def initialize
+    @running = false
+  end
+  # Run the automatically-reloading web server.
+  # This method blocks.
+  # @option opts [Numeric] :interval (0.5) Interval in seconds to scan the
+  #   filesystem for changes.
+  def run opts = {}
+    @running = true
+    interval = opts[:interval] || 0.5
+    @pid = start_server
+    @watcher = FileWatcher.new("./**/*.rb")
-    FileWatcher.new("./**/*.rb").watch do
-      Process.kill "INT", pid
-      Process.wait pid
-      pid = start_server
+    @watcher.watch interval do
+      stop_server
+      @pid = start_server
     end
   end
+  # Stop watching for file changes and shutdown the web server.
+  def stop
+    return unless @running
+    @watcher.stop
+    stop_server
+    @running = false
+  end
+  # @return true if the server is running.
+  def running?
+    @running
+  end
   private
-  def self.start_server
-    pid = fork do
+  # Start the web server in a forked process.
+  # @return process id
+  def start_server
+    fork do
       $0 = "rack"
       Rack::Server.start
     end
-    pid
+  end
+  # Gracefully stop the web server's forked process.
+  def stop_server
+    Process.kill "INT", @pid
+    Process.wait @pid
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: machinegun
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex McLain
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2015-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -106,28 +106,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: fivemat
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +142,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cuba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 description: An automatic reloading Rack development web server for Ruby.
 email:
 - alex@alexmclain.com
@@ -190,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.1
+rubygems_version: 2.2.3
 signing_key:
 specification_version: 4
 summary: An automatic reloading Rack development web server for Ruby.