memcache_array 1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Travel IQ GmbH
+
+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.rdoc

@@ -0,0 +1,33 @@
+= MemcacheArray
+
+MemcacheArray is a wrapper for Memcache so it can be used as shared memory holding arrays.
+It is intended as a mechanism to move data from one ruby process to another.
+
+Warning: When writing to the same MemcacheArray (several instances using the same key) concurrently, there is a slim chance that writes are lost.
+The time window of this to happen is one read of a small bucket from memcache, pushing an integer into an array and writing this small array back to memcache. With a normal setup, this schould not be more than 1-2 ms.
+
+
+When creating an new instance you pass the key and optionally an instance of a memcache store. If no store is passed, Rails.cache is assumed.
+  require 'active_support'
+  require 'memcache_array'
+
+  mamcache_array = MemcacheArray.new('my_key', ActiveSupport::Cache::MemCacheStore.new)
+  mamcache_array << [1, 2, 3]
+  mamcache_array << [4, 5, 6]
+  mamcache_array.all
+  => [1, 2, 3, 1, 2, 3, 4, 5, 6]
+  mamcache_array.all(:delete => true)
+  => [1, 2, 3, 1, 2, 3, 4, 5, 6]
+  mamcache_array.all
+  => []
+
+You can also pass metadata and filter for it when accessing the data. This way you can avoid reading large buckets only to discard them later.
+  require 'active_support'
+  require 'memcache_array'
+
+  mamcache_array = MemcacheArray.new('another_key', ActiveSupport::Cache::MemCacheStore.new)
+  mamcache_array.<<([1, 3, 5], 'odd')
+  mamcache_array.<<([2, 4, 6], 'even')
+  mamcache_array.<<([7], 'odd')
+  mamcache_array.all{|meta| meta == 'odd'}
+  => [1, 3, 5, 7]

data/lib/memcache_array.rb

@@ -0,0 +1,78 @@
+class MemcacheArray
+  
+  attr_reader :key
+  
+  def initialize(key, client = nil)
+    @key = key
+    @client = client || Rails.cache
+  end
+  
+  def <<(data, metadata = nil)
+    raise ArgumentError, "You can only append arrays." unless data.is_a? Array
+    index = next_index
+    @client.write(metadata_key_with_index(index), metadata) if metadata
+    @client.write(key_with_index(index), data)
+  end
+
+  def all(options = {})
+    delete = options[:delete]
+    indices.inject([]) do |accumulator, i|
+      key = key_with_index(i)
+      include_data = 
+      if block_given?
+        metadata = @client.read(metadata_key_with_index(i))
+        metadata ? yield(metadata) : false
+      else
+        true
+      end
+      if include_data
+        value = @client.read(key)
+        delete_bucket(i) if delete
+        accumulator += value.is_a?(Array) ? value : []
+      else
+        accumulator
+      end
+    end    
+  end
+
+  def delete!
+    indices.each do |i|
+      @client.delete(key_with_index(i))
+      @client.delete(metadata_key_with_index(i))
+    end
+    @client.delete(index_key)
+  end
+  
+  def delete_bucket(index)
+    delete_index(index)
+    @client.delete(key_with_index(index))
+  end
+  
+  def next_index
+    indices_new = indices.dup || []
+    indices_new << (indices.last || -1) + 1
+    @client.write(index_key, indices_new)
+    indices.last  
+  end
+
+  def delete_index(index)
+    @client.write(index_key, (indices - [index]))    
+  end
+
+  def indices
+    @client.read(index_key) || []
+  end
+  
+  def index_key
+    "#{@key}_indices"
+  end
+    
+  def key_with_index(index)
+    "#{@key}_#{index}"
+  end
+  
+  def metadata_key_with_index(index)
+    "#{key_with_index(index)}_meta"
+  end
+  
+end

data/spec/memcache_array_spec.rb

