RubyGems - time_span - Versions diffs - 0.0.1.alpha05 → 0.0.1.beta.01 - Mend

time_span 0.0.1.alpha05 → 0.0.1.beta.01

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 (13) hide show

data/.gitignore +2 -0
data/README.md +11 -0
data/doc/TimeSpan/RelativeTime.html +28 -14
data/doc/TimeSpan/TimeLine.html +50 -31
data/doc/TimeSpan/TimeSpan.html +42 -26
data/doc/created.rid +3 -3
data/doc/index.html +2 -2
data/doc/lib/time_span/version_rb.html +1 -1
data/doc/lib/time_span_rb.html +1 -1
data/lib/time_span/version.rb +1 -1
data/lib/time_span.rb +112 -52
data/spec/time_span/time_span_spec.rb +37 -8
metadata +6 -4

data/.gitignore CHANGED Viewed

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+.idea/*
+.gitignore

data/README.md ADDED Viewed

@@ -0,0 +1,11 @@
+Time Span
+==========
+This gem is still in Alpha.  The API might well break between now and release, use at your risk.
+Better documentation will also follow, as I learn how to write Yard docs.
+A RelativeTime can occur with more than one TimeSpan, so must also keep track of the TimeLine to TimeSpan relationship.
+For now I am focused on spec coverage and core code functionality.

data/doc/TimeSpan/RelativeTime.html CHANGED Viewed

@@ -133,20 +133,34 @@
     <div id="description" class="description">
+<p>class <a href="RelativeTime.html">RelativeTime</a>
+#</p>
 <pre>#</pre>
-<p>A relative time must be able to be have equal times
-# implemented as an Array of Arrays; all elements of the ‘subarray’ are
-equal in time,    # otherwise, the time relationship are based on position
-in the main array                #</p>
+<p>public methods:
+#</p>
-<pre>#</pre>
+<pre>comparators: &lt; &lt;= == != &gt;= &gt;                                                                      #
+   work on any two RelativeTime objects on the same TimeLine                                      #
+positioned?                                                                                       #
+   true if a RelativeTime has been put on a TimeLine                                              #                                                                                   #
+colinear_with?(RelativeTime.new)                                                                  #
+   true if both RelativeTime objects are positioned and on same TimeLine                          #
+                                                                                                  #</pre>
+<p>protected method:
+#</p>
+<pre>valid_and_comparable_with?(RelativeTime)                                                          #
+   true if                                                                                        #
+                                                                                                  #</pre>
 <p>diff cannot be done, it makes no sense, due to the fuzziness
 #</p>
-<pre>                                                                                       #
-RelativeTime must be within a TimeLine                                                 #</pre>
+<pre>                                                                                                   #
+RelativeTime must be within a TimeLine                                                             #</pre>
     </div><!-- description -->
@@ -228,7 +242,7 @@ RelativeTime must be within a TimeLine
             <div class="method-source-code" id="new-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 226</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 261</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>  <span class="ruby-identifier">tline</span>, <span class="ruby-identifier">ref</span>
    <span class="ruby-ivar">@timeline</span>= <span class="ruby-identifier">tline</span>
    <span class="ruby-ivar">@reference_to</span>= <span class="ruby-identifier">ref</span>
@@ -268,9 +282,9 @@ RelativeTime must be within a TimeLine
             <div class="method-source-code" id="colinear_with-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 247</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 282</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">colinear_with?</span>(<span class="ruby-identifier">b</span>)
-  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">timeline</span>.<span class="ruby-identifier">equal?</span>(<span class="ruby-identifier">b</span>.<span class="ruby-identifier">timeline</span>)
+  <span class="ruby-identifier">b</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>) <span class="ruby-operator">&amp;&amp;</span>  <span class="ruby-identifier">b</span>.<span class="ruby-identifier">positioned?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">positioned?</span> <span class="ruby-operator">&amp;&amp;</span>  <span class="ruby-identifier">timeline</span>.<span class="ruby-identifier">equal?</span>(<span class="ruby-identifier">b</span>.<span class="ruby-identifier">timeline</span>)
 <span class="ruby-keyword">end</span></pre>
             </div><!-- colinear_with-3F-source -->
@@ -301,9 +315,9 @@ RelativeTime must be within a TimeLine
             <div class="method-source-code" id="positioned-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 243</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 278</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">positioned?</span>
-  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">timeline</span>.<span class="ruby-identifier">indices_of</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-keyword">self</span>)
+  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">timeline</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">timeline</span>.<span class="ruby-identifier">indices_of</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-keyword">self</span>)
 <span class="ruby-keyword">end</span></pre>
             </div><!-- positioned-3F-source -->
@@ -334,7 +348,7 @@ RelativeTime must be within a TimeLine
             <div class="method-source-code" id="to_s-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 231</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 266</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
   <span class="ruby-identifier">reference_to</span>.<span class="ruby-identifier">to_s</span>
 <span class="ruby-keyword">end</span></pre>
@@ -373,7 +387,7 @@ RelativeTime must be within a TimeLine
             <div class="method-source-code" id="valid_and_comparable_with-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 254</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 289</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">valid_and_comparable_with?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-operator">!</span><span class="ruby-keyword">self</span>.<span class="ruby-identifier">timeline</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">b</span>.<span class="ruby-identifier">timeline</span>.<span class="ruby-identifier">nil?</span>  <span class="ruby-operator">&amp;&amp;</span>  <span class="ruby-identifier">colinear_with?</span>(<span class="ruby-identifier">b</span>)
 <span class="ruby-keyword">end</span></pre>

data/doc/TimeSpan/TimeLine.html CHANGED Viewed

@@ -143,6 +143,33 @@
     <div id="description" class="description">
+<p>class <a href="TimeLine.html">TimeLine</a>
+#</p>
+<pre>#</pre>
+<p><a href="TimeLine.html">TimeLine</a> is how <a
+href="RelativeTime.html">RelativeTime</a> objects are related to each
+other, they have to have the same         #</p>
+<pre>frame of reference.                                                                              #
+                                                                                                 #</pre>
+<p>instance methods:
+#</p>
+<pre>                                                                                                 #
+to_s  -- convenience method to see which object we have                                          #
+position_of(obj) -- its location on the TimeLine                                                 #
+increase_after(position, amount) -- make room in the index for an insertion                      #
+append (obj)  -- add obj to end of the TimeLine                                                  #
+append_to_next(relative_object, object, relative) at relative offset to relative_object, put obj #
+insert_before_next(relative_object, object, relative) inserts into new time slot relative to relative_object
+insert_at(position, object) -- places object at position, appending if equal time exists         #
+remove(obj) -- remove object from the TimeLine                                                   #
+compress! -- compresses the TimeLine, removing [] and adjusting the index accordingly            #
+                                                                                                 #</pre>
     </div><!-- description -->
@@ -240,7 +267,7 @@
             <div class="method-source-code" id="new-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 127</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 156</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>=<span class="ruby-string">&quot;&quot;</span>)
   <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
   <span class="ruby-ivar">@line</span> = []
@@ -275,13 +302,13 @@
           <div class="method-description">
+            <p>add to the  end of the <a href="TimeLine.html">TimeLine</a></p>
             <div class="method-source-code" id="append-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 137</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 177</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">append</span>(<span class="ruby-identifier">obj</span>)
   <span class="ruby-identifier">insert_at</span>(<span class="ruby-ivar">@line</span>.<span class="ruby-identifier">size</span>, <span class="ruby-identifier">obj</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -308,13 +335,13 @@
           <div class="method-description">
+            <p>inserts to the end of the relative object’s time, becoming equal with it</p>
             <div class="method-source-code" id="append_to_next-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 147</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 182</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">append_to_next</span>(<span class="ruby-identifier">relative_obj</span>, <span class="ruby-identifier">obj</span>, <span class="ruby-identifier">relative</span>=<span class="ruby-value">1</span>)
   <span class="ruby-identifier">insert_at</span>(<span class="ruby-identifier">position_of</span>(<span class="ruby-identifier">relative_obj</span>)<span class="ruby-operator">+</span><span class="ruby-identifier">relative</span>, <span class="ruby-identifier">obj</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -350,24 +377,19 @@ href="TimeLine.html#attribute-i-indices_of">indices_of</a></p>
             <div class="method-source-code" id="compress-21-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 187</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 219</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">compress!</span>
   <span class="ruby-identifier">mod_level</span> = <span class="ruby-value">0</span>
   <span class="ruby-identifier">offsets</span> = []
   <span class="ruby-value">0</span>.<span class="ruby-identifier">upto</span>(<span class="ruby-identifier">line</span>.<span class="ruby-identifier">size</span><span class="ruby-operator">-</span><span class="ruby-value">1</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
     <span class="ruby-identifier">mod_level</span> <span class="ruby-operator">-=</span> <span class="ruby-value">1</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@line</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">empty?</span>
     <span class="ruby-identifier">offsets</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">mod_level</span>
   <span class="ruby-keyword">end</span>
   <span class="ruby-comment">## poor man's transaction.  Don't do directly on indices_of so less chance of interruption</span>
   <span class="ruby-identifier">indices</span> = <span class="ruby-identifier">indices_of</span>
-  <span class="ruby-comment">## refactor to use increase_after</span>
   <span class="ruby-identifier">indices</span>.<span class="ruby-identifier">each_key</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
     <span class="ruby-identifier">indices</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">indices</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">offsets</span>[<span class="ruby-identifier">indices</span>[<span class="ruby-identifier">key</span>]]
   <span class="ruby-keyword">end</span>
   <span class="ruby-identifier">indices_of</span> = <span class="ruby-identifier">indices</span>
   <span class="ruby-ivar">@line</span>.<span class="ruby-identifier">delete</span>([])
 <span class="ruby-keyword">end</span></pre>
@@ -400,7 +422,7 @@ href="TimeLine.html#attribute-i-indices_of">indices_of</a></p>
             <div class="method-source-code" id="increase_after-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 141</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 168</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">increase_after</span>(<span class="ruby-identifier">pos</span>, <span class="ruby-identifier">by</span>=<span class="ruby-value">1</span>)
   <span class="ruby-ivar">@indices_of</span>.<span class="ruby-identifier">each_key</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
     <span class="ruby-ivar">@indices_of</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">+=</span> <span class="ruby-identifier">by</span> <span class="ruby-keyword">if</span> (<span class="ruby-ivar">@indices_of</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">&gt;=</span> <span class="ruby-identifier">pos</span>)
@@ -429,24 +451,23 @@ href="TimeLine.html#attribute-i-indices_of">indices_of</a></p>
           <div class="method-description">
-            <p>needs work for <a href="RelativeTime.html">RelativeTime</a> objects</p>
+            <p>place obj at the numbered position</p>
             <div class="method-source-code" id="insert_at-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 159</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 195</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">insert_at</span>(<span class="ruby-identifier">pos</span>, <span class="ruby-identifier">obj</span>)
   <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;can only add a time to its own timeline&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">timeline</span>.<span class="ruby-identifier">equal?</span> <span class="ruby-keyword">self</span>
   <span class="ruby-keyword">if</span> <span class="ruby-ivar">@line</span>[<span class="ruby-identifier">pos</span>].<span class="ruby-identifier">nil?</span>
     <span class="ruby-ivar">@line</span>[<span class="ruby-identifier">pos</span>] = [<span class="ruby-identifier">obj</span>]
-    <span class="ruby-ivar">@indices_of</span>[<span class="ruby-identifier">obj</span>] = <span class="ruby-identifier">pos</span>
   <span class="ruby-keyword">else</span>
     <span class="ruby-identifier">op</span> = <span class="ruby-ivar">@line</span>[<span class="ruby-identifier">pos</span>].<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-operator">?</span> <span class="ruby-string">'&lt;&lt;'</span>  <span class="ruby-operator">:</span> <span class="ruby-string">'='</span>
-    <span class="ruby-ivar">@line</span>[<span class="ruby-identifier">pos</span>].<span class="ruby-identifier">send</span>(<span class="ruby-identifier">op</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-identifier">obj</span>) <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@line</span>[<span class="ruby-identifier">pos</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">obj</span>)  <span class="ruby-comment"># no dupliates</span>
-    <span class="ruby-ivar">@indices_of</span>[<span class="ruby-identifier">obj</span>] = <span class="ruby-identifier">pos</span>                                           <span class="ruby-comment"># dup overwrites</span>
+    <span class="ruby-ivar">@line</span>[<span class="ruby-identifier">pos</span>].<span class="ruby-identifier">send</span>(<span class="ruby-identifier">op</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-identifier">obj</span>).<span class="ruby-identifier">uniq!</span>                <span class="ruby-comment"># no duplicates in same position</span>
+    <span class="ruby-comment"># dup in diff position overwrites below</span>
   <span class="ruby-keyword">end</span>
+  <span class="ruby-ivar">@indices_of</span>[<span class="ruby-identifier">obj</span>] = <span class="ruby-identifier">pos</span>
 <span class="ruby-keyword">end</span></pre>
             </div><!-- insert_at-source -->
@@ -471,13 +492,13 @@ href="TimeLine.html#attribute-i-indices_of">indices_of</a></p>
           <div class="method-description">
+            <p>inserts into a new space before the relative object (first parameter)</p>
             <div class="method-source-code" id="insert_before_next-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 151</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 187</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">insert_before_next</span>(<span class="ruby-identifier">relative_obj</span>, <span class="ruby-identifier">obj</span>, <span class="ruby-identifier">relative_offset</span>=<span class="ruby-value">1</span>)
   <span class="ruby-identifier">relative_position</span> = <span class="ruby-identifier">position_of</span>(<span class="ruby-identifier">relative_obj</span>)
   <span class="ruby-identifier">increase_after</span>(<span class="ruby-identifier">relative_position</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">relative_offset</span>, <span class="ruby-identifier">relative_offset</span>)
@@ -507,13 +528,13 @@ href="TimeLine.html#attribute-i-indices_of">indices_of</a></p>
           <div class="method-description">
+            <p>indices methods</p>
             <div class="method-source-code" id="position_of-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 133</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 164</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">position_of</span>(<span class="ruby-identifier">obj</span>)
   <span class="ruby-ivar">@indices_of</span>[<span class="ruby-identifier">obj</span>]
 <span class="ruby-keyword">end</span></pre>
@@ -540,23 +561,21 @@ href="TimeLine.html#attribute-i-indices_of">indices_of</a></p>
           <div class="method-description">
+            <p>cannot remove [] or the @<a
+href="TimeLine.html#attribute-i-indices_of">indices_of</a> will be wrong
+call  compress to remove the extra []s</p>
             <div class="method-source-code" id="remove-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 172</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 209</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">remove</span>(<span class="ruby-identifier">obj</span>)
-  <span class="ruby-comment"># cannot remove [] or the @indices_of will be wrong</span>
-  <span class="ruby-comment"># call to #compress to remove the extra []s</span>
   <span class="ruby-identifier">pos</span> =  <span class="ruby-identifier">position_of</span>(<span class="ruby-identifier">obj</span>)
   <span class="ruby-keyword">if</span> <span class="ruby-identifier">pos</span>                        <span class="ruby-comment"># do nothing if it isn't there'</span>
-    <span class="ruby-ivar">@line</span>[<span class="ruby-identifier">pos</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">obj</span>)
-    <span class="ruby-ivar">@indices_of</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">obj</span>)
+    <span class="ruby-ivar">@line</span>[<span class="ruby-identifier">pos</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">obj</span>)      <span class="ruby-comment">#  remove from list</span>
+    <span class="ruby-ivar">@indices_of</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">obj</span>)     <span class="ruby-comment">#  remove from index</span>
   <span class="ruby-keyword">end</span>
 <span class="ruby-keyword">end</span></pre>
             </div><!-- remove-source -->
@@ -587,7 +606,7 @@ href="TimeLine.html#attribute-i-indices_of">indices_of</a></p>
             <div class="method-source-code" id="to_s-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 123</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 152</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
   <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>
 <span class="ruby-keyword">end</span></pre>

data/doc/TimeSpan/TimeSpan.html CHANGED Viewed

@@ -169,6 +169,13 @@
     <div id="description" class="description">
+<p>this classes’ object have a starting and ending <a
+href="RelativeTime.html">RelativeTime</a>, and both times must be on the
+same <a href="TimeLine.html">TimeLine</a></p>
+<p>it implements a large selection of comparators, both for start / end times
+(single time compartors), and also range comparators</p>
     </div><!-- description -->
@@ -243,18 +250,18 @@
           <div class="method-description">
-            <p>time comparison               #</p>
             <div class="method-source-code" id="new-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 13</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 14</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">starting_at</span>, <span class="ruby-identifier">ending_at</span>)
   <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Cannot make a span unless both points are on the same timeline&quot;</span> <span class="ruby-keyword">unless</span>  <span class="ruby-identifier">starting_at</span>.<span class="ruby-identifier">colinear_with?</span>(<span class="ruby-identifier">ending_at</span>)
   <span class="ruby-keyword">self</span>.<span class="ruby-identifier">starts</span> = <span class="ruby-identifier">starting_at</span>
   <span class="ruby-keyword">self</span>.<span class="ruby-identifier">ends</span>   = <span class="ruby-identifier">ending_at</span>
-  <span class="ruby-identifier">starting_at</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">RelativeTime</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">ending_at</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">RelativeTime</span>)
+  <span class="ruby-identifier">starting_at</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">RelativeTime</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">ending_at</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">RelativeTime</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">starting_at</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-identifier">ending_at</span>)
 <span class="ruby-keyword">end</span></pre>
             </div><!-- new-source -->
@@ -291,7 +298,7 @@
             <div class="method-source-code" id="21-3D-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 89</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 98</span>
 <span class="ruby-keyword">def</span> <span class="ruby-operator">!=</span> (<span class="ruby-identifier">b</span>)
   <span class="ruby-operator">!</span><span class="ruby-identifier">end_with</span>(<span class="ruby-identifier">b</span>) <span class="ruby-operator">||</span> <span class="ruby-operator">!</span><span class="ruby-identifier">starts_with</span>(<span class="ruby-identifier">b</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -324,7 +331,7 @@
             <div class="method-source-code" id="3C-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 93</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 102</span>
 <span class="ruby-keyword">def</span> <span class="ruby-operator">&lt;</span> (<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">ends_before_other_starts?</span>(<span class="ruby-identifier">b</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -352,12 +359,16 @@
           <div class="method-description">
             <p>&gt;= and &lt;=  intentionally not defined;</p>
+<pre>logically can only mean starts_after? or ends_before? respectively
+which are basically aliased to &gt; &amp; &lt;
+unless it is meant &lt; XOR =</pre>
             <div class="method-source-code" id="3D-3D-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 85</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 94</span>
 <span class="ruby-keyword">def</span> <span class="ruby-operator">==</span> (<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">ends_with?</span>(<span class="ruby-identifier">b</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">starts_with?</span>(<span class="ruby-identifier">b</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -390,7 +401,7 @@
             <div class="method-source-code" id="3E-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 97</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 106</span>
 <span class="ruby-keyword">def</span> <span class="ruby-operator">&gt;</span> (<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts_after_other_ends?</span>(<span class="ruby-identifier">b</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -423,7 +434,7 @@
             <div class="method-source-code" id="contained_fully_inside-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 101</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 110</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">contained_fully_inside?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts_after?</span>(<span class="ruby-identifier">b</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">ends_before?</span>(<span class="ruby-identifier">b</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -456,7 +467,7 @@
             <div class="method-source-code" id="contained_inside-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 105</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 114</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">contained_inside?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts_on_or_after?</span>(<span class="ruby-identifier">b</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">ends_on_or_before?</span>(<span class="ruby-identifier">b</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -489,7 +500,7 @@
             <div class="method-source-code" id="contains-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 113</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 122</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">contains?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts_before_or_with?</span>(<span class="ruby-identifier">b</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">ends_on_or_after?</span>(<span class="ruby-identifier">b</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -522,7 +533,7 @@
             <div class="method-source-code" id="contains_fully-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 109</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 118</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">contains_fully?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts_before?</span>(<span class="ruby-identifier">b</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">ends_after?</span>(<span class="ruby-identifier">b</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -555,7 +566,7 @@
             <div class="method-source-code" id="ends_after-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 54</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 60</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">ends_after?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">ends</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ends</span>
 <span class="ruby-keyword">end</span></pre>
@@ -588,7 +599,7 @@
             <div class="method-source-code" id="ends_as_other_starts-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 66</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 72</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">ends_as_other_starts?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">ends</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">starts</span>
 <span class="ruby-keyword">end</span></pre>
@@ -621,7 +632,7 @@
             <div class="method-source-code" id="ends_before-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 42</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 48</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">ends_before?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">ends</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ends</span>
 <span class="ruby-keyword">end</span></pre>
@@ -654,7 +665,7 @@
             <div class="method-source-code" id="ends_before_other_starts-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 62</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 68</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">ends_before_other_starts?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">ends</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">starts</span>
 <span class="ruby-keyword">end</span></pre>
@@ -687,7 +698,7 @@
             <div class="method-source-code" id="ends_on_or_after-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 50</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 56</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">ends_on_or_after?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">ends</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ends</span>
 <span class="ruby-keyword">end</span></pre>
@@ -720,7 +731,7 @@
             <div class="method-source-code" id="ends_on_or_before-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 46</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 52</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">ends_on_or_before?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">ends</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ends</span>
 <span class="ruby-keyword">end</span></pre>
@@ -753,7 +764,7 @@
             <div class="method-source-code" id="ends_with-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 58</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 64</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">ends_with?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">ends</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ends</span>
 <span class="ruby-keyword">end</span></pre>
@@ -786,7 +797,7 @@
             <div class="method-source-code" id="starts_after-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 25</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 31</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">starts_after?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">starts</span>
 <span class="ruby-keyword">end</span></pre>
@@ -819,7 +830,7 @@
             <div class="method-source-code" id="starts_after_other_ends-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 70</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 76</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">starts_after_other_ends?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ends</span>
 <span class="ruby-keyword">end</span></pre>
@@ -852,7 +863,7 @@
             <div class="method-source-code" id="starts_as_other_ends-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 74</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 80</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">starts_as_other_ends?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ends</span>
 <span class="ruby-keyword">end</span></pre>
@@ -879,13 +890,18 @@
           <div class="method-description">
+            <pre>#</pre>
+<p>single <a href="RelativeTime.html">RelativeTime</a> comparators
+#</p>
+<pre>#</pre>
             <div class="method-source-code" id="starts_before-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 21</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 27</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">starts_before?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">starts</span>
 <span class="ruby-keyword">end</span></pre>
@@ -918,7 +934,7 @@
             <div class="method-source-code" id="starts_before_or_with-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 38</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 44</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">starts_before_or_with?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">starts</span>
 <span class="ruby-keyword">end</span></pre>
@@ -951,7 +967,7 @@
             <div class="method-source-code" id="starts_on_or_after-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 29</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 35</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">starts_on_or_after?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">starts</span>
 <span class="ruby-keyword">end</span></pre>
@@ -984,7 +1000,7 @@
             <div class="method-source-code" id="starts_with-3F-source">
 <pre>
-<span class="ruby-comment"># File lib/time_span.rb, line 34</span>
+<span class="ruby-comment"># File lib/time_span.rb, line 40</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">starts_with?</span>(<span class="ruby-identifier">b</span>)
   <span class="ruby-identifier">starts</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">starts</span>
 <span class="ruby-keyword">end</span></pre>

data/doc/created.rid CHANGED Viewed

@@ -1,7 +1,7 @@
-Sat, 04 Feb 2012 21:02:13 -0800
+Sun, 05 Feb 2012 20:05:38 -0800
 ./spec/spec_helper.rb	Mon, 30 Jan 2012 19:58:16 -0800
 ./spec/time_span/time_span_spec.rb	Sat, 04 Feb 2012 20:55:54 -0800
-./lib/time_span/version.rb	Sat, 04 Feb 2012 20:58:56 -0800
-./lib/time_span.rb	Sat, 04 Feb 2012 20:53:50 -0800
+./lib/time_span/version.rb	Sat, 04 Feb 2012 21:03:20 -0800
+./lib/time_span.rb	Sun, 05 Feb 2012 20:01:10 -0800
 ./Gemfile	Mon, 30 Jan 2012 19:39:04 -0800
 ./Rakefile	Mon, 30 Jan 2012 19:39:04 -0800

data/doc/index.html CHANGED Viewed

@@ -123,10 +123,10 @@
       <li><a href="TimeSpan/TimeSpan.html#method-i-starts_with-3F">#starts_with? &mdash; TimeSpan::TimeSpan</a></li>
-      <li><a href="TimeSpan/RelativeTime.html#method-i-to_s">#to_s &mdash; TimeSpan::RelativeTime</a></li>
       <li><a href="TimeSpan/TimeLine.html#method-i-to_s">#to_s &mdash; TimeSpan::TimeLine</a></li>
+      <li><a href="TimeSpan/RelativeTime.html#method-i-to_s">#to_s &mdash; TimeSpan::RelativeTime</a></li>
       <li><a href="TimeSpan/RelativeTime.html#method-i-valid_and_comparable_with-3F">#valid_and_comparable_with? &mdash; TimeSpan::RelativeTime</a></li>
   </ul>

data/doc/lib/time_span/version_rb.html CHANGED Viewed

@@ -24,7 +24,7 @@
   <div id="metadata">
     <dl>
       <dt class="modified-date">Last Modified</dt>
-      <dd class="modified-date">2012-02-04 20:58:56 -0800</dd>
+      <dd class="modified-date">2012-02-04 21:03:20 -0800</dd>
       <dt class="requires">Requires</dt>

data/doc/lib/time_span_rb.html CHANGED Viewed

@@ -24,7 +24,7 @@
   <div id="metadata">
     <dl>
       <dt class="modified-date">Last Modified</dt>
-      <dd class="modified-date">2012-02-04 20:53:50 -0800</dd>
+      <dd class="modified-date">2012-02-05 20:01:10 -0800</dd>
       <dt class="requires">Requires</dt>

data/lib/time_span/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module TimeSpan
-  VERSION = "0.0.1.alpha05"
+  VERSION = "0.0.1.beta.01"
 end

data/lib/time_span.rb CHANGED Viewed

@@ -2,21 +2,34 @@
 module TimeSpan
+  #######################################################################################################
+  #    this classes' object have a starting and ending RelativeTime, and both times must be on the same TimeLine
+  #
+  #    it implements a large selection of comparators, both for start / end times (single time compartors),
+  #    and also range comparators
   class TimeSpan
-    attr_accessor :starts, :ends     # RelativeTime objects
+    attr_accessor :starts, :ends, :time_line, :name     # RelativeTime objects
-    ##################################
-    ## time comparison               #
-    ##################################
+    def initialize(starting_at, ending_at, t_line, nom="(unnamed)")
+      raise "Cannot make a span unless both points are on the same time_line" unless  starting_at.colinear_with?(ending_at)
+      self.starts           = starting_at
+      self.ends             = ending_at
+      self.time_line        = t_line
+      self.time_line.spans  << self
+      self.name             = nom
+      starting_at.kind_of?(RelativeTime) && ending_at.kind_of?(RelativeTime) && (starting_at <= ending_at)
+    end
-    def initialize(starting_at, ending_at)
-      raise "Cannot make a span unless both points are on the same timeline" unless  starting_at.colinear_with?(ending_at)
-      self.starts = starting_at
-      self.ends   = ending_at
-      starting_at.kind_of?(RelativeTime) && ending_at.kind_of?(RelativeTime)
+    def endpoint_statuses
+      {self => [self.starts.reference_to, self.ends.reference_to]}
     end
+  #######################################################################################################
+  #                                                                                                     #
+  #  single RelativeTime comparators                                                                    #
+  #                                                                                                     #
+  #######################################################################################################
     def starts_before?(b)
       starts < b.starts
@@ -80,6 +93,9 @@ module TimeSpan
     ##################################
     ## >= and <=  intentionally not defined;
+    ##    logically can only mean starts_after? or ends_before? respectively
+    ##    which are basically aliased to > & <
+    ##    unless it is meant < XOR =
     def == (b)
@@ -115,39 +131,84 @@ module TimeSpan
     end
   end
-  #
+  #######################################################################################################
+  #  class TimeLine                                                                                     #
+  #                                                                                                     #
+  #  TimeLine is how RelativeTime objects are related to each other, they have to have the same         #
+  #    frame of reference.                                                                              #
+  #                                                                                                     #
+  #  instance methods:                                                                                  #
+  #                                                                                                     #
+  #    to_s  -- convenience method to see which object we have                                          #
+  #    position_of(obj) -- its location on the TimeLine                                                 #
+  #    increase_after(position, amount) -- make room in the index for an insertion                      #
+  #    append (obj)  -- add obj to end of the TimeLine                                                  #
+  #    append_to_next(relative_object, object, relative) at relative offset to relative_object, put obj #
+  #    insert_before_next(relative_object, object, relative) inserts into new time slot relative to relative_object
+  #    insert_at(position, object) -- places object at position, appending if equal time exists         #
+  #    remove(obj) -- remove object from the TimeLine                                                   #
+  #    compress! -- compresses the TimeLine, removing [] and adjusting the index accordingly            #
+  #                                                                                                     #
+  #######################################################################################################
   class TimeLine <  Array
-    attr_accessor :line, :indices_of, :name
+    attr_accessor :line, :indices_of, :name, :spans
     def to_s
       name.to_s
     end
+    def inspect
+      line.inspect + name
+    end
+    def all_endpoint_statuses
+      spans.inject({}){ |acc, span| acc.merge!(span.endpoint_statuses) }
+    end
+    ## attached times only
+    def relative_times
+      indices_of.keys
+    end
+    def all_relative_time_statuses
+      relative_times.inject([]) {|acc, v| acc << v.reference_to }
+    end
     def initialize(name="")
       @name = name
       @line = []
       @indices_of = {}
+      @spans = []
     end
+    ## indices methods
     def position_of(obj)
       @indices_of[obj]
     end
-    def append(obj)
-      insert_at(@line.size, obj)
-    end
     def increase_after(pos, by=1)
       @indices_of.each_key do |key|
         @indices_of[key] += by if (@indices_of[key] >= pos)
       end
     end
+    ## insertion
+    # add to the  end of the TimeLine
+    def append(obj)
+      insert_at(@line.size, obj)
+    end
+    # inserts to the end of the relative object's time, becoming equal with it
     def append_to_next(relative_obj, obj, relative=1)
       insert_at(position_of(relative_obj)+relative, obj)
     end
+    ## inserts into a new space before the relative object (first parameter)
     def insert_before_next(relative_obj, obj, relative_offset=1)
       relative_position = position_of(relative_obj)
       increase_after(relative_position + relative_offset, relative_offset)
@@ -155,76 +216,75 @@ module TimeSpan
       insert_at(relative_position+relative_offset, obj)
     end
-    ## needs work for RelativeTime objects
+    ## place obj at the numbered position
     def insert_at(pos, obj)
-      raise "can only add a time to its own timeline" unless obj.timeline.equal? self
+      raise "can only add a time to its own time_line" unless obj.time_line.equal? self
       if @line[pos].nil?
         @line[pos] = [obj]
-        @indices_of[obj] = pos
       else
         op = @line[pos].kind_of?(Array) ? '<<'  : '='
-        @line[pos].send(op.to_sym, obj) unless @line[pos].include?(obj)  # no dupliates
-        @indices_of[obj] = pos                                           # dup overwrites
+        @line[pos].send(op.to_sym, obj).uniq!                # no duplicates in same position
+        # dup in diff position overwrites below
       end
+      @indices_of[obj] = pos
     end
+    # cannot remove [] or the @indices_of will be wrong
+    # call  #compress to remove the extra []s
     def remove(obj)
-      # cannot remove [] or the @indices_of will be wrong
-      # call to #compress to remove the extra []s
       pos =  position_of(obj)
       if pos                        # do nothing if it isn't there'
-        @line[pos].delete(obj)
-        @indices_of.delete(obj)
+        @line[pos].delete(obj)      #  remove from list
+        @indices_of.delete(obj)     #  remove from index
       end
     end
     ## removes all [] elements, and decrements accordingly the @indices_of
     ##  ideally this should be transactional
     def compress!
       mod_level = 0
       offsets = []
       0.upto(line.size-1) do |i|
         mod_level -= 1 if @line[i].empty?
         offsets << mod_level
       end
       ## poor man's transaction.  Don't do directly on indices_of so less chance of interruption
       indices = indices_of
-      ## refactor to use increase_after
       indices.each_key do |key|
         indices[key] = indices[key] + offsets[indices[key]]
       end
       indices_of = indices
       @line.delete([])
     end
   end
-  ###########################################################################################
-  #                                                                                         #
-  # A relative time must be able to be have equal times                                     #
-  # implemented as an Array of Arrays; all elements of the 'subarray' are equal in time,    #
-  # otherwise, the time relationship are based on position in the main array                #
-  #                                                                                         #
-  # diff cannot be done, it makes no sense, due to the fuzziness                            #
-  #                                                                                         #
-  #  RelativeTime must be within a TimeLine                                                 #
-  ###########################################################################################
+  #######################################################################################################
+  # class RelativeTime                                                                                  #
+  #                                                                                                     #
+  # public methods:                                                                                     #
+  #   comparators: < <= == != >= >                                                                      #
+  #      work on any two RelativeTime objects on the same TimeLine                                      #
+  #   positioned?                                                                                       #
+  #      true if a RelativeTime has been put on a TimeLine                                              #                                                                                   #
+  #   colinear_with?(RelativeTime.new)                                                                  #
+  #      true if both RelativeTime objects are positioned and on same TimeLine                          #
+  #                                                                                                     #
+  # protected method:                                                                                   #
+  #   valid_and_comparable_with?(RelativeTime)                                                          #
+  #      true if                                                                                        #
+  #                                                                                                     #
+  # diff cannot be done, it makes no sense, due to the fuzziness                                        #
+  #                                                                                                     #
+  #  RelativeTime must be within a TimeLine                                                             #
+  #######################################################################################################
   class RelativeTime
-    attr_accessor  :timeline, :reference_to    # reference_to should respond_to? :to_s
+    attr_accessor  :time_line, :reference_to    # reference_to should respond_to? :to_s
-    # create a realtive time *within a timeline*  after position
+    # create a realtive time *within a time_line*  after position
     def initialize  tline, ref
-       @timeline= tline
+       @time_line= tline
        @reference_to= ref
     end
@@ -235,24 +295,24 @@ module TimeSpan
     ## any method on fixnum with 1 RelativeTime param can be in the list below
     %w{< <= == != >= >}.each{ |meth|
       self.send(:define_method, meth) {|b|
-        raise "can only compare to other times on the same timeline." unless valid_and_comparable_with?(b)     # can NOT compare across TimeLines
-        self.timeline.position_of(self).send(meth, b.timeline.position_of(b))
+        raise "can only compare to other times on the same time_line." unless valid_and_comparable_with?(b)     # can NOT compare across TimeLines
+        self.time_line.position_of(self).send(meth, b.time_line.position_of(b))
       }
     }
     def positioned?
-      self.timeline.indices_of.keys.include?(self)
+      self.time_line && self.time_line.indices_of.include?(self)
     end
     def colinear_with?(b)
-      self.timeline.equal?(b.timeline)
+      b.kind_of?(self.class) &&  b.positioned? && positioned? &&  time_line.equal?(b.time_line)
     end
     protected
     def valid_and_comparable_with?(b)
-      !self.timeline.nil? && !b.timeline.nil?  &&  colinear_with?(b)
+      !self.time_line.nil? && !b.time_line.nil?  &&  colinear_with?(b)
     end

data/spec/time_span/time_span_spec.rb CHANGED Viewed

@@ -22,20 +22,40 @@ describe "TimeSpan" do
     TimeSpan::RelativeTime.new timeline, "Some timepoint d"
   end
+  let (:time_span) do
+    TimeSpan::TimeSpan.new(time_a, time_c, timeline, "testing time span")
+  end
   before(:each) do
     timeline.append time_a
     timeline.append time_b
     timeline.append time_c
   end
-  let (:time_span) do
-    TimeSpan::TimeSpan.new(time_a, time_c)
-  end
   context "TimeSpan::TimeLine" do
     context "instance methods" do
+      context "statues" do
+        it "should get all the endpoint statuses" do
+          timeline.all_endpoint_statuses.should ==  {time_span => [time_span.starts.reference_to, time_span.ends.reference_to]}
+        end
+        it "knows the statuses for all associated TimeSpan objects" do
+          timeline.all_relative_time_statuses.sort.should == ["Some timepoint a", "Some timepoint b", "Some timepoint c"]
+        end
+      end
+      context "spans" do
+        it "the TimeLine knows its TimeSpan list" do
+          timeline.spans.should include(time_span)
+        end
+      end
       context "insertion"  do
         it "inserts a TimeSpan::RelativeTime into the timeline." do
@@ -172,12 +192,21 @@ describe "TimeSpan" do
       end
+      context "relative status methods" do
+        it "should get the relative statuses for the endpoints" do
+          time_span.endpoint_statuses.should == { time_span => [time_a.reference_to, time_c.reference_to]}
+        end
+      end
       context "single time point comparators" do
         context "same end time, time_span starts before other time_span" do
           let (:time_span_2) do
-            TimeSpan::TimeSpan.new(time_b, time_c)
+            TimeSpan::TimeSpan.new(time_b, time_c, timeline)
           end
           it "start before other time_span" do
@@ -243,19 +272,19 @@ describe "TimeSpan" do
         end
         let (:time_span_mid) do
-          TimeSpan::TimeSpan.new(time_b, time_c)
+          TimeSpan::TimeSpan.new(time_b, time_c, timeline)
         end
         let(:time_span_all) do
-          TimeSpan::TimeSpan.new(time_a, time_e)
+          TimeSpan::TimeSpan.new(time_a, time_e, timeline)
         end
         let (:time_span_last) do
-          TimeSpan::TimeSpan.new(time_d, time_e)
+          TimeSpan::TimeSpan.new(time_d, time_e, timeline)
         end
         it "identical start and end times should return == as true" do
-          time_span_3 = TimeSpan::TimeSpan.new(time_a, time_c)
+          time_span_3 = TimeSpan::TimeSpan.new(time_a, time_c, timeline)
           time_span.should == time_span_3
         end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_span
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha05
+  version: 0.0.1.beta.01
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-02-05 00:00:00.000000000 Z
+date: 2012-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &85009820 !ruby/object:Gem::Requirement
+  requirement: &77411640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *85009820
+  version_requirements: *77411640
 description: Time spans, including many comparators
 email:
 - craig.a.cook@gmail.com
@@ -31,6 +31,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - doc/Gemfile.html
 - doc/Rakefile.html
@@ -100,3 +101,4 @@ signing_key:
 specification_version: 3
 summary: Time Span
 test_files: []
+has_rdoc: