redis_storage_methods 0.0.2 → 0.0.3

data/README.md

@@ -18,15 +18,26 @@ Or install it yourself as:
 
 ## Usage
 
-Presumably, you'll be passing hashes into your create method. Now you will need to pass them into your
+What this Gem does is provides a framework mixin for your models that exposes new methods that allow you to save to redis when you save to the database, and let you get/update redis without getting/updating the database until later(maybe under a cron job or something.) This is great if you want all the speed of redis but the querying reporting ability of SQL.
+
+When you create, normally you'll be passing hashes into your create method, most likely from form submission. Now you will need to pass them into your
   
     create_with_associations_and_redis(params)
 
-method. This is to differentiate between the two: This method will take your object and create it, and then store it in redis as a hash. It will not store it's associations unless you instruct it to do so. This is because redis has no ability to store foreign keyed objects, if a Battle has a Soldier in it, you can really only store it in a redis hash for Battle like this: soldier0hp, soldier0stamina, soldier1hp, soldier1stamina, etc.
-
-You need to instruct it to do this.
- 
-Pretty easy here, just do:
+method. I didn't overwrite the create method, because I wanted to differentiate between the two: This method will take your object and create it, and then store it in redis as a hash. It will not store it's associations unless you instruct it to do so, as will be discussed further in depth below. This is because redis has no ability to store foreign keyed objects, if a Battle has a Soldier in it, you can really only store it in a redis hash for Battle like this: 
+  
+{
+battle_name
+battle_time
+soldier0hp 
+soldier0stamina
+soldier1hp
+soldier1stamina
+}
+
+You can see how this is a limitation of redis - you can clearly see there are two soldiers in this battle hash but it only allows storing of hashes at the top level. You cannot store hashes in hashes, so you have to use this method. Because of this limitation, when I designed this mixin, I made it non-implementation specific for pushing associations with your model. 
+
+Pretty easy to use, just do:
 
     class Battle < ActiveRecord::Base
       include RedisStorageMethods

data/lib/redis_storage_methods.rb

@@ -1,10 +1,5 @@
-#This module is for Toplevel Objects that are intended for storage in redis, with possible nested subobjects that are not meant to be
-#stored independently in redis.
-
-# So a Battle is a Toplevel Object. Video is not - it's always nested in redis, so it's just normal. Video does not include this
-#module, but Battle would. A Toplevel Object should not reference another Toplevel Object via an association, but if it must, do not
-#put it in the associations_names method so that this Toplevel object doesnt try to store it. That's what this module uses
-# to determine associations with.
+require 'redis'
+require 'hiredis'
 module RedisStorageMethods
 
   module ClassMethods

data/lib/redis_storage_methods/version.rb

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

data/redis_storage_methods.gemspec

@@ -14,4 +14,6 @@ Gem::Specification.new do |gem|
   gem.name          = "redis_storage_methods"
   gem.require_paths = ["lib"]
   gem.version       = RedisStorageMethods::VERSION
+  gem.add_dependency "redis"
+  gem.add_dependency "hiredis"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_storage_methods
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2013-02-05 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &11928740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11928740
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: &11928020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11928020
 description: Transparently store objects both in redis and your sql store, but GET
   only on the redis store for speed.
 email: