redistry 0.1.1 → 0.1.2

data/README.md

@@ -1,11 +1,67 @@
-Redistry
-========
+Getting Started
+---------------
 
-Some useful Redis patterns for Ruby (and Rails)
+### Rails 3
 
+Add `redistry` to your `Gemfile`
 
-TODO
-----
+    gem "redistry"
+
+
+#### Using has_list
+
+Associate a Redis list with each ActiveRecord item:
+
+    class Notification < ActiveRecord::Base
+
+    end
+
+    ...
+
+    class User < ActiveRecord::Base
+      has_list :recent_notifications, :class => Notification, :size => 10
+
+      ...
+    end
+
+You can add items to the list with `add`:
+
+    user.recent_notifications.add(notification)
+
+Since you specified `:size`, Redistry will treat the list as a queue (first in, last out) with a 
+maximum of `size` elements. If you don't specify `:size`, the list will not limit the size at all.
+
+You can fetch the items with `all`:
+
+    @notifications = user.recent_notifications.all
+
+And you can clear all the notifications with `clear`:
+
+    user.recent_notifications.clear
+
+
+#### Using list
+
+Sometimes, you want to associate a list generically with an entire class (or a module)
+
+    class User
+      list :popular, :size => 10
+      ...
+    end
+
+Note that since we didn't specify `:class`, Redistry will assume the objects are of the same type as the outer class (in this case, `User`).
+
+Use the same interface as `has_list` to access the items:
+
+    User.popular.add(@user)
+    @popular_users = User.popular.all
+    User.popular.clear
+
+
+Known Issues / TODO
+-------------------
 
 * JSON serializer does not work with strings... not sure how to deal since this technically is not valid json
-* Allow :class as option on has_list rather than always autodetecting
+
+
+Copyright (c) 2011 Brian Smith (bsmith@swig505.com)

data/lib/redistry/{has_list → list}/collection_proxy.rb

@@ -1,5 +1,5 @@
 module Redistry
-  module HasList
+  module List
     class CollectionProxy
       attr_accessor :klass, :collection_name, :options
       

data/lib/redistry/list.rb

@@ -0,0 +1,35 @@
+require 'redistry/list/collection_proxy'
+
+module Redistry
+  module List
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      
+      def has_list(name, options = {})
+        klass = options.delete(:class) || self
+
+        raise("The class `#{klass.name}` must have an unique `id` to use `has_list`") unless klass.instance_methods.include?(:id)
+
+        define_method name do
+          return instance_variable_get("@_#{name}_has_list") if instance_variable_get("@_#{name}_has_list")
+          instance_variable_set("@_#{name}_has_list", CollectionProxy.new(klass, "#{name}-#{id}", options))
+        end
+      end
+
+      def list(name, options = {})
+        klass = options.delete(:class) || self
+
+        instance_variable_set("@_#{name}_list".to_sym, CollectionProxy.new(klass, name, options))
+        class_eval <<-EOF
+          def self.#{name}
+            @_#{name}_list
+          end
+        EOF
+      end
+    end
+  end
+end

data/lib/redistry/version.rb

@@ -1,5 +1,5 @@
 module Redistry
 
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 
 end

data/lib/redistry.rb

@@ -1,6 +1,6 @@
 require 'redis'
 require 'redistry/version'
-require 'redistry/has_list'
+require 'redistry/list'
 require 'redistry/serializers/json'
 
 module Redistry
@@ -20,7 +20,7 @@ module Redistry
 
   def setup_active_record!
     require 'redistry/serializers/activerecord'
-    ActiveRecord::Base.send(:include, Redistry::HasList)   
+    ActiveRecord::Base.send(:include, Redistry::List)   
     @loaded_frameworks << :activerecord
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Brian Smith
@@ -81,8 +81,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/redistry/has_list/collection_proxy.rb
-- lib/redistry/has_list.rb
+- lib/redistry/list/collection_proxy.rb
+- lib/redistry/list.rb
 - lib/redistry/serializers/activerecord.rb
 - lib/redistry/serializers/json.rb
 - lib/redistry/version.rb

data/lib/redistry/has_list.rb

@@ -1,24 +0,0 @@
-require 'redistry/has_list/collection_proxy'
-
-module Redistry
-  module HasList
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      
-      def has_list(name, options = {})
-        klass = options.delete(:class) || self
-        instance_variable_set("@_#{name}_has_list".to_sym, CollectionProxy.new(klass, name, options))
-
-        class_eval <<-EOF
-          def self.#{name}
-            @_#{name}_has_list
-          end
-        EOF
-      end
-    end
-  end
-end