jqr-versionable 0.0.3

data/CHANGELOG

@@ -0,0 +1,5 @@
+v0.0.3. New standardized usage with per-model options.
+
+v0.0.2. Initial gem release.
+
+v0.0.1. Initial release.

data/Manifest

@@ -0,0 +1,10 @@
+CHANGELOG
+init.rb
+lib/versionable.rb
+Manifest
+Rakefile
+README.rdoc
+spec/fake_cache.rb
+spec/spec_helper.rb
+spec/versionable.spec
+versionable.gemspec

data/README.rdoc

@@ -0,0 +1,54 @@
+= Versionable
+
+Super fast and easy versioning for models and associations. Do cache lookups 
+using this fast version number instead of managing complex cache expiry.
+
+Versionable is intended for versioning of a model or an association and doesn't 
+currently provide any means of caching version numbers for normal model 
+instances.
+
+== Examples
+
+  # A simple User model with a User.cached_all method that returns all users 
+  # in the application. This method is cached and will automatically "expire" 
+  # whenever a record is saved or you call User.new_version.
+
+  class User < ActiveRecord::Base
+    versionable :cache => Rails.cache
+    
+    after_save { new_version }
+    
+    def self.cached_all
+      # reference version in cache keys
+      Rails.cache.fetch("User.cached_all:#{version}") { all }
+    end
+  end
+  
+  >> User.cached_all    # initial cache miss and cache fill
+  >> User.cached_all    # cache hit
+
+  >> User.new_version   # => 1224985243
+  >> User.cached_all    # new cache miss and cache fill
+  
+  >> User.first.save    # causing new_version to be called from after_save
+  >> User.cached_all    # new cache miss and cache fill
+
+
+You can also use it on associations...
+
+
+== Install
+
+As a Rails plugin.
+
+  ./script/plugin install git://github.com/jqr/versionable.git
+
+Prefer gems? Add this to your environment.rb and run the following command.
+
+  config.gem 'jqr-versionable', :lib => 'versionable', :source => 'http://gems.github.com'
+
+  $ rake gems:install
+
+
+Homepage:: http://github.com/jqr/versionable/tree/master  
+License:: Copyright (c) 2008 Elijah Miller <mailto:elijah.miller@gmail.com>, released under the MIT license.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'spec/rake/spectask'
+
+require 'echoe'
+Echoe.new 'versionable' do |p|
+  p.description     = "Simple versioning for Ruby objects using only the Rails cache."
+  # p.url             = "http://versionable.rubyforge.org"
+  p.author          = "Elijah Miller"
+  p.email           = "elijah.miller@gmail.com"
+  p.retain_gemspec  = true
+  p.need_tar_gz     = false
+  p.extra_deps      = [
+  ]
+end
+
+desc 'Default: run specs'
+task :default => :spec
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end
+
+task :test => :spec

data/init.rb

@@ -0,0 +1 @@
+require 'versionable'

data/lib/versionable.rb

@@ -0,0 +1,81 @@
+class Object
+  # For extending models and assocations to provide an time based version number
+  # for cache expiration by changing part of the key we lookup the cache by.
+  def versionable(options = {})
+    default_options = {
+      # :cache => Rails.cache,
+      :ttl => 0
+    }
+    instance_eval "
+      class << self
+        attr_accessor :versionable_options
+      end
+    "
+    self.versionable_options = default_options.merge(options)
+
+    include Versionable
+  end
+end
+
+module Versionable
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    # Returns the current version of the assocation. Likely to be nil.
+    def version
+      versionable_options[:cache].read(version_cache_key)
+    end
+
+    # Sets the version of this assocation to the current time in integer form.
+    def new_version
+      # the expiry needs to be longer than any page that might use this as a
+      # cache key.
+      time = Time.now.to_i
+      versionable_options[:cache].write(version_cache_key, time, :expires_in => versionable_options[:ttl])
+      time
+    end
+
+    # Returns the association version key.
+    def version_cache_key
+      parts =
+        if object.class == Class
+          [object]
+        else
+          [object.class, object.id]
+        end
+      
+      parts << version_name
+      parts * ':'
+    end
+  
+    # Returns the object that version applies to.
+    def object
+      if inside_association?
+        proxy_owner
+      else
+        self
+      end
+    end
+  
+    # Returns the name portion of the version cache key
+    def version_name
+      if inside_association?
+        "#{proxy_reflection.name}_version"
+      else
+        "version"
+      end
+    end
+  
+    private
+    
+    # Returns true if this is called with the context available to an 
+    # assocation.
+    def inside_association?
+      # TODO: see if we can memoize
+      self.respond_to?(:proxy_owner)
+    end
+  end
+end

data/spec/fake_cache.rb

@@ -0,0 +1,16 @@
+class FakeCache
+  attr_accessor :store
+  
+  def initialize
+    self.store = {}
+  end
+  
+  def read(key)
+    store[key]
+  end
+
+  def write(key, value, options = {})
+    store[key] = value
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'spec'
+
+$: << File.dirname(__FILE__)
+require 'fake_cache'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'versionable')
+

data/spec/versionable.spec

@@ -0,0 +1,48 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Versionable do
+  describe "initializing" do
+    it "should allow initializing without any options" do
+      lambda { 
+        class DefaultListy
+          versionable
+        end
+      }.should_not raise_error
+    end
+
+    it "should store options in Class.versionable_options" do
+      class TTLListy
+        versionable :ttl => 60
+      end
+      
+      TTLListy.versionable_options.should == { :ttl => 60 }
+    end
+
+  end
+
+  describe "versioning" do
+    before(:each) do
+      class Listy
+        versionable :cache => FakeCache.new, :ttl => 30
+      end
+      @cache = Listy.versionable_options[:cache]
+      @ttl =  Listy.versionable_options[:ttl]
+    end
+    
+    it "should start off with a nil version" do
+      Listy.version.should == nil
+    end
+
+    it "should have a version after calling new_version" do
+      Listy.new_version
+      Listy.new_version.should_not be_nil
+    end
+
+    it "should set the version with the TTL from the options" do
+      @cache.should_receive(:write).with(anything, anything, hash_including(:expires_in => 30))
+      Listy.new_version
+    end
+
+  end
+
+end

data/versionable.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{versionable}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Elijah Miller"]
+  s.date = %q{2009-02-09}
+  s.description = %q{Simple versioning for Ruby objects using only the Rails cache.}
+  s.email = %q{elijah.miller@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/versionable.rb", "README.rdoc"]
+  s.files = ["CHANGELOG", "init.rb", "lib/versionable.rb", "Manifest", "Rakefile", "README.rdoc", "spec/fake_cache.rb", "spec/spec_helper.rb", "spec/versionable.spec", "versionable.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Versionable", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{versionable}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Simple versioning for Ruby objects using only the Rails cache.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: jqr-versionable
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Elijah Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-09 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simple versioning for Ruby objects using only the Rails cache.
+email: elijah.miller@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/versionable.rb
+- README.rdoc
+files: 
+- CHANGELOG
+- init.rb
+- lib/versionable.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- spec/fake_cache.rb
+- spec/spec_helper.rb
+- spec/versionable.spec
+- versionable.gemspec
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Versionable
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: versionable
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple versioning for Ruby objects using only the Rails cache.
+test_files: []
+