temporal_object 0.1.0 → 0.1.1

data/doc/TemporalObject.html

@@ -104,17 +104,7 @@
   
 </ul>
 
-</div><h2>Defined Under Namespace</h2>
-<p class="children">
-   
-    
-   
-    
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="TemporalObject/TemporalObject.html" title="TemporalObject::TemporalObject (class)">TemporalObject</a></span>
-    
-  
-</p>
-
+</div>
   <h2>Constant Summary</h2>
   
     <dl class="constants">
@@ -122,7 +112,7 @@
         <dt id="VERSION-constant" class="">VERSION =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.2</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
       
     </dl>
   
@@ -130,15 +120,493 @@
 
 
 
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#temporal_statuses-instance_method" title="#temporal_statuses (instance method)">- (Object) <strong>temporal_statuses</strong> </a>
+    
+
+    
+  </span>
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><dl class="rdoc-list"><dt>Array</dt>
+<dd>
+<p>of TimeSpan::TimeLine statuses for temporal attributes.</p>
+</dd></dl>
+</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="#add_timeline-instance_method" title="#add_timeline (instance method)">- (Array) <strong>add_timeline</strong>(timeline) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>add a timeline to the TemporalObject.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (TemporalObject) <strong>initialize</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of TemporalObject.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#remove_timeline-instance_method" title="#remove_timeline (instance method)">- (TimeSpan::TimeLine<sup>?</sup>) <strong>remove_timeline</strong>(timeline) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>delete the cited   timeline.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#remove_timelines-instance_method" title="#remove_timelines (instance method)">- (Array) <strong>remove_timelines</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>remove all TimeLine s from the TemporalObject.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id="temporal_statuses=-instance_method"></span>
+      <span id="temporal_statuses-instance_method"></span>
+      <div class="method_details first">
+  <p class="signature first" id="temporal_statuses-instance_method">
+  
+    - (<tt>Object</tt>) <strong>temporal_statuses</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <dl class="rdoc-list"><dt>Array</dt>
+<dd>
+<p>of TimeSpan::TimeLine statuses for temporal attributes</p>
+</dd></dl>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/temporal_object.rb', line 9</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_temporal_statuses'>temporal_statuses</span>
+  <span class='ivar'>@temporal_statuses</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">
+  <p class="signature first" id="add_timeline-instance_method">
+  
+    - (<tt>Array</tt>) <strong>add_timeline</strong>(timeline) 
+  
 
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>add a timeline to the TemporalObject</p>
 
 
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>timeline</span>
+      
+      
+        <span class='type'>(<tt>TimeSpan::TimeLine</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>added to the object</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>adjusted list of timelines if no exception raised.</p>
+</div>
+      
+    </li>
+  
+</ul>
+<h3>Raises:</h3>
+<ul class="raise">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>ArgumentError</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+19
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/temporal_object.rb', line 19</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_add_timeline'>add_timeline</span><span class='lparen'>(</span><span class='id identifier rubyid_timeline'>timeline</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Can only add a TimeSpan::TimeLine to a TemporalObject's statuses</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_timeline'>timeline</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='const'>TimeSpan</span><span class='op'>::</span><span class='const'>TimeLine</span>
+  <span class='ivar'>@temporal_statuses</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_timeline'>timeline</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="initialize-instance_method">
+  
+    - (<tt><span class='object_link'><a href="" title="TemporalObject (module)">TemporalObject</a></span></tt>) <strong>initialize</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>A new instance of TemporalObject</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+11
+12
+13
+14</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/temporal_object.rb', line 11</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
+  <span class='kw'>super</span>
+  <span class='ivar'>@temporal_statuses</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>         <span class='comment'># Array of TimeSpan::TimeLine
+</span><span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="remove_timeline-instance_method">
+  
+    - (<tt>TimeSpan::TimeLine</tt><sup>?</sup>) <strong>remove_timeline</strong>(timeline) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>delete the cited   timeline</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>timeline</span>
+      
+      
+        <span class='type'>(<tt>TimeSpan::TimeLine</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>timeline to delete</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>TimeSpan::TimeLine</tt>, <tt>nil</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>TimeLIne deleted if successful or nil if not</p>
+</div>
+      
+    </li>
+  
+</ul>
+<h3>Raises:</h3>
+<ul class="raise">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>ArgumentError if called with a non-TimeLine object</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+34
+35
+36
+37</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/temporal_object.rb', line 34</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_remove_timeline'>remove_timeline</span><span class='lparen'>(</span><span class='id identifier rubyid_timeline'>timeline</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Can only remove a TimeLine with this call.</span><span class='tstring_end'>&quot;</span></span>  <span class='kw'>unless</span> <span class='id identifier rubyid_timeline'>timeline</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='const'>TimeSpan</span><span class='op'>::</span><span class='const'>TimeLine</span>
+  <span class='ivar'>@temporal_statuses</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_timeline'>timeline</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="remove_timelines-instance_method">
+  
+    - (<tt>Array</tt>) <strong>remove_timelines</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>remove all TimeLine s from the TemporalObject</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the associated timelines</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+26
+27
+28</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/temporal_object.rb', line 26</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_remove_timelines'>remove_timelines</span>
+  <span class='ivar'>@temporal_statuses</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
 
 </div>
     
     <div id="footer">
-  Generated on Mon Mar  5 16:14:00 2012 by 
+  Generated on Fri Mar 16 16:34:52 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/doc/_index.html

@@ -85,13 +85,6 @@
                 
               </li>
             
-              <li>
-                <span class='object_link'><a href="TemporalObject/TemporalObject.html" title="TemporalObject::TemporalObject (class)">TemporalObject</a></span> 
-                
-                  <small>(TemporalObject)</small>
-                
-              </li>
-            
           </ul>
         </ul>
       
@@ -104,7 +97,7 @@
 </div>
     
     <div id="footer">
-  Generated on Mon Mar  5 16:14:00 2012 by 
+  Generated on Fri Mar 16 16:34:52 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/doc/class_list.html

@@ -39,7 +39,7 @@
 
       <ul id="full_list" class="class">
         <li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
-<li><a class='toggle'></a> <span class='object_link'><a href="TemporalObject.html" title="TemporalObject (module)">TemporalObject</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="TemporalObject/TemporalObject.html" title="TemporalObject::TemporalObject (class)">TemporalObject</a></span> &lt; Object<small class='search_info'>TemporalObject</small></li></ul>
+<li><span class='object_link'><a href="TemporalObject.html" title="TemporalObject (module)">TemporalObject</a></span><small class='search_info'>Top Level Namespace</small></li>
 
       </ul>
     </div>

data/doc/file.README.html

@@ -56,15 +56,30 @@
     
     <div id="content"><div id='filecontents'><h1>Temporal Object</h1>
 
-<p>This is a first stab at creating a RubyGem to implement Martin Fowler&#39;s &quot;Temporal Objects&quot; paradigm.</p>
+<p>This gem is implemented as a mixin, so that you can do the following:</p>
 
-<p>So far there are time comparators.  TemporalObject::RelativeTime just inherits from DateTime (for now).</p>
+<pre class="code ruby"><code><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>temporal_object</span><span class='tstring_end'>'</span></span>
+<span class='id identifier rubyid_include'>include</span> <span class='const'>TemporalObject</span>
+</code></pre>
 
-<p>IT IS NOT YET READY FOR PRIME TIME!  Do not use.  I will be refactoring, so the API <em>will</em> be changing.  Thanks.</p>
+<p>Will add instance methods to manipulate TimeLines (and thereby TimeSpans and RelativeTimes) to the including object.</p>
+
+<p>Most of the temporal aspects for Temporal Object are delegated to TimeSpan.  The Temporal Object just has any number of
+TimeSpan statuses.</p>
+
+<p>More information on TimeSpan:</p>
+
+<ul>
+<li><a href="http://rubydoc.info/gems/time_span/0.0.3/frames">rdoc</a></li>
+<li><a href="https://github.com/coyote/time_span">github</a></li>
+<li><a href="https://rubygems.org/gems/time_span">rubygems</a></li>
+</ul>
+
+<p>Note, that this implementation is quite changed from gem version 0.0.3, where TemporalObjects needed to be created, which pointed to your actual object.  Code has been simplified thereby, and is much cleaner.</p>
 </div></div>
     
     <div id="footer">
-  Generated on Mon Mar  5 16:14:00 2012 by 
+  Generated on Fri Mar 16 16:34:52 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/doc/index.html

@@ -56,15 +56,30 @@
     
     <div id="content"><div id='filecontents'><h1>Temporal Object</h1>
 
-<p>This is a first stab at creating a RubyGem to implement Martin Fowler&#39;s &quot;Temporal Objects&quot; paradigm.</p>
+<p>This gem is implemented as a mixin, so that you can do the following:</p>
 
-<p>So far there are time comparators.  TemporalObject::RelativeTime just inherits from DateTime (for now).</p>
+<pre class="code ruby"><code><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>temporal_object</span><span class='tstring_end'>'</span></span>
+<span class='id identifier rubyid_include'>include</span> <span class='const'>TemporalObject</span>
+</code></pre>
 
-<p>IT IS NOT YET READY FOR PRIME TIME!  Do not use.  I will be refactoring, so the API <em>will</em> be changing.  Thanks.</p>
+<p>Will add instance methods to manipulate TimeLines (and thereby TimeSpans and RelativeTimes) to the including object.</p>
+
+<p>Most of the temporal aspects for Temporal Object are delegated to TimeSpan.  The Temporal Object just has any number of
+TimeSpan statuses.</p>
+
+<p>More information on TimeSpan:</p>
+
+<ul>
+<li><a href="http://rubydoc.info/gems/time_span/0.0.3/frames">rdoc</a></li>
+<li><a href="https://github.com/coyote/time_span">github</a></li>
+<li><a href="https://rubygems.org/gems/time_span">rubygems</a></li>
+</ul>
+
+<p>Note, that this implementation is quite changed from gem version 0.0.3, where TemporalObjects needed to be created, which pointed to your actual object.  Code has been simplified thereby, and is much cleaner.</p>
 </div></div>
     
     <div id="footer">
-  Generated on Mon Mar  5 16:14:00 2012 by 
+  Generated on Fri Mar 16 16:34:52 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/doc/method_list.html

@@ -41,57 +41,41 @@
         
 
   <li class="r1 ">
-    <span class='object_link'><a href="TemporalObject/TemporalObject.html#add_timeline-instance_method" title="TemporalObject::TemporalObject#add_timeline (method)">#add_timeline</a></span>
+    <span class='object_link'><a href="TemporalObject.html#add_timeline-instance_method" title="TemporalObject#add_timeline (method)">#add_timeline</a></span>
     
-      <small>TemporalObject::TemporalObject</small>
+      <small>TemporalObject</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="TemporalObject/TemporalObject.html#initialize-instance_method" title="TemporalObject::TemporalObject#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="TemporalObject.html#initialize-instance_method" title="TemporalObject#initialize (method)">#initialize</a></span>
     
-      <small>TemporalObject::TemporalObject</small>
+      <small>TemporalObject</small>
     
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="TemporalObject/TemporalObject.html#name-instance_method" title="TemporalObject::TemporalObject#name (method)">#name</a></span>
+    <span class='object_link'><a href="TemporalObject.html#remove_timeline-instance_method" title="TemporalObject#remove_timeline (method)">#remove_timeline</a></span>
     
-      <small>TemporalObject::TemporalObject</small>
+      <small>TemporalObject</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="TemporalObject/TemporalObject.html#reference_object-instance_method" title="TemporalObject::TemporalObject#reference_object (method)">#reference_object</a></span>
+    <span class='object_link'><a href="TemporalObject.html#remove_timelines-instance_method" title="TemporalObject#remove_timelines (method)">#remove_timelines</a></span>
     
-      <small>TemporalObject::TemporalObject</small>
+      <small>TemporalObject</small>
     
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="TemporalObject/TemporalObject.html#remove_timeline-instance_method" title="TemporalObject::TemporalObject#remove_timeline (method)">#remove_timeline</a></span>
+    <span class='object_link'><a href="TemporalObject.html#temporal_statuses-instance_method" title="TemporalObject#temporal_statuses (method)">#temporal_statuses</a></span>
     
-      <small>TemporalObject::TemporalObject</small>
-    
-  </li>
-  
-
-  <li class="r2 ">
-    <span class='object_link'><a href="TemporalObject/TemporalObject.html#remove_timelines-instance_method" title="TemporalObject::TemporalObject#remove_timelines (method)">#remove_timelines</a></span>
-    
-      <small>TemporalObject::TemporalObject</small>
-    
-  </li>
-  
-
-  <li class="r1 ">
-    <span class='object_link'><a href="TemporalObject/TemporalObject.html#statuses-instance_method" title="TemporalObject::TemporalObject#statuses (method)">#statuses</a></span>
-    
-      <small>TemporalObject::TemporalObject</small>
+      <small>TemporalObject</small>
     
   </li>
   

data/doc/top-level-namespace.html

@@ -96,7 +96,7 @@
 </div>
     
     <div id="footer">
-  Generated on Mon Mar  5 16:14:00 2012 by 
+  Generated on Fri Mar 16 16:34:52 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/lib/temporal_object/version.rb

@@ -1,3 +1,3 @@
 module TemporalObject
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: temporal_object
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &85683880 !ruby/object:Gem::Requirement
+  requirement: &78374510 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *85683880
+  version_requirements: *78374510
 - !ruby/object:Gem::Dependency
   name: time_span
-  requirement: &85683570 !ruby/object:Gem::Requirement
+  requirement: &78374220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *85683570
+  version_requirements: *78374220
 description: Martin Fowler\'s Temporal Object Pattern.  Use time_span gem for the
   times.
 email: