battlesnake 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2100d8f190752e432572971a16b1ad7de7ee941008df10df475084d9851cb8e
-  data.tar.gz: 17435dbdad3f48cb3f99591af60b2f471dcafca058221146b534754a09b6be13
+  metadata.gz: b89d9fd8df0aef295a5b8b854347b633550daf06ec2327c9f0fbd7b220eaace4
+  data.tar.gz: 9eb544e850f0f4267519e9b802db9dce508f7a8eeb9d6d9cbc19463a0596f2e1
 SHA512:
-  metadata.gz: 34023efce3a589e86f65a30f983b93f9c24d745faebbaf05ef4db31d0a695be641665f282f45fe6d84a0c35462c4b7d67a91ae67bee11af0842fa67cf71536f9
-  data.tar.gz: 8565f7f891d1c59be120f9b002e2f2c2242ef38b68dae5e0798da735a3353f83d8cd1ec232203e3515845b3380690f378a744851671ffa2b1c9de0af8cec63d8
+  metadata.gz: 48edb7affb7b6ff01e943b5cd4c9c87c8b6284b281f256bddda9412c1b371ab8ccdeb504fd5de469e830f789ea54fe66ae36c768e079f0f0757161bd88cac855
+  data.tar.gz: 86dbedc0c782be217c6220de2de438606fb8b006d6f0661b5da08c9f68dc967eaf116bc1901ae8451c55c3bb303d20287ab220762115cff4d62f8dfb90948e87

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Battlesnake
 
+## 0.1.3 (2022-11-07)
+
+### Added
+
+  - Board
+    - #on_board?(location) returns true if location is within board boundaries.
+    - #paths(from, to) returns all valid paths from one location to the next.
+  
+### Changed
+
+  - Board
+    - #occupied?(location) now only accepts a location object.
+    - #available?(location) now only accepts a location object.
+    - locations must be both unoccupied AND on_board to be considered available.
+
 ## 0.1.2 (2022-11-05)
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    battlesnake (0.1.2)
+    battlesnake (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/docs/Battlesnake/Base.html

@@ -241,7 +241,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Nov  5 20:09:02 2022 by
+  Generated on Mon Nov  7 15:30:13 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-2.7.2).
 </div>

data/docs/Battlesnake/Board.html

@@ -309,7 +309,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#available%3F-instance_method" title="#available? (instance method)">#<strong>available?</strong>(*coordinates)  &#x21d2; Boolean </a>
+      <a href="#available%3F-instance_method" title="#available? (instance method)">#<strong>available?</strong>(location)  &#x21d2; Boolean </a>
     
 
     
@@ -383,7 +383,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#occupied%3F-instance_method" title="#occupied? (instance method)">#<strong>occupied?</strong>(*coordinates)  &#x21d2; Boolean </a>
+      <a href="#occupied%3F-instance_method" title="#occupied? (instance method)">#<strong>occupied?</strong>(location)  &#x21d2; Boolean </a>
     
 
     
@@ -425,6 +425,54 @@
 <p>List of all occupied locations on the board; snakes, food, hazards, etc.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#on_board%3F-instance_method" title="#on_board? (instance method)">#<strong>on_board?</strong>(location)  &#x21d2; Boolean </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Where the supplied location falls within the boundaries of the board.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#paths-instance_method" title="#paths (instance method)">#<strong>paths</strong>(from, to)  &#x21d2; Array&lt;Path&gt; </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>List of valid, consecutive paths from one location to the next.</p>
+</div></span>
+  
 </li>
 
       
@@ -901,7 +949,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="available?-instance_method">
   
-    #<strong>available?</strong>(*coordinates)  &#x21d2; <tt>Boolean</tt> 
+    #<strong>available?</strong>(location)  &#x21d2; <tt>Boolean</tt> 
   
 
   
@@ -921,16 +969,16 @@
   
     <li>
       
-        <span class='name'>*coordinates</span>
+        <span class='name'>location</span>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>, <tt>Hash</tt>, <tt>String</tt>, <tt>Array</tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>)</span>
       
       
       
         &mdash;
         <div class='inline'>
-<p>can be specified as a <em>Location</em> object, hash containing x/y keys, JSON string of such a hash, or a pair of x,y coordinates expressed as a 2-element array or two separate parameters.</p>
+<p>being tested for availability.</p>
 </div>
       
     </li>
@@ -962,15 +1010,15 @@
       <pre class="lines">
 
 
-73
-74
-75</pre>
+78
+79
+80</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 73</span>
+      <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 78</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_available?'>available?</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_coordinates'>coordinates</span><span class='rparen'>)</span>
-  <span class='op'>!</span><span class='id identifier rubyid_occupied?'>occupied?</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_coordinates'>coordinates</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_available?'>available?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_on_board?'>on_board?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_occupied?'>occupied?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1041,14 +1089,14 @@
       <pre class="lines">
 
 
-83
-84
-85
-86
-87</pre>
+88
+89
+90
+91
+92</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 83</span>
+      <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 88</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_available_directions'>available_directions</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
   <span class='const'><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Location.html#DIRECTIONS-constant" title="Battlesnake::Location::DIRECTIONS (constant)">DIRECTIONS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_direction'>direction</span><span class='op'>|</span>
@@ -1063,7 +1111,7 @@
       <div class="method_details ">
   <h3 class="signature " id="occupied?-instance_method">
   
-    #<strong>occupied?</strong>(*coordinates)  &#x21d2; <tt>Boolean</tt> 
+    #<strong>occupied?</strong>(location)  &#x21d2; <tt>Boolean</tt> 
   
 
   
@@ -1083,16 +1131,16 @@
   
     <li>
       
-        <span class='name'>*coordinates</span>
+        <span class='name'>location</span>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>, <tt>Hash</tt>, <tt>String</tt>, <tt>Array</tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>)</span>
       
       
       
         &mdash;
         <div class='inline'>
-<p>can be specified as a <em>Location</em> object, hash containing x/y keys, JSON string of such a hash, or a pair of x,y coordinates expressed as a 2-element array or two separate parameters.</p>
+<p>being checked for occupancy.</p>
 </div>
       
     </li>
@@ -1124,16 +1172,14 @@
       <pre class="lines">
 
 
-60
-61
-62
-63</pre>
+58
+59
+60</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 60</span>
+      <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 58</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_occupied?'>occupied?</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_coordinates'>coordinates</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_location'>location</span> <span class='op'>=</span> <span class='id identifier rubyid_coordinates'>coordinates</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_coordinates'>coordinates</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='op'>:</span> <span class='const'><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Location.html#initialize-instance_method" title="Battlesnake::Location#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_coordinates'>coordinates</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_occupied?'>occupied?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_occupied_locations'>occupied_locations</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -1196,6 +1242,187 @@
 <span class='kw'>def</span> <span class='id identifier rubyid_occupied_locations'>occupied_locations</span>
   <span class='kw'>return</span> <span class='ivar'>@occupied_locations</span> <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@occupied_locations</span><span class='rparen'>)</span>
   <span class='ivar'>@occupied_locations</span> <span class='op'>=</span> <span class='id identifier rubyid_snakes'>snakes</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:body</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span> <span class='op'>+</span> <span class='id identifier rubyid_food'>food</span> <span class='op'>+</span> <span class='id identifier rubyid_hazards'>hazards</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="on_board?-instance_method">
+  
+    #<strong>on_board?</strong>(location)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Where the supplied location falls within the boundaries of the board.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>location</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>being tested.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>true if location is within the boundaries of the board.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+68
+69
+70</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 68</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_on_board?'>on_board?</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_location'>location</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='op'>&gt;=</span> <span class='int'>0</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_location'>location</span><span class='period'>.</span><span class='id identifier rubyid_y'>y</span> <span class='op'>&gt;=</span> <span class='int'>0</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_location'>location</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='op'>&lt;</span> <span class='id identifier rubyid_width'>width</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_location'>location</span><span class='period'>.</span><span class='id identifier rubyid_y'>y</span> <span class='op'>&lt;</span> <span class='id identifier rubyid_height'>height</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="paths-instance_method">
+  
+    #<strong>paths</strong>(from, to)  &#x21d2; <tt>Array&lt;Path&gt;</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>List of valid, consecutive paths from one location to the next. Paths may not:</p>
+
+<pre class="code ruby"><code class="ruby">- wander outside board boundaries.
+- use the same location more than once.
+- contain occupied locations, EXCEPT the start/end locations.
+</code></pre>
+
+<p>The exception for start/end locations allows us to generate paths, for example, from a snake to a food location, without having to calulate the starting/ending permutations ourselves.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>from</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>starting location, may be occupied</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>to</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Location.html" title="Battlesnake::Location (class)">Location</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>starting location, may be occupied</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array&lt;Path&gt;</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>a list of paths, which themselves are lists of consecutive, valid locations.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+108
+109
+110</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/battlesnake/board.rb', line 108</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_paths'>paths</span><span class='lparen'>(</span><span class='id identifier rubyid_from'>from</span><span class='comma'>,</span> <span class='id identifier rubyid_to'>to</span><span class='rparen'>)</span>
+
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1207,7 +1434,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Nov  5 20:09:02 2022 by
+  Generated on Mon Nov  7 15:30:13 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-2.7.2).
 </div>

data/docs/Battlesnake/Error.html

@@ -125,7 +125,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Nov  5 20:09:02 2022 by
+  Generated on Mon Nov  7 15:30:13 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-2.7.2).
 </div>

data/docs/Battlesnake/Game.html

@@ -803,7 +803,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Nov  5 20:09:02 2022 by
+  Generated on Mon Nov  7 15:30:13 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-2.7.2).
 </div>

data/docs/Battlesnake/Location.html

@@ -1008,7 +1008,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Nov  5 20:09:02 2022 by
+  Generated on Mon Nov  7 15:30:13 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-2.7.2).
 </div>

data/docs/Battlesnake/Snake.html

@@ -1352,7 +1352,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Nov  5 20:09:02 2022 by
+  Generated on Mon Nov  7 15:30:13 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-2.7.2).
 </div>

data/docs/Battlesnake.html

@@ -145,7 +145,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Nov  5 20:09:02 2022 by
+  Generated on Mon Nov  7 15:30:13 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-2.7.2).
 </div>

data/docs/_index.html

@@ -171,7 +171,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Nov  5 20:09:02 2022 by
+  Generated on Mon Nov  7 15:30:12 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-2.7.2).
 </div>

data/docs/file.README.html

@@ -97,7 +97,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sat Nov  5 20:09:02 2022 by
+  Generated on Mon Nov  7 15:30:13 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-2.7.2).
 </div>

data/docs/index.html

@@ -97,7 +97,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sat Nov  5 20:09:02 2022 by
+  Generated on Mon Nov  7 15:30:12 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-2.7.2).
 </div>

data/docs/method_list.html

@@ -62,16 +62,16 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="Battlesnake/Snake.html#as_json-instance_method" title="Battlesnake::Snake#as_json (method)">#as_json</a></span>
-      <small>Battlesnake::Snake</small>
+      <span class='object_link'><a href="Battlesnake/Game.html#as_json-instance_method" title="Battlesnake::Game#as_json (method)">#as_json</a></span>
+      <small>Battlesnake::Game</small>
     </div>
   </li>
   
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="Battlesnake/Game.html#as_json-instance_method" title="Battlesnake::Game#as_json (method)">#as_json</a></span>
-      <small>Battlesnake::Game</small>
+      <span class='object_link'><a href="Battlesnake/Snake.html#as_json-instance_method" title="Battlesnake::Snake#as_json (method)">#as_json</a></span>
+      <small>Battlesnake::Snake</small>
     </div>
   </li>
   
@@ -214,16 +214,16 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="Battlesnake/Location.html#initialize-instance_method" title="Battlesnake::Location#initialize (method)">#initialize</a></span>
-      <small>Battlesnake::Location</small>
+      <span class='object_link'><a href="Battlesnake/Board.html#initialize-instance_method" title="Battlesnake::Board#initialize (method)">#initialize</a></span>
+      <small>Battlesnake::Board</small>
     </div>
   </li>
   
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="Battlesnake/Board.html#initialize-instance_method" title="Battlesnake::Board#initialize (method)">#initialize</a></span>
-      <small>Battlesnake::Board</small>
+      <span class='object_link'><a href="Battlesnake/Location.html#initialize-instance_method" title="Battlesnake::Location#initialize (method)">#initialize</a></span>
+      <small>Battlesnake::Location</small>
     </div>
   </li>
   
@@ -292,6 +292,22 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Battlesnake/Board.html#on_board%3F-instance_method" title="Battlesnake::Board#on_board? (method)">#on_board?</a></span>
+      <small>Battlesnake::Board</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Battlesnake/Board.html#paths-instance_method" title="Battlesnake::Board#paths (method)">#paths</a></span>
+      <small>Battlesnake::Board</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Battlesnake/Game.html#ruleset-instance_method" title="Battlesnake::Game#ruleset (method)">#ruleset</a></span>

data/docs/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Nov  5 20:09:02 2022 by
+  Generated on Mon Nov  7 15:30:13 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-2.7.2).
 </div>

data/lib/battlesnake/board.rb

@@ -52,26 +52,31 @@ module Battlesnake
     ##
     # Whether the supplied location is occupied.
     #
-    # @param *coordinates [Location,Hash,String,Array] can be specified as a _Location_ object,
-    #   hash containing x/y keys, JSON string of such a hash, or a pair of x,y coordinates expressed
-    #   as a 2-element array or two separate parameters.
+    # @param [Location] location being checked for occupancy.
     #
     # @return [Boolean] true if location is occupied by snakes, food, hazards, etc.
-    def occupied?(*coordinates)
-      location = coordinates.first.is_a?(Location) ? coordinates.first : Location.new(*coordinates)
+    def occupied?(location)
       occupied_locations.include?(location)
     end
 
+    ##
+    # Where the supplied location falls within the boundaries of the board.
+    #
+    # @param [Location] location being tested.
+    #
+    # @return [Boolean] true if location is within the boundaries of the board.
+    def on_board?(location)
+      location.x >= 0 && location.y >= 0 && location.x < width && location.y < height
+    end
+
     ##
     # Whether the supplied location is available (unoccupied).
     #
-    # @param *coordinates [Location,Hash,String,Array] can be specified as a _Location_ object,
-    #   hash containing x/y keys, JSON string of such a hash, or a pair of x,y coordinates expressed
-    #   as a 2-element array or two separate parameters.
+    # @param [Location] location being tested for availability.
     #
     # @return [Boolean] true if location is available (unoccupied by snakes, food, hazards, etc).
-    def available?(*coordinates)
-      !occupied?(*coordinates)
+    def available?(location)
+      on_board?(location) && !occupied?(location)
     end
 
     ##
@@ -85,5 +90,129 @@ module Battlesnake
         available?(location.move(direction))
       end
     end
+
+    ##
+    # List of valid, consecutive paths from one location to the next. Paths may not:
+    #
+    #  - wander outside board boundaries.
+    #  - use the same location more than once.
+    #  - contain occupied locations, EXCEPT the start/end locations.
+    #
+    # The exception for start/end locations allows us to generate paths, for example, from a snake
+    # to a food location, without having to calulate the starting/ending permutations ourselves.
+    #
+    # @param from [Location] starting location, may be occupied
+    # @param to   [Location] starting location, may be occupied
+    #
+    # @return [Array<Path>] a list of paths, which themselves are lists of consecutive, valid locations.
+    def find_path(from, to, max_distance: nil)
+      @paths = []
+      @ideal_path_size = from.distance(to) + 1
+      @shortest_path_size = max_distance || @ideal_path_size
+      @ideal_path_size_found = false
+
+      recursive_paths(from, to, [from])
+
+      @paths.select{ |path| path.size == @shortest_path_size }.first
+    end
+
+    def recursive_paths(from, to, path)
+      head = path.last
+
+      # give up if path is too long already.
+      return [] if path.size > @shortest_path_size || @ideal_path_size_found
+
+      # if we've made it to "to", we have a successful candidate path.
+      if head.as_json == to.as_json
+        @paths << path
+        @shortest_path_size = [@shortest_path_size, path.size].min
+        @ideal_path_size_found = true if path.size == @ideal_path_size
+
+        return path
+      end
+
+      available_directions(head).sort_by do |direction|
+        # prefer to continue in same direction
+        neck = path[-2]
+
+        if neck && neck.direction(head) == direction
+          0
+        else
+          rand
+        end
+      end.map do |direction|
+        # convert direction string to a location
+        head.move(direction)
+      end.map do |location|
+        # convert location to a full path
+        path + [location]
+      end.select do |candidate|
+        # don't allow paths that overlap themselves
+        candidate.size == candidate.uniq(&:as_json).size
+      end.each do |candidate|
+        # recurse into remaining candidate paths
+        recursive_paths(from, to, candidate)
+      end
+    end
+
+    def shorty(location)
+      "#{location.x}:#{location.y}"
+    end
+
+    def shorties(list)
+      case list.first
+      when Array
+        list.map{ |l| shorties(l) }
+      when Location
+        list.map{|x| shorty(x)}.join(' ')
+      end
+    end
+
+    def print_grid(path, prefix: '  ')
+      max_x = path.map(&:x).max
+      max_y = path.map(&:y).max
+
+      (0..max_y).each do |row|
+        y = max_y - row
+
+        cols = (0..max_x).map do |x|
+          loc = Location.new(x, y)
+
+          if path.include?(loc)
+            after = path.index{ |l| l.as_json == loc.as_json} + 1
+
+            if after >= path.size
+              "\u00d7"
+            elsif loc.as_json == path.first.as_json
+              case loc.direction(path[after])
+              when 'up'
+                "\u21a5"
+              when 'down'
+                "\u21a7"
+              when 'left'
+                "\u21a4"
+              when 'right'
+                "\u21a6"
+              end
+            else
+              case loc.direction(path[after])
+              when 'up'
+                "\u2191"
+              when 'down'
+                "\u2193"
+              when 'left'
+                "\u2190"
+              when 'right'
+                "\u2192"
+              end
+            end
+          else
+            'O'
+          end
+        end.join(' ')
+
+        puts "#{prefix}  #{cols}"
+      end
+    end
   end
 end

data/lib/battlesnake/version.rb

@@ -1,4 +1,4 @@
 module Battlesnake
   # The current version of the driver.
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: battlesnake
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jaime Bellmyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-06 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec