cached_at 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b1253fed9c1d3d09be31eb8c020547d0457f3b7
+  data.tar.gz: 8fbc50fb8c8c3e2baa3268c4c4245319793bfc0c
+SHA512:
+  metadata.gz: c858b0d99ce82233306a5342c10053350fbac67364c89a4384711c9827925bd8699917858e1307577469629b51af4bf6afe7717a4bf173db2da0fc2b7c7aac35
+  data.tar.gz: 82cac81a5325d5a27f88e3de960e99b6e6be1f35b7b18df5e191b563517bdeaf3920b360ee6afe9fbd0477a7b79d09b67d64c54e1f84b8d443f80c58a03e6a89

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Delwyn de Villiers
+
+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,35 @@
+# CachedAt
+
+[![Build Status](https://api.travis-ci.org/delwyn/cached_at.png?branch=master)](http://travis-ci.org/delwyn/cached_at)
+[![Code Climate](https://codeclimate.com/github/delwyn/cached_at.png)](https://codeclimate.com/github/delwyn/cached_at)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cached_at'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cached_at
+
+## Usage
+Too add to any class, just include CachedAt. The cache_at column will be update when a record is created or updated.
+
+    class User
+      include CachedAt
+    end
+
+## 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,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/cached_at.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cached_at/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cached_at"
+  spec.version       = CachedAt::VERSION
+  spec.authors       = ["Delwyn de Villiers"]
+  spec.email         = ["delwyn.d@gmail.com"]
+  spec.description   = %q{Use cached_at for ActiveRecord cache key}
+  spec.summary       = %q{Use cached_at for ActiveRecord cache key instead of updated at}
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "activerecord", "~> 3.2"
+  spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/cached_at/version.rb

@@ -0,0 +1,3 @@
+module CachedAt
+  VERSION = "0.0.1"
+end

data/lib/cached_at.rb

@@ -0,0 +1,30 @@
+require "cached_at/version"
+
+module CachedAt
+  def self.included(klass)
+    klass.instance_eval do
+      before_save :_set_cached_at
+    end
+  end
+
+  def cache_key
+    case
+    when new_record?
+      "#{self.class.model_name.cache_key}/new"
+    when timestamp = self[:cached_at]
+      timestamp = timestamp.utc.to_s(:number)
+      "#{self.class.model_name.cache_key}/#{id}-#{timestamp}"
+    else
+      "#{self.class.model_name.cache_key}/#{id}"
+    end
+  end
+
+  def touch(name = nil)
+    update_column :cached_at, current_time_from_proper_timezone
+  end
+
+  private
+  def _set_cached_at
+    self.cached_at = current_time_from_proper_timezone if new_record? || self.changed?
+  end
+end

data/test/cached_at_test.rb

@@ -0,0 +1,97 @@
+require 'test_helper'
+
+def key_for(object, key)
+  timestamp = object.send(key).utc.to_s(:number)
+  "#{object.class.model_name.cache_key}/#{object.id}-#{timestamp}"
+end
+
+describe 'Cached At' do
+  describe 'Cache Key' do
+    context 'new record' do
+      it 'uses new' do
+        user = User.new
+        user.cache_key.must_equal 'users/new'
+      end
+    end
+
+    context 'existing record' do
+      it 'uses cached_at' do
+        user = User.create
+        user.cached_at = Time.now + 1.minute
+        user.cache_key.wont_equal key_for(user, :updated_at)
+        user.cache_key.must_equal key_for(user, :cached_at)
+      end
+    end
+
+    context 'cached_at nil' do
+      it 'user' do
+        user = User.create
+        user.cached_at = nil
+        user.cache_key.must_equal "users/#{user.id}"
+      end
+    end
+  end
+
+  describe 'Set Cached At' do
+    it 'sets cached_at when creating' do
+      user = User.new
+      user.cached_at.must_be_nil
+      user.save
+      user.cached_at.wont_be_nil
+    end
+
+    it 'updates cached_at when updating' do
+      user = User.create
+      old_cached_at = user.cached_at
+      user.update_attribute(:name, 'Bob')
+      user.cached_at.wont_equal old_cached_at
+    end
+
+    it 'does not update the cached_at when nothing has changed' do
+      user = User.create
+      cached_at = user.cached_at
+      user.save
+      user.cached_at.must_equal cached_at
+    end
+  end
+
+  describe 'Associated' do
+    let(:user) { User.create }
+
+    context 'create association' do
+      let(:post) { Post.new user: user }
+
+      before do
+        @old_cached_at  = user.cached_at
+        @old_updated_at = user.updated_at
+        post.save
+      end
+
+      it 'updates the cached_at' do
+        user.cached_at.wont_equal @old_cached_at
+      end
+
+      it 'does not update the updated_at' do
+        user.updated_at.must_equal @old_updated_at
+      end
+    end
+
+    context 'update association' do
+      let(:post) { Post.create user: user }
+
+      before do
+        @old_cached_at  = user.cached_at
+        @old_updated_at = user.updated_at
+        post.update_attribute(:title, 'New')
+      end
+
+      it 'updates the cached_at' do
+        user.cached_at.wont_equal @old_cached_at
+      end
+
+      it 'does not update the updated_at' do
+        user.updated_at.must_equal @old_updated_at
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+require 'bundler/setup'
+require 'cached_at'
+require 'minitest/autorun'
+require 'active_record'
+
+class Minitest::Spec
+  class << self
+    alias :context :describe
+  end
+end
+
+ActiveRecord::Base::establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+ActiveRecord::Base.connection.execute(%{CREATE TABLE users  (id INTEGER PRIMARY KEY, name VARCHAR, updated_at DATETIME, cached_at DATETIME);})
+ActiveRecord::Base.connection.execute(%{CREATE TABLE posts  (id INTEGER PRIMARY KEY, title STRING, user_id INTEGER, updated_at DATETIME);})
+
+class User < ActiveRecord::Base
+  include CachedAt
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :user, touch: true
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: cached_at
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Delwyn de Villiers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+- !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'
+description: Use cached_at for ActiveRecord cache key
+email:
+- delwyn.d@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cached_at.gemspec
+- lib/cached_at.rb
+- lib/cached_at/version.rb
+- test/cached_at_test.rb
+- test/test_helper.rb
+homepage: ''
+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.3
+signing_key: 
+specification_version: 4
+summary: Use cached_at for ActiveRecord cache key instead of updated at
+test_files:
+- test/cached_at_test.rb
+- test/test_helper.rb