generation_cacheable 1.0.0

data/spec/gen_cache/keys_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe GenCache do
+	let(:cache) { Rails.cache }
+  let(:user)  { User.create(:login => 'flyerhzm') }
+
+	context "methods" do
+
+		it "should generate a model prefix" do
+			schema_string = User.columns.sort_by(&:name).map { |c| "#{c.name}:#{c.type}"}.join(",")
+			schema_hash = CityHash.hash64(schema_string)
+			prefix = GenCache.model_prefix(User)
+			prefix.should == "users/#{schema_hash}"
+		end
+
+		it "should generate an instance prefix" do
+			attribute_string = user.attributes.sort.map { |k,v| [k,v].join(":")}.join(",")
+			attribute_hash = CityHash.hash64(attribute_string)
+			prefix = GenCache.instance_prefix(user)
+			prefix.should == GenCache.model_prefix(User) + "/#{user.id.to_s}/#{attribute_hash}"
+		end
+
+		it "should generate an instance key" do
+			expected_key = {type: :object, key: GenCache.model_prefix(User) + "/#{user.id.to_s}"}
+			GenCache.instance_key(User, user.id).should == expected_key
+		end
+
+		it "should generate an attribute key" do
+			expected_key = {type: :object, key: GenCache.model_prefix(User) + '/login/pathouse'}
+			att_key = GenCache.attribute_key(User, :login, ['pathouse'])
+			att_key.should == expected_key
+		end
+
+		it "should generate an all w/ attribute key" do
+			expected_key = {type: :object, key: GenCache.model_prefix(User) + "/all/login/pathouse"}
+			att_key = GenCache.attribute_key(User, :login, ['pathouse'], all: true)
+			att_key.should == expected_key
+		end
+
+		it "should generate a class method key" do
+			expected_key = {type: :method, key: GenCache.model_prefix(User) + "/default_name"}
+			cmethod_key = GenCache.class_method_key(User, :default_name)
+			cmethod_key.should == expected_key
+		end
+
+		it "should return all class method keys" do
+			all_cmethod_keys = GenCache.all_class_method_keys(User)
+			comparison = User.cached_class_methods.map do |cmeth|
+				GenCache.class_method_key(User, cmeth)
+			end
+			all_cmethod_keys.should == comparison
+		end
+
+		it "should generate a method key" do
+			expected_key = {type: :method, key: GenCache.instance_prefix(user) + "/last_post"}
+			method_key = GenCache.method_key(user, :last_post)
+			method_key.should == expected_key
+		end
+
+		it "should generate an association key" do
+			expected_key = {type: :association, key: GenCache.instance_prefix(user) + "/posts"}
+			assoc_key = GenCache.association_key(user, :posts)
+			assoc_key.should == expected_key
+		end
+	end
+end

data/spec/gen_cache_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Cacheable do
+  let(:cache) { Rails.cache }
+  let(:user)  { User.create(:login => 'flyerhzm') }
+
+  before :all do
+    @group1 = Group.create(name: "Ruby On Rails")
+    @account = user.create_account(group: @group1)
+    @post1 = user.posts.create(:title => 'post1')
+    @image1 = @post1.images.create
+    @comment1 = @post1.comments.create
+    @tag1 = @post1.tags.create(title: "Rails")
+  end
+
+  before :each do
+    cache.clear
+    user.reload
+  end
+
+  context "Association Expires on Save" do
+    it "should delete has_many with_association cache" do
+      user.cached_posts
+      key = Cacheable.association_key(user, :posts)
+      Rails.cache.read(key[:key]).should_not be_nil
+      @post1.update_attribute(:title, "Blarg")
+      old_key = Rails.cache.read(key[:key]).first
+      Rails.cache.read(old_key[:key]).should be_nil
+    end
+
+    it "should delete has_many with polymorphic with_association cache" do
+      @post1.cached_comments
+      key = Cacheable.association_key(@post1, :comments)
+      Rails.cache.read(key[:key]).should_not be_nil
+      @comment1.update_attribute(:commentable_type, "fart")
+      old_key = Rails.cache.read(key[:key]).first
+      Rails.cache.read(old_key[:key]).should be_nil
+    end
+
+    it "should delete has_many through with_association cache" do
+      user.cached_images
+      key = Cacheable.association_key(user, :images)
+      Rails.cache.read(key[:key]).should_not be_nil
+      @image1.update_attribute(:viewable_type, "Gralb")
+      old_key = Rails.cache.read(key[:key]).first
+      Rails.cache.read(old_key[:key]).should be_nil
+    end
+
+    it "should delete has_one with_association cache" do
+      user.cached_account
+      key = Cacheable.association_key(user, :account)
+      Rails.cache.read(key[:key]).should_not be_nil
+      @account.update_attribute(:group_id, 7)
+      old_key = Rails.cache.read(key[:key]).first
+      Rails.cache.read(old_key[:key]).should be_nil
+    end
+
+    it "should delete has_and_belongs_to_many with_association cache" do
+      @post1.cached_tags
+      key = Cacheable.association_key(@post1, :tags)
+      Rails.cache.read(key[:key]).should_not be_nil
+      old_key = Rails.cache.read(key[:key]).first
+      @tag1.update_attribute(:title, "new title")
+      Rails.cache.read(old_key[:key]).should be_nil
+    end
+
+    it "should delete has_one through belongs_to with_association cache" do
+      @account.update_attribute(:group_id, 1)
+      @group1.update_attribute(:name, "Poop Group")
+      key = Cacheable.association_key(user, :group)
+      Rails.cache.read(key[:key]).should be_nil
+      user.cached_group.should == @group1
+      Rails.cache.read(key[:key]).should == [Cacheable.instance_key(Group, @group1.id)]
+    end
+  end
+end

