sadie 0.0.6 → 0.0.7

data/CHANGELOG

@@ -0,0 +1 @@
+Up to v0.0.6: getting it all working

data/lib/sadie/version.rb

@@ -2,5 +2,5 @@
 # this file sets the version of the Sadie gem
 
 class Sadie
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/sadie.rb

@@ -39,6 +39,7 @@ class Sadie
         @shortterm                      = Hash.new
         @flag_expensive                 = Hash.new
         @flag_primed                    = Hash.new
+        @flag_eachtimeprime             = Hash.new
 
         # init class
         Sadie::_checkSanity
@@ -136,18 +137,44 @@ class Sadie
     # completely behind-the-scenes as directed by the resource (.res) files
     def get( k )
         
+        # if it's already set, return known answer
+        if _isset?( k )
+            
+            # _get the return value
+            return_value = _get( k )
+            
+            # unset and unprime if destructOnGet?
+            if destructOnGet?( k )
+#                 puts "destructing #{k}"
+                unset( k )
+                unprime( k )
+            end
+            
+            return return_value
+        end
+        
         # prime if not yet primed
         primed?( k ) \
             or _prime( k )
             
         # if not expensive, then return what's already known
         expensive?( k ) \
-            or return _get( k )
+            and return _recallExpensive( k )
             
-        # expensive, so recall from file
-        return _recallExpensive( k )
+        # _get the return value
+        return_value = _get( k )
+        
+        # unset and unprime if destructOnGet?
+        if destructOnGet?( k )
+#                 puts "destructing #{k}"
+            unset( k )
+            unprime( k )
+        end
+        
+        return return_value
     end
     
+    
     # ==method: setCheap
     #
     # the expensive setter.  key, value pairs stored via this method are not kept in memory
@@ -162,6 +189,58 @@ class Sadie
         _primed( k, true )
     end
     
+    # ==method: setDestructOnGet
+    #
+    #    key value will go away and key will be unprimed and unset after next get
+    #
+    #    NOTE: this doesn't make sense with keys that were set via setExpensive
+    #          so it can be set, but nothing's going to happen differently
+    def setDestructOnGet( key, turnon=true )
+#         puts "setDestructOnGet( #{key}, #{turnon} )"
+        if ( turnon )
+#             puts "turning on destructOnGet for key: #{key}"
+            @flag_eachtimeprime["#{key}"] = true
+            return true
+        end
+        @flag_eachtimeprime.has_key?( key ) \
+            and @flag_eachtimeprime.delete( key )
+    end
+    
+    # ==method: destructOnGet?
+    #
+    # returns true if the destructOnGet flag is set for the key
+    def destructOnGet?( key )
+#         print "destructOnGet?> key #{key} "
+        @flag_eachtimeprime.has_key?( key ) \
+            or return _newline( false )
+#         print " defined-in-eachtimeprime "
+        @flag_eachtimeprime["#{key}"] \
+            and return _newline( true )
+#         print " defined-but-false "
+        return _newline(false)
+    end
+    
+    def _newline( rval=true )
+        #puts
+        return rval
+    end
+    
+    # ==method: unset
+    # unsets the value of k.  Note that this does not unprime, so
+    # get(key) will simply return nil. Run with unprime to have the
+    # primer run again
+    def unset( key )
+        _unset( key )
+    end
+    
+    # ==method: unprime
+    # unprimes k.  Note that this does not unset the value, so
+    # get(key) will continue to return whatever it otherwise would have.
+    # run unset as well to have the primer run again.
+    def unprime( key )
+        _primed( key, false )
+    end
+    
     # ==method: set
     # alias for setCheap(k,v)
     def set( k, v )
@@ -171,7 +250,7 @@ class Sadie
     # ==method: setCheap
     #
     # the cheap setter.  key, value pairs stored via this method are kept in memory
-    def setCheap(k,v)
+    def setCheap( k, v )
         
         # set it, mark not expensive and primed
         _set( k, v )
@@ -217,7 +296,9 @@ class Sadie
     #   INTERNAL: this method should only be called the the class method, Prime
     #
     def primed?( k )
-        @flag_primed[:"#{k}"] \
+        @flag_primed.has_key?( k ) \
+            or return false
+        @flag_primed["#{k}"] \
             and return true
         return false
     end
@@ -227,7 +308,8 @@ class Sadie
     #   INTERNAL: this method should only be called the the class method, Prime
     #
     def expensive?( k )
-        @flag_expensive[:"#{k}"] \
+        @flag_expensive.has_key?( k ) or return false;
+        @flag_expensive["#{k}"] \
             and return true
         return false
     end
@@ -238,12 +320,22 @@ class Sadie
     
     
     def _prime ( k )
+#         puts "_prime( #{k} )"
+        # fetch primers dirpath and validate the primer hash
         primer_dirpath = _get("sadie.primers_dirpath")
-        if primer_filepath = @@primer_hash["#{primer_dirpath}"]["#{k}"]
+        @@primer_hash.has_key?(primer_dirpath) \
+            or @@primer_hash[primer_dirpath] = Hash.new
+        
+        primers = @@primer_hash[primer_dirpath]
+        primers.has_key?( k ) or return true
+                
+        if primer_filepath = primers[k]
+#             puts "loading filepath: #{primer_filepath}"
             Sadie::_setCurrentPrimerFilepath(primer_filepath)
             Sadie::_setCurrentSadieInstance( self )
             load primer_filepath
         end
+        return true
         
     end
     
@@ -344,7 +436,7 @@ class Sadie
     
     def _primed( k, isprimed )
         if isprimed
-            @flag_primed[:"#{k}"]       = true
+            @flag_primed["#{k}"]       = true
             return
         end
         @flag_primed.delete( k )
@@ -352,7 +444,7 @@ class Sadie
     
     def _expensive( k, isexpensive )
         if isexpensive
-            @flag_expensive[:"#{k}"]    = true
+            @flag_expensive["#{k}"]    = true
             return
         end
         @flag_expensive.delete( k )
@@ -360,7 +452,7 @@ class Sadie
     
     # direct access getter for shortterm memory
     def _get( key )
-        value = @shortterm[:"#{key}"]
+        value = @shortterm["#{key}"]
         #puts "_get(#{key})> #{value}"
         return value
     end
@@ -369,7 +461,16 @@ class Sadie
     def _set( key, value )
         
 #        puts "_set> key: #{key}, value: #{value}"
-        @shortterm[:"#{key}"]           = value
+        @shortterm["#{key}"]           = value
+    end
+    
+    def _unset( key )
+        @shortterm.has_key?( key ) \
+            and @shortterm.delete( key )
+    end
+    
+    def _isset?( key )
+        return @shortterm.has_key?( key )
     end
     
     # init given path to session file
@@ -429,7 +530,7 @@ class Sadie
     
     def self._memorizePrimerLocation( filepath, primer_provides )
         primer_dirpath = @@mid_primer_toplevel_primer_dirpath
-        @@primer_hash.has_key?(primer_dirpath) \
+        @@primer_hash.has_key?( primer_dirpath ) \
             or @@primer_hash["#{primer_dirpath}"] = Hash.new
         primer_provides.each do | key |
             Sadie::_setPrimerProvider( key, filepath )

data/rdoc/classes/Sadie.html

@@ -103,14 +103,21 @@ the sadie constructor
 
       <div class="name-list">
       <a href="#M000003">Prime</a>&nbsp;&nbsp;
+      <a href="#M000008">_newline</a>&nbsp;&nbsp;
+      <a href="#M000007">destructOnGet?</a>&nbsp;&nbsp;
+      <a href="#M000016">expensive?</a>&nbsp;&nbsp;
       <a href="#M000004">get</a>&nbsp;&nbsp;
       <a href="#M000002">getSadieInstance</a>&nbsp;&nbsp;
       <a href="#M000001">new</a>&nbsp;&nbsp;
-      <a href="#M000009">revert!</a>&nbsp;&nbsp;
-      <a href="#M000008">save</a>&nbsp;&nbsp;
-      <a href="#M000006">set</a>&nbsp;&nbsp;
-      <a href="#M000007">setCheap</a>&nbsp;&nbsp;
+      <a href="#M000015">primed?</a>&nbsp;&nbsp;
+      <a href="#M000014">revert!</a>&nbsp;&nbsp;
+      <a href="#M000013">save</a>&nbsp;&nbsp;
+      <a href="#M000011">set</a>&nbsp;&nbsp;
+      <a href="#M000012">setCheap</a>&nbsp;&nbsp;
+      <a href="#M000006">setDestructOnGet</a>&nbsp;&nbsp;
       <a href="#M000005">setExpensive</a>&nbsp;&nbsp;
+      <a href="#M000010">unprime</a>&nbsp;&nbsp;
+      <a href="#M000009">unset</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -130,7 +137,7 @@ the sadie constructor
         <tr class="top-aligned-row context-row">
           <td class="context-item-name">VERSION</td>
           <td>=</td>
-          <td class="context-item-value">&quot;0.0.4&quot;</td>
+          <td class="context-item-value">&quot;0.0.7&quot;</td>
         </tr>
         <tr class="top-aligned-row context-row">
           <td class="context-item-name">DEFAULTS</td>
@@ -173,7 +180,7 @@ resource (.res) file will have provided after the block is evaluated
             onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000003-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/sadie.rb, line 95</span>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 96</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-constant">Prime</span> ( <span class="ruby-identifier">primer_definition</span> )
         
         <span class="ruby-comment cmt"># validate params</span>
@@ -187,14 +194,25 @@ resource (.res) file will have provided after the block is evaluated
         <span class="ruby-comment cmt"># if initializing primers, just remember how to get back to the primer later,</span>
         <span class="ruby-comment cmt"># otherwise, prime</span>
         <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Sadie</span><span class="ruby-operator">::</span><span class="ruby-identifier">_midPrimerInit?</span>
+            
+            <span class="ruby-comment cmt"># mid primer init, just memorize primer location</span>
             <span class="ruby-constant">Sadie</span><span class="ruby-operator">::</span><span class="ruby-identifier">_memorizePrimerLocation</span>( <span class="ruby-ivar">@@mid_primer_filepath</span>,  <span class="ruby-identifier">primer_definition</span>[<span class="ruby-value str">&quot;provides&quot;</span>] )
         <span class="ruby-keyword kw">else</span>
+            
+            <span class="ruby-comment cmt"># run code block with the current sadie instance</span>
             <span class="ruby-identifier">current_sadie_instance</span> = <span class="ruby-constant">Sadie</span><span class="ruby-operator">::</span><span class="ruby-identifier">_getCurrentSadieInstance</span>
-            <span class="ruby-identifier">current_primer_filepath</span> = <span class="ruby-constant">Sadie</span><span class="ruby-operator">::</span><span class="ruby-identifier">_getCurrentPrimerFilepath</span>
             <span class="ruby-keyword kw">yield</span>( <span class="ruby-identifier">current_sadie_instance</span> )
+            
+            <span class="ruby-comment cmt"># loop thru all primer provides, ensuring each primed</span>
+            <span class="ruby-identifier">current_primer_filepath</span> = <span class="ruby-constant">Sadie</span><span class="ruby-operator">::</span><span class="ruby-identifier">_getCurrentPrimerFilepath</span>
             <span class="ruby-identifier">primer_definition</span>[<span class="ruby-value str">&quot;provides&quot;</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">key</span> <span class="ruby-operator">|</span>
+                
+                <span class="ruby-comment cmt"># skip blank lines</span>
                 <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">match</span> <span class="ruby-regexp re">/^\s*$/</span>
+                
                 <span class="ruby-comment cmt">#puts &quot;Prime&gt; providing: #{key}&quot;</span>
+                
+                <span class="ruby-comment cmt"># key primed or raise error</span>
                 <span class="ruby-identifier">current_sadie_instance</span>.<span class="ruby-identifier">primed?</span> <span class="ruby-identifier">key</span> \
                     <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;primer definition file: #{current_primer_filepath} was supposed to define #{key}, but did not&quot;</span>
             <span class="ruby-keyword kw">end</span>
@@ -225,7 +243,7 @@ href="Sadie.html">Sadie</a>&#8216;s constructor method
             onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000002-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/sadie.rb, line 83</span>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 84</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">getSadieInstance</span>( <span class="ruby-identifier">options</span> )
         <span class="ruby-constant">Sadie</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
     <span class="ruby-keyword kw">end</span>
@@ -270,6 +288,7 @@ href="Sadie.html">Sadie</a>&#8216;s constructor method
         <span class="ruby-ivar">@shortterm</span>                      = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
         <span class="ruby-ivar">@flag_expensive</span>                 = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
         <span class="ruby-ivar">@flag_primed</span>                    = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
+        <span class="ruby-ivar">@flag_eachtimeprime</span>             = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
 
         <span class="ruby-comment cmt"># init class</span>
         <span class="ruby-constant">Sadie</span><span class="ruby-operator">::</span><span class="ruby-identifier">_checkSanity</span>
@@ -314,6 +333,95 @@ href="Sadie.html">Sadie</a>&#8216;s constructor method
 
       <h3 class="section-bar">Public Instance methods</h3>
 
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="#M000008" class="method-signature">
+          <span class="method-name">_newline</span><span class="method-args">( rval=true )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000008-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 223</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">_newline</span>( <span class="ruby-identifier">rval</span>=<span class="ruby-keyword kw">true</span> )
+        <span class="ruby-comment cmt">#puts</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">rval</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+
+        <div class="method-heading">
+          <a href="#M000007" class="method-signature">
+          <span class="method-name">destructOnGet?</span><span class="method-args">( key )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <h2>method: <a href="Sadie.html#M000007">destructOnGet?</a></h2>
+<p>
+returns true if the destructOnGet flag is <a
+href="Sadie.html#M000011">set</a> for the key
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000007-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 212</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">destructOnGet?</span>( <span class="ruby-identifier">key</span> )
+<span class="ruby-comment cmt">#         print &quot;destructOnGet?&gt; key #{key} &quot;</span>
+        <span class="ruby-ivar">@flag_eachtimeprime</span>.<span class="ruby-identifier">has_key?</span>( <span class="ruby-identifier">key</span> ) \
+            <span class="ruby-keyword kw">or</span> <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">_newline</span>( <span class="ruby-keyword kw">false</span> )
+<span class="ruby-comment cmt">#         print &quot; defined-in-eachtimeprime &quot;</span>
+        <span class="ruby-ivar">@flag_eachtimeprime</span>[<span class="ruby-node">&quot;#{key}&quot;</span>] \
+            <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">_newline</span>( <span class="ruby-keyword kw">true</span> )
+<span class="ruby-comment cmt">#         print &quot; defined-but-false &quot;</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">_newline</span>(<span class="ruby-keyword kw">false</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000016" class="method-detail">
+        <a name="M000016"></a>
+
+        <div class="method-heading">
+          <a href="#M000016" class="method-signature">
+          <span class="method-name">expensive?</span><span class="method-args">( k )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <h2>method: <a href="Sadie.html#M000015">primed?</a></h2>
+<pre>
+  INTERNAL: this method should only be called the the class method, Prime
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000016-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 310</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">expensive?</span>( <span class="ruby-identifier">k</span> )
+        <span class="ruby-ivar">@flag_expensive</span>.<span class="ruby-identifier">has_key?</span>( <span class="ruby-identifier">k</span> ) <span class="ruby-keyword kw">or</span> <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>;
+        <span class="ruby-ivar">@flag_expensive</span>[<span class="ruby-node">&quot;#{k}&quot;</span>] \
+            <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
       <div id="method-M000004" class="method-detail">
         <a name="M000004"></a>
 
@@ -334,44 +442,100 @@ directed by the resource (.res) files
             onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000004-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/sadie.rb, line 126</span>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 138</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>( <span class="ruby-identifier">k</span> )
         
+        <span class="ruby-comment cmt"># if it's already set, return known answer</span>
+        <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_isset?</span>( <span class="ruby-identifier">k</span> )
+            
+            <span class="ruby-comment cmt"># _get the return value</span>
+            <span class="ruby-identifier">return_value</span> = <span class="ruby-identifier">_get</span>( <span class="ruby-identifier">k</span> )
+            
+            <span class="ruby-comment cmt"># unset and unprime if destructOnGet?</span>
+            <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">destructOnGet?</span>( <span class="ruby-identifier">k</span> )
+<span class="ruby-comment cmt">#                 puts &quot;destructing #{k}&quot;</span>
+                <span class="ruby-identifier">unset</span>( <span class="ruby-identifier">k</span> )
+                <span class="ruby-identifier">unprime</span>( <span class="ruby-identifier">k</span> )
+            <span class="ruby-keyword kw">end</span>
+            
+            <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">return_value</span>
+        <span class="ruby-keyword kw">end</span>
+        
         <span class="ruby-comment cmt"># prime if not yet primed</span>
         <span class="ruby-identifier">primed?</span>( <span class="ruby-identifier">k</span> ) \
             <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">_prime</span>( <span class="ruby-identifier">k</span> )
             
         <span class="ruby-comment cmt"># if not expensive, then return what's already known</span>
         <span class="ruby-identifier">expensive?</span>( <span class="ruby-identifier">k</span> ) \
-            <span class="ruby-keyword kw">or</span> <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">_get</span>( <span class="ruby-identifier">k</span> )
+            <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">_recallExpensive</span>( <span class="ruby-identifier">k</span> )
             
-        <span class="ruby-comment cmt"># expensive, so recall from file</span>
-        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">_recallExpensive</span>( <span class="ruby-identifier">k</span> )
+        <span class="ruby-comment cmt"># _get the return value</span>
+        <span class="ruby-identifier">return_value</span> = <span class="ruby-identifier">_get</span>( <span class="ruby-identifier">k</span> )
+        
+        <span class="ruby-comment cmt"># unset and unprime if destructOnGet?</span>
+        <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">destructOnGet?</span>( <span class="ruby-identifier">k</span> )
+<span class="ruby-comment cmt">#                 puts &quot;destructing #{k}&quot;</span>
+            <span class="ruby-identifier">unset</span>( <span class="ruby-identifier">k</span> )
+            <span class="ruby-identifier">unprime</span>( <span class="ruby-identifier">k</span> )
+        <span class="ruby-keyword kw">end</span>
+        
+        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">return_value</span>
     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
       </div>
 
-      <div id="method-M000009" class="method-detail">
-        <a name="M000009"></a>
+      <div id="method-M000015" class="method-detail">
+        <a name="M000015"></a>
 
         <div class="method-heading">
-          <a href="#M000009" class="method-signature">
+          <a href="#M000015" class="method-signature">
+          <span class="method-name">primed?</span><span class="method-args">( k )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <h2>method: <a href="Sadie.html#M000015">primed?</a></h2>
+<pre>
+  INTERNAL: this method should only be called the the class method, Prime
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000015-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 298</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">primed?</span>( <span class="ruby-identifier">k</span> )
+        <span class="ruby-ivar">@flag_primed</span>.<span class="ruby-identifier">has_key?</span>( <span class="ruby-identifier">k</span> ) \
+            <span class="ruby-keyword kw">or</span> <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+        <span class="ruby-ivar">@flag_primed</span>[<span class="ruby-node">&quot;#{k}&quot;</span>] \
+            <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000014" class="method-detail">
+        <a name="M000014"></a>
+
+        <div class="method-heading">
+          <a href="#M000014" class="method-signature">
           <span class="method-name">revert!</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
-          <h2>method: <a href="Sadie.html#M000009">revert!</a></h2>
+          <h2>method: <a href="Sadie.html#M000014">revert!</a></h2>
 <p>
 return to last saved state
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000009-source">
+            onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000014-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/sadie.rb, line 194</span>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 284</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">revert!</span>
         
         <span class="ruby-ivar">@shortterm</span> = {
@@ -386,25 +550,25 @@ return to last saved state
         </div>
       </div>
 
-      <div id="method-M000008" class="method-detail">
-        <a name="M000008"></a>
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
 
         <div class="method-heading">
-          <a href="#M000008" class="method-signature">
+          <a href="#M000013" class="method-signature">
           <span class="method-name">save</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
-          <h2>method: <a href="Sadie.html#M000008">save</a></h2>
+          <h2>method: <a href="Sadie.html#M000013">save</a></h2>
 <p>
 serialize to session file
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000008-source">
+            onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000013-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/sadie.rb, line 182</span>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 272</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">save</span>
         <span class="ruby-identifier">session_filepath</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>( <span class="ruby-value str">&quot;session.&quot;</span><span class="ruby-operator">+</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">get</span>( <span class="ruby-value str">&quot;sadie.sessions_dirpath&quot;</span> ) )
         <span class="ruby-identifier">serialized_value</span>                = <span class="ruby-constant">Marshal</span><span class="ruby-operator">::</span><span class="ruby-identifier">dump</span>( [ <span class="ruby-ivar">@shortterm</span>, <span class="ruby-ivar">@flag_primed</span>, <span class="ruby-ivar">@flag_expensive</span> ] )
@@ -417,25 +581,25 @@ serialize to session file
         </div>
       </div>
 
-      <div id="method-M000006" class="method-detail">
-        <a name="M000006"></a>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
 
         <div class="method-heading">
-          <a href="#M000006" class="method-signature">
+          <a href="#M000011" class="method-signature">
           <span class="method-name">set</span><span class="method-args">( k, v )</span>
           </a>
         </div>
       
         <div class="method-description">
-          <h2>method: <a href="Sadie.html#M000006">set</a></h2>
+          <h2>method: <a href="Sadie.html#M000011">set</a></h2>
 <p>
-alias for <a href="Sadie.html#M000007">setCheap</a>(k,v)
+alias for <a href="Sadie.html#M000012">setCheap</a>(k,v)
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000006-source">
+            onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000011-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/sadie.rb, line 156</span>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 246</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set</span>( <span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span> )
         <span class="ruby-identifier">setCheap</span>( <span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span> )
     <span class="ruby-keyword kw">end</span>
@@ -444,27 +608,27 @@ alias for <a href="Sadie.html#M000007">setCheap</a>(k,v)
         </div>
       </div>
 
-      <div id="method-M000007" class="method-detail">
-        <a name="M000007"></a>
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
 
         <div class="method-heading">
-          <a href="#M000007" class="method-signature">
-          <span class="method-name">setCheap</span><span class="method-args">(k,v)</span>
+          <a href="#M000012" class="method-signature">
+          <span class="method-name">setCheap</span><span class="method-args">( k, v )</span>
           </a>
         </div>
       
         <div class="method-description">
-          <h2>method: <a href="Sadie.html#M000007">setCheap</a></h2>
+          <h2>method: <a href="Sadie.html#M000012">setCheap</a></h2>
 <p>
 the cheap setter. key, value pairs stored via this method are kept in
 memory
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000007-source">
+            onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000012-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/sadie.rb, line 163</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setCheap</span>(<span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span>)
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 253</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setCheap</span>( <span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span> )
         
         <span class="ruby-comment cmt"># set it, mark not expensive and primed</span>
         <span class="ruby-identifier">_set</span>( <span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span> )
@@ -484,6 +648,43 @@ memory
         </div>
       </div>
 
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+
+        <div class="method-heading">
+          <a href="#M000006" class="method-signature">
+          <span class="method-name">setDestructOnGet</span><span class="method-args">( key, turnon=true )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <h2>method: <a href="Sadie.html#M000006">setDestructOnGet</a></h2>
+<pre>
+   key value will go away and key will be unprimed and unset after next get
+
+   NOTE: this doesn't make sense with keys that were set via setExpensive
+         so it can be set, but nothing's going to happen differently
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000006-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 198</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setDestructOnGet</span>( <span class="ruby-identifier">key</span>, <span class="ruby-identifier">turnon</span>=<span class="ruby-keyword kw">true</span> )
+<span class="ruby-comment cmt">#         puts &quot;setDestructOnGet( #{key}, #{turnon} )&quot;</span>
+        <span class="ruby-keyword kw">if</span> ( <span class="ruby-identifier">turnon</span> )
+<span class="ruby-comment cmt">#             puts &quot;turning on destructOnGet for key: #{key}&quot;</span>
+            <span class="ruby-ivar">@flag_eachtimeprime</span>[<span class="ruby-node">&quot;#{key}&quot;</span>] = <span class="ruby-keyword kw">true</span>
+            <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+        <span class="ruby-keyword kw">end</span>
+        <span class="ruby-ivar">@flag_eachtimeprime</span>.<span class="ruby-identifier">has_key?</span>( <span class="ruby-identifier">key</span> ) \
+            <span class="ruby-keyword kw">and</span> <span class="ruby-ivar">@flag_eachtimeprime</span>.<span class="ruby-identifier">delete</span>( <span class="ruby-identifier">key</span> )
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
       <div id="method-M000005" class="method-detail">
         <a name="M000005"></a>
 
@@ -494,7 +695,7 @@ memory
         </div>
       
         <div class="method-description">
-          <h2>method: <a href="Sadie.html#M000007">setCheap</a></h2>
+          <h2>method: <a href="Sadie.html#M000012">setCheap</a></h2>
 <p>
 the expensive setter. key, value pairs stored via this method are not kept
 in memory but are stored to file and recalled as needed
@@ -503,7 +704,7 @@ in memory but are stored to file and recalled as needed
             onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000005-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/sadie.rb, line 144</span>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 182</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setExpensive</span>(<span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span>)
         <span class="ruby-identifier">expensive_filepath</span>              = <span class="ruby-identifier">_computeExpensiveFilepath</span>( <span class="ruby-identifier">k</span> )
         <span class="ruby-identifier">serialized_value</span>                = <span class="ruby-constant">Marshal</span><span class="ruby-operator">::</span><span class="ruby-identifier">dump</span>( <span class="ruby-identifier">v</span> )
@@ -518,6 +719,66 @@ in memory but are stored to file and recalled as needed
         </div>
       </div>
 
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+
+        <div class="method-heading">
+          <a href="#M000010" class="method-signature">
+          <span class="method-name">unprime</span><span class="method-args">( key )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <h2>method: <a href="Sadie.html#M000010">unprime</a></h2>
+<p>
+unprimes k. Note that this does not <a href="Sadie.html#M000009">unset</a>
+the value, so <a href="Sadie.html#M000004">get</a>(key) will continue to
+return whatever it otherwise would have. run <a
+href="Sadie.html#M000009">unset</a> as well to have the primer run again.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000010-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 240</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unprime</span>( <span class="ruby-identifier">key</span> )
+        <span class="ruby-identifier">_primed</span>( <span class="ruby-identifier">key</span>, <span class="ruby-keyword kw">false</span> )
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+
+        <div class="method-heading">
+          <a href="#M000009" class="method-signature">
+          <span class="method-name">unset</span><span class="method-args">( key )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <h2>method: <a href="Sadie.html#M000009">unset</a></h2>
+<p>
+unsets the value of k. Note that this does not <a
+href="Sadie.html#M000010">unprime</a>, so <a
+href="Sadie.html#M000004">get</a>(key) will simply return nil. Run with <a
+href="Sadie.html#M000010">unprime</a> to have the primer run again
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000009-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/sadie.rb, line 232</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unset</span>( <span class="ruby-identifier">key</span> )
+        <span class="ruby-identifier">_unset</span>( <span class="ruby-identifier">key</span> )
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
 
     </div>
 

data/rdoc/created.rid

@@ -1 +1 @@
-Thu, 19 Jan 2012 17:31:13 -0500
+Fri, 20 Jan 2012 01:26:54 -0500

data/rdoc/files/lib/sadie/version_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jan 19 16:26:14 -0500 2012</td>
+      <td>Thu Jan 19 22:57:21 -0500 2012</td>
     </tr>
     </table>
   </div>

data/rdoc/files/lib/sadie_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jan 19 16:25:47 -0500 2012</td>
+      <td>Fri Jan 20 01:26:13 -0500 2012</td>
     </tr>
     </table>
   </div>

data/rdoc/fr_method_index.html

@@ -21,14 +21,21 @@
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
     <a href="classes/Sadie.html#M000003">Prime (Sadie)</a><br />
+    <a href="classes/Sadie.html#M000008">_newline (Sadie)</a><br />
+    <a href="classes/Sadie.html#M000007">destructOnGet? (Sadie)</a><br />
+    <a href="classes/Sadie.html#M000016">expensive? (Sadie)</a><br />
     <a href="classes/Sadie.html#M000004">get (Sadie)</a><br />
     <a href="classes/Sadie.html#M000002">getSadieInstance (Sadie)</a><br />
     <a href="classes/Sadie.html#M000001">new (Sadie)</a><br />
-    <a href="classes/Sadie.html#M000009">revert! (Sadie)</a><br />
-    <a href="classes/Sadie.html#M000008">save (Sadie)</a><br />
-    <a href="classes/Sadie.html#M000006">set (Sadie)</a><br />
-    <a href="classes/Sadie.html#M000007">setCheap (Sadie)</a><br />
+    <a href="classes/Sadie.html#M000015">primed? (Sadie)</a><br />
+    <a href="classes/Sadie.html#M000014">revert! (Sadie)</a><br />
+    <a href="classes/Sadie.html#M000013">save (Sadie)</a><br />
+    <a href="classes/Sadie.html#M000011">set (Sadie)</a><br />
+    <a href="classes/Sadie.html#M000012">setCheap (Sadie)</a><br />
+    <a href="classes/Sadie.html#M000006">setDestructOnGet (Sadie)</a><br />
     <a href="classes/Sadie.html#M000005">setExpensive (Sadie)</a><br />
+    <a href="classes/Sadie.html#M000010">unprime (Sadie)</a><br />
+    <a href="classes/Sadie.html#M000009">unset (Sadie)</a><br />
   </div>
 </div>
 </body>

data/test/tc_sadie_toplevel.rb

@@ -16,6 +16,15 @@ class TestSadieToplevel < Test::Unit::TestCase
             
             # test top-level res
             assert_equal( sadie.get( "toplevel_single.oneprime" ), "primedit" )
+            
+            # test destruct on get
+            dog1a = sadie.get( "toplevel_destructonget.oneprime" )
+            dog2a = sadie.get( "toplevel_destructonget.twoprime" )
+            dog2b = sadie.get( "toplevel_destructonget.twoprime" )
+            sleep( 2 )
+            dog1b = sadie.get( "toplevel_destructonget.oneprime" )
+            assert_equal( dog2a, dog2b )
+            assert_not_equal( dog1a, dog1b )
         end
     end
 end

data/test/test_primers/toplevel_destructonget.res.rb

@@ -0,0 +1,11 @@
+require 'sadie'
+
+Sadie::Prime( "provides" =>     %w{ toplevel_destructonget.oneprime
+                                    toplevel_destructonget.twoprime } ) do |sadie|
+    puts "running destructonget primer..."
+    timeobj = Time.now
+    timeinsecs = timeobj.to_f
+    sadie.set( "toplevel_destructonget.oneprime", "primedthem - #{timeinsecs}" )
+    sadie.set( "toplevel_destructonget.twoprime", "primedthem" )
+    sadie.setDestructOnGet("toplevel_destructonget.oneprime")
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sadie
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Fred McDavid
@@ -29,6 +29,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG
 - Gemfile
 - LEGAL
 - LICENSE
@@ -52,8 +53,10 @@ files:
 - sadie.gemspec
 - test/tc_sadie_toplevel.rb
 - test/tc_sadie_twodeep.rb
+- test/test_primers/.toplevel_double.res.rb.kate-swp
 - test/test_primers/onedeep/multiresult.res
 - test/test_primers/toplevel.ini
+- test/test_primers/toplevel_destructonget.res.rb
 - test/test_primers/toplevel_double.res.rb
 - test/test_primers/toplevel_single.res.rb
 - test/test_primers/two/deep/conf.ini