redis-breadcrumbs 0.0.1 → 0.0.2

data/.gitignore

@@ -1 +1,4 @@
 Gemfile.lock
+pkg
+.rvmrc
+*.rdb

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm: 
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Eoin Coffey
+
+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.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/ecoffey/redis-breadcrumbs.png)](https://travis-ci.org/ecoffey/redis-breadcrumbs)
+
 ## Redis and key tracking
 
 Redis is a bit different than a lot of other "data stores". This also means that thinking about ownership management
@@ -19,13 +21,19 @@ class WorkerBreadcrumb < Redis::Breadcrumb
   owns 'resque:worker:<id>'
   owns 'resque:worker:<id>:started'
 
-  member_of_set :id => 'resque:workers'
+  member_of_set '<id>' => 'resque:workers'
 end
 ```
 
 ## Usage
 
-No release yet :)
+Either
+
+`gem install redis-breadcrumbs`
+
+or add the following to your Gemfile
+
+`gem "redis-breadcrumbs", "~> 0.0.1"`
 
 ## Contributing
 

data/lib/redis-breadcrumbs/breadcrumb.rb

@@ -1,35 +1,46 @@
-module Redis
+require 'redis-breadcrumbs/dsl'
+require 'redis-breadcrumbs/keys'
+
+class Redis
   class Breadcrumb
-    class << self
-      attr_accessor :owned_keys
+    include Breadcrumbs::Dsl
 
-      def redis
-       @@redis
-      end
+    attr_reader :tracked_in
 
-      def redis= redis
-        @@redis = redis
-      end
+    def initialize object
+      @tracked_in = self.class.tracked_in_key.specialize(object).to_s
+      @keys = self.class.keys.specialize object
+    end
 
-      def tracked_in *args
-        args.length > 0 ? @tracked_in = args[0] : @tracked_in
-      end
+    def track!
+      return if @tracked_in.nil? || @tracked_in == ""
 
-      def owns key
-        (@owned_keys ||= []) << key
-      end
+      jsons = @keys.clean_cmds.map(&:to_json)
+
+      redis.sadd @tracked_in, jsons
+    end
+
+    def clean!
+      cmds = Set.new tracked_keys.concat(@keys.clean_cmds)
 
-      def register
-        @owned_keys.each do |key|
-          redis.sadd @tracked_in, [:del, key].to_json
-        end
+      cmds.each do |cmd_tuple|
+        cmd = cmd_tuple[0]
+        args = cmd_tuple[1..-1]
+        redis.send cmd, *args
       end
+    end
 
-      def tracked_keys
-        redis.smembers(@tracked_in).map do |json|
-          JSON.parse(json)
-        end
+    def tracked_keys
+      redis.smembers(@tracked_in).map do |json|
+        JSON.parse(json)
       end
     end
+
+    private
+
+    def redis
+      self.class.redis
+    end
+
   end
 end

data/lib/redis-breadcrumbs/dsl.rb

@@ -0,0 +1,86 @@
+require 'redis-breadcrumbs/keys'
+
+class BreadcrumbSpecializationError < Exception; end
+
+module Breadcrumbs
+  module Dsl
+
+    class UnspecializedDummyObject
+      instance_methods.each do |m|
+        undef_method m unless m =~ /^(__|object_id|instance_eval)/
+      end
+
+      def method_missing method, *args
+        raise BreadcrumbSpecializationError, "#{method}"
+      end
+
+      def respond_to? *args; false; end
+    end
+
+    def self.included subclass
+      subclass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def redis
+        @@redis
+      end
+
+      def redis= redis
+        if defined?(Redis::Namespace) && redis.is_a?(Redis::Namespace)
+          redis = redis.redis # yo dawg
+        end
+
+        @@redis = redis
+      end
+
+      def tracked_in *args
+        args.length > 0 ? @tracked_in = args[0] : @tracked_in
+      end
+
+      def tracked_in_key
+        Key.new tracked_in
+      end
+
+      def owns key
+        owned_keys << key
+        keys << OwnedKey.new(key)
+      end
+
+      def member_of_set member_to_set
+        member = member_to_set.keys[0]
+        set = member_to_set[member]
+
+        member_of_sets << [member, set]
+        keys << MemberOfSetKey.new(member, set, :srem)
+      end
+
+      def track! object=UnspecializedDummyObject.new
+        new(object).tap(&:track!)
+      end
+
+      def clean! object=UnspecializedDummyObject.new
+        new(object).tap(&:clean!)
+      end
+
+      def tracked_keys
+        redis.smembers(@tracked_in).map do |json|
+          JSON.parse(json)
+        end
+      end
+
+      def keys
+        @keys ||= Keys.new
+      end
+
+      def owned_keys
+        @owned_keys ||= []
+      end
+
+      def member_of_sets
+        @member_of_sets ||= []
+      end
+    end
+
+  end
+end

data/lib/redis-breadcrumbs/key.rb

@@ -0,0 +1,40 @@
+module Breadcrumbs
+  class Key
+    def initialize key_template
+      @key_template = key_template.to_s
+    end
+
+    def specialize object
+      Key.new specialize_from_template(@key_template, object)
+    end
+
+    def clean_cmd
+      raise "Can't clean this key #{@key_template}"
+    end
+
+    def to_s
+      @key_template
+    end
+
+    protected
+
+    TEMPLATE_REGEX = /(<\w+>)/
+
+    def specialize_from_template template, object
+      matches = TEMPLATE_REGEX.match template.to_s
+
+      return template if matches.nil?
+
+      specialized = template.dup
+
+      matches.captures.each do |method_marker|
+        method = method_marker[1..-2].to_sym
+
+        specialized.gsub! method_marker, object.send(method)
+      end
+
+      specialized
+    end
+  end
+
+end

data/lib/redis-breadcrumbs/keys.rb

@@ -0,0 +1,26 @@
+require 'redis-breadcrumbs/key'
+require 'redis-breadcrumbs/owned_key'
+require 'redis-breadcrumbs/member_of_set_key'
+
+module Breadcrumbs
+  class Keys
+    def initialize keys=[]
+      @keys = keys
+    end
+
+    def << key
+      @keys << key
+    end
+
+    def specialize object
+      Keys.new(@keys.map do |key|
+        key.specialize object
+      end)
+    end
+
+    def clean_cmds
+      @keys.map &:clean_cmd
+    end
+  end
+
+end

data/lib/redis-breadcrumbs/member_of_set_key.rb

@@ -0,0 +1,22 @@
+module Breadcrumbs
+  class MemberOfSetKey < Key
+    def initialize member_template, set_template, clean_method
+      @member_template = member_template.to_s
+      @set_template = set_template.to_s
+      @clean_method = clean_method
+    end
+
+    def specialize object
+      MemberOfSetKey.new(
+        specialize_from_template(@member_template, object),
+        specialize_from_template(@set_template, object),
+        @clean_method
+      )
+    end
+
+    def clean_cmd
+      [@clean_method, @set_template, @member_template]
+    end
+  end
+
+end

data/lib/redis-breadcrumbs/owned_key.rb

@@ -0,0 +1,16 @@
+module Breadcrumbs
+  class OwnedKey < Key
+    def initialize key_template
+      @key_template = key_template.to_s
+    end
+
+    def specialize object
+      OwnedKey.new specialize_from_template(@key_template, object)
+    end
+
+    def clean_cmd
+      [:del, @key_template]
+    end
+  end
+
+end

data/lib/redis-breadcrumbs/version.rb

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

data/redis-breadcrumbs.gemspec

@@ -18,8 +18,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency "json"
+  s.add_dependency "redis"
+
   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"
+  s.add_development_dependency "redis-namespace", "~> 1.2"
 end

data/test/cleaning_test.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+
+describe 'Redis::Breadcrumb' do
+  before do
+    Redis::Breadcrumb.redis = MockRedis.new
+  end
+
+  it 'will clean up currently defined keys' do
+    class CleanUpCurrentKeys < Redis::Breadcrumb
+      owns :a_key
+    end
+
+    CleanUpCurrentKeys.redis.set 'a_key', 'hello'
+
+    assert_equal 'hello', CleanUpCurrentKeys.redis.get('a_key')
+
+    CleanUpCurrentKeys.clean!
+
+    assert_nil CleanUpCurrentKeys.redis.get('a_key')
+  end
+
+  it 'will raise if no object given for specialized template' do
+    class UnspecializedCleanKeys < Redis::Breadcrumb
+      owns 'widget:<id>'
+    end
+
+    assert_raises BreadcrumbSpecializationError do
+      UnspecializedCleanKeys.clean!
+    end
+  end
+
+  it 'will clean up currently defined specialized keys' do
+    class CleanUpCurrentSpecializedKeys < Redis::Breadcrumb
+      owns 'widget:<id>'
+    end
+
+    obj = Object.new
+    class << obj
+      def id; 'foo'; end
+    end
+
+    CleanUpCurrentSpecializedKeys.redis.set 'widget:foo', 'yarg'
+
+    assert_equal 'yarg', CleanUpCurrentSpecializedKeys.redis.get('widget:foo')
+
+    CleanUpCurrentSpecializedKeys.clean! obj
+
+    assert_nil CleanUpCurrentSpecializedKeys.redis.get('widget:foo')
+  end
+
+  it 'will clean up previously tracked and current keys' do
+    class CleanUpPrevAndCurrentKeys < Redis::Breadcrumb
+      tracked_in 'widget:<id>:tracking'
+
+      owns 'widget:<id>'
+
+      member_of_set '<id>' => 'widgets'
+    end
+
+    obj = Object.new
+    class << obj
+      def id; 'foo'; end
+    end
+
+    CleanUpPrevAndCurrentKeys.redis.sadd 'widget:foo:tracking', [:del, 'widget:foo:blah'].to_json
+
+    CleanUpPrevAndCurrentKeys.redis.set 'widget:foo', 'hello'
+    CleanUpPrevAndCurrentKeys.redis.set 'widget:foo:blah', 'world'
+    CleanUpPrevAndCurrentKeys.redis.sadd 'widgets', 'foo'
+
+    CleanUpPrevAndCurrentKeys.clean! obj
+
+    assert_nil CleanUpPrevAndCurrentKeys.redis.get('widget:foo')
+    assert_nil CleanUpPrevAndCurrentKeys.redis.get('widget:foo:blah')
+    refute CleanUpPrevAndCurrentKeys.redis.sismember('widgets', 'foo')
+  end
+end

data/test/dsl_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+describe 'Redis::Breadcrumb' do
+  class DslBreadcrumb < Redis::Breadcrumb
+    tracked_in 'tracking_key'
+
+    owns :a_owned_key
+
+    member_of_set :id => :a_set_of_things
+  end
+
+  before do
+    redis = MockRedis.new
+
+    Redis::Breadcrumb.redis = redis
+  end
+
+  it 'will unwrap a RedisNamespace to the "raw" client' do
+    require 'redis-namespace'
+
+    redis = MockRedis.new
+    rn = Redis::Namespace.new :namespaced, :redis => redis
+
+    Redis::Breadcrumb.redis = rn
+
+    Redis::Breadcrumb.redis.set 'blah', 1
+
+    assert_nil redis.get('namespaced:blah')
+    assert_equal "1", redis.get('blah')
+  end
+
+  it 'can record a key to track in' do
+    assert_equal 'tracking_key', DslBreadcrumb.tracked_in
+  end
+
+  it 'can own a key' do
+    assert_equal [:a_owned_key], DslBreadcrumb.owned_keys
+  end
+
+  it 'can be a member of a set' do
+    assert_equal [[:id, :a_set_of_things]], DslBreadcrumb.member_of_sets
+  end
+
+  it 'tracks keys for each class' do
+    class Test2Breadcrumb < Redis::Breadcrumb
+      tracked_in 'different_tracking_key'
+
+      owns :a_different_key
+    end
+
+    refute_equal DslBreadcrumb.owned_keys, Test2Breadcrumb.owned_keys
+  end
+
+end

data/test/tracking_test.rb

@@ -0,0 +1,80 @@
+require 'test_helper'
+
+describe 'Redis::Breadcrumb' do
+  before do
+    Redis::Breadcrumb.redis = MockRedis.new
+  end
+
+  it 'can track tracked keys in tracked_in' do
+    class TrackedInBreadcrumb < Redis::Breadcrumb
+      tracked_in 'tracking_key'
+
+      owns :a_owned_key
+
+      member_of_set :id => :a_set_of_things
+    end
+
+    TrackedInBreadcrumb.track!
+
+    assert_equal [
+      ["srem", "a_set_of_things", "id"],
+      ["del", "a_owned_key"]
+    ].sort, TrackedInBreadcrumb.tracked_keys.sort
+  end
+
+  it 'tracked_in can be optional' do
+    class NoTrackedInBreadcrumb < Redis::Breadcrumb
+      owns :a_key
+    end
+
+    NoTrackedInBreadcrumb.track!
+
+    assert_equal [], NoTrackedInBreadcrumb.redis.keys('*')
+  end
+
+  it 'will raise if no object given for specialized template' do
+    class UnspecializedBreadcrumb < Redis::Breadcrumb
+      tracked_in 'tracking_key'
+
+      owns 'a_special_<id>_key'
+    end
+
+    assert_raises BreadcrumbSpecializationError do
+      UnspecializedBreadcrumb.track!
+    end
+  end
+
+  it 'can track owned keys for a specific object' do
+    class OwnedBreadcrumb < Redis::Breadcrumb
+      tracked_in 'widget:<id>:tracking'
+
+      owns 'widget:<id>'
+    end
+
+    obj = Object.new
+    class << obj
+      def id; "foo"; end
+    end
+
+    breadcrumb = OwnedBreadcrumb.track!(obj)
+
+    assert_equal [["del", "widget:foo"]], breadcrumb.tracked_keys
+  end
+
+  it 'can track member of set keys for a specific object' do
+    class MemberOfSetBreadcrumb < Redis::Breadcrumb
+      tracked_in 'widget:<id>:tracking'
+
+      member_of_set "<id>" => :a_set_of_things
+    end
+
+    obj = Object.new
+    class << obj
+      def id; "foo"; end
+    end
+
+    breadcrumb = MemberOfSetBreadcrumb.track!(obj)
+
+    assert_equal [["srem", "a_set_of_things", "foo"]], breadcrumb.tracked_keys
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-breadcrumbs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,40 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-19 00:00:00.000000000 Z
+date: 2012-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.2
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +91,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Inherit from Redis::Breadcrumb to get going!
 email:
 - ecoffey@gmail.com
@@ -83,16 +115,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
+- .travis.yml
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/redis-breadcrumbs.rb
 - lib/redis-breadcrumbs/breadcrumb.rb
+- lib/redis-breadcrumbs/dsl.rb
+- lib/redis-breadcrumbs/key.rb
+- lib/redis-breadcrumbs/keys.rb
+- lib/redis-breadcrumbs/member_of_set_key.rb
+- lib/redis-breadcrumbs/owned_key.rb
 - lib/redis-breadcrumbs/version.rb
 - redis-breadcrumbs.gemspec
-- test/breadcrumb_test.rb
+- test/cleaning_test.rb
+- test/dsl_test.rb
 - test/test_helper.rb
+- test/tracking_test.rb
 homepage: https://github.com/ecoffey/redis-breadcrumbs
 licenses: []
 post_install_message: 
@@ -107,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3876120171022687880
+      hash: -4237510823449836628
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -116,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3876120171022687880
+      hash: -4237510823449836628
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -124,5 +164,7 @@ signing_key:
 specification_version: 3
 summary: A friendly DSL for tracking and cleaning up redis keys.
 test_files:
-- test/breadcrumb_test.rb
+- test/cleaning_test.rb
+- test/dsl_test.rb
 - test/test_helper.rb
+- test/tracking_test.rb

data/.rvmrc

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

data/test/breadcrumb_test.rb

@@ -1,40 +0,0 @@
-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