lock_and_cache 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f956903ed9cadae938803806da303032e5770a3
+  data.tar.gz: bcb67b572971fbc37311f14d998c3b97b29d3317
+SHA512:
+  metadata.gz: 5f3788ca8c067748e1dd8f3e75fca7d5ba0d669c09eea78a703fdf4cb6314be2d0f30e40d9898a765678f683b935956d9072fe2f8478a3b59dbf6c00abef8c9e
+  data.tar.gz: 54b68c613423afc0b56e7d17a98091c10ebd18b5614aa462489b14e4f573cc6abdf2fcd65aa8f5349b39b91ba6eb8f0d64ca91611f2f33e8c5b462dde5cd65bc

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/CHANGELOG

@@ -0,0 +1,9 @@
+0.0.2 / 2014-12-11
+
+* Bug fixes
+
+  * Gem name is activerecord
+
+0.0.1 / 2014-12-11
+
+initial release!

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lock_and_cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Seamus Abshere
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# LockAndCache
+
+TODO: Write a gem description
+
+## Wishlist
+
+* no dep on activerecord
+* no dep on cache_method
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lock_and_cache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lock_and_cache
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/lock_and_cache/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/lock_and_cache.rb

@@ -0,0 +1,27 @@
+require 'lock_and_cache/version'
+
+require 'hash_digest'
+require 'cache_method'
+require 'active_record'
+require 'with_advisory_lock'
+
+module LockAndCache
+  # only for instance methods
+  def lock_and_cache(method_id)
+    unlocked_method_id = "_lock_and_cache_unlocked_#{method_id}"
+    alias_method unlocked_method_id, method_id
+
+    define_method method_id do |*args|
+      lock_key = [self.class.name, method_id, HashDigest.digest3([as_cache_key]+args)].join('/')
+      ActiveRecord::Base.with_advisory_lock(lock_key) do
+        if cache_method_cached?(method_id, args)
+          send method_id, *args # which will be the cached version
+        else
+          send unlocked_method_id
+        end
+      end
+    end
+
+    cache_method method_id
+  end
+end

data/lib/lock_and_cache/version.rb

@@ -0,0 +1,3 @@
+module LockAndCache
+  VERSION = "0.0.2"
+end

data/lock_and_cache.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lock_and_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lock_and_cache"
+  spec.version       = LockAndCache::VERSION
+  spec.authors       = ["Seamus Abshere"]
+  spec.email         = ["seamus@abshere.net"]
+  spec.summary       = %q{Lock and cache methods.}
+  spec.description   = %q{Lock and cache methods, in case things should only be calculated once across processes.}
+  spec.homepage      = "https://github.com/seamusabshere/lock_and_cache"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activerecord'
+  spec.add_runtime_dependency 'cache_method'
+  spec.add_runtime_dependency 'hash_digest'
+  spec.add_runtime_dependency 'with_advisory_lock'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'activesupport'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/spec/lock_and_cache_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+class Foo
+  def initialize(id)
+    @id = id
+    @count = 0
+  end
+  def click
+    @count += 1
+  end
+
+  extend LockAndCache
+  lock_and_cache :click
+  def as_cache_key
+    @id
+  end
+end
+
+require 'set'
+$clicking = Set.new
+class Bar
+  def initialize(id)
+    @id = id
+    @count = 0
+  end
+  def unsafe_click
+    Thread.exclusive do
+      # puts "clicking bar #{@id} - #{$clicking.to_a} - #{$clicking.include?(@id)} - #{@id == $clicking.to_a[0]}"
+      raise "somebody already clicking Bar #{@id}" if $clicking.include?(@id)
+      $clicking << @id
+    end
+    sleep 1
+    @count += 1
+    Thread.exclusive do
+      $clicking.delete @id
+    end
+    @count
+  end
+  def click
+    unsafe_click
+  end
+
+  extend LockAndCache
+  lock_and_cache :click
+  def as_cache_key
+    @id
+  end
+end
+
+describe LockAndCache do
+  it 'has a version number' do
+    expect(LockAndCache::VERSION).not_to be nil
+  end
+
+  describe "caching" do
+    let(:foo) { Foo.new(rand.to_s) }
+    it "works" do
+      expect(foo.click).to eq(1)
+      expect(foo.click).to eq(1)
+    end
+  end
+
+  describe "locking" do
+    let(:bar) { Bar.new(rand.to_s) }
+    it "it blows up normally" do
+      a = Thread.new do
+        bar.unsafe_click
+      end
+      b = Thread.new do
+        bar.unsafe_click
+      end
+      expect do
+        a.join
+        b.join
+      end.to raise_error(/somebody/)
+    end
+
+    it "doesn't blow up if you lock it" do
+      a = Thread.new do
+        bar.click
+      end
+      b = Thread.new do
+        bar.click
+      end
+      a.join
+      b.join
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'lock_and_cache'
+require 'thread/pool'
+
+ActiveRecord::Base.establish_connection adapter: 'postgresql', database: 'lock_and_cache_test'
+
+require 'pry'

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: lock_and_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cache_method
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hash_digest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: with_advisory_lock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lock and cache methods, in case things should only be calculated once
+  across processes.
+email:
+- seamus@abshere.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lock_and_cache.rb
+- lib/lock_and_cache/version.rb
+- lock_and_cache.gemspec
+- spec/lock_and_cache_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/seamusabshere/lock_and_cache
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Lock and cache methods.
+test_files:
+- spec/lock_and_cache_spec.rb
+- spec/spec_helper.rb
+has_rdoc: