incrdecr_cached_counts 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 033e0da0b3b6191884b1ed3547029daf979e9af7
-  data.tar.gz: b3e5b4e46ac655f2ab54b6b59ce57544b0b11177
+  metadata.gz: d751a2be8fc971ab8346677cf6af2417bd24c484
+  data.tar.gz: b05d9811217b500bc3e28fd15d0719837833c9cc
 SHA512:
-  metadata.gz: 7d0a1cf6c691aa0f41d86ab72743575d5eb906943eba00295681e033a69d39c2f5bc5d9ab0c0f1865bb387a82d6016ffe2f442844876f8c7bb3375ac11fb665e
-  data.tar.gz: 578b20bd19e73cd0df63d4fbbb99618f7bf7c343b85b049a9560be46ae8e493c746dc835710977440572fe792f6df72a1750fae61dd28fde207e8eaa4268ab65
+  metadata.gz: 1f42924de3ffae5cebb7c496a95a486a283126852c3d0c0a9239b158204aa38ba0191d8569b26266466f50f8ae200344ae4ab4e59db0c33b7b598bf80f1176a8
+  data.tar.gz: cf742a3a18c544245972b41e7187ab5d1f82374bc8d664387cbdf196e12447978f9e0aebb273849a73c0b0e011bb90936f55b57ad0773254ee75add302e8dd93

data/.gitignore

@@ -9,3 +9,6 @@ test/dummy/db/*.sqlite3-journal
 test/dummy/log/*.log
 test/dummy/tmp/
 test/dummy/.sass-cache
+tags
+.yardoc/*
+doc/*

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/README.rdoc

@@ -35,12 +35,12 @@ Basic usage:
   class Following < ActiveRecord::Base
     include CachedCounts
 
-    belongs_to :followee, class_name: 'User', # ...
+    belongs_to :followee, class_name: 'User' #, ...
   end
 
-Note that _CachedCounts_ must be included in the counted class, but no class methods need be called there.
+Note that +CachedCounts+ must be included in the counted class, but no class methods need be called there.
 
-For full options, see docs for _CachedCounts.caches_count_of_ and _CachedCounts.caches_count_where_.
+For full options, see docs for +CachedCounts.caches_count_of+ and +CachedCounts.caches_count_where+.
 
 = Licence
 

data/Rakefile

@@ -4,12 +4,6 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  rdoc.main = "README.rdoc"
-  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
-end
-
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec')
 

data/lib/cached_counts.rb

@@ -14,33 +14,37 @@ module CachedCounts
     # Automatically adds after_commit hooks which increment/decrement the value
     # in memcached when needed. Queries the db on cache miss.
     #
-    # Valid options:
-    #   :scope
-    #     Name of the scope to count. Defaults to the attribute_name
-    #     (the required argument to `caches_count_where`).
+    # @param [String] attribute_name
     #
-    #   :alias
-    #     Alias(es) for the count attribute.
-    #     e.g. `caches_count_where :confirmed, alias: 'sitemap'`
+    # @param [Hash] options
+    #
+    # @option options [String] :scope
+    #   Name of the scope to count. Defaults to the +attribute_name+
+    #   (the required argument to +caches_count_where+).
+    #
+    # @option options [String, Array<String>] :alias
+    #   Alias(es) for the count attribute.
+    #   e.g.
+    #     caches_count_where :confirmed, alias: 'sitemap'
     #     > User.sitemap_count
     #
-    #   :expires_in
-    #     Expiry for the cached value.
+    # @option options [Integer] :expires_in
+    #   Expiry for the cached value.
     #
-    #   :if
-    #     proc passed through to the after_commit hooks;
-    #     decides whether an object counts towards the association total.
+    # @option options [Proc] :if
+    #   proc passed through to the after_commit hooks;
+    #   decides whether an object counts towards the association total.
     #
-    #   :version
-    #     Cache version - bump if you change the definition of a count.
+    # @option options [Integer, #to_s] :version
+    #   Cache version - bump if you change the definition of a count.
     #
-    #   :race_condition_fallback
-    #     Fallback to the result of this proc if the cache is empty, while
-    #     loading the actual value from the db. Works similarly to
-    #     race_condition_ttl but for empty caches rather than expired values.
-    #     Meant to prevent a thundering-herd scenario, if for example a
-    #     memcached instance goes away. Can be nil; defaults to using a value
-    #     grabbed from the cache or DB at startup.
+    # @option options [Proc] :race_condition_fallback
+    #   Fallback to the result of this proc if the cache is empty, while
+    #   loading the actual value from the db. Works similarly to
+    #   +race_condition_ttl+ but for empty caches rather than expired values.
+    #   Meant to prevent a thundering-herd scenario, if for example a
+    #   memcached instance goes away. Can be nil; defaults to using a value
+    #   grabbed from the cache or DB at startup.
     #
     def caches_count_where(attribute_name, options = {})
       # Delay actual run to work around circular dependencies
@@ -60,28 +64,32 @@ module CachedCounts
     # increment/decrement the value in memcached when needed. Queries the db
     # on cache miss.
     #
-    # Valid options:
-    #   :association
-    #     Name of the association to count. Defaults to the attribute_name
-    #     (the required argument to `caches_count_of`).
+    # @param [String] attribute_name
+    #
+    # @param [Hash] options
     #
-    #   :alias
-    #     Alias(es) for the count attribute. Useful with join tables.
-    #     e.g. `caches_count_of :user_departments, alias: 'users'`
+    # @option options [Symbol] :association
+    #   Name of the association to count. Defaults to the +attribute_name+
+    #   (the required argument to +caches_count_of+).
+    #
+    # @option options [String, Array<String>] :alias
+    #   Alias(es) for the count attribute. Useful with join tables.
+    #   e.g.
+    #     caches_count_of :user_departments, alias: 'users'
     #     > Department.first.users_count
     #
-    #   :expires_in
-    #     Expiry for the cached value.
+    # @option options [Integer] :expires_in
+    #   Expiry for the cached value.
     #
-    #   :if
-    #     proc passed through to the after_commit hooks on the counted class;
-    #     decides whether an object counts towards the association total.
+    # @option options [Proc] :if
+    #   proc passed through to the after_commit hooks on the counted class;
+    #   decides whether an object counts towards the association total.
     #
-    #   :scope
-    #     proc used like an ActiveRecord scope on the counted class on cache misses.
+    # @option options [Proc] :scope
+    #   proc used like an ActiveRecord scope on the counted class on cache misses.
     #
-    #   :version
-    #     Cache version - bump if you change the definition of a count.
+    # @option options [Integer, #to_s] :version
+    #   Cache version - bump if you change the definition of a count.
     #
     def caches_count_of(attribute_name, options = {})
       # Delay actual run to work around circular dependencies
@@ -91,10 +99,12 @@ module CachedCounts
       end
     end
 
+    # @private
     def scope_count_key(attribute_name, version = 1)
       "#{name}:#{attribute_name}_count:#{version}"
     end
 
+    # @private
     def association_count_key(counter_id, attribute_name, version = 1)
       "#{name}:#{counter_id}:#{attribute_name}_count:#{version}" unless counter_id.nil?
     end
@@ -156,7 +166,7 @@ module CachedCounts
           fallback = 0
         end
 
-        Rails.cache.write key, fallback, expires_in: options.fetch(:expires_in, 1.week)
+        Rails.cache.write key, fallback, expires_in: options.fetch(:expires_in, 1.week), raw: true
       end
 
       -> { fallback }
@@ -231,6 +241,7 @@ module CachedCounts
             # Ensure that other reads find something in the cache, but
             # continue calculating here because the default is likely inaccurate.
             fallback_value = instance_exec &race_condition_fallback
+            logger.warn "Setting #{fallback_value} as race_condition_fallback for #{send(key_method)}"
             Rails.cache.write(
               send(key_method),
               fallback_value.to_i,
@@ -385,6 +396,17 @@ module CachedCounts
         -> { send(association_name).spawn }
       end
     end
+
+    def logger
+      @logger ||= begin
+        if Rails.logger.nil?
+          require 'logger'
+          Logger.new($stderr)
+        else
+          Rails.logger
+        end
+      end
+    end
   end
 end
 

data/lib/cached_counts/version.rb

@@ -1,3 +1,3 @@
 module CachedCounts
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: incrdecr_cached_counts
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - David Judd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -133,6 +133,7 @@ files:
 - ".circleci-matrix.yml"
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - MIT-LICENSE
 - README.rdoc