async_cache 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 403da7156db830a1ce124c163bd01f76bbc8d74e
-  data.tar.gz: baaead5a8cdf2518c73e3d951620db13c5bf02e2
+  metadata.gz: 500e9448eef871f617a1d0a131fd3838c231058d
+  data.tar.gz: 3f09a314542ea93102d65d96e6417f25374483d0
 SHA512:
-  metadata.gz: a2335c08328573320f258606f2d19a70a28bccc8328d3d3a8ce6ce576f079e76cb4b5d5931fb297837e6e95714bf44e4e8912681a355273486f1f38d9ec15d98
-  data.tar.gz: 73dd67211b1b431155dbbd35e89f824db065fb2bb80066f07eef86e908931f8db533bc94c7d195d4d7d8bada9e8e022f36f57791637a1f828028b15eafc9f6e6
+  metadata.gz: e174c76425afb575ace71b4902b6b7fcb6acc9d2b096fc4955e0a0c88c738c4441e83529d274243dd40d2360c5f265bc69e267c4773558e2587a5849311da30a
+  data.tar.gz: 51e30ffe8cb929710185ee2624e6a957a33b33338a3724f317414597bf75786f7b96944abf02a3878212fd7daa85137b3cbe39f58ed2d56e3e8b73ba5f637bab

data/.gitignore

@@ -1,3 +1,5 @@
 .DS_Store
+.yardoc
 coverage
+doc
 pkg

data/.yardopts

@@ -0,0 +1,4 @@
+--markup-provider=redcarpet
+--markup=markdown
+--private
+- README.md LICENSE

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    async_cache (1.0.1)
+    async_cache (1.0.2)
       sourcify (~> 0.5.0)
 
 GEM
@@ -122,6 +122,7 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.4.2)
+    redcarpet (3.3.4)
     redis (3.2.1)
     redis-activesupport (4.1.5)
       activesupport (>= 3, < 5)
@@ -184,6 +185,7 @@ GEM
     tins (1.8.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby
@@ -193,11 +195,13 @@ DEPENDENCIES
   httparty (~> 0.13.7)
   pry (~> 0.10.1)
   rails (~> 4.2.4)
+  redcarpet (~> 3.3.4)
   redis-activesupport (~> 4.1.5)
   rspec (~> 3.4.0)
   sidekiq (~> 3.5.2)
   simplecov (~> 0.9.2)
   sinatra (~> 1.4.6)
+  yard (~> 0.8)
 
 BUNDLED WITH
    1.11.2

data/Rakefile

@@ -2,3 +2,8 @@ require "bundler/gem_tasks"
 
 # No-op to make Travis CI happy
 task 'default'
+
+desc 'Generate documentation with YARD'
+task 'doc' do
+  exec 'bundle exec yardoc'
+end

data/async_cache.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov',           '~> 0.9.2'
   s.add_development_dependency 'redis-activesupport', '~> 4.1.5'
   s.add_development_dependency 'httparty',            '~> 0.13.7'
+  s.add_development_dependency 'yard',                '~> 0.8'
+  s.add_development_dependency 'redcarpet',           '~> 3.3.4'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")

data/lib/async_cache/store.rb

@@ -2,6 +2,12 @@ module AsyncCache
   class Store
     attr_accessor :backend, :worker_klass
 
+    # @param [Hash] opts Initialization options
+    # @option opts [Object] :backend The backend that it will read/write
+    #   entries to/from
+    # @option opts [Symbol] :worker Shorthand symbol for the worker to use,
+    #   options are `:active_job` and `:sidekiq`.
+    # @option ops [Class] :worker_klass Class of the worker to use.
     def initialize(opts = {})
       @worker_klass =
         if opts[:worker_klass]
@@ -15,6 +21,10 @@ module AsyncCache
       @backend = opts[:backend] || AsyncCache.backend
     end
 
+    # @param [String] locator The constant locator for the entry in the cache
+    # @param [Fixnum] version Version of the value identified by that locator
+    # @param [Hash] options
+    # @yield [*arguments in options[:arguments]] Called if entry out-of-date
     def fetch(locator, version, options = {}, &block)
       options = options.dup  # Duplicate to avoid side effects
       version = version.to_i # Versions must *always* be convertible to integers
@@ -103,13 +113,16 @@ module AsyncCache
 
     private
 
-      # Ensure the arguments are primitives
+      # Ensures the arguments are primitives.
       def check_arguments arguments
         arguments.each_with_index do |argument, index|
           next if argument.is_a? Numeric
           next if argument.is_a? String
           next if argument.is_a? Symbol
           next if argument.is_a? Hash
+          next if argument.is_a? NilClass
+          next if argument.is_a? TrueClass
+          next if argument.is_a? FalseClass
 
           raise ArgumentError, "Cannot send complex data for block argument #{index + 1}: #{argument.class.name}"
         end

data/lib/async_cache/version.rb

@@ -1,3 +1,3 @@
 module AsyncCache
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/async_cache/workers/base.rb

@@ -15,20 +15,26 @@ module AsyncCache
 
     module Base
       # Abstract public interface to workers that process AsyncCache jobs
+
+      # @return [Boolean] Returns whether or not workers are running to
+      #   process enqueue AsyncCache jobs. Return `false` if this
+      #   functionality isn't available by the underlying system.
       def self.has_workers?
         raise NotImplementedError
       end
 
+      # Public interface for enqueuing jobs. This is what is called by
+      # {AsyncCache::Store}.
       def self.enqueue_async_job(key:, version:, expires_in:, block:, arguments:)
         raise NotImplementedError
       end
 
-      # key             - String or array cache key computed by `AsyncCache`
-      # version         - Monotonically increasing integer indicating the version
-      #                   of the resource being cached
-      # expires_in      - Optional expiration to pass to the cache store
-      # block_arguments - Arguments with which to call the block
-      # block_source    - Ruby source to evaluate to produce the value
+      # @param [String] key String or array cache key computed by `AsyncCache`
+      # @param [Fixnum] version Monotonically increasing integer indicating
+      #   the version of the resource being cached
+      # @param [Fixnum] expires_in Optional expiration to pass to the cache store
+      # @param [Array] block_arguments Arguments with which to call the block
+      # @param [String] block_source Ruby source to evaluate to produce the value
       def perform key, version, expires_in, block_arguments, block_source
         t0 = Time.now
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Adam Derewecki
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-07 00:00:00.000000000 Z
+date: 2016-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sourcify
@@ -137,6 +137,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.4
 description: 
 email:
 - derewecki@gmail.com
@@ -148,6 +176,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -196,3 +225,4 @@ signing_key:
 specification_version: 4
 summary: Pattern and library for implementing asynchronous caching
 test_files: []
+has_rdoc: