representable-cache 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+representable-cache

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p327

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in representable-cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Allen Wei
+
+MIT License
+
+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,73 @@
+# Representable::Cache
+
+provide cache feature for Representable
+
+[representable](https://github.com/apotonick/representable)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'representable-cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install representable-cache
+
+## Usage
+
+
+### Default Configuration
+
+```ruby
+Representable::Cache.cache_engine = Dalli::Client.new('localhost:11211', :namespace => "app_v1")
+Representable::Cache.default_cache_key = [:id, :updated_at]
+Representable::Cache.enable = false # Default: true
+```
+
+### Setup
+
+```ruby
+require 'representable/json'
+require 'representable/cache'
+
+module SongRepresenter
+  include Representable::JSON
+  include Representable::Cache
+
+  property :title
+  property :track
+end
+```
+
+### settings
+
+```ruby
+module SongRepresenter
+  include Representable::JSON
+  include Representable::Cache
+
+  property :title
+  property :track
+  representable_cache :cache_key => :id, :cache_name => "Brand",
+:version => "v1"
+end
+```
+
+options:
+* cache_key: could be symble or array, will use default_cache_key if not
+  set
+* cache_name: default: module or class name
+* version: version name, you can invalid old cache by bump cache version
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/representable/cache/version.rb

@@ -0,0 +1,5 @@
+module Representable
+  module Cache
+    VERSION = "0.0.2"
+  end
+end

data/lib/representable/cache.rb

@@ -0,0 +1,118 @@
+require "representable/cache/version"
+require 'representable/binding'
+
+module Representable::Cache
+  def self.reset
+    @default_cache_key = nil
+    @engine = nil
+    @enable = nil
+  end
+  def self.cache_engine=(engine)
+    raise "engine doesn't response to get" if !engine.respond_to?(:get)
+    raise "engine doesn't response to set" if !engine.respond_to?(:set)
+    @engine = engine
+  end
+
+  def self.default_cache_key=(default_cache_key)
+    @default_cache_key = default_cache_key
+  end
+
+  def self.default_cache_key
+    @default_cache_key
+  end
+
+  def self.enable=(enable)
+    @enable = enable
+  end
+
+  def self.enable
+    return true if @enable.nil?
+    @enable
+  end
+
+  def self.cache
+    @engine
+  end
+
+  # include presenter in model
+  def self.included(base)
+    base.send(:include, InstanceMethods)
+    base.extend ClassMethods
+    base.representable_cache_options[:cache_name] ||= base.name
+  end
+
+  module ClassMethods
+    # DCI
+    def extended(base)
+      super(base)
+      base.instance_eval do
+        def representable_cache_options
+          @representable_cache_options
+        end
+        def representable_cache_options=(options)
+          @representable_cache_options = options
+        end
+      end
+
+      base.representable_cache_options ||= self.representable_cache_options
+    end
+
+    # inherited representable
+    def included(base)
+      super(base)
+      base.instance_eval do
+        def representable_cache_options
+          @representable_cache_options
+        end
+        def representable_cache_options=(options)
+          @representable_cache_options = options
+        end
+      end
+      base.representable_cache_options = self.representable_cache_options
+      base.representable_cache_options[:cache_name] ||= base.name
+    end
+
+    def representable_cache(options={})
+      @representable_cache_options = @representable_cache_options.merge options
+    end
+
+    def representable_cache_options
+      @representable_cache_options ||={}
+    end
+  end
+  module InstanceMethods
+    def to_hash(options={}, binding_builder=Representable::Hash::PropertyBinding)
+      return super(options, binding_builder) if !Representable::Cache.enable
+      if hash = Representable::Cache.cache.get(self.representable_cache_key)
+        return hash
+      end
+      hash = super(options, binding_builder)
+      Representable::Cache.cache.set(self.representable_cache_key, hash)
+      hash
+    end
+
+    def representable_cache_options
+      @representable_cache_options || self.class.representable_cache_options
+    end
+
+    def representable_cache_key
+      self.representable_cache_options[:cache_key] ||= Representable::Cache.default_cache_key
+      self.representable_cache_options[:cache_version] ||= "v1"
+      self.representable_cache_options[:cache_name] ||= self.class.name
+
+      keys = [
+        self.representable_cache_options[:cache_version],
+        self.representable_cache_options[:cache_name]
+      ]
+      raise "cache_key or default_cache_key is required" if self.representable_cache_options[:cache_key].nil?
+      if self.representable_cache_options[:cache_key].kind_of? Array
+        keys += self.representable_cache_options[:cache_key].map do |k|
+          self.send(k).to_s.gsub(/\s+/,'')
+        end
+      else
+        self.send(self.representable_cache_options[:cache_key]).to_s.gsub(/\s+/,'')
+      end
+      keys.compact.join("-")
+    end
+  end
+end

data/representable-cache.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'representable/cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "representable-cache"
+  spec.version       = Representable::Cache::VERSION
+  spec.authors       = ["Allen Wei"]
+  spec.email         = ["digruby@gmail.com"]
+  spec.description   = %q{cache solution for representable}
+  spec.summary       = %q{cache solution for representable}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "representable"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "dalli"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "debugger"
+end

data/spec/representable/configuration_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'dalli'
+require 'representable/cache'
+
+describe "configuration" do
+  context "cache engine" do
+    it "should be able to set cache engine" do
+      Representable::Cache.cache_engine = Dalli::Client.new('localhost:11211', :namespace => "app_v1", :compress => true)
+      Representable::Cache.cache.should be_kind_of Dalli::Client
+    end
+
+    it "should raise error if engine not resposne to get/set" do
+      expect {
+        Representable::Cache.cache_engine =  "123"
+      }.to raise_error RuntimeError
+
+    end
+  end
+
+  context "cache" do
+    it "should be able to set and get from cache" do
+      Representable::Cache.cache_engine = Dalli::Client.new('localhost:11211', :namespace => "Representable::CacheTest", :compress => true)
+      Representable::Cache.cache.set("test_set", "test_set")
+      Representable::Cache.cache.get("test_set").should eq "test_set"
+    end
+  end
+
+  context "default_cache_key" do
+    it "should support default cache key" do
+      Representable::Cache.default_cache_key = [:id, :updated_at]
+      Representable::Cache.default_cache_key.should eq [:id, :updated_at]
+    end
+  end
+
+  context "enable" do
+    it "should support enable or disable it" do
+      Representable::Cache.enable = false
+      Representable::Cache.enable.should be_false
+      Representable::Cache.enable = true
+      Representable::Cache.enable.should be_true
+    end
+  end
+end

data/spec/representable/single_representable_spec.rb

@@ -0,0 +1,273 @@
+require 'spec_helper'
+require 'dalli'
+require 'representable'
+require 'representable/json'
+require 'representable/cache'
+
+describe Representable::Cache do
+  before do
+    Representable::Cache.cache_engine = Dalli::Client.new('localhost:11211', :namespace => "Representable::CacheTest", :compress => true)
+    Representable::Cache.cache.flush
+  end
+
+  let(:cache)  { Representable::Cache.cache }
+
+  context "cache configuration" do
+    it "should allow multiple cache_key" do
+      @Brand = Class.new(Object) do
+        include Representable::JSON
+        include Representable::Cache
+        attr_accessor :name, :label, :updated_at
+        property :name
+        property :label
+        property :updated_at
+        representable_cache :cache_key => [:name, :label]
+      end
+      brand = @Brand.new
+      brand.name = "123"
+      brand.label = "321"
+      brand.representable_cache_key.should be_include("123-321")
+    end
+    it "should allow set cache_name" do
+      @Brand = Class.new(Object) do
+        include Representable::JSON
+        include Representable::Cache
+        attr_accessor :name, :label, :updated_at
+        property :name
+        property :label
+        property :updated_at
+        representable_cache :cache_key => :name, :cache_name => "cache_name_123"
+      end
+      brand = @Brand.new
+      brand.name = "123"
+      brand.label = "321"
+      brand.representable_cache_key.should be_include("cache_name_123")
+    end
+    it "should not read from cache if disable it" do
+      @Brand = Class.new(Object) do
+        include Representable::JSON
+        include Representable::Cache
+        attr_accessor :name, :label, :updated_at
+        property :name
+        property :label
+        property :updated_at
+        representable_cache :cache_key => :updated_at
+      end
+      Representable::Cache.enable = false
+      b = @Brand.new
+      b.name = "b1"
+      b.label = "l 1"
+      b.updated_at = Time.now
+      Representable::Cache.cache.set(b.representable_cache_key, {"brand" => {"name"=>"b 2", "label"=>"l 2", "updated_at"=>"2013-08-04 08:55:50 +0800"}})
+      json = b.to_json(:wrap => "brand")
+      hash = MultiJson.decode(json)
+      hash["brand"]["name"].should eq "b1"
+    end
+  end
+
+  context "simple representable" do
+    before do
+      @Brand = Class.new(Object) do
+        include Representable::JSON
+        include Representable::Cache
+        attr_accessor :name, :label, :updated_at
+        property :name
+        property :label
+        property :updated_at
+        representable_cache :cache_key => :updated_at
+      end
+    end
+    it "should write cache" do
+      b = @Brand.new
+      b.name = "b1"
+      b.label = "l 1"
+      b.updated_at = Time.now
+      hash = b.to_hash(:wrap => "brand")
+      Representable::Cache.cache.get(b.representable_cache_key).should eq hash
+    end
+
+    it "to_json should use cache" do
+      b = @Brand.new
+      b.name = "b1"
+      b.label = "l 1"
+      b.updated_at = Time.now
+      Representable::Cache.cache.set(b.representable_cache_key, {"brand" => {"name"=>"b 2", "label"=>"l 2", "updated_at"=>"2013-08-04 08:55:50 +0800"}})
+      json = b.to_json(:wrap => "brand")
+      hash = MultiJson.decode(json)
+      hash["brand"]["name"].should eq "b 2"
+    end
+  end
+
+  context "simple DCI" do
+    before do
+      @Brand = Class.new do
+        attr_accessor :name, :label, :updated_at
+      end
+      @BrandPresenter = Module.new do
+        include Representable::JSON
+        include Representable::Cache
+        property :name
+        property :label
+        property :updated_at
+        representable_cache :cache_key => :updated_at
+      end
+    end
+    it "should write cache" do
+      b = @Brand.new
+      b.extend @BrandPresenter
+      b.name = "b1"
+      b.label = "l 1"
+      b.updated_at = Time.now
+      hash = b.to_hash(:wrap => "brand")
+      Representable::Cache.cache.get(b.representable_cache_key).should eq hash
+    end
+
+    it "to_json should use cache" do
+      b = @Brand.new
+      b.extend @BrandPresenter
+      b.name = "b1"
+      b.label = "l 1"
+      b.updated_at = Time.now
+      Representable::Cache.cache.set(b.representable_cache_key, {"brand" => {"name"=>"b 2", "label"=>"l 2", "updated_at"=>"2013-08-04 08:55:50 +0800"}})
+      json = b.to_json(:wrap => "brand")
+      hash = MultiJson.decode(json)
+      hash["brand"]["name"].should eq "b 2"
+    end
+  end
+
+  context "extend DCI" do
+    before do
+      @Brand = Class.new do
+        attr_accessor :name, :label, :updated_at
+      end
+      brandPresenter = Module.new do
+        include Representable::JSON
+        include Representable::Cache
+        property :name
+        property :updated_at
+        representable_cache :cache_key => :updated_at
+      end
+      @BrandPresenter2 = Module.new do
+        include Representable::JSON
+        include Representable::Cache
+        include brandPresenter
+        property :label
+      end
+    end
+    it "should write cache" do
+      b = @Brand.new
+      b.extend @BrandPresenter2
+      b.name = "b1"
+      b.label = "l 1"
+      b.updated_at = Time.now
+      hash = b.to_hash(:wrap => "brand")
+      Representable::Cache.cache.get(b.representable_cache_key).should eq hash
+    end
+
+    it "to_json should use cache" do
+      b = @Brand.new
+      b.extend @BrandPresenter2
+      b.name = "b1"
+      b.label = "l 1"
+      b.updated_at = Time.now
+      Representable::Cache.cache.set(b.representable_cache_key, {"brand" => {"name"=>"b 2", "label"=>"l 2", "updated_at"=>"2013-08-04 08:55:50 +0800"}})
+      json = b.to_json(:wrap => "brand")
+      hash = MultiJson.decode(json)
+      hash["brand"]["name"].should eq "b 2"
+      hash["brand"]["label"].should eq "l 2"
+    end
+  end
+
+  context "collections" do
+    let(:product_class)  do
+      Class.new do
+        attr_accessor :name,:updated_at
+      end
+    end
+    let(:product_presenter_class) do
+      Module.new do
+        include Representable::JSON
+        include Representable::Cache
+        property :name
+        property :updated_at
+        representable_cache :cache_key => :updated_at, :cache_name => "Product"
+      end
+    end
+
+    before do
+      product_class = product_class
+      productPresenter = product_presenter_class
+      @Brand = Class.new do
+        attr_accessor :name, :label, :updated_at,:products
+      end
+      @BrandPresenter = Module.new do
+        include Representable::JSON
+        include Representable::Cache
+        property :name
+        property :label
+        property :updated_at
+        collection :products, :extend => productPresenter, :class => product_class
+        representable_cache :cache_key => :updated_at, :cache_name => "Brand"
+      end
+    end
+
+    it "should cache each collection object" do
+      p1 = product_class.new
+      p1.name = "p1"
+      p1.updated_at = Time.now
+      p2 = product_class.new
+      p2.name = "p2"
+      p2.updated_at = Time.now
+      b = @Brand.new
+      b.name = "b1"
+      b.label = "l 1"
+      b.products = [p1, p2]
+      b.updated_at = Time.now
+
+      b.extend @BrandPresenter
+      hash = b.to_hash(:wrap => "brand")
+      Representable::Cache.cache.get(b.representable_cache_key).should eq hash
+      p1_hash = Representable::Cache.cache.get(p1.representable_cache_key)
+      p1_hash["name"].should eq "p1"
+    end
+
+    it "should get collection object from cache" do
+      p1 = product_class.new
+      p1.name = "p1"
+      p1.updated_at = Time.now
+      p1.extend product_presenter_class
+
+      b = @Brand.new
+      b.name = "b1"
+      b.label = "l 1"
+      b.updated_at = Time.now
+      b.extend @BrandPresenter
+      b.products = [p1]
+      Representable::Cache.cache.set(p1.representable_cache_key, {"name"=>"p 2","updated_at"=>"2013-08-04 08:55:50 +0800"})
+      json = b.to_json(:wrap => "brand")
+      hash = MultiJson.decode(json)
+      hash["brand"]["products"].first["name"].should eq "p 2"
+    end
+  end
+
+  describe "default_cache_key" do
+    it "should use default cache_key" do
+      Representable::Cache.default_cache_key = [:id, :name]
+      @Brand = Class.new(Object) do
+        include Representable::JSON
+        include Representable::Cache
+        attr_accessor :id, :name, :label, :updated_at
+        property :id
+        property :name
+        property :label
+        property :updated_at
+      end
+      brand = @Brand.new
+      brand.id = "1"
+      brand.name = "123"
+      brand.label = "321"
+      brand.representable_cache_key.should be_include("1-123")
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  #config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  #config.order = 'random'
+  config.before do
+    Representable::Cache.reset
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: representable-cache
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Allen Wei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: representable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: cache solution for representable
+email:
+- digruby@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/representable/cache.rb
+- lib/representable/cache/version.rb
+- representable-cache.gemspec
+- spec/representable/configuration_spec.rb
+- spec/representable/single_representable_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 624065444298100772
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 624065444298100772
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: cache solution for representable
+test_files:
+- spec/representable/configuration_spec.rb
+- spec/representable/single_representable_spec.rb
+- spec/spec_helper.rb