ultracache 0.1.0

data/spec/models/order.rb

@@ -0,0 +1,11 @@
+class Order
+  include Mongoid::Document
+  include Ultracache::Cached
+
+  field :name
+
+  belongs_to :customer
+  cached_queue_in :customer, :as => :cached_orders do |obj|
+    obj.to_json
+  end
+end

data/spec/models/person.rb

@@ -0,0 +1,15 @@
+class Person
+  include Ultracache::Cached
+
+  has_cached_attribute :cached_name do |person|
+    person.name
+  end
+
+  def id
+    "1"
+  end
+
+  def name
+    'person'
+  end
+end

data/spec/models/post.rb

@@ -0,0 +1,9 @@
+class Post
+  include Ultracache::Cached
+
+  attr_accessor :person_id
+
+  def id
+    "1"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+MODELS = File.join(File.dirname(__FILE__), "models")
+$LOAD_PATH.unshift(MODELS)
+
+require "mongoid"
+require "ultracache"
+require "rspec"
+
+Dir[ File.join(MODELS, "*.rb") ].sort.each { |file| require File.basename(file) }
+
+def to_proc(&block)
+  block
+end

data/spec/unit/cached_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe Ultracache::Cached do
+  before do
+    Ultracache::Configurations.storage = Ultracache::Storage::Redis.new(:urls => ['localhost:6379'])
+  end
+
+  context "without model hierarchy" do
+    let(:post) { Post.new }
+
+    it "should have a relationships object" do
+      Post.relationships.should_not == nil
+    end
+  end
+
+  context "with model hierarchy" do
+    let(:person) { Person.new }
+    let(:admin)  { Admin.new }
+
+    context "for parent models" do
+      it "has defined relationships" do
+        expect{person.cached_name}.to_not raise_error(NoMethodError)
+      end
+
+      it "should not have relationships declared in child class" do
+        expect{person.cached_permissions}.to raise_error(NoMethodError)
+      end
+
+      it "has relationships only in its scope" do
+        Person.relationships.keys.should == [:cached_name]
+      end
+    end
+
+    context "for child models" do
+      it "has relationships different to parent class" do
+        Admin.relationships.object_id.should_not == Person.relationships.object_id
+      end
+      it "has defined relationships" do
+        expect{admin.cached_permissions}.to_not raise_error(NoMethodError)
+      end
+
+      it "has relationships declared in parent class" do
+        expect{admin.cached_name}.to_not raise_error(NoMethodError)
+      end
+
+      it "has relationships only in its scope" do
+        Admin.relationships.keys.map(&:to_s).sort.should == [:cached_name, :cached_permissions].map(&:to_s).sort
+      end
+    end
+  end
+end

data/spec/unit/configurations_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Ultracache::Configurations do
+  let(:config) do
+    Ultracache::Configurations
+  end
+
+  let(:redis_storage) do
+    Ultracache::Storage::Redis.new(:urls => ['localhost:6379'])
+  end
+
+  let(:json_serializer) do
+    Ultracache::Serializer::JsonSerializer.new
+  end
+
+  it "cannot be initialized" do
+    Ultracache::Configurations.new.should raise_error(NoMethodError)
+  end
+
+  describe "#storage=" do
+    it "sets storage object for ultracache" do
+      config.storage = redis_storage
+
+      Ultracache::Configurations.storage.should == redis_storage
+    end
+  end
+
+  describe "#serializer=" do
+    it "sets serializer object for ultracache" do
+      config.serializer = json_serializer
+
+      Ultracache::Configurations.serializer.should == json_serializer
+    end
+  end
+
+  describe "#add_relationships" do
+    it "adds relationships object for the specified class" do
+      config.add_relationships(Post)
+      container = config.send :relationships_container
+      container[Post].relationships.should == {}
+    end
+  end
+
+  describe "#find_relationships" do
+    it "finds relationships object associated with the specified class" do
+      config.find_relationships(Post).relationships.should == {}
+    end
+  end
+end

data/spec/unit/relationship/belongs_as_cached_queue_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe Ultracache::BelongsAsCachedQueue do
+  let(:belongs_as_cached_queue) do
+    Ultracache::BelongsAsCachedQueue.new :cached_posts,
+      :self_class => Post, :associated_class => Person do |p|
+      p.to_json
+    end
+  end
+
+  describe "#key" do
+    it "has form of [parent_class]:[id]:[name]" do
+      p = Post.new
+      p.person_id = 1
+      belongs_as_cached_queue.key(p).should == "person:1:cached_posts"
+    end
+  end
+end

data/spec/unit/relationship/has_cached_attribute_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Ultracache::HasCachedAttribute do
+  let(:person_attribute_block) do
+    to_proc do |obj|
+      obj.name
+    end
+  end
+
+  let(:cached_attribute) do
+    Ultracache::HasCachedAttribute.new :cached_name,
+      :self_class => Person, :serializer_block => person_attribute_block
+  end
+
+  describe "#key" do
+    it "has proper form" do
+      cached_attribute.key(Person.new).should == "person:1:cached_name"
+    end
+  end
+end

data/spec/unit/relationship/has_cached_queue_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Ultracache::HasCachedQueue do
+  let(:object_block) do
+    to_proc do |obj|
+      obj.to_json
+    end
+  end
+
+  let(:has_cached_queue) do
+    Ultracache::HasCachedQueue.new :cached_objects,
+      :self_class => 'Person', :serializer_block => object_block
+  end
+
+  describe "#key" do
+    it "has form of [class]:[id]:[name]" do
+      has_cached_queue.key(Person.new).should == "person:1:cached_objects"
+    end
+  end
+end

data/spec/unit/relationship_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe Ultracache::Relationship do
+  it "is initialized with name and options" do
+    relationship = Ultracache::Relationship.new :my,
+      :self_class => 'Person', :associated_class => 'Admin'
+
+    relationship.name.should == :my
+    relationship.self_class.should == Person
+    relationship.associated_class.should == Admin
+  end
+end

data/spec/unit/relationships_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+describe Ultracache::Relationships do
+  let(:relationship_1) { Ultracache::Relationship.new(:attr_1) }
+  let(:relationship_2) { Ultracache::Relationship.new(:attr_2) }
+  let(:relationships) { Ultracache::Relationships.new(Person) }
+
+  let(:relationships_admin) { Ultracache::Relationships.new(Admin) }
+  let(:relationship_3) { Ultracache::Relationship.new(:attr_3) }
+
+  it "is initialized with class" do
+    rs = Ultracache::Relationships.new(Person)
+    rs.klass.should == Person
+  end
+
+  it "is initialized with optional hash" do
+    rs = Ultracache::Relationships.new(Person, :attr_1 => relationship_1)
+    rs.relationships.should == { :attr_1 => relationship_1 }
+  end
+
+  describe "#add" do
+    it "adds relationship objects to self" do
+      relationships.add(relationship_1)
+      relationships.relationships.should == { :attr_1 => relationship_1 }
+    end
+  end
+
+  describe "#keys" do
+    it "returns all key values contained in the relationships object" do
+      relationships.add(relationship_1)
+      relationships.add(relationship_2)
+
+      relationships.keys.map(&:to_s).sort.should == [:attr_1, :attr_2].map(&:to_s).sort
+    end
+  end
+
+  describe "#find" do
+    it "finds desired relationship" do
+      relationships.add(relationship_1)
+      relationships.add(relationship_2)
+
+      relationships.find(:attr_1).should == relationship_1
+    end
+  end
+
+  describe "#merge" do
+    before(:each) do
+      relationships.add(relationship_1)
+      relationships.add(relationship_2)
+      relationships_admin.add(relationship_3)
+    end
+
+    it "concatenates two relationships" do
+      rs = relationships.merge(relationships_admin)
+
+      rs.relationships.should == {
+        :attr_1 => relationship_1,
+        :attr_2 => relationship_2,
+        :attr_3 => relationship_3
+      }
+    end
+
+    it "makes merged relationships to have child class as its label" do
+      rs_1 = relationships.merge(relationships_admin)
+      rs_1.klass.should == Admin
+
+      rs_2 = relationships_admin.merge(relationships)
+      rs_2.klass.should == Admin
+    end
+  end
+
+end

data/spec/unit/serializer/json_serializer_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Ultracache::Serializer::JsonSerializer do
+  let(:serializer) { Ultracache::Serializer::JsonSerializer.new }
+  let(:obj) { Person.new }
+
+  describe "#serialize" do
+    it "serializes object to JSON" do
+      serialized_str = serializer.serialize(obj) do
+        { :id => obj.id }
+      end
+
+      serialized_str.should == "{\"id\":\"1\"}"
+    end
+  end
+
+  describe "#deserialize" do
+    it "deserializes JSON into object hash" do
+      obj_hash = serializer.deserialize("{\"id\":1}")
+
+      obj_hash["id"].should == 1
+    end
+  end
+end

data/ultracache.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+require "ultracache/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ultracache"
+  s.version     = Ultracache::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Inbeom Hwang"]
+  s.email       = ["inbeom@wafflestudio.com"]
+  s.homepage    = "http://github.com/inbeom/ultracache"
+  s.summary     = "Redis based cache for ActiveModel"
+  s.description = "Ultracache reduces computational costs occur from dynamic attributes by caching them into Redis"
+
+  s.add_dependency("activemodel", ["~> 3.0"])
+  s.add_dependency("activesupport", ["~> 3.0"])
+  s.add_dependency("redis", ["~> 2.2"])
+  s.add_dependency("json")
+
+  s.add_development_dependency("rspec", ["~> 2.6"])
+  s.add_development_dependency("mocha")
+  s.add_development_dependency("bson_ext")
+  s.add_development_dependency("mongoid")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: ultracache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Inbeom Hwang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &70152863679380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70152863679380
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70152863677340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70152863677340
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70152863675180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70152863675180
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70152863673460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70152863673460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70152863669820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70152863669820
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70152863666360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70152863666360
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &70152863663540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70152863663540
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70152863657880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70152863657880
+description: Ultracache reduces computational costs occur from dynamic attributes
+  by caching them into Redis
+email:
+- inbeom@wafflestudio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/ultracache.rb
+- lib/ultracache/cached.rb
+- lib/ultracache/configurations.rb
+- lib/ultracache/macro.rb
+- lib/ultracache/models/mongoid_extension.rb
+- lib/ultracache/railtie.rb
+- lib/ultracache/relationship.rb
+- lib/ultracache/relationship/belongs_as_cached_queue.rb
+- lib/ultracache/relationship/has_cached_attribute.rb
+- lib/ultracache/relationship/has_cached_queue.rb
+- lib/ultracache/relationships.rb
+- lib/ultracache/serializer/base.rb
+- lib/ultracache/serializer/json_serializer.rb
+- lib/ultracache/storage/redis.rb
+- lib/ultracache/version.rb
+- spec/models/admin.rb
+- spec/models/customer.rb
+- spec/models/order.rb
+- spec/models/person.rb
+- spec/models/post.rb
+- spec/spec_helper.rb
+- spec/unit/cached_spec.rb
+- spec/unit/configurations_spec.rb
+- spec/unit/relationship/belongs_as_cached_queue_spec.rb
+- spec/unit/relationship/has_cached_attribute_spec.rb
+- spec/unit/relationship/has_cached_queue_spec.rb
+- spec/unit/relationship_spec.rb
+- spec/unit/relationships_spec.rb
+- spec/unit/serializer/json_serializer_spec.rb
+- ultracache.gemspec
+homepage: http://github.com/inbeom/ultracache
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Redis based cache for ActiveModel
+test_files:
+- spec/models/admin.rb
+- spec/models/customer.rb
+- spec/models/order.rb
+- spec/models/person.rb
+- spec/models/post.rb
+- spec/spec_helper.rb
+- spec/unit/cached_spec.rb
+- spec/unit/configurations_spec.rb
+- spec/unit/relationship/belongs_as_cached_queue_spec.rb
+- spec/unit/relationship/has_cached_attribute_spec.rb
+- spec/unit/relationship/has_cached_queue_spec.rb
+- spec/unit/relationship_spec.rb
+- spec/unit/relationships_spec.rb
+- spec/unit/serializer/json_serializer_spec.rb