redis_backed_model 0.0.5 → 1.0.0

data/README.md

@@ -22,7 +22,6 @@ Subclass your models from RedisBackedModel::RedisBackedModel
 
 ```ruby
   class Person < RedisBackedModel::RedisBackedModel
-    ...
   end
 ```
 
@@ -46,6 +45,17 @@ You can use RBM to get Redis commands that will save your object as a hash
 
 You can parse these and pass them to Redis yourself or use the gem 'redis_pipeline': https://github.com/SeniorServiceAmerica/redis_pipeline
 
+Once your data is in Redis, you can use RBM to find and instantiate objects:
+
+```ruby
+  p = Person.find(2) => #<Person:0x00000104023a00 @id=2, @first_name=Bill, @last_name=Smith>
+```
+
+You can also find multiple records:
+
+```ruby
+  p = Person.find([1,2,3]) => [person,person,person]
+```
 
 ## Contributing
 

data/lib/redis_backed_model/inflections.rb

@@ -1,15 +1,17 @@
 module ActiveSupport::Inflector
 
+  # Downcases and removes a leading @
   def deinstance_variableize(the_string)
     result = the_string.to_s.dup
     result.downcase.gsub(/^@/, '')
   end
   
+  # Adds a @ to the beginning of <tt>the_string</tt> and returns it as a symbol
   def instance_variableize(the_string)
     "@#{the_string}".to_sym
   end
-  
 end
+
 class String
   def deinstance_variableize
     ActiveSupport::Inflector.deinstance_variableize(self)

data/lib/redis_backed_model/redis_backed_model.rb

@@ -1,6 +1,12 @@
 module RedisBackedModel
   class RedisBackedModel
 
+    # Finds and returns one or more objects by their id.
+    # Pass in a single id or an array of ids.
+    #   obj.find(1) => obj
+    #   obj.find([1,2,3]) => [obj,obj,obj]
+    # returns an empty array if no object matches the id in Redis
+    #   obj.find(bad_id) => []
     def self.find(*args)
       found = []
       args.flatten.each do |id|
@@ -10,6 +16,8 @@ module RedisBackedModel
       (found.count == 1) ? found.first : found
     end
 
+    # Instantiates the object with the provided attributes.
+    # If the object does not have an instance variable that matches one of the passed attributes, one will be created.
     def initialize(attributes={})
       if attributes.class == Hash
         attributes.each do |key, value|
@@ -20,6 +28,7 @@ module RedisBackedModel
       end
     end
     
+    # Serializes the object as redis commands.
     def to_redis
       redis_commands = []
       redis_commands << id_set_command

data/lib/redis_backed_model/sorted_set.rb

@@ -5,26 +5,27 @@ module RedisBackedModel
     
   
     def initialize(model, model_id, definition)
-      @model      = model
-      @model_id   = model_id
-      @definition = definition
+      self.model      = model
+      self.model_id   = model_id
+      self.definition = definition
       self
     end
   
+    # Serializes the object as a redis command to create a sorted set.
     def to_redis
       "zadd|#{key}|#{score}|#{member}"
     end
   
     private
       
-      attr_accessor :model, :model_id #, :by_attribute, :score_label, :score
+      attr_accessor :model, :model_id, :definition
       
       def definition_keys
-        @definition.keys.first
+        definition.keys.first
       end
       
       def definition_values
-        @definition.values.first
+        definition.values.first
       end
       
       def key_by
@@ -36,7 +37,7 @@ module RedisBackedModel
       end
 
       def key_model_name
-        @model.to_s.underscore.pluralize
+        model.to_s.underscore.pluralize
       end
 
       def key_for_value
@@ -44,7 +45,7 @@ module RedisBackedModel
       end
 
       def member
-        @model_id
+        model_id
       end
         
       def key

data/lib/redis_backed_model/version.rb

@@ -1,3 +1,3 @@
 module RedisBackedModel
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

data/redis_backed_model.gemspec

@@ -16,5 +16,5 @@ Gem::Specification.new do |gem|
   gem.version       = RedisBackedModel::VERSION
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'redis'
-  gem.add_dependency('activesupport')
+  gem.add_dependency('activesupport', '~> 3.0.0')
 end

data/spec/redis_backed_model_spec.rb

@@ -1,5 +1,4 @@
 require "spec_helper"
-require 'extras/person'
 
 describe RedisBackedModel do
   before(:all) do
@@ -190,29 +189,3 @@ describe RedisBackedModel do
   end
 
 end
-
-# test inheriting from RedisBackedModel
-describe Person do 
-  
-  before(:all) do 
-    $redis.hset 'person:0', 'first_name', 'jane'
-    $redis.hset 'person:0', 'last_name', 'doe'
-  end
-
-  it "should set its instance_variables from redis, using RedisBackedModel initialize" do
-    person = Person.find(0)
-    person.instance_variables.include?(:@first_name).should eq(true)
-    person.instance_variables.include?(:@last_name).should eq(true)
-    person.instance_variables.include?(:@id).should eq(true)    
-  end
-    
-  it "should have same name method" do
-    person = Person.find(0)
-    person.name.should eq('jane doe')    
-  end
-  
-  after(:all) do 
-    $redis.hdel 'person:0', 'first_name'
-    $redis.hdel 'person:0', 'last_name'
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_backed_model
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-05 00:00:00.000000000 Z
+date: 2012-09-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2165686260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,15 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2165686260
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2165685840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,28 +33,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2165685840
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2165685340 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2165685340
 description: Provides methods to models that are backed by a redis instance.
 email:
 - iwhitney@ssa-i.org
@@ -79,7 +64,6 @@ files:
 - lib/redis_backed_model/sorted_set.rb
 - lib/redis_backed_model/version.rb
 - redis_backed_model.gemspec
-- spec/extras/person.rb
 - spec/redis_backed_model/inflections_spec.rb
 - spec/redis_backed_model/sorted_set_spec.rb
 - spec/redis_backed_model_spec.rb
@@ -104,14 +88,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Provides methods for the creation of redis-backed models, specifically the
   handling of sorted-set attributes and returning commands that will store the object
   in redis.
 test_files:
-- spec/extras/person.rb
 - spec/redis_backed_model/inflections_spec.rb
 - spec/redis_backed_model/sorted_set_spec.rb
 - spec/redis_backed_model_spec.rb

data/spec/extras/person.rb

@@ -1,50 +0,0 @@
-class Person < RedisBackedModel::RedisBackedModel
-  attr_reader :id, :first_name, :last_name
-  
-  def self.all
-    all = []
-    ids.each do |id|
-      all << self.find(id)
-    end
-    all
-  end
-
-  #def self.first
-    #id = ids.first
-    #self.find(id)
-  #end
-  
-  def self.find(id)
-    attr = $redis.hgetall("person:#{id}")
-    self.new(attr.merge({:id => id}))
-  end
-
-  #def self.last
-    #id = ids.last
-    #self.find(id)
-  #end
-
-  def self.to_csv
-    f = File.new("person.csv", "w+")
-    f << "id,first_name,last_name\n"
-    self.all.each do |x|
-      f << "#{x.id},#{x.first_name},#{x.last_name}\n"
-    end
-  end
-
-  # def initialize(attr)
-  #   @id = attr[:id]
-  #   @first_name = attr["first_name"]
-  #   @last_name = attr["last_name"]
-  # end
-
-  def name
-    "#{self.first_name} #{self.last_name}"
-  end
-
-  private
-
-  def self.ids
-    @ids ||= $redis.sort('person_ids')
-  end
-end