shadow_model 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9518b18405e37c61c19150b09c2c4203592b6584
-  data.tar.gz: cb61c047872eb147c663f91f17a2e4879e4370b7
+  metadata.gz: c83ab40b9ae9fcca01d524c4c8668680c7e15fcf
+  data.tar.gz: 48fe962f66e5408a852522337227f679b8859776
 SHA512:
-  metadata.gz: dc810d648888fc744c8fc6f781e6fad8adb0102e19d89e2e9648a942c4d6cc1247f659b186360795446644782d2d55940a58f5acc16f675665a4efe16f76908e
-  data.tar.gz: fd22eef1713aef85f2d4f7d1fc31aea29bc50c25f33feebab4e1d91ecf8bffc4269ea2eb70c95ed6613c3f1174a9b9de6a88812c7479431e44f8ea70df3bbea2
+  metadata.gz: d42b3640f6a22d7c34e79d9d8b3edb5182ec4fa11e68c8d841ac84cee945942d2666e1c8cb6664c29c3bd78a7f96a06c54931b0bcc6591f82b588c71634fd6f3
+  data.tar.gz: 81c2e002a0e49d2745e24da7b8148bf0a419b4dcb8afe87940941468484976b74fbaeb0bc9ef172eabf2d129aca1d0ae9fbafd06514ff81eac4ab75e6f45197a

data/README.md

@@ -16,13 +16,16 @@ And then execute:
 
 ## Usage
 
-Add this to your model class, then the models will be cached with the assigned attributes and methods after the model saved or updated.
+Add this to your model class, then the models will be cached with the assigned attributes and methods after saved or updated.
 
     shadow_model attribute_or_method1, attribute_or_method2, ..., options
 
 And use this to retrieve the model from redis.
 
-    YourModelClass.find_by_shadow(primary_key)
+    model = YourModelClass.find_by_shadow(primary_key)
+
+    model.is_a?(YourModelClass) # true
+    model.readonly?             # true
 
 ### options
 
@@ -31,14 +34,14 @@ And use this to retrieve the model from redis.
     <td>expiration</td><td>Set the timeout of each cache.</td>
   </tr>
   <tr>
-    <td>&nbsp;&nbsp;update_expiration</td><td>Reset cache expiration after model updated.</td>
+    <td>update_expiration</td><td>Reset cache expiration after model updated (if expiration has been set).</td>
   </tr>
   <tr>
     <td>expireat</td><td>Set the absolute timeout timestamp of each cache.</td>
   </tr>
 </table>
 
-## Example
+### Example
 
     # == Schema Information
     #
@@ -57,3 +60,27 @@ And use this to retrieve the model from redis.
         "result to cache"
       end
     end
+
+## Associations
+
+### has_many
+
+You can set the **shadow** option of has_many association to allow shadow_model to cache all the related models.
+
+    class Game < ActiveRecord::Base
+      has_many :players, shadow: true
+    end
+
+This will use hash data structure of redis to save the cache data, and you can retrieve all of them with one redis connection.
+
+    game = Game.create(name: "pikmin")
+    game.players.create(name: "player one")
+    game.players.create(name: "player two")
+
+    game.players_by_shadow # [#<Player id: 1, game_id: 1, name: "player one", ...>, #<Player id: 2, game_id: 1, name: "player two", ...>]
+
+If you don't want to cache models seperately and use the association type only, you can set the **association_only** option to disable it.
+
+    class Player < ActiveRecord::Base
+      shadow_model ..., association_only: true
+    end

data/lib/shadow_model/associations/has_many.rb

@@ -0,0 +1,48 @@
+class ::ActiveRecord::Associations::Builder::HasMany
+  def valid_options_with_shadow_option
+    valid_options_without_shadow_option + [:shadow]
+  end
+  alias_method_chain :valid_options, :shadow_option
+
+  def build_with_shadow_option
+    reflection = build_without_shadow_option
+    if options[:shadow]
+      model_name = model.table_name.singularize
+      model.class_eval <<-RUBY
+        def #{name}_shadow_cache_key
+          "#{model_name}_\#{self[self.class.primary_key]}_#{name}_shadow_cache"
+        end
+
+        def #{name}_by_shadow
+          Redis.current.hvals(#{name}_shadow_cache_key).map do |val|
+            shadow_data = Marshal.load(val)
+            #{reflection.klass.name}.instantiate_shadow_model(shadow_data)
+          end
+        end
+
+        def clear_#{name}_shadow_cache
+          Redis.current.del(#{name}_shadow_cache_key)
+        end
+      RUBY
+
+      reflection.klass.class_eval <<-RUBY
+        after_save :update_shadow_cach_of_#{model_name}
+        after_destroy :delete_shadow_cach_of_#{model_name}
+
+        def belongs_to_#{model_name}_shadow_cache_key
+          "#{model_name}_\#{self[:#{reflection.foreign_key}]}_#{name}_shadow_cache"
+        end
+
+        def update_shadow_cach_of_#{model_name}
+          Redis.current.hset(belongs_to_#{model_name}_shadow_cache_key, self[self.class.primary_key], self.build_shadow_data)
+        end
+
+        def delete_shadow_cach_of_#{model_name}
+          Redis.current.hdel(belongs_to_#{model_name}_shadow_cache_key, self[self.class.primary_key])
+        end
+      RUBY
+    end
+    reflection
+  end
+  alias_method_chain :build, :shadow_option
+end

data/lib/shadow_model/model_extension.rb

@@ -5,6 +5,7 @@ module ShadowModel
         mattr_accessor :shadow_options
         extend ClassMethods
         after_save :update_shadow_cache
+        after_destroy :clear_shadow_data
       RUBY
     end
 
@@ -43,6 +44,7 @@ module ShadowModel
     end
 
     def update_shadow_cache
+      return if shadow_options[:association_only]
       Redis.current.set(shadow_cache_key, build_shadow_data)
       update_expiration
     end
@@ -110,11 +112,7 @@ module ShadowModel
 
       def find_by_shadow(id)
         if shadow_data = find_shadow_data(id)
-          instance = self.new
-          instance.shadow_model = true
-          instance.shadow_data = shadow_data
-          instance.readonly!
-          instance
+          instantiate_shadow_model(shadow_data)
         else
           instance = self.find(id)
           instance.update_shadow_cache
@@ -127,6 +125,14 @@ module ShadowModel
         data ? Marshal.load(data) : nil
       end
 
+      def instantiate_shadow_model(shadow_data)
+        instance = self.new
+        instance.shadow_model = true
+        instance.shadow_data = shadow_data
+        instance.readonly!
+        instance
+      end
+
       def build_shadow_cache_key(id)
         "#{self.name.tableize}:Shadow:#{id}"
       end

data/lib/shadow_model/version.rb

@@ -1,3 +1,3 @@
 module ShadowModel
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/shadow_model.rb

@@ -17,3 +17,5 @@ module ShadowModel
 end
 
 ActiveRecord::Base.send :include, ShadowModel
+
+require 'shadow_model/associations/has_many'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shadow_model
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Weihu Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -87,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/shadow_model/associations/has_many.rb
 - lib/shadow_model/model_extension.rb
 - lib/shadow_model/version.rb
 - lib/shadow_model.rb
@@ -116,5 +117,5 @@ rubyforge_project:
 rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
-summary: rails model cache with redis
+summary: Rails model cache with redis
 test_files: []