cache_guard 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9c48a204891eb04bb84c52347b5025352f0f41e
+  data.tar.gz: 0f90e08c1138244ca18129db5850288a1aab33be
+SHA512:
+  metadata.gz: bc8d26739c8394c4892b964473002ad35606ea025324909c2d43f4a3b8125ea08e099afb7f2df3b4ce559ac57b54ce4b14e53b22da9deec798cd25682b8d8b79
+  data.tar.gz: fbc853045045d2b9b4ffb870e908155c0cc6655904e86e651b1c2fec3eaeaa9416f31199d44842b09e74f95437e9c3a62b192c5b3deeae3473d326358bb7295c

data/lib/cache_guard.rb

@@ -0,0 +1,40 @@
+class CacheGuard
+  class AcquireError < RuntimeError
+  end
+
+  def initialize(name, options = {})
+    @name = name
+    @default_value = options[:default_value] || 1
+    @expires_in = options[:expires_in] || 120
+    @cache_store = options[:cache_store] || Rails.store
+  end
+
+  def guard
+    raise AcquireError, "Unable to acquire guard for: #{@name}" unless acquire
+
+    begin
+      yield
+    ensure
+      release
+    end
+  end
+
+  def self.guard(name, options = {}, &block)
+    new(name, options).guard(&block)
+  end
+
+  private
+
+  def acquire
+    # The FileStore increment operation returns nil if the cache key doesn't exist. Since the FileStore strategy
+    # should be only used in development environment we can allow all guards to pass.
+    # http://api.rubyonrails.org/classes/ActiveSupport/Cache/FileStore.html#method-i-increment
+    # http://www.rubydoc.info/github/mperham/dalli/ActiveSupport/Cache/DalliStore#increment-instance_method
+    value = @cache_store.increment(@name, @default_value, :expires_in => @expires_in)
+    value.nil? || value == @default_value ? true : false
+  end
+
+  def release
+    @cache_store.delete(@name)
+  end
+end

data/spec/lib/cache_guard_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+require "cache_guard"
+
+describe CacheGuard do
+  describe "#guard" do
+    let(:cache_store){ double("Cache", :delete => true) }
+    subject{ described_class.new("guard", :cache_store => cache_store) }
+
+    context "when able to acquire guard" do
+      before do
+        allow(cache_store).to receive(:increment).and_return(1)
+      end
+
+      it "executes the given block" do
+        expect{ |probe| subject.guard(&probe) }.to yield_control
+      end
+
+      it "releases on success" do
+        subject.guard{ true }
+        expect(cache_store).to have_received(:delete)
+      end
+
+      it "releases on exception" do
+        subject.guard{ raise } rescue nil
+        expect(cache_store).to have_received(:delete)
+      end
+    end
+
+    context "when unable to acquire guard" do
+      before do
+        allow(cache_store).to receive(:increment).and_return(2)
+      end
+
+      it "raises an CacheGuard::AcquireError" do
+        expect{ subject.guard{ true } }.to raise_error(CacheGuard::AcquireError)
+      end
+
+      it "doesn't release" do
+        subject.guard{ true } rescue nil
+        expect(cache_store).to_not have_received(:delete)
+      end
+    end
+  end
+
+  describe ".guard" do
+    subject{ double("guard") }
+
+    before do
+      allow(subject).to receive(:guard).and_yield
+      allow(described_class).to receive(:new).with("static", :expires_in => 100).and_return(subject)
+    end
+
+    it "creates a new instance and calls guard with the given block" do
+      expect{ |probe| described_class.guard("static", { :expires_in => 100 }, &probe) }.to yield_control
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: cache_guard
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Duarte Henriques
+- Miguel Teixeira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+description: 
+email:
+- duarte.henriques@seedrs.com
+- miguel.teixeira@seedrs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cache_guard.rb
+- spec/lib/cache_guard_spec.rb
+homepage: http://rubygems.org/gems/cache_guard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Allows you to protect the execution of a block against concurrency.
+test_files:
+- spec/lib/cache_guard_spec.rb