redis_backed_model 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,6 @@
 # RedisBackedModel
 
-TODO: Write a gem description
+Provides useful functions to objects that are backed by a Redis store instead of ActiveRecord.
 
 ## Installation
 
@@ -18,7 +18,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Subclass your models from RedisBackedModel::RedisBackedModel
+
+```ruby
+  class Person < RedisBackedModel::RedisBackedModel
+    ...
+  end
+```
+
+When initializing a person, pass in a hash of attributes
+
+```ruby
+  p = Person.new({:id => 2, :first_name => "Bill", :last_name => "Smith"})
+```
+
+RBM will create instance variables as needed
+
+```ruby
+  p.instance_variables => [:@id, :@first_name, :@last_name]
+```
+
+You can use RBM to get Redis commands that will save your object as a hash
+
+```ruby
+  p.to_redis => ["sadd|person_ids|2", "hset|person:2|id|2", "hset|person:2|first_name|Bill", "hset|person:2|last_name|Smith"]
+```
+
+You can parse these and pass them to Redis yourself or use the gem 'redis_pipeline': https://github.com/SeniorServiceAmerica/redis_pipeline
+
 
 ## Contributing
 

data/lib/redis_backed_model/redis_backed_model.rb

@@ -1,6 +1,6 @@
 module RedisBackedModel
   class RedisBackedModel
-    
+
     def initialize(attributes={})
       if attributes.class == Hash
         attributes.each do |key, value|
@@ -17,12 +17,13 @@ module RedisBackedModel
       instance_variables.each do | var |
         build_command_for_variable(var, redis_commands)
       end
+
       redis_commands
     end
     
     private
     
-      attr_reader :id, :scores
+      attr_reader :id
     
       def add_to_instance_variables(key, value)
         if key.match(/score_\[\w+\|\w+\]/)
@@ -33,8 +34,7 @@ module RedisBackedModel
       end
     
       def add_to_scores(key, value)
-        @scores ||= []
-        @scores << SortedSet.new(self.class, id, Hash[key,value])
+        scores << SortedSet.new(self.class, id, Hash[key,value])
       end
       
       def build_command_for_variable(variable, collection)
@@ -59,7 +59,10 @@ module RedisBackedModel
       def model_name_for_redis
         class_as_string = self.class.to_s.demodulize.underscore        
       end
-              
+
+      def scores
+        @scores ||= []
+      end
   end
     
 end

data/lib/redis_backed_model/sorted_set.rb

@@ -8,6 +8,7 @@ module RedisBackedModel
       @model      = model
       @model_id   = model_id
       @definition = definition
+      self
     end
   
     def to_redis

data/lib/redis_backed_model/version.rb

@@ -1,3 +1,3 @@
 module RedisBackedModel
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_backed_model
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-31 00:00:00.000000000Z
+date: 2012-09-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156372240 !ruby/object:Gem::Requirement
+  requirement: &2164484940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156372240
+  version_requirements: *2164484940
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2156371820 !ruby/object:Gem::Requirement
+  requirement: &2164484520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156371820
+  version_requirements: *2164484520
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2156371400 !ruby/object:Gem::Requirement
+  requirement: &2164484100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156371400
+  version_requirements: *2164484100
 description: Provides methods to models that are backed by a redis instance.
 email:
 - iwhitney@ssa-i.org