prosto_cache 0.1.2 → 0.1.3

data/README.rdoc

@@ -1,25 +1,49 @@
 = prosto_cache
 
-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.
+prosto_cache provides a simple way to cache enumeration-like models in memory and to access this cache in uniform way.
+
+Here are couple thinks that it will NOT do for you.
+
+- it will not monkey patch rails in attempt to make itself 'totally' easy to use
+- it will not attempt to share/distribute cache
+- it will not cook your breakfeast, it does one thing only, and that thing is in-memory cache
+
+And that is a good thing. Why?
+
+- next time you upgrade your rails things are not likely to break in spectacular way (well, at least not because of this gem)
+- there is a possibility/plan to make it work even for those not using ActiveRecord
+- and most of all - it keeps things SIMPLE (do not confuse with 'easy')
+
+Here are main features of this library:
+
+- cache is accessible in a map-like way, and you can choose and specify ONE way to contruct the key to that map
+- access key can be simple or compound (multi-step)
+- virtual/transient/non-db attributes can be used for keys
+- all cache values are accessible as a plain array
+- changes to the model's objects will automatically result in cache reload when saved to database
+- 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 for you, well, this library will not work for you, use something fancier, like Memcached.
+- it is possible to invalidate cache by hand, although usually there is no reason to
 
 Usage:
-1. add ProstoCache mixin to your model
+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).
+3. Your model MUST have non-nullable column updated_at, add new migration with it if 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.
+* Case of 2 or more keys where it is known ahead of time that all parent keys exist.
+  Looks conventional, but is not quite unreliable because brackets operation on nil will raise an error.
+  If you know a good way to make it reliable, let me know!
 
     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.
+* 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]]
 
@@ -31,7 +55,9 @@ Usage:
 * 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.
+* 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
 

data/lib/prosto_cache.rb

@@ -120,10 +120,12 @@ module ProstoCache
     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 = ActiveRecord::Base.connection.execute "select max(updated_at) as max_updated_at, max(id) as max_id, count(id) as count from #{model_class.table_name}"
       array_result = case raw_result.class.name
       when 'Mysql::Result'
         [].tap { |rows| raw_result.each_hash { |h| rows << h } }
+      when 'Mysql2::Result'
+        [].tap { |rows| raw_result.each(:as => :hash) { |h| rows << h } }
       when 'PGresult'
         raw_result.map(&:to_hash)
       else

data/prosto_cache.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "prosto_cache"
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Olek Poplavsky"]
-  s.date = "2012-07-13"
+  s.date = "2011-05-23"
   s.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."
   s.email = "olek@woodenbits.com"
   s.extra_rdoc_files = [

metadata

@@ -1,97 +1,89 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: prosto_cache
-version: !ruby/object:Gem::Version 
-  hash: 31
+version: !ruby/object:Gem::Version
+  version: 0.1.3
   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 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2011-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
-  version_requirements: *id001
-  name: hashie
-  prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 3
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.3.0
-  version_requirements: *id002
-  name: rspec
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 1
-        - 0
-        version: 1.1.0
-  version_requirements: *id003
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 8
-        - 7
-        version: 0.8.7
-  version_requirements: *id004
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
   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.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+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: 
+files:
 - .rspec
 - Gemfile
 - Gemfile.lock
@@ -102,39 +94,32 @@ files:
 - prosto_cache.gemspec
 - spec/prosto_cache_spec.rb
 - spec/spec_helper.rb
-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 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 849790085734229441
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Very simple caching for your ActiveRecord models.
 test_files: []
-