async_cache 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ebb087efa77e51ac632b1fdb6e5bc646c8fc924
-  data.tar.gz: 87c132d6f30e941a877bf2c5b221a2ab657e7aa9
+  metadata.gz: 403da7156db830a1ce124c163bd01f76bbc8d74e
+  data.tar.gz: baaead5a8cdf2518c73e3d951620db13c5bf02e2
 SHA512:
-  metadata.gz: 3249570fd6634cca700cb69a4de34c2f4a9966df8db958ac4d701da432ae8b51e81730fd26b91d5a8e2e557bcf3d8c5a47f5bba815617675564dee07cdfcc506
-  data.tar.gz: 1b00cf6f828c2d61497979df32cff4e4f76853e9bb13b2765a6dbb84dcecdd9c267394a8888950790a5a505007b9de64452974a5fcac6332ab9d40f92b6168de
+  metadata.gz: a2335c08328573320f258606f2d19a70a28bccc8328d3d3a8ce6ce576f079e76cb4b5d5931fb297837e6e95714bf44e4e8912681a355273486f1f38d9ec15d98
+  data.tar.gz: 73dd67211b1b431155dbbd35e89f824db065fb2bb80066f07eef86e908931f8db533bc94c7d195d4d7d8bada9e8e022f36f57791637a1f828028b15eafc9f6e6

data/.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
+coverage
 pkg

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - '2.2.1'
+  - '2.2.3'
+  - '2.3.0'
+
+services:
+  - redis-server
+
+before_script:
+  - bundle exec ruby spec/integration/support/run_all.rb &
+  - sleep 2
+
+script:
+  - bundle exec rspec --exclude-pattern "spec/integration/*"
+  - bundle exec rspec spec/integration

data/Gemfile

@@ -1,8 +1,3 @@
 source "https://rubygems.org"
 
 gemspec
-
-gem 'rspec-core',         '~> 3.2.3'
-gem 'rspec-expectations', '~> 3.2.1'
-gem 'rspec-mocks',        '~> 3.2.1'
-gem 'pry', :require => false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    async_cache (1.0.0)
+    async_cache (1.0.1)
       sourcify (~> 0.5.0)
 
 GEM
