revolver 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Michael Kohl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.markdown

@@ -0,0 +1,95 @@
+Description
+---
+
+A fixed size LIFO data structure, optionally free of duplicates. They feel a lot like arrays, but differ in some important areas like indexing. This is e.g. useful for keeping a history of recent actions.
+
+Usage
+---
+
+Create a new `Revolver`:
+
+    r = Revolver.new(3)
+    #=> #<Revolver: []>
+
+Create a `Revolver` with unique elements:
+
+    r = Revolver.new(3, true)
+    #=> #<Revolver: []>
+
+Alternatively, you can create a `Revolver` from an existing array:
+
+    Revolver.from_array([*1..3], 3)
+    #=> #<Revolver: [1, 2, 3]>
+
+You can also create a unique `Revolver` that way:
+
+    Revolver.from_array([1, 1, 3], true)
+    #=> #<Revolver: [1, 3]>
+
+Add elements:
+
+    r = Revolver.new(3).push(1).push(2).push(3)
+    #=> #<Revolver: [1, 2, 3]>
+    r.push(4)
+    #=> #<Revolver: [2, 3, 4]>
+    r << 5 << 6
+    #=> #<Revolver: [4, 5, 6]>
+
+Remove an element from the end:
+
+    r.pop
+    #=> 6
+
+Check a `Revolver`'s size:
+
+    r.size
+    #=> 2
+
+A `Revolver` can be indexed like an array:
+
+    r = Revolver.from_array([*1..5])
+    #=> #<Revolver: [1, 2, 3, 4, 5]>
+    r[4]
+    #=> 5
+
+However, indices wrap around:
+
+    r[10]
+    #=> 1
+
+This also works for negative indices:
+
+    r[-1]
+    #=> 5
+    r[-6]
+    #=> 1
+    r[-8]
+    #=> 3
+
+Finally you can get a plain array out of a `Revolver`:
+
+    r.to_a
+    #=> [1, 2, 3, 4, 5]
+
+License
+---
+
+Copyright (c) 2012 Michael Kohl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/revolver.rb

@@ -0,0 +1,42 @@
+class Revolver
+  def self.from_array(array, unique = false)
+    rev = Revolver.new(array.size, unique)
+    array.inject(rev) { |r, e| r << e }
+  end
+
+  def initialize(size, unique = false)
+    @array = []
+    @size = size
+    @unique = unique
+  end
+
+  def push(e)
+    @array.delete(e) if @unique
+    @array << e
+    @array.shift if @array.size > @size
+    self
+  end
+
+  def pop
+    @array.pop
+  end
+
+  def [](i)
+    @array[i % @size]
+  end
+
+  def size
+    @array.size
+  end
+
+  def to_a
+    @array
+  end
+
+  def to_s
+    "#<Revolver: #{@array.inspect}>"
+  end
+
+  alias :<< :push
+  alias :to_ary :to_a
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: revolver
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Kohl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-24 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: citizen428@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/revolver.rb
+- ./LICENSE
+- ./README.markdown
+homepage: http://citizen428.github.com/revolver/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A fixed-size LIFO data structure
+test_files: []
+has_rdoc: false