shadow_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af8efdd8209465e2f3160872a3ebd70d13386b66
+  data.tar.gz: 5a95826af5c3f28814fa974c5348972ce0d475ba
+SHA512:
+  metadata.gz: 57371ab38d192ab2eefc309ddf9d24fa7020e627196016371e58c930e26cbdf508b776c40e714a3d937187b8e07a8820943f18ce4a86a6e19d6fb57d5e352ee5
+  data.tar.gz: 5187008742137a1ca9f641f2946adbf01bdd9d2e69e726fee007fd9684fc956368944e9147e2cdcaec044c301bb80126b27efe2f0d03c9b6ff0f07d05f071f0f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Weihu Chen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# ShadowModel
+
+A rails plugin use redis to cache models data.
+
+[![Build Status](https://travis-ci.org/cctiger36/shadow_model.png?branch=master)](https://travis-ci.org/cctiger36/shadow_model)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shadow_model'
+
+And then execute:
+
+    $ bundle
+
+## 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.
+
+    shadow_model attribute_or_method1, attribute_or_method2, ..., options
+
+And use this to retrieve the model from redis.
+
+    YourModelClass.find_by_shadow(primary_key)
+
+### options
+
+<table>
+  <tr>
+    <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>
+  </tr>
+  </tr>
+    <td>expireat</td><td>Set the absolute timeout timestamp of each cache.</td>
+  </tr>
+</table>
+
+## Example
+
+    # == Schema Information
+    #
+    # Table name: players
+    #
+    #  id                   :integer          not null, primary key
+    #  name                 :string(255)
+    #  stamina              :integer
+    #  created_at           :datetime         not null
+    #  updated_at           :datetime         not null
+
+    class Player < ActiveRecord::Base
+      shadow_model :name, :stamina, :cacheable_method, expiration: 30.minutes
+
+      def cacheable_method
+        "result to cache"
+      end
+    end

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+desc 'Default: run specs'
+task :default => :spec  
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+    t.pattern = "spec/**/*_spec.rb"
+end
+
+Bundler::GemHelper.install_tasks

data/lib/shadow_model.rb

@@ -0,0 +1,19 @@
+require 'active_support'
+require 'active_record'
+require 'shadow_model/version'
+
+module ShadowModel
+  extend ActiveSupport::Concern
+
+  autoload :Extension, 'shadow_model/extension'
+  
+  module ClassMethods
+    def shadow_model(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      self.send :include, ShadowModel::Extension
+      set_shadow_keys(args, options)
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ShadowModel

data/lib/shadow_model/extension.rb

@@ -0,0 +1,128 @@
+module ShadowModel
+  module Extension
+    def self.included(base)
+      base.class_eval <<-RUBY
+        mattr_accessor :shadow_options
+        extend ClassMethods
+        after_save :update_shadow_cache
+      RUBY
+    end
+
+    def shadow_model?
+      @shadow_model
+    end
+
+    def shadow_model=(value)
+      @shadow_model = value
+    end
+
+    def shadow_cache_key
+      @shadow_cache_key ||= self.class.build_shadow_cache_key(self[self.class.primary_key])
+    end
+
+    def shadow_data
+      @shadow_data ||= self.class.find_shadow_data(self[self.class.primary_key])
+    end
+
+    def shadow_data=(data)
+      @shadow_data = data
+    end
+
+    def clear_shadow_data
+      Redis.current.del(shadow_cache_key)
+    end
+
+    def build_shadow_data
+      Marshal.dump(self.class.shadow_keys.inject({}) { |data, attr| data[attr] = send(attr); data })
+    end
+
+    def update_shadow_cache
+      Redis.current.set(shadow_cache_key, build_shadow_data)
+      update_expiration
+    end
+
+    def update_expiration
+      if self.class.shadow_options[:expiration].present?
+        if self.class.shadow_options[:update_expiration] || shadow_ttl < 0
+          Redis.current.expire(shadow_cache_key, self.class.shadow_options[:expiration])
+        end
+      elsif self.class.shadow_options[:expireat].present?
+        Redis.current.expireat(shadow_cache_key, self.class.shadow_options[:expireat].to_i) if shadow_ttl < 0
+      end
+    end
+
+    def shadow_ttl
+      Redis.current.ttl(shadow_cache_key)
+    end
+
+    module ClassMethods
+      def set_shadow_keys(args, options = {})
+        @shadow_attributes ||= []
+        @shadow_methods ||= []
+        self.shadow_options = options
+        args.each do |arg|
+          if self.attribute_names.include?(arg.to_s)
+            @shadow_attributes << arg.to_sym
+          else
+            @shadow_methods << arg.to_sym
+          end
+        end
+        @shadow_attributes.each { |attr| define_shadow_attributes(attr) }
+      end
+
+      def shadow_keys
+        @shadow_attributes + @shadow_methods
+      end
+
+      def method_added(method_name)
+        define_shadow_methods(method_name)
+      end
+
+      def define_shadow_attributes(attribute_name)
+        self.class_eval <<-RUBY
+          def #{attribute_name}_without_shadow
+            self.read_attribute(:#{attribute_name})
+          end
+
+          def #{attribute_name}
+            shadow_model? ? shadow_data[:#{attribute_name}] : #{attribute_name}_without_shadow
+          end
+        RUBY
+      end
+
+      def define_shadow_methods(method_name)
+        if self.shadow_keys.include?(method_name.to_sym) && !self.instance_methods.include?("#{method_name}_without_shadow".to_sym)
+          self.class_eval <<-RUBY
+            def #{method_name}_with_shadow
+              shadow_model? ? shadow_data[:#{method_name}] : #{method_name}_without_shadow
+            end
+            alias_method_chain :#{method_name}, :shadow
+          RUBY
+        end
+      end
+
+      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
+        else
+          instance = self.find(id)
+          instance.update_shadow_cache
+          find_by_shadow(id)
+        end
+      end
+
+      def find_shadow_data(id)
+        data = Redis.current.get(build_shadow_cache_key(id))
+        data ? Marshal.load(data) : nil
+      end
+
+      def build_shadow_cache_key(id)
+        "#{self.name.tableize}:Shadow:#{id}"
+      end
+    end
+  end
+end

data/lib/shadow_model/version.rb

@@ -0,0 +1,3 @@
+module ShadowModel
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: shadow_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Weihu Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A rails plugin use reids to cache models data.
+email:
+- cctiger36@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/shadow_model/extension.rb
+- lib/shadow_model/version.rb
+- lib/shadow_model.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/cctiger36/shadow_model
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: rails model cache with redis
+test_files: []