prosto_cache 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--format
+documentation
+--backtrace
+

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+  gem "reek", "~> 1.2.8"
+  gem "roodi", "~> 2.1.0"
+  gem "rake", "0.8.7"
+end
+
+gem "hashie", ">= 1.0.0"

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    hashie (1.0.0)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.5)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  hashie (>= 1.0.0)
+  jeweler (~> 1.6.0)
+  rake (= 0.8.7)
+  rcov
+  reek (~> 1.2.8)
+  roodi (~> 2.1.0)
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Olek Poplavsky
+
+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.rdoc

@@ -0,0 +1,19 @@
+= prosto_cache
+
+Description goes here.
+
+== Contributing to prosto_cache
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Olek Poplavsky. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "prosto_cache"
+  gem.homepage = "http://github.com/olek/prosto_cache"
+  gem.license = "MIT"
+  gem.summary = %Q{Very simple caching for your ActiveRecord models.}
+  gem.description = %Q{Use this gem if you want a simple 'enum-like' cache for your models that does not restrict updates, but will stay current with them.}
+  gem.email = "olek@woodenbits.com"
+  gem.authors = ["Olek Poplavsky"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/prosto_cache.rb

@@ -0,0 +1,139 @@
+=begin
+This library provides a simple way to cache model and to access this cache in some canonical way.
+Any changes to the model's objects will automatically result in cache reload.
+Cache reload in other ruby processes of same app will be triggered as well, but with some delay (currently up to 60 seconds).
+If delay in cache reloading is not an option, well, this simply library will not work for you, and you have to use something fancier, like Memcached.
+
+Usage:
+1. add ProstoCache mixin to your model
+  class YourModel < ActiveRecord::Base
+    include ProstoCache
+2. Configure cache access keys (optional step, by default cache is accessed by key 'name')
+  cache_accessor_keys %w(scope name)
+3. Your model must have non-nullable column updated_at, add it in migration if it is missing (this field is used for invalidating cache in other ruby processes).
+4. Access cached model object in your code like this
+  Simple case of one key
+    YourModel.cache[:key1]
+  Case of 2 or more keys where it is known ahead of time that all parent keys exist. Looks conventional, but is unreliable because brackets operation on nill will raise an error.
+    YourModel.cache[:key1][:key2][:key3]
+  Case of 2 or more keys where any key may not be present in cache, and expected answer is nil. Looks so-so, but is much more reliable then previos use case.
+    YourModel.cache[[:key1, :key2, :key3]]
+=end
+
+require 'hashie'
+
+module ProstoCache
+  # cache itself, contains pretty much all the logic
+  class ProstoModelCache
+    attr_accessor :model_class, :cache, :signature, :validated_at, :accessor_keys
+
+    def initialize(model_class, accessor_keys)
+      self.model_class = model_class
+      self.accessor_keys = accessor_keys || 'name'
+    end
+
+    def invalidate
+      self.cache = self.signature = self.validated_at = nil
+    end
+
+    def [](keys)
+      if keys.respond_to?(:to_ary)
+        keys_ary = keys.to_ary
+        if keys_ary.empty?
+          nil
+        else
+          # looks like an array of key was passed in, lets try them one after another, without failing
+          keys_ary.inject(safe_cache) do |memo,key|
+            break unless memo
+            memo[key]
+          end
+        end
+      else
+        safe_cache[keys]
+      end
+    end
+
+    def keys
+      safe_cache.keys
+    end
+
+    def values
+      safe_cache.values
+    end
+
+    private
+
+    def safe_cache
+      max_cache_life = 60 # seconds
+      current_time = Time.now.to_i
+
+      if cache && validated_at < current_time - max_cache_life
+        current_cache_signature = query_cache_signature
+        if current_cache_signature == signature
+          self.validated_at = current_time
+        else
+          invalidate
+        end
+      end
+
+      unless cache
+        current_cache_signature ||= query_cache_signature
+
+        self.cache = build_cache(model_class.all, accessor_keys)
+        self.validated_at = current_time
+        self.signature = current_cache_signature
+      end
+
+      return cache
+    end
+
+    def build_cache(objects, attributes=nil)
+      attributes = [*attributes] if attributes
+      if !attributes || attributes.empty?
+        # terminal case
+        raise "No cache entry found" if objects.nil? || objects.empty?
+        raise "Non deterministic search result, more then one cache entry found" if objects.size > 1
+        return objects.first
+      else
+        reduced_attributes = attributes.dup
+        attribute = reduced_attributes.delete_at(0).to_sym
+        array_map = objects.inject({}) do |memo, o|
+          key = o.send(attribute).to_s
+          memo[key] ||= []
+          memo[key] << o
+          memo
+        end
+        array_map.inject(Hashie::Mash.new) do |memo, (k, v)|
+          # recursion !
+          memo[k] = build_cache(v, reduced_attributes)
+          memo
+        end
+      end
+    end
+
+    def query_cache_signature
+      raw_result = ActiveRecord::Base.connection.execute "select max(updated_at) as max_updated_at, max(id) as max_id, count(id) as count from #{model_class.name.tableize}"
+      raw_result.map(&:to_hash).map(&:symbolize_keys).first
+    end
+  end
+
+  def self.included(cl)
+
+    cl.after_save { cl.cache.invalidate }
+
+    class << cl
+
+      def cache
+        @cache ||= ProstoModelCache.new self, @accessor_keys
+      end
+
+      def cache_accessor_keys(keys)
+        @accessor_keys = keys
+      end
+    end
+  end
+end
+
+
+
+

data/spec/prosto_cache_spec.rb

@@ -0,0 +1,120 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ProstoCache" do
+  before do
+    Object.send(:remove_const, 'Foo') if Object.const_defined? 'Foo'
+
+    class Foo; end
+    Foo.should_receive(:after_save)
+    class Foo
+      include ProstoCache
+    end
+  end
+
+  it "should be a mix-in" do
+  end
+
+  it "should add a cache method" do
+    Foo.cache.should_not be_nil
+    Foo.cache.should be_an_instance_of(ProstoCache::ProstoModelCache)
+  end
+
+  it "should not load cache if it was never accessed" do
+    Foo.cache.should_not be_nil
+    Foo.cache.should_not_receive(:query_cache_signature)
+    Foo.should_not_receive(:all)
+  end
+
+  context "[] method with single key access" do
+    before do
+      Object.send(:remove_const, 'Foo') if Object.const_defined? 'Foo'
+
+      class Foo
+        attr_accessor :name
+        def initialize(name)
+          self.name = name
+        end
+      end
+
+      Foo.should_receive(:after_save)
+
+      class Foo
+        include ProstoCache
+      end
+
+      Foo.cache.should_not be_nil
+      Foo.cache.should_receive(:query_cache_signature).once.and_return(:foo)
+      Foo.should_receive(:all).once.and_return(%w(foo bar).map { |n| Foo.new(n) })
+    end
+
+    it "should load cache when it is accessed" do
+      Foo.cache[:nondef]
+    end
+
+    it "should return nil for key that was not found" do
+      Foo.cache[:nondef].should be_nil
+    end
+
+    it "should return proper object for key that was found" do
+      Foo.cache[:foo].should_not be_nil
+      Foo.cache[:foo].name.should == 'foo'
+      Foo.cache[:bar].name.should == 'bar'
+    end
+  end
+
+  context "[] method with composite key access" do
+    before do
+      Object.send(:remove_const, 'Foo') if Object.const_defined? 'Foo'
+
+      class Foo
+        attr_accessor :key1, :key2, :name
+        def initialize(name, key1, key2)
+          self.name = name
+          self.key1 = key1
+          self.key2 = key2
+        end
+      end
+
+      Foo.should_receive(:after_save)
+
+      class Foo
+        include ProstoCache
+        cache_accessor_keys %w(key1 key2)
+      end
+
+      Foo.cache.should_not be_nil
+      Foo.cache.should_receive(:query_cache_signature).once.and_return(:foo)
+      Foo.should_receive(:all).once.and_return(%w(foo bar).map { |n| Foo.new(n, n + '1', n + '2') })
+    end
+
+    it "should return nil for first level key that was not found" do
+      Foo.cache[:nondef].should be_nil
+    end
+
+    it "should return nil for second level key that was not found" do
+      Foo.cache[:foo1][:nondef].should be_nil
+    end
+
+    it "should return nil for safe access method when first level key was not found" do
+      Foo.cache[[:nodef, :foo2]].should be_nil
+    end
+
+    it "should return proper object for key that was found, using unsafe access method" do
+      Foo.cache[:foo1][:foo2].should_not be_nil
+      Foo.cache[:foo1][:foo2].name.should == 'foo'
+      Foo.cache[:bar1][:bar2].name.should == 'bar'
+    end
+
+    it "should return proper object for key that was found, using safe access method" do
+      Foo.cache[[:foo1, :foo2]].should_not be_nil
+      Foo.cache[[:foo1, :foo2]].name.should == 'foo'
+      Foo.cache[[:bar1, :bar2]].name.should == 'bar'
+    end
+
+    it "should fail with exception for the unsafe access method when first level key that was not found" do
+      lambda {
+        Foo.cache[:nondef][:foo2]
+      }.should raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'prosto_cache'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,235 @@
+--- !ruby/object:Gem::Specification 
+name: prosto_cache
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Olek Poplavsky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: hashie
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  name: jeweler
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 2
+        - 8
+        version: 1.2.8
+  name: reek
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  name: roodi
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  name: rake
+  version_requirements: *id009
+description: Use this gem if you want a simple 'enum-like' cache for your models that does not restrict updates, but will stay current with them.
+email: olek@woodenbits.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/prosto_cache.rb
+- spec/prosto_cache_spec.rb
+- spec/spec_helper.rb
+- vendor/cache/diff-lcs-1.1.2.gem
+- vendor/cache/git-1.2.5.gem
+- vendor/cache/hashie-1.0.0.gem
+- vendor/cache/jeweler-1.6.0.gem
+- vendor/cache/rake-0.8.7.gem
+- vendor/cache/rcov-0.9.9.gem
+- vendor/cache/reek-1.2.8.gem
+- vendor/cache/roodi-2.1.0.gem
+- vendor/cache/rspec-2.3.0.gem
+- vendor/cache/rspec-core-2.3.1.gem
+- vendor/cache/rspec-expectations-2.3.0.gem
+- vendor/cache/rspec-mocks-2.3.0.gem
+- vendor/cache/ruby2ruby-1.2.5.gem
+- vendor/cache/ruby_parser-2.0.6.gem
+- vendor/cache/sexp_processor-3.0.5.gem
+- vendor/cache/yard-0.6.8.gem
+has_rdoc: true
+homepage: http://github.com/olek/prosto_cache
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Very simple caching for your ActiveRecord models.
+test_files: []
+