@@ -64,12 +64,16 @@ GEM
     coderay (1.1.0)
     connection_pool (2.2.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     erubis (2.7.0)
     file-tail (1.1.0)
       tins (~> 1.0)
     globalid (0.3.6)
       activesupport (>= 4.1.0)
     hitimes (1.2.3)
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
     i18n (0.7.0)
     json (1.8.3)
     loofah (2.0.3)
@@ -80,6 +84,8 @@ GEM
     mime-types (2.6.2)
     mini_portile (0.6.2)
     minitest (5.8.2)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
     pry (0.10.1)
@@ -87,6 +93,8 @@ GEM
       method_source (~> 0.8.1)
       slop (~> 3.4)
     rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
     rack-test (0.6.3)
       rack (>= 1.0)
     rails (4.2.4)
@@ -115,17 +123,26 @@ GEM
       thor (>= 0.18.1, < 2.0)
     rake (10.4.2)
     redis (3.2.1)
+    redis-activesupport (4.1.5)
+      activesupport (>= 3, < 5)
+      redis-store (~> 1.1.0)
     redis-namespace (1.5.2)
       redis (~> 3.0, >= 3.0.4)
-    rspec-core (3.2.3)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.1)
+    redis-store (1.1.7)
+      redis (>= 2.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     ruby2ruby (2.2.0)
       ruby_parser (~> 3.1)
       sexp_processor (~> 4.0)
@@ -138,6 +155,15 @@ GEM
       json (~> 1.0)
       redis (~> 3.2, >= 3.2.1)
       redis-namespace (~> 1.5, >= 1.5.2)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    sinatra (1.4.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
     slop (3.6.0)
     sourcify (0.5.0)
       file-tail (>= 1.0.5)
@@ -152,6 +178,7 @@ GEM
       sprockets (>= 2.8, < 4.0)
     thor (0.19.1)
     thread_safe (0.3.5)
+    tilt (1.4.1)
     timers (4.1.1)
       hitimes
     tins (1.8.1)
@@ -163,12 +190,14 @@ PLATFORMS
 
 DEPENDENCIES
   async_cache!
-  pry
+  httparty (~> 0.13.7)
+  pry (~> 0.10.1)
   rails (~> 4.2.4)
-  rspec-core (~> 3.2.3)
-  rspec-expectations (~> 3.2.1)
-  rspec-mocks (~> 3.2.1)
+  redis-activesupport (~> 4.1.5)
+  rspec (~> 3.4.0)
   sidekiq (~> 3.5.2)
+  simplecov (~> 0.9.2)
+  sinatra (~> 1.4.6)
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/async_cache.gemspec

@@ -15,8 +15,14 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'sourcify', '~> 0.5.0'
 
-  s.add_development_dependency 'rails',   '~> 4.2.4'
-  s.add_development_dependency 'sidekiq', '~> 3.5.2'
+  s.add_development_dependency 'rails',               '~> 4.2.4'
+  s.add_development_dependency 'sidekiq',             '~> 3.5.2'
+  s.add_development_dependency 'sinatra',             '~> 1.4.6'
+  s.add_development_dependency 'rspec',               '~> 3.4.0'
+  s.add_development_dependency 'pry',                 '~> 0.10.1'
+  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.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")

data/lib/async_cache/store.rb

@@ -109,6 +109,7 @@ module AsyncCache
           next if argument.is_a? Numeric
           next if argument.is_a? String
           next if argument.is_a? Symbol
+          next if argument.is_a? Hash
 
           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.0'
+  VERSION = '1.0.1'
 end

data/spec/integration/store_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+require 'httparty'
+
+require_relative './support/config'
+
+describe AsyncCache::Store do
+  context '#fetch' do
+    before(:all) do
+      unless File.exist? VERSION_PATH
+        raise "Version file #{VERSION_PATH} doesn't exist"
+      end
+    end
+
+    before(:each) do
+      # 'y' is the locator used in `support/sinatra.rb`.
+      Rails.cache.delete LOCATOR
+    end
+
+    after(:each) do
+      sleep 1
+    end
+
+    def get_endpoint
+      response = HTTParty.get 'http://localhost:4567'
+      expect(response.success?).to eq true
+
+      return response.body
+    end
+
+    def touch_version_file
+      FileUtils.touch VERSION_PATH
+    end
+
+    it 'serves the fresh version if the cache is empty' do
+      get_endpoint
+    end
+
+    it "serves the old version if it's cached" do
+      body1 = get_endpoint
+
+      touch_version_file
+
+      body2 = get_endpoint
+
+      expect(body1).to eq body2
+    end
+
+    it 'serves the new version after the worker has run' do
+      body1 = get_endpoint
+
+      touch_version_file
+
+      body2 = get_endpoint
+
+      # Check again that it served the old version
+      expect(body2).to eq body1
+
+      sleep 0.5 # Give the worker a chance to run
+
+      body3 = get_endpoint
+      # Check that it served the new version after the worker ran
+      expect(body3).not_to eq body1
+    end
+  end
+end

data/spec/integration/support/config.rb

@@ -0,0 +1,18 @@
+require 'sidekiq'
+require 'async_cache'
+require 'async_cache/workers/sidekiq'
+require 'rails'
+require 'redis-activesupport'
+
+Rails.cache  = ActiveSupport::Cache::RedisStore.new
+Rails.logger = Logger.new($stdout).tap { |log| log.level = Logger::WARN }
+
+Sidekiq.configure_client do |config|
+  config.redis = { :namespace => 'x', :size => 1 }
+end
+Sidekiq.configure_server do |config|
+  config.redis = { :namespace => 'x' }
+end
+
+LOCATOR = 'y'
+VERSION_PATH = File.join(File.dirname(__FILE__), 'version.txt')

data/spec/integration/support/run_all.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+commands = [
+  'bundle exec sidekiq -c 2 -r ./spec/integration/support/config.rb',
+  'bundle exec ruby spec/integration/support/sinatra.rb'
+]
+
+pids = commands.map { |c| Process.spawn c }
+
+shutdown = proc { Process.kill 'TERM', *pids }
+
+Signal.trap 'INT',  &shutdown
+Signal.trap 'TERM', &shutdown
+
+Process.waitall

data/spec/integration/support/sinatra.rb

@@ -0,0 +1,23 @@
+require 'sinatra'
+require 'securerandom'
+
+require_relative './config'
+
+store = nil
+
+configure do
+  store = AsyncCache::Store.new worker: :sidekiq
+end
+
+def get_file_version(path)
+  File.mtime(path).to_i
+end
+
+get '/' do
+  locator = LOCATOR
+  version = get_file_version VERSION_PATH
+
+  store.fetch(locator, version) do
+    SecureRandom.uuid
+  end
+end

data/spec/spec_helper.rb

@@ -3,8 +3,11 @@ require 'bundler/setup'
 require 'rails'
 require 'sidekiq'
 require 'sidekiq/testing'
+require 'simplecov'
 
 Sidekiq::Testing.inline!
+SimpleCov.start
+
 Rails.cache  = ActiveSupport::Cache::MemoryStore.new
 Rails.logger = Logger.new($stdout).tap { |log| log.level = Logger::ERROR }
 

data/spec/store_spec.rb

@@ -10,6 +10,12 @@ describe AsyncCache::Store do
     )
   end
 
+  it "raises if it doesn't receive a worker class" do
+    expect {
+      AsyncCache::Store.new backend: Rails.cache
+    }.to raise_error(ArgumentError)
+  end
+
   context 'caching' do
     def stub_not_present(key)
       expect(Rails.cache).to receive(:read).with(key).and_return(nil)

data/spec/workers/base_spec.rb

@@ -14,4 +14,29 @@ describe AsyncCache::Workers do
       expect(subject.worker_for_name :active_job).to eql AsyncCache::Workers::ActiveJobWorker
     end
   end
+
+  describe '#perform' do
+    class TestWorker
+      include AsyncCache::Workers::Base
+    end
+
+    subject do
+      TestWorker.new
+    end
+
+    it 'evaluates the job and writes to the backend' do
+      backend = spy 'Backend'
+      allow(AsyncCache).to receive(:backend).and_return(backend)
+
+      key             = 'test'
+      version         = 42
+      expires_in      = 1337
+      block_arguments = [1]
+      block_source    = 'proc { |arg| arg * 2 }'
+
+      expect(backend).to receive(:write).with(key, [2, version], expires_in: expires_in)
+
+      subject.perform key, version, expires_in, block_arguments, block_source
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Adam Derewecki
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2016-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sourcify
@@ -53,6 +53,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: redis-activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
 description: 
 email:
 - derewecki@gmail.com
@@ -62,6 +146,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -75,6 +161,11 @@ files:
 - lib/async_cache/workers/active_job.rb
 - lib/async_cache/workers/base.rb
 - lib/async_cache/workers/sidekiq.rb
+- spec/integration/store_spec.rb
+- spec/integration/support/config.rb
+- spec/integration/support/run_all.rb
+- spec/integration/support/sinatra.rb
+- spec/integration/support/version.txt
 - spec/spec_helper.rb
 - spec/store_spec.rb
 - spec/workers/active_job_spec.rb
@@ -100,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Pattern and library for implementing asynchronous caching