data/spec/models/account.rb

@@ -0,0 +1,7 @@
+class Account < ActiveRecord::Base
+	include Cacheable 
+	
+  belongs_to :user
+
+  belongs_to :group
+end

data/spec/models/comment.rb

@@ -0,0 +1,9 @@
+class Comment < ActiveRecord::Base
+  include Cacheable
+
+  belongs_to :commentable, :polymorphic => true
+
+  model_cache do
+    with_association :commentable
+  end
+end

data/spec/models/descendant.rb

@@ -0,0 +1,20 @@
+class Descendant < User
+
+  belongs_to :location
+
+  model_cache do
+    with_attribute :email
+    with_method :name
+    with_association :location
+    with_class_method :default_name
+  end
+
+  def name
+    "ScotterC"
+  end
+
+  def self.default_name
+    "ScotterC"
+  end
+
+end

data/spec/models/group.rb

@@ -0,0 +1,6 @@
+class Group < ActiveRecord::Base
+
+  has_many :accounts
+
+  has_many :images, as: :viewable
+end

data/spec/models/image.rb

@@ -0,0 +1,11 @@
+class Image < ActiveRecord::Base
+	include Cacheable
+
+  belongs_to :viewable, :polymorphic => true
+
+  after_commit :do_something
+
+  def do_something
+    e = 1337
+  end
+end

data/spec/models/location.rb

@@ -0,0 +1,3 @@
+class Location < ActiveRecord::Base
+
+end

data/spec/models/post.rb

@@ -0,0 +1,31 @@
+class Post < ActiveRecord::Base
+  include Cacheable
+
+  belongs_to :location
+  belongs_to :user
+
+  has_many :comments, :as => :commentable
+  has_many :images, :as => :viewable
+
+  has_and_belongs_to_many :tags
+
+  model_cache do
+    with_key
+    with_attribute :user_id
+    with_association :user, :comments, :images, :tags
+    with_class_method :default_post, :retrieve_with_user_id, :retrieve_with_both
+  end
+
+  def self.default_post
+    Post.first
+  end
+
+  def self.retrieve_with_user_id(user_id)
+    Post.find_by_user_id(user_id)
+  end
+
+  def self.retrieve_with_both(user_id, post_id)
+    Post.find(post_id) == Post.find_by_user_id(user_id)
+  end
+
+end

data/spec/models/tag.rb

@@ -0,0 +1,6 @@
+class Tag < ActiveRecord::Base
+	include Cacheable
+
+  has_and_belongs_to_many :posts
+
+end

data/spec/models/user.rb

@@ -0,0 +1,54 @@
+class User < ActiveRecord::Base
+  include Cacheable
+
+  has_many :posts
+  has_one :account
+  has_many :images, through: :posts
+
+  has_one :group, through: :account
+
+  model_cache do
+    with_key
+    with_attribute :login
+    with_method :last_post, :bad_iv_name!, :bad_iv_name?
+    with_association :posts, :account, :images, :group
+    with_class_method :default_name, :user_with_id, :user_with_email,
+                      :users_with_ids, :users_with_ids_in, :user_with_attributes
+  end
+
+  def last_post
+    posts.last
+  end
+
+  def self.default_name
+    "flyerhzm"
+  end
+
+  def bad_iv_name!
+    42
+  end
+
+  def bad_iv_name?
+    44
+  end
+
+    # accepts a number
+  def self.user_with_id(id)
+    User.find(id)
+  end
+
+  # accepts a string
+  def self.user_with_email(email)
+    User.find_by_email(email)
+  end
+
+  # accepts an array
+  def self.users_with_ids(ids)
+    User.find(ids)
+  end
+
+  # accepts a range
+  def self.users_with_ids_in(range)
+    User.select { |u| range.include?(u.id) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'rails'
+require 'active_record'
+require 'rspec'
+require 'mocha/api'
+require 'memcached'
+require 'cacheable'
+
+# It needs this order otherwise cacheable throws
+# errors when looking for reflection classes
+# Specifically, post can't be before tag
+# and user can't be before post
+require 'models/location'
+require 'models/account'
+require 'models/group'
+require 'models/comment'
+require 'models/image'
+require 'models/tag'
+require 'models/post'
+require 'models/user'
+require 'models/descendant'
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+module Rails
+  class <<self
+    def cache
+      @cache ||= Memcached::Rails.new
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.before :all do
+    ::ActiveRecord::Schema.define(:version => 1) do
+      create_table :users do |t|
+        t.string :login
+        t.string :email
+      end
+
+      create_table :accounts do |t|
+        t.integer :user_id
+        t.integer :group_id
+      end
+
+      create_table :posts do |t|
+        t.integer :user_id
+        t.string :title
+        t.integer :location_id
+      end
+
+      create_table :comments do |t|
+        t.integer :commentable_id
+        t.string :commentable_type
+      end
+
+      create_table :images do |t|
+        t.integer :viewable_id
+        t.string :viewable_type
+        t.string :name
+      end
+
+      create_table :tags do |t|
+        t.string :title
+      end
+
+      create_table :posts_tags, id: false do |t|
+        t.integer :post_id
+        t.integer :tag_id
+      end
+
+      create_table :groups do |t|
+        t.string :name
+      end
+
+      create_table :locations do |t|
+        t.string :city
+      end
+    end
+
+  end
+
+  config.after :all do
+    ::ActiveRecord::Base.connection.tables.each do |table|
+      ::ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: generation_cacheable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pat McGee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.5
+description: a simple cache implementation with attribute based expiry
+email:
+- patmcgee331@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- ChangeLog
+- Gemfile
+- README.md
+- Rakefile
+- generation_cacheable.gemspec
+- lib/gen_cache.rb
+- lib/gen_cache/cache_io/fetching.rb
+- lib/gen_cache/cache_io/formatting.rb
+- lib/gen_cache/cache_io/parsing.rb
+- lib/gen_cache/cache_types/association_cache.rb
+- lib/gen_cache/cache_types/attribute_cache.rb
+- lib/gen_cache/cache_types/class_method_cache.rb
+- lib/gen_cache/cache_types/key_cache.rb
+- lib/gen_cache/cache_types/method_cache.rb
+- lib/gen_cache/caches.rb
+- lib/gen_cache/expiry.rb
+- lib/gen_cache/keys.rb
+- lib/gen_cache/version.rb
+- spec/gen_cache/cache_io/fetching_spec.rb
+- spec/gen_cache/cache_io/formatting_spec.rb
+- spec/gen_cache/cache_io/parsing_spec.rb
+- spec/gen_cache/cache_types/association_cache_spec.rb
+- spec/gen_cache/cache_types/attribute_cache_spec.rb
+- spec/gen_cache/cache_types/class_method_cache_spec.rb
+- spec/gen_cache/cache_types/key_cache_spec.rb
+- spec/gen_cache/cache_types/method_cache_spec.rb
+- spec/gen_cache/expiry_spec.rb
+- spec/gen_cache/keys_spec.rb
+- spec/gen_cache_spec.rb
+- spec/models/account.rb
+- spec/models/comment.rb
+- spec/models/descendant.rb
+- spec/models/group.rb
+- spec/models/image.rb
+- spec/models/location.rb
+- spec/models/post.rb
+- spec/models/tag.rb
+- spec/models/user.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pathouse/generation-cacheable
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: a simple cache implementation with attribute based expiry
+test_files:
+- spec/gen_cache/cache_io/fetching_spec.rb
+- spec/gen_cache/cache_io/formatting_spec.rb
+- spec/gen_cache/cache_io/parsing_spec.rb
+- spec/gen_cache/cache_types/association_cache_spec.rb
+- spec/gen_cache/cache_types/attribute_cache_spec.rb
+- spec/gen_cache/cache_types/class_method_cache_spec.rb
+- spec/gen_cache/cache_types/key_cache_spec.rb
+- spec/gen_cache/cache_types/method_cache_spec.rb
+- spec/gen_cache/expiry_spec.rb
+- spec/gen_cache/keys_spec.rb
+- spec/gen_cache_spec.rb
+- spec/models/account.rb
+- spec/models/comment.rb
+- spec/models/descendant.rb
+- spec/models/group.rb
+- spec/models/image.rb
+- spec/models/location.rb
+- spec/models/post.rb
+- spec/models/tag.rb
+- spec/models/user.rb
+- spec/spec_helper.rb