cached_at 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b1253fed9c1d3d09be31eb8c020547d0457f3b7
-  data.tar.gz: 8fbc50fb8c8c3e2baa3268c4c4245319793bfc0c
+  metadata.gz: 0d073e4785a832e81ac169d68ada7c955ca1c8e8
+  data.tar.gz: 9b8b06f0c202052174deee91e542114f76eafed9
 SHA512:
-  metadata.gz: c858b0d99ce82233306a5342c10053350fbac67364c89a4384711c9827925bd8699917858e1307577469629b51af4bf6afe7717a4bf173db2da0fc2b7c7aac35
-  data.tar.gz: 82cac81a5325d5a27f88e3de960e99b6e6be1f35b7b18df5e191b563517bdeaf3920b360ee6afe9fbd0477a7b79d09b67d64c54e1f84b8d443f80c58a03e6a89
+  metadata.gz: 27194ed3a1eecbc22ecb0167c69710a77156791ee73d7318af4314aeec208b72447a4907efc2717ea5a3d0bab6ed034c3c8426b6dfb702e3fe52ffac150ebd5e
+  data.tar.gz: 7cda8cb407d51f94303ac1020b0678f4d5df6fc2cc46a32daea14b25423458d8c40d6f91e7a216c64e39fb59e4f3b432cd45a606abdaf595cffcbddedcedfad9

data/README.md

@@ -3,7 +3,7 @@
 [![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
+Use cached_at for ActiveRecord cache key instead of updated at
 
 ## Installation
 
@@ -20,12 +20,45 @@ 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.
+Too add to any class, just include CachedAt
 
     class User
       include CachedAt
     end
 
+You will need to add the cached_at column to the table
+
+    rails generate migration add_cached_at_to_users cached_at:datetime
+
+The cache_at column will be update when a record is created or updated.
+
+    user = User.create # sets the cached_at
+    user.save          # updates cached_at if another attribute on the record has changed
+
+When a records associations are created/updated, the cached_at column will be updated but the updated_at will not change.
+
+    class Post
+      belongs_to :user, touch: true
+    end
+
+    post = Post.create user: user # updates the user cached_at
+
+Gem also provides class method `cache_key` for your model, that
+ will generate cache key string from `maximum(:cached_at)`
+
+    Post.cache_key
+    # SELECT MAX(`posts`.`cached_at`) AS max_id FROM `posts`
+    # => "Post-1377768216"
+
+This way you can pass your model class to `Rails.cache.fetch` as an
+argument to monitor when any record was changed.
+
+    Rails.cache.fetch [Post, 'last_posts'] do
+      Post.last_posts
+    end
+    # => Cache fetch_hit: Post-1377768216/last_posts
+
+
 ## Contributing
 
 1. Fork it

data/cached_at.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.homepage      = "https://github.com/delwyn/cached_at"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/cached_at.rb

@@ -4,6 +4,7 @@ module CachedAt
   def self.included(klass)
     klass.instance_eval do
       before_save :_set_cached_at
+      klass.extend ClassMethods
     end
   end
 
@@ -23,6 +24,12 @@ module CachedAt
     update_column :cached_at, current_time_from_proper_timezone
   end
 
+  module ClassMethods
+    def cache_key
+      "#{model_name}-#{maximum(:cached_at).to_i}"
+    end
+  end
+
   private
   def _set_cached_at
     self.cached_at = current_time_from_proper_timezone if new_record? || self.changed?

data/lib/cached_at/version.rb

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

data/test/cached_at_test.rb

@@ -94,4 +94,15 @@ describe 'Cached At' do
       end
     end
   end
+
+  describe 'Model.cache_key' do
+    subject { User.cache_key }
+
+    it { subject.must_equal "User-#{User.maximum(:cached_at).to_i}" }
+
+    context 'when no record exist' do
+      before { User.destroy_all }
+      it { subject.must_equal "User-0" }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cached_at
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Delwyn de Villiers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-22 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,7 +97,7 @@ files:
 - lib/cached_at/version.rb
 - test/cached_at_test.rb
 - test/test_helper.rb
-homepage: ''
+homepage: https://github.com/delwyn/cached_at
 licenses:
 - MIT
 metadata: {}
@@ -124,3 +124,4 @@ summary: Use cached_at for ActiveRecord cache key instead of updated at
 test_files:
 - test/cached_at_test.rb
 - test/test_helper.rb
+has_rdoc: