prosto_cache 0.1.1 → 0.1.2

data/Gemfile

@@ -1,18 +1,8 @@
 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 "bundler", "~> 1.1.0"
   gem "rake", "0.8.7"
 end
 

data/Gemfile.lock

@@ -2,20 +2,8 @@ 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)
@@ -24,24 +12,12 @@ GEM
     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)
+  bundler (~> 1.1.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/README.rdoc

@@ -1,9 +1,30 @@
 = prosto_cache
 
-Description goes here.
+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]]
 
 == 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

data/Rakefile

@@ -1,55 +1,9 @@
 # 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 "bundler/gem_tasks"
 
 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/lib/prosto_cache.rb

@@ -18,6 +18,14 @@ Usage:
     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]]
+5. If you want to, you can add extra lookup helpers to the objects that relate to the cached object, that will allow those objects to update 'string' attribute, and that will result in database reference change.
+    class OtherModel < ActiveRecord::Base
+      belongs_to :your_model
+      lookup_enum_for :your_model
+    end
+    
+    This lookup was intertionally not integrated with ActiveRecord since not everybody would want that, and monkey-patching other library (AR) is not really a good thing, even if it results in more magically 'smooth' experience.
+    Principle of least surprise, right?
 =end
 
 require 'hashie'
@@ -140,6 +148,21 @@ module ProstoCache
       end
     end
   end
+    module Extensions
+    def lookup_enum_for(name, enum_class=nil)
+      raise unless name
+      enum_class = name.to_s.classify.constantize unless enum_class
+      define_method("#{name}_with_lookup=") do |o|
+        new_value = o
+        unless o.is_a?(enum_class)
+          new_value = o.blank? ? nil : enum_class[o.to_s]
+        end
+        self.send("#{name}_without_lookup=", new_value)
+      end
+
+      alias_method_chain "#{name}=", :lookup
+    end
+  end
 end
 
 

data/prosto_cache.gemspec

@@ -1,11 +1,8 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 Gem::Specification.new do |s|
   s.name = "prosto_cache"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Olek Poplavsky"]
@@ -17,34 +14,16 @@ Gem::Specification.new do |s|
     "README.rdoc"
   ]
   s.files = [
-    ".document",
     ".rspec",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
-    "VERSION",
     "lib/prosto_cache.rb",
     "prosto_cache.gemspec",
     "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"
   ]
   s.homepage = "http://github.com/olek/prosto_cache"
   s.licenses = ["MIT"]
@@ -58,34 +37,18 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<hashie>, [">= 1.0.0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
-      s.add_development_dependency(%q<roodi>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_development_dependency(%q<rake>, ["= 0.8.7"])
     else
       s.add_dependency(%q<hashie>, [">= 1.0.0"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_dependency(%q<yard>, ["~> 0.6.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<reek>, ["~> 1.2.8"])
-      s.add_dependency(%q<roodi>, ["~> 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_dependency(%q<rake>, ["= 0.8.7"])
     end
   else
     s.add_dependency(%q<hashie>, [">= 1.0.0"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-    s.add_dependency(%q<yard>, ["~> 0.6.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<reek>, ["~> 1.2.8"])
-    s.add_dependency(%q<roodi>, ["~> 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
     s.add_dependency(%q<rake>, ["= 0.8.7"])
   end
 end
-

metadata

@@ -1,178 +1,140 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: prosto_cache
-version: !ruby/object:Gem::Version
-  version: 0.1.1
+version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
 platform: ruby
-authors:
+authors: 
 - Olek Poplavsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-13 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: &2152717360 !ruby/object:Gem::Requirement
+
+date: 2012-07-13 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-  type: :runtime
+  version_requirements: *id001
+  name: hashie
   prerelease: false
-  version_requirements: *2152717360
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2152716740 !ruby/object:Gem::Requirement
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
         version: 2.3.0
-  type: :development
-  prerelease: false
-  version_requirements: *2152716740
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &2152716160 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: *2152716160
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &2152715480 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: *2152715480
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &2152714520 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.0
-  type: :development
+  version_requirements: *id002
+  name: rspec
   prerelease: false
-  version_requirements: *2152714520
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &2152713460 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: *2152713460
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: &2152712960 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.8
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  version_requirements: *id003
+  name: bundler
   prerelease: false
-  version_requirements: *2152712960
-- !ruby/object:Gem::Dependency
-  name: roodi
-  requirement: &2152712460 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.1.0
   type: :development
-  prerelease: false
-  version_requirements: *2152712460
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &2152728200 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
         version: 0.8.7
-  type: :development
+  version_requirements: *id004
+  name: rake
   prerelease: false
-  version_requirements: *2152728200
-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.
+  type: :development
+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:
+
+extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
-files:
-- .document
+files: 
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
-- VERSION
 - lib/prosto_cache.rb
 - prosto_cache.gemspec
 - 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:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -4108692343015697059
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Very simple caching for your ActiveRecord models.
 test_files: []
+

data/.document

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

data/VERSION

@@ -1 +0,0 @@
-0.1.1