rrlist 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/
+.yardoc/
+.rspec

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rrlist.gemspec
+gemspec
+

data/README.md

@@ -0,0 +1,158 @@
+# RRList
+
+[Docs](http://rubydoc.info/github/fddayan/rrlist/master/frames)
+
+Inspired by `RRDTool`
+
+Basically, you can add elements to a list, but the sizes remains constant over time.
+
+If you add an element to to the list that is out of the range, moves the cursor forward and items at the lower indexes are lost.
+
+For example with a list of size 5:
+
+    [1,2,3,4,5]
+    add 6
+    [2,3,4,5,6]
+    add 7
+    [3,4,5,6,7]
+    add 20
+    [nil,nil,nil,nil,20]
+
+Install
+========
+
+    gem install rrlist
+
+or
+
+    gem 'rrlist'
+
+or
+
+    git clone ...
+    rake install
+
+Usage
+======
+
+```ruby
+    require 'rrlist'
+```
+
+*Basic manipulation*
+
+```ruby
+    rrlist = RRList::List.new :size => 10
+
+    rrlist.values #=> [nil, nil, nil, nil, nil, nil, nil, nil, nil, nil]
+
+    1.upto(100) { |n| rrlist.add(n) }
+
+    rrlist.values     #=> [91, 92, 93, 94, 95, 96, 97, 98, 99, 100]
+    rrlist.min_index  #=> 91
+    rrlist.min_index  #=> 100
+    rrlist.get(93)    #=> 93
+
+    rrlist.add(101)
+
+    rrlist.values     #=> [92, 93, 94, 95, 96, 97, 98, 99, 100, 101]
+    rrlist.min_index  #=> 92
+    rrlist.min_index  #=> 101
+
+    rrlist.add("any object")
+
+    rrlist.values     #=> [93, 94, 95, 96, 97, 98, 99, 100, 101, "any object"]
+    rrlist.min_index  #=> 93
+    rrlist.min_index  #=> 102
+
+    rrlist.add_at 105, "A"
+    rrlist.values     #=> [96, 97, 98, 99, 100, 101, "any object", nil, nil, "A"]
+    rrlist.min_index  #=> 96
+    rrlist.max_index  #=> 105
+
+    rrlist.add_at 2000,"B"
+    rrlist.add_at 105, "A"
+    rrlist.values         #=> [nil, nil, nil, nil, nil, nil, nil, nil, nil, "B"]
+    rrlist.min_index      #=> 1991
+    rrlist.max_index      #=> 2000
+```
+
+*Looping*
+
+```ruby
+    rrlist = RRList::List.new :size => 10
+
+    1.upto(100) { |n| rrlist.add(n) }
+
+    rrlist.each {  |value| ... }
+    rrlist.each_with_index {  |value,index| puts "#{value} #{index}" }
+    # => 91 91
+    # => 92 92
+    ....
+```
+
+*Ranges*
+
+A range of indexs grouped in the same position.
+For a renge of 3 for indexes 0,1,2 the value goes in position 1
+
+```ruby
+    rrlist = RRList::List.new :size => 10, :range => 3
+
+    rrlist.add_at 0, 0
+    rrlist.values         #=> [0, nil, nil, nil, nil, nil, nil, nil, nil, nil]
+    rrlist.add_at 1, 1
+    rrlist.values         #=> [1, nil, nil, nil, nil, nil, nil, nil, nil, nil]
+    rrlist.add_at 2, 2
+    rrlist.values         #=> [2, nil, nil, nil, nil, nil, nil, nil, nil, nil]
+    rrlist.add_at 3, 3
+    rrlist.values         #=> [2, 3, nil, nil, nil, nil, nil, nil, nil, nil]
+    rrlist.add_at 4, 4
+    rrlist.values         #=> [2, 4, nil, nil, nil, nil, nil, nil, nil, nil]
+    rrlist.add_at 5, 5
+    rrlist.values         #=> [2, 5, nil, nil, nil, nil, nil, nil, nil, nil]
+
+    rrlist = RRList::List.new :size => 10, :range => 5
+
+    0.upto(100) { |n| rrlist.add(n) }
+
+    rrlist.values     #=> [59, 64, 69, 74, 79, 84, 89, 94, 99, 100]
+    rrlist.min_index  #=> 55
+    rrlist.max_index  #=> 100
+```
+
+*Functions*
+
+To sum all the values added to a range
+
+```ruby
+    rrlist = RRList::List.new :size => 10, :range => 5 do |index, old_value, new_value|
+      (old_value||0) + new_value
+    end
+
+    0.upto(100) { |n| rrlist.add(n) }
+
+    rrlist.values     #=> [285, 310, 335, 360, 385, 410, 435, 460, 485, 100]
+    rrlist.min_index  #=> 55
+    rrlist.max_index  #=> 100
+```
+
+*Array API*
+
+```ruby
+    rrlist = RRList::List.new :size => 10
+
+    rrlist.values   #=> [nil, nil, nil, nil, nil, nil, nil, nil, nil, nil]
+
+    rrlist[1]="a"
+    rrlist.values   #=> [nil, "a", nil, nil, nil, nil, nil, nil, nil, nil]
+    rrlist[1]       #=> "a"
+
+    rrlist[2]="b"
+    rrlist.values   #=> [nil, "a", "b", nil, nil, nil, nil, nil, nil, nil]
+    rrlist[2]       #=> "b"
+
+    rrlist << "c"
+    rrlist.values   #=> [nil, "a", "b", "c", nil, nil, nil, nil, nil, nil]
+    rrlist[3]       #=> "c"
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/doc/RRArchive.html

@@ -0,0 +1,555 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: RRArchive
+  
+    &mdash; Documentation by YARD 0.8.6.1
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (R)</a> &raquo;
+    
+    
+    <span class="title">RRArchive</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: RRArchive
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">RRArchive</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/rrlist/rrarchive.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>
+Why do I need this class? What the purpose of this? Decorate RRList and add
+flush ? Is in it better to pass a DiskArray object to RRlist and call flush
+outisde RRList? <&#8212; Perhaps made RRArchive be a RRListComposite that
+olds many RRList and controls the LifeCycle of Flush, SerDi and before_add
+?
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="DEFAULT_SERDI_STRATEGY-constant" class="">DEFAULT_SERDI_STRATEGY =
+          
+        </dt>
+        <dd><pre class="code"><span class='const'>Marshal</span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#load-class_method" title="load (class method)">+ (Object) <strong>load</strong>(filename, options = {}) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></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-instance_method" title="#add (instance method)">- (Object) <strong>add</strong>(value) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#add_at-instance_method" title="#add_at (instance method)">- (Object) <strong>add_at</strong>(index, value) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#flush-instance_method" title="#flush (instance method)">- (Object) <strong>flush</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (RRArchive) <strong>initialize</strong>(filename, options) </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+A new instance of RRArchive.
+</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#rr_list-instance_method" title="#rr_list (instance method)">- (Object) <strong>rr_list</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    - (<tt><span class='object_link'><a href="" title="RRArchive (class)">RRArchive</a></span></tt>) <strong>initialize</strong>(filename, options) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>
+A new instance of RRArchive
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+25
+26
+27
+28
+29</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrlist/rrarchive.rb', line 25</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+  <span class='ivar'>@rr_list</span> <span class='op'>=</span> <span class='const'>RRList</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_options'>options</span>
+  <span class='ivar'>@filename</span> <span class='op'>=</span> <span class='id identifier rubyid_filename'>filename</span>
+  <span class='ivar'>@strategy</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:strategy</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>DEFAULT_SERDI_STRATEGY</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="load-class_method">
+  
+    + (<tt>Object</tt>) <strong>load</strong>(filename, options = {}) 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrlist/rrarchive.rb', line 12</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span><span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_strategy'>strategy</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:strategy</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>DEFAULT_SERDI_STRATEGY</span>
+
+  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_strategy'>strategy</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>r</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='rparen'>)</span>
+
+  <span class='const'>RRArchive</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span>
+    <span class='symbol'>:size</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:size</span><span class='rbracket'>]</span><span class='comma'>,</span>
+    <span class='symbol'>:range</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:range</span><span class='rbracket'>]</span><span class='comma'>,</span>
+    <span class='symbol'>:values</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:values</span><span class='rbracket'>]</span><span class='comma'>,</span>
+    <span class='symbol'>:position</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:position</span><span class='rbracket'>]</span><span class='comma'>,</span>
+    <span class='symbol'>:overal_position</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:overal_position</span><span class='rbracket'>]</span><span class='comma'>,</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="add-instance_method">
+  
+    - (<tt>Object</tt>) <strong>add</strong>(value) 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+35
+36
+37</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrlist/rrarchive.rb', line 35</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
+  <span class='ivar'>@rr_list</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="add_at-instance_method">
+  
+    - (<tt>Object</tt>) <strong>add_at</strong>(index, value) 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrlist/rrarchive.rb', line 31</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_add_at'>add_at</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='comma'>,</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
+  <span class='ivar'>@rr_list</span><span class='period'>.</span><span class='id identifier rubyid_add_at'>add_at</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='comma'>,</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="flush-instance_method">
+  
+    - (<tt>Object</tt>) <strong>flush</strong> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrlist/rrarchive.rb', line 43</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_flush'>flush</span>
+  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span>
+    <span class='label'>size:</span> <span class='id identifier rubyid_rr_list'>rr_list</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span><span class='comma'>,</span>
+    <span class='label'>range:</span> <span class='id identifier rubyid_rr_list'>rr_list</span><span class='period'>.</span><span class='id identifier rubyid_range'>range</span><span class='comma'>,</span>
+    <span class='label'>values:</span><span class='id identifier rubyid_rr_list'>rr_list</span><span class='period'>.</span><span class='id identifier rubyid_raw_values'>raw_values</span><span class='comma'>,</span>
+    <span class='label'>position:</span> <span class='id identifier rubyid_rr_list'>rr_list</span><span class='period'>.</span><span class='id identifier rubyid_position'>position</span><span class='comma'>,</span>
+    <span class='label'>overal_position:</span> <span class='id identifier rubyid_rr_list'>rr_list</span><span class='period'>.</span><span class='id identifier rubyid_overal_position'>overal_position</span>
+  <span class='rbrace'>}</span>
+
+  <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='ivar'>@filename</span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>w</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>  <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span>
+    <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='ivar'>@strategy</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="rr_list-instance_method">
+  
+    - (<tt>Object</tt>) <strong>rr_list</strong> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+39
+40
+41</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrlist/rrarchive.rb', line 39</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_rr_list'>rr_list</span>
+  <span class='ivar'>@rr_list</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+    <div id="footer">
+  Generated on Mon May 27 09:26:44 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.6.1 (ruby-1.9.2).
+</div>
+
+  </body>
+</html>