redis-breadcrumbs 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@redis-breadcrumbs --create

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+## Redis and key tracking
+
+Redis is a bit different than a lot of other "data stores". This also means that thinking about ownership management
+is a little bit different in redis.
+
+Typically one domain "concept" will have different relationships with multiple keys.
+
+Take Resque for example. A individual worker in Resque interacts with the following keys:
+
+* The worker id is a member of `resque:workers`
+* It creates `resque:worker:<id>` and `resque:worker:<id>:started`
+
+When the worker shuts down it must remove its id from `resque:workers` and delete the other two keys.
+
+With breadcrumbs you could describe those relationships thusly:
+
+```ruby
+class WorkerBreadcrumb < Redis::Breadcrumb
+  owns 'resque:worker:<id>'
+  owns 'resque:worker:<id>:started'
+
+  member_of_set :id => 'resque:workers'
+end
+```
+
+## Usage
+
+No release yet :)
+
+## Contributing
+
+1. Fork it.
+2. Create a branch (`git checkout -b my_awesome_branch`)
+3. Commit your changes (`git commit -am "Added some magic"`)
+4. Push to the branch (`git push origin my_awesome_branch`)
+5. Send pull request

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler"
+  exit -1
+end
+
+require 'bundler/gem_tasks'
+
+$LOAD_PATH.unshift 'lib'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.verbose = true
+  test.libs << "test"
+  test.libs << "lib"
+  test.test_files = FileList['test/**/*_test.rb']
+end
+task :default => :test

data/lib/redis-breadcrumbs.rb

@@ -0,0 +1,3 @@
+require 'json'
+
+require 'redis-breadcrumbs/breadcrumb'

data/lib/redis-breadcrumbs/breadcrumb.rb

@@ -0,0 +1,35 @@
+module Redis
+  class Breadcrumb
+    class << self
+      attr_accessor :owned_keys
+
+      def redis
+       @@redis
+      end
+
+      def redis= redis
+        @@redis = redis
+      end
+
+      def tracked_in *args
+        args.length > 0 ? @tracked_in = args[0] : @tracked_in
+      end
+
+      def owns key
+        (@owned_keys ||= []) << key
+      end
+
+      def register
+        @owned_keys.each do |key|
+          redis.sadd @tracked_in, [:del, key].to_json
+        end
+      end
+
+      def tracked_keys
+        redis.smembers(@tracked_in).map do |json|
+          JSON.parse(json)
+        end
+      end
+    end
+  end
+end

data/lib/redis-breadcrumbs/version.rb

@@ -0,0 +1,3 @@
+module RedisBreadcrumbs
+  VERSION = "0.0.1"
+end

data/redis-breadcrumbs.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "redis-breadcrumbs/version"
+
+Gem::Specification.new do |s|
+  s.name        = "redis-breadcrumbs"
+  s.version     = RedisBreadcrumbs::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Eoin Coffey']
+  s.email       = ['ecoffey@gmail.com']
+  s.homepage    = "https://github.com/ecoffey/redis-breadcrumbs"
+  s.summary     = %q{A friendly DSL for tracking and cleaning up redis keys.}
+
+  s.description = %q{Inherit from Redis::Breadcrumb to get going!}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake", ">= 0.9.2"
+  s.add_development_dependency "redis", "~> 3.0.0"
+  s.add_development_dependency "minitest", "~> 4.3.2"
+  s.add_development_dependency "mock_redis", "~> 0.6"
+end

data/test/breadcrumb_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+describe 'Redis::Breadcrumb' do
+  class TestBreadcrumb < Redis::Breadcrumb
+    tracked_in 'tracking_key'
+
+    owns :a_owned_key
+  end
+
+  before do
+    redis = MockRedis.new
+
+    Redis::Breadcrumb.redis = redis
+  end
+
+  it 'can record a key to track in' do
+    assert_equal 'tracking_key', TestBreadcrumb.tracked_in
+  end
+
+  it 'can own a key' do
+    assert_equal [:a_owned_key], TestBreadcrumb.owned_keys
+  end
+
+  it 'will register tracked keys in tracked_in' do
+    TestBreadcrumb.register
+
+    assert_equal 1, Redis::Breadcrumb.redis.scard(TestBreadcrumb.tracked_in)
+    assert_equal [["del", "a_owned_key"]], TestBreadcrumb.tracked_keys
+  end
+
+  it 'tracks keys for each class' do
+    class Test2Breadcrumb < Redis::Breadcrumb
+      tracked_in 'different_tracking_key'
+
+      owns :a_different_key
+    end
+
+    refute_equal TestBreadcrumb.owned_keys, Test2Breadcrumb.owned_keys
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'mock_redis'
+require 'minitest/autorun'
+
+require 'redis-breadcrumbs'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: redis-breadcrumbs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eoin Coffey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.2
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Inherit from Redis::Breadcrumb to get going!
+email:
+- ecoffey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/redis-breadcrumbs.rb
+- lib/redis-breadcrumbs/breadcrumb.rb
+- lib/redis-breadcrumbs/version.rb
+- redis-breadcrumbs.gemspec
+- test/breadcrumb_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ecoffey/redis-breadcrumbs
+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'
+      segments:
+      - 0
+      hash: 3876120171022687880
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3876120171022687880
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A friendly DSL for tracking and cleaning up redis keys.
+test_files:
+- test/breadcrumb_test.rb
+- test/test_helper.rb