redis-breadcrumbs 0.0.2 → 0.0.3

data/.gitignore

@@ -2,3 +2,4 @@ Gemfile.lock
 pkg
 .rvmrc
 *.rdb
+.rbx

data/.travis.yml

@@ -3,7 +3,11 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - jruby-18mode
   - jruby-19mode
   - rbx-18mode
   - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Redis Breadcrumbs Changelog
+
+## 0.0.3
+
+[28 commits by 1 author](https://github.com/ecoffey/redis-breadcrumbs/compare/v0.0.2...v0.0.3)
+
+* Add ability to track sorted set membership
+  [aaa36c4](https://github.com/ecoffey/redis-breadcrumbs/commit/aaa36c4)
+  [51b46f9](https://github.com/ecoffey/redis-breadcrumbs/commit/51b46f9)
+* Introduce reseting keys
+  [bdc053b](https://github.com/ecoffey/redis-breadcrumbs/commit/bdc053b)
+  [9b863ce](https://github.com/ecoffey/redis-breadcrumbs/commit/9b863ce)
+* Introduce `as` proxy methods
+  [9485610](https://github.com/ecoffey/redis-breadcrumbs/commit/9485610)
+  [b50cee1](https://github.com/ecoffey/redis-breadcrumbs/commit/b50cee1)
+
+## 0.0.2
+
+[40 commits by 1 author](https://github.com/ecoffey/redis-breadcrumbs/compare/v0.0.1...v0.0.2)
+
+* Can be a member of a set
+  [bab7a45](https://github.com/ecoffey/redis-breadcrumbs/commit/bab7a45)
+* Add support for templating in relationship declarations
+  [63357f4](https://github.com/ecoffey/redis-breadcrumbs/commit/63357f4)
+  [579f1c7](https://github.com/ecoffey/redis-breadcrumbs/commit/579f1c7)
+  [0df0562](https://github.com/ecoffey/redis-breadcrumbs/commit/0df0562)
+* `tracked_in` is optional
+  [23b17ae](https://github.com/ecoffey/redis-breadcrumbs/commit/23b17ae)
+* Unwraps Redis::Namespace to the raw connection
+  [ddc9e3f](https://github.com/ecoffey/redis-breadcrumbs/commit/ddc9e3f)
+* Introduce cleaning up keys
+  [79b161a](https://github.com/ecoffey/redis-breadcrumbs/commit/79b161a)
+  [ff562c0](https://github.com/ecoffey/redis-breadcrumbs/commit/ff562c0)
+  [5053284](https://github.com/ecoffey/redis-breadcrumbs/commit/5053284)
+
+## 0.0.1
+
+[8 commits by 1 author](https://github.com/ecoffey/redis-breadcrumbs/compare/aa281857c04a4900e92888e276d2d777d71257ce...v0.0.1)
+
+* Added ability to track keys in redis
+  [7342aeb](https://github.com/ecoffey/redis-breadcrumbs/commit/7342aeb)
+* Added ability to own a key
+  [65b5767](https://github.com/ecoffey/redis-breadcrumbs/commit/65b5767)

data/README.md

@@ -25,7 +25,7 @@ class WorkerBreadcrumb < Redis::Breadcrumb
 end
 ```
 
-## Usage
+## Installation
 
 Either
 
@@ -33,7 +33,50 @@ Either
 
 or add the following to your Gemfile
 
-`gem "redis-breadcrumbs", "~> 0.0.1"`
+`gem "redis-breadcrumbs", "~> 0.0.3"`
+
+## Usage
+
+Create your breadcrumb; we'll continue with the Resque example:
+
+```ruby
+class WorkerBreadcrumb < Redis::Breadcrumb
+  owns 'resque:worker:<id>'
+  owns 'resque:worker:<id>:started'
+
+  member_of_set '<id>' => 'resque:workers'
+end
+```
+
+Keys that have `<...>` snippets in them are **templates**.  When you call `track!` or `clean!`,
+the Breadcrumb will expect an object that responds to symbols in between the brackets.
+
+You can also specify a key to track keys in with `tracked_in 'resque:worker:<id>:tracking'`
+
+Using `tracked_in` will let your breadcrumb remember how to clean up keys that are not currently
+defined in the class (because of code changes, etc).
+
+Breadcrumb also needs to be told about a redis connection:
+
+```ruby
+# Breadcrumb always operates on the 'raw' client,
+# so it will 'unwrap' Redis::Namespace
+
+Redis::Breadcrumb.redis = Resque.redis
+```
+
+When you're ready to start tracking keys (say after the worker finished booting) you can
+do:
+
+```ruby
+WorkerBreadcrumb.track!(self)
+```
+
+And when you're ready to clean up keys (say when working is shutting down, or in a clean up rake task)
+
+```ruby
+WorkerBreadcrumb.clean!(self)
+```
 
 ## Contributing
 

data/TODO.txt

@@ -0,0 +1 @@
+prefix namespace

data/lib/redis-breadcrumbs/as_methods.rb

@@ -0,0 +1,20 @@
+require 'redis-breadcrumbs/key_proxy'
+
+module Breadcrumbs
+  module AsMethods
+
+    def self.included subclass
+      subclass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def create_as_method key_template, as
+        instance_eval do
+          define_method as.to_sym do
+            KeyProxy.new(self.class.keys[key_template], redis)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redis-breadcrumbs/breadcrumb.rb

@@ -1,13 +1,24 @@
 require 'redis-breadcrumbs/dsl'
+require 'redis-breadcrumbs/as_methods'
+require 'redis-breadcrumbs/entrance'
 require 'redis-breadcrumbs/keys'
+require 'redis-breadcrumbs/unspecialized_dummy_object'
 
 class Redis
   class Breadcrumb
     include Breadcrumbs::Dsl
+    include Breadcrumbs::AsMethods
+    include Breadcrumbs::Entrance
+
+    class << self
+      def method_missing mthd, *args
+        new.send(mthd)
+      end
+    end
 
     attr_reader :tracked_in
 
-    def initialize object
+    def initialize object=Breadcrumbs::UnspecializedDummyObject.new
       @tracked_in = self.class.tracked_in_key.specialize(object).to_s
       @keys = self.class.keys.specialize object
     end
@@ -20,14 +31,12 @@ class Redis
       redis.sadd @tracked_in, jsons
     end
 
-    def clean!
-      cmds = Set.new tracked_keys.concat(@keys.clean_cmds)
+    def reset!
+      run_cmds @keys.reset_cmds
+    end
 
-      cmds.each do |cmd_tuple|
-        cmd = cmd_tuple[0]
-        args = cmd_tuple[1..-1]
-        redis.send cmd, *args
-      end
+    def clean!
+      run_cmds Set.new(tracked_keys.concat(@keys.clean_cmds))
     end
 
     def tracked_keys
@@ -42,5 +51,13 @@ class Redis
       self.class.redis
     end
 
+    def run_cmds cmds
+      cmds.each do |cmd_tuple|
+        cmd = cmd_tuple[0]
+        args = cmd_tuple[1..-1]
+        redis.send cmd, *args
+      end
+    end
+
   end
 end

data/lib/redis-breadcrumbs/dsl.rb

@@ -1,22 +1,8 @@
 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
@@ -42,27 +28,25 @@ module Breadcrumbs
         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]
+      def owns key_template, options={}
+        owned_keys << key_template
+        as = options.delete(:as)
+        key = OwnedKey.new key_template, options
+        keys[key_template] = OwnedKey.new(key_template, options)
 
-        member_of_sets << [member, set]
-        keys << MemberOfSetKey.new(member, set, :srem)
+        create_as_method key_template, as unless as.nil?
       end
 
-      def track! object=UnspecializedDummyObject.new
-        new(object).tap(&:track!)
+      def member_of_set options
+        add_member_of_set options, member_of_sets, :srem
       end
 
-      def clean! object=UnspecializedDummyObject.new
-        new(object).tap(&:clean!)
+      def member_of_sorted_set options
+        add_member_of_set options, member_of_sorted_sets, :zrem
       end
 
+      alias :member_of_zset :member_of_sorted_set
+
       def tracked_keys
         redis.smembers(@tracked_in).map do |json|
           JSON.parse(json)
@@ -80,6 +64,23 @@ module Breadcrumbs
       def member_of_sets
         @member_of_sets ||= []
       end
+
+      def member_of_sorted_sets
+        @member_of_sorted_sets ||= []
+      end
+
+      private
+
+      def add_member_of_set options, specific_keys, clean_cmd
+        member_to_set = Hash[[options.to_a.shift]]
+
+        member = member_to_set.keys[0]
+        set = member_to_set[member]
+
+        specific_keys << [member, set]
+        keys[set] = MemberOfSetKey.new(member, set, clean_cmd, options)
+      end
+
     end
 
   end

data/lib/redis-breadcrumbs/entrance.rb

@@ -0,0 +1,29 @@
+require 'redis-breadcrumbs/key_proxy'
+require 'redis-breadcrumbs/unspecialized_dummy_object'
+
+module Breadcrumbs
+  module Entrance
+
+    def self.included subclass
+      subclass.extend ClassMethods
+    end
+
+    def self.included subclass
+      subclass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def track! object=UnspecializedDummyObject.new
+        new(object).tap(&:track!)
+      end
+
+      def reset! object=UnspecializedDummyObject.new
+        new(object).tap(&:reset!)
+      end
+
+      def clean! object=UnspecializedDummyObject.new
+        new(object).tap(&:clean!)
+      end
+    end
+  end
+end

data/lib/redis-breadcrumbs/key.rb

@@ -1,7 +1,7 @@
 module Breadcrumbs
   class Key
     def initialize key_template
-      @key_template = key_template.to_s
+      @key_template = key_template
     end
 
     def specialize object
@@ -21,7 +21,8 @@ module Breadcrumbs
     TEMPLATE_REGEX = /(<\w+>)/
 
     def specialize_from_template template, object
-      matches = TEMPLATE_REGEX.match template.to_s
+      template = template.to_s
+      matches = TEMPLATE_REGEX.match template
 
       return template if matches.nil?
 

data/lib/redis-breadcrumbs/key_proxy.rb

@@ -0,0 +1,12 @@
+module Breadcrumbs
+  class KeyProxy
+    def initialize key, redis
+      @key = key
+      @redis = redis
+    end
+
+    def method_missing mthd, *args
+      @redis.send(mthd, *([@key.key_name] + args))
+    end
+  end
+end

data/lib/redis-breadcrumbs/keys.rb

@@ -4,22 +4,30 @@ require 'redis-breadcrumbs/member_of_set_key'
 
 module Breadcrumbs
   class Keys
-    def initialize keys=[]
+    def initialize keys={}
       @keys = keys
     end
 
-    def << key
-      @keys << key
+    def [] key_template
+      @keys[key_template]
+    end
+
+    def []= key_template, key
+      @keys[key_template] = key
     end
 
     def specialize object
-      Keys.new(@keys.map do |key|
-        key.specialize object
-      end)
+      Keys.new(Hash[@keys.map do |(key_template, key)|
+        [key_template, key.specialize(object)]
+      end])
     end
 
     def clean_cmds
-      @keys.map &:clean_cmd
+      @keys.values.map &:clean_cmd
+    end
+
+    def reset_cmds
+      @keys.values.map(&:reset_cmd).compact
     end
   end
 

data/lib/redis-breadcrumbs/member_of_set_key.rb

@@ -1,22 +1,33 @@
 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
+    def initialize member_template, set_template, clean_method, options
+      @options = options || {}
+      @member_template = member_template
+      @set_template = set_template
       @clean_method = clean_method
+      @resetable = options[:reset]
     end
 
     def specialize object
       MemberOfSetKey.new(
         specialize_from_template(@member_template, object),
         specialize_from_template(@set_template, object),
-        @clean_method
+        @clean_method,
+        @options
       )
     end
 
     def clean_cmd
       [@clean_method, @set_template, @member_template]
     end
+
+    def reset_cmd
+      clean_cmd if @resetable
+    end
+
+    def key_name
+      @set_template
+    end
   end
 
 end

data/lib/redis-breadcrumbs/owned_key.rb

@@ -1,16 +1,26 @@
 module Breadcrumbs
   class OwnedKey < Key
-    def initialize key_template
-      @key_template = key_template.to_s
+    def initialize key_template, options
+      @options = options || {}
+      @key_template = key_template
+      @resetable = options[:reset]
     end
 
     def specialize object
-      OwnedKey.new specialize_from_template(@key_template, object)
+      OwnedKey.new specialize_from_template(@key_template, object), @options
     end
 
     def clean_cmd
       [:del, @key_template]
     end
+
+    def reset_cmd
+      clean_cmd if @resetable
+    end
+
+    def key_name
+      @key_template
+    end
   end
 
 end

data/lib/redis-breadcrumbs/unspecialized_dummy_object.rb

@@ -0,0 +1,15 @@
+class BreadcrumbSpecializationError < Exception; end
+
+module Breadcrumbs
+  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
+end

data/lib/redis-breadcrumbs/version.rb

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

data/test/as_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+describe 'Redis::Breadcrumb' do
+  before do
+    Redis::Breadcrumb.redis = MockRedis.new
+  end
+
+  it 'can access as methods directly from the breadcrumb' do
+    class DirectAsMethod < Redis::Breadcrumb
+      owns :a_key, :as => :my_key
+    end
+
+    DirectAsMethod.my_key.set 'hello'
+
+    assert_equal 'hello', DirectAsMethod.redis.get('a_key')
+  end
+
+  it 'can create a method to access the key through' do
+    class OwnedAsMethod < Redis::Breadcrumb
+      owns :a_key, :as => :my_key
+    end
+
+    OwnedAsMethod.new.my_key.set 'hello'
+
+    assert_equal 'hello', OwnedAsMethod.redis.get('a_key')
+  end
+end

data/test/dsl_test.rb

@@ -7,6 +7,7 @@ describe 'Redis::Breadcrumb' do
     owns :a_owned_key
 
     member_of_set :id => :a_set_of_things
+    member_of_zset :id => :a_sorted_set_of_things
   end
 
   before do
@@ -41,6 +42,10 @@ describe 'Redis::Breadcrumb' do
     assert_equal [[:id, :a_set_of_things]], DslBreadcrumb.member_of_sets
   end
 
+  it 'can be a member of a sorted set' do
+    assert_equal [[:id, :a_sorted_set_of_things]], DslBreadcrumb.member_of_sorted_sets
+  end
+
   it 'tracks keys for each class' do
     class Test2Breadcrumb < Redis::Breadcrumb
       tracked_in 'different_tracking_key'

data/test/reseting_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+describe 'Redis::Breadcrumb' do
+  before do
+    Redis::Breadcrumb.redis = MockRedis.new
+  end
+
+  it 'by default resets owned key with clean command' do
+    class OwnedResetWithClean < Redis::Breadcrumb
+      owns :a_key, :reset => true
+    end
+
+    OwnedResetWithClean.redis.set 'a_key', 'hello'
+
+    OwnedResetWithClean.reset!
+
+    assert_nil OwnedResetWithClean.redis.get('a_key')
+  end
+
+  it 'by default resets member of set keys with clean command' do
+    class MemberOfSetResetWithClean < Redis::Breadcrumb
+      member_of_set :blah => :a_set, :reset => true
+    end
+
+    MemberOfSetResetWithClean.redis.sadd 'a_set', 'blah'
+
+    assert_equal 1, MemberOfSetResetWithClean.redis.scard('a_set')
+    assert MemberOfSetResetWithClean.redis.sismember 'a_set', 'blah'
+
+    MemberOfSetResetWithClean.reset!
+
+    assert_equal 0, MemberOfSetResetWithClean.redis.scard('a_set')
+    refute MemberOfSetResetWithClean.redis.sismember 'a_set', 'blah'
+  end
+
+  it 'by default resets member of sorted set keys with clean command' do
+    class MemberOfZsetResetWithClean < Redis::Breadcrumb
+      member_of_zset :blah => :a_set, :reset => true
+    end
+
+    MemberOfZsetResetWithClean.redis.zadd 'a_set', 1, 'blah'
+
+    assert_equal 1, MemberOfZsetResetWithClean.redis.zcard('a_set')
+    assert MemberOfZsetResetWithClean.redis.zrank 'a_set', 'blah'
+
+    MemberOfZsetResetWithClean.reset!
+
+    assert_equal 0, MemberOfZsetResetWithClean.redis.zcard('a_set')
+    refute MemberOfZsetResetWithClean.redis.zrank 'a_set', 'blah'
+  end
+
+end

data/test/test_helper.rb

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

data/test/tracking_test.rb

@@ -12,13 +12,15 @@ describe 'Redis::Breadcrumb' do
       owns :a_owned_key
 
       member_of_set :id => :a_set_of_things
+      member_of_zset :id => :a_sorted_set_of_things
     end
 
     TrackedInBreadcrumb.track!
 
     assert_equal [
       ["srem", "a_set_of_things", "id"],
-      ["del", "a_owned_key"]
+      ["del", "a_owned_key"],
+      ["zrem", "a_sorted_set_of_things", "id"]
     ].sort, TrackedInBreadcrumb.tracked_keys.sort
   end
 
@@ -77,4 +79,21 @@ describe 'Redis::Breadcrumb' do
 
     assert_equal [["srem", "a_set_of_things", "foo"]], breadcrumb.tracked_keys
   end
+
+  it 'can track member of sorted set keys for a specific object' do
+    class MemberOfZsetBreadcrumb < Redis::Breadcrumb
+      tracked_in 'widget:<id>:tracking'
+
+      member_of_zset "<id>" => :a_sorted_set_of_things
+    end
+
+    obj = Object.new
+    class << obj
+      def id; "foo"; end
+    end
+
+    breadcrumb = MemberOfZsetBreadcrumb.track!(obj)
+
+    assert_equal [["zrem", "a_sorted_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.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-30 00:00:00.000000000 Z
+date: 2013-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -116,21 +116,29 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.txt
 - lib/redis-breadcrumbs.rb
+- lib/redis-breadcrumbs/as_methods.rb
 - lib/redis-breadcrumbs/breadcrumb.rb
 - lib/redis-breadcrumbs/dsl.rb
+- lib/redis-breadcrumbs/entrance.rb
 - lib/redis-breadcrumbs/key.rb
+- lib/redis-breadcrumbs/key_proxy.rb
 - lib/redis-breadcrumbs/keys.rb
 - lib/redis-breadcrumbs/member_of_set_key.rb
 - lib/redis-breadcrumbs/owned_key.rb
+- lib/redis-breadcrumbs/unspecialized_dummy_object.rb
 - lib/redis-breadcrumbs/version.rb
 - redis-breadcrumbs.gemspec
+- test/as_test.rb
 - test/cleaning_test.rb
 - test/dsl_test.rb
+- test/reseting_test.rb
 - test/test_helper.rb
 - test/tracking_test.rb
 homepage: https://github.com/ecoffey/redis-breadcrumbs
@@ -147,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4237510823449836628
+      hash: 2467543944267407332
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -156,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4237510823449836628
+      hash: 2467543944267407332
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -164,7 +172,9 @@ signing_key:
 specification_version: 3
 summary: A friendly DSL for tracking and cleaning up redis keys.
 test_files:
+- test/as_test.rb
 - test/cleaning_test.rb
 - test/dsl_test.rb
+- test/reseting_test.rb
 - test/test_helper.rb
 - test/tracking_test.rb