pg_advisory_locker 0.9.0

data/.gitignore

@@ -0,0 +1,24 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+.idea/*
+database.yml
+/log/*.pid
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+spec/dummy/config/database.yml
+spec/dummy/db/schema.rb

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in partitioned.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug'

data/Gemfile.lock

@@ -0,0 +1,108 @@
+PATH
+  remote: .
+  specs:
+    pg_application_name (0.8.0)
+      pg
+      rails (>= 3.0.0)
+      rspec-rails
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.3)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.5)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    pg (0.14.1)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    rspec-rails (2.8.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.8.0)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pg_application_name!

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2010-2012, Fiksu, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+ o Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+ o Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the
+   distribution.
+
+ o Fiksu, Inc. nor the names of its contributors may be used to
+   endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,47 @@
+pg_advisory_locker
+==================
+
+Helper for calling PostgreSQL functions: pg_advisory_lock,
+pg_advisory_try_lock, and pg_advisory_unlock.
+
+Examples
+========
+
+Basic example of passing a block to the locker
+
+    class Foo < ActiveRecord::Base
+      include PgAdvisoryLocker
+
+      def self.lock_for_whatever(&block)
+	return lock_record(0, &block)
+      end
+
+      def self.do_something
+        lock_for_whatever do
+          # do something here
+        end
+      end
+    end
+
+Advisory lock on id:
+
+    class Foo < ActiveRecord::Base
+      include PgAdvisoryLocker
+
+      def lock_for_whatever
+	return advisory_lock
+      end
+
+      def unlock_for_whatever
+	return advisory_unlock
+      end
+
+      def do_something
+        lock_for_whatever
+	begin
+          # do something
+        ensure
+	 unlock_for_whatever
+        end
+      end
+    end

data/Rakefile

@@ -0,0 +1,26 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+task :default => :spec
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'pg_advisory_locker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/lib/pg_advisory_locker/pg_advisory_locker.rb

@@ -0,0 +1,75 @@
+module PgAdvisoryLocker
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def advisory_lock(&block)
+    return self.class.lock_record(id, &block)
+  end
+
+  def advisory_try_lock(&block)
+    return self.class.try_lock_record(id, &block)
+  end
+
+  def advisory_unlock
+    self.class.unlock_record(id)
+  end
+
+  module ClassMethods
+    def table_oid
+      if @table_oid.nil?
+        sql_table_components = table_name.split('.')
+        if sql_table_components.length == 1
+          sql_table_components.prepend('public')
+        end
+        sql = <<-SQL
+         SELECT
+           pg_class.oid
+         FROM
+           pg_class,pg_namespace
+         WHERE
+           pg_namespace.nspname = ? AND
+           pg_class.relnamespace = pg_namespace.oid AND
+           pg_class.relname = ?
+        SQL
+        @table_oid = find_by_sql([sql, *sql_table_components]).first.oid.to_i
+      end
+      return @table_oid
+    end
+
+    def lock_record(id, &block)
+      locked = uncached do
+        find_by_sql(["select pg_advisory_lock(?, ?)", table_oid, id])[0].pg_advisory_lock == "t"
+      end
+      if block.present?
+        begin
+          return block.call
+        ensure
+          unlock_record(id)
+        end
+      end
+      return locked
+    end
+
+    def try_lock_record(id, &block)
+      locked = uncached do
+        find_by_sql(["select pg_try_advisory_lock(?, ?)", table_oid, id])[0].pg_try_advisory_lock == "t"
+      end
+      if block.present?
+        begin
+          block.call
+        ensure
+          unlock_record(id)
+        end
+      end
+      return locked
+    end
+
+    def unlock_record(id)
+      unlocked = uncached do
+        find_by_sql(["select pg_advisory_unlock(?, ?)", table_oid, id])[0].pg_advisory_unlock == "t"
+      end
+      return unlocked
+    end
+  end
+end

data/lib/pg_advisory_locker/version.rb

@@ -0,0 +1,4 @@
+module PgAdvisoryLocker
+  # the current version of this gem
+  VERSION = "0.9.0"
+end

data/lib/pg_advisory_locker.rb

@@ -0,0 +1,2 @@
+require 'pg_advisory_locker/pg_advisory_locker'
+require 'pg_advisory_locker/version'

data/lib/tasks/desirable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :desirable do
+#   # Task goes here
+# end

data/pg_advisory_locker.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "pg_advisory_locker/version"
+
+Gem::Specification.new do |s|
+ s.name        = 'pg_advisory_locker'
+ s.version     = PgAdvisoryLocker::VERSION
+ s.license     = 'New BSD License'
+ s.date        = '2012-09-14'
+ s.summary     = "Helper for calling PostgreSQL pg_advisory_lock, pg_advisory_try_lock, and pg_advisory_unlock."
+ s.description = "This gem provides a module that, when included in your ActiveRecord model, provides methods to acquire and release advisory locks for PostgreSQL connections."
+ s.authors     = ["Keith Gabryelski"]
+ s.email       = 'keith@fiksu.com'
+ s.files       = `git ls-files`.split("\n")
+ s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+ s.require_path = 'lib'
+ s.homepage    = 'http://github.com/fiksu/pg_advisory_locker'
+ s.add_dependency "pg"
+ s.add_dependency "rails", '>= 3.0.0'
+ s.add_dependency 'rspec-rails'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: pg_advisory_locker
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Keith Gabryelski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides a module that, when included in your ActiveRecord model,
+  provides methods to acquire and release advisory locks for PostgreSQL connections.
+email: keith@fiksu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README
+- Rakefile
+- lib/pg_advisory_locker.rb
+- lib/pg_advisory_locker/pg_advisory_locker.rb
+- lib/pg_advisory_locker/version.rb
+- lib/tasks/desirable_tasks.rake
+- pg_advisory_locker.gemspec
+homepage: http://github.com/fiksu/pg_advisory_locker
+licenses:
+- New BSD License
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Helper for calling PostgreSQL pg_advisory_lock, pg_advisory_try_lock, and
+  pg_advisory_unlock.
+test_files: []