@@ -0,0 +1,188 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'memcache_array'
+
+class MockClient < Hash
+  def read(key)
+    self[key]
+  end
+  def write(key, value)
+    self[key] = value
+  end
+end
+
+describe MemcacheArray, 'expose its key' do
+
+  it 'should expose its key' do
+    client = MockClient.new
+    array = MemcacheArray.new('the_key', client)
+    array.key.should == 'the_key'
+  end
+  
+end
+
+describe MemcacheArray, 'finding indices' do
+
+  before :each do
+    @client = MockClient.new
+    @client['the_key_indices'] = [0,1,2,3]
+    @array_few = MemcacheArray.new('the_key', @client)
+  end
+  
+  it 'should find the and lock the next index' do
+    @array_few.next_index.should == 4
+    @client['the_key_indices'].should == [0,1,2,3,4]
+  end
+  
+end
+
+describe MemcacheArray, 'deleting indices' do
+
+  before :each do
+    @client = MockClient.new
+    @client['the_key_indices'] = [0,1,2,3]
+    @array = MemcacheArray.new('the_key', @client)
+  end
+  
+  it 'should find the and lock the next index' do
+    @client.should_receive(:write).with('the_key_indices', [0, 1, 3])
+    @array.delete_index(2)
+  end
+  
+end
+
+describe MemcacheArray, 'deleting data' do
+
+  before :each do
+    @client = MockClient.new
+    @array = MemcacheArray.new('the_key', @client)
+  end
+  
+  it 'should find the and lock the next index' do
+    @array.should_receive(:delete_index).with(2)
+    @client.should_receive(:delete).with('the_key_2')
+    @array.delete_bucket(2)
+  end
+  
+end
+
+describe MemcacheArray, 'writing' do
+
+  it 'should write' do
+    client = mock('Client')
+    array = MemcacheArray.new('the_key', client)
+    array.should_receive(:next_index).and_return(4)
+    client.should_receive('write').with('the_key_4', ['the_data'])
+    array << ['the_data']
+  end
+  
+  it 'should write metadata' do
+    client = mock('Client')
+    array = MemcacheArray.new('the_key', client)
+    array.should_receive(:next_index).and_return(4)
+    client.should_receive(:write).with('the_key_4_meta', 'metadata')
+    client.should_receive(:write).with('the_key_4', ['the_data'])
+    array.<<(['the_data'], 'metadata')
+  end
+  
+  it 'should raise an error when no array is passed' do
+    client = mock('Client')
+    array = MemcacheArray.new('the_key', client)
+    lambda {array << 'lala!'}.should raise_error
+  end
+    
+end
+
+describe MemcacheArray, 'reading' do
+
+  before :each do
+    @client = MockClient.new
+    @client['the_key_indices'] = [0,1,2]
+    @client['the_key_0'] = ['null', 'zero']
+    @client['the_key_1'] = ['one']
+    @client['the_key_2'] = ['two']
+    @array = MemcacheArray.new('the_key', @client)
+  end
+  
+  it 'should read continous elements' do
+    @array.all.should == ['null', 'zero','one', 'two']
+  end
+  
+  it 'should ignore nil elements' do
+    @client['the_key_indices'] = [0,1,2,3,4,5]
+    @client['the_key_5'] = ['five']
+    @array.all.should == ['null', 'zero', 'one', 'two', 'five']
+  end
+  
+end
+
+describe MemcacheArray, 'reading with deleting' do
+
+  before :each do
+    @client = MockClient.new
+    @client['the_key_indices'] = [0,1,2]
+    @client['the_key_0'] = ['null', 'zero']
+    @client['the_key_1'] = ['one']
+    @client['the_key_2'] = ['two']
+    @array = MemcacheArray.new('the_key', @client)
+  end
+  
+  it 'should read continous elements' do
+    @array.all(:delete => true).should == ['null', 'zero','one', 'two']
+  end
+    
+  it 'should read continous elements' do
+    @client.should_receive(:delete).with('the_key_0')
+    @client.should_receive(:delete).with('the_key_1')
+    @client.should_receive(:delete).with('the_key_2')
+    @array.all(:delete => true)
+  end
+    
+end
+
+describe MemcacheArray, 'reading with metadata' do
+
+  before :each do
+    @client = MockClient.new
+    @client['the_key_indices'] = [0,1,2,3]
+    @client['the_key_0'] = ['null', 'zero']
+    @client['the_key_0_meta'] = 0
+    @client['the_key_1'] = ['one']
+    @client['the_key_1_meta'] = 1
+    @client['the_key_2'] = ['two']
+    @client['the_key_2_meta'] = 2
+    @client['the_key_3'] = ['three']
+    @array = MemcacheArray.new('the_key', @client)
+  end
+  
+  it 'should respect block when getting elements' do
+    @array.all{|m| m > 0}.should == ['one', 'two']
+  end
+  
+end
+
+describe MemcacheArray, 'deleting with metadata' do
+
+  before :each do
+    @client = MockClient.new
+    @client['the_key_indices'] = [0,1,2]
+    @client['the_key_0'] = ['null', 'zero']
+    @client['the_key_0_meta'] = 0
+    @client['the_key_1'] = ['one']
+    @client['the_key_1_meta'] = 1
+    @client['the_key_2'] = ['two']
+    @client['the_key_2_meta'] = 2
+    @array = MemcacheArray.new('the_key', @client)
+  end
+  
+  it 'should delete all data' do
+    @client.should_receive(:delete).with('the_key_0')
+    @client.should_receive(:delete).with('the_key_1')
+    @client.should_receive(:delete).with('the_key_2')
+    @client.should_receive(:delete).with('the_key_0_meta')
+    @client.should_receive(:delete).with('the_key_1_meta')
+    @client.should_receive(:delete).with('the_key_2_meta')
+    @client.should_receive(:delete).with('the_key_indices')
+    @array.delete!
+  end
+  
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: memcache_array
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Florian Odronitz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: odo@mac.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- LICENSE
+- lib/memcache_array.rb
+- spec/memcache_array_spec.rb
+has_rdoc: true
+homepage: http://github.com/traveliq/memcache_array
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: MemcacheArray is a wrapper for Memcache so it can be used as shared memory holding arrays.
+test_files: 
+- spec/memcache_array_spec.rb