the_lone_dyno 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cc00080214d127a40dd7ffde3cd0ae7e7298bda
-  data.tar.gz: 8948b5958cae2c5cf67e17cdf4c82ab8949a376e
+  metadata.gz: 57ba91bea8834c6e34ddbb1c1538ba646e9d82a0
+  data.tar.gz: afe9c78b57d5a1d032f36f28a9e450e4a6cff5f0
 SHA512:
-  metadata.gz: 56a23c590fdcce8d35b9891e99482feafb9a932d7623a398e085fec5d8f1fbc2510415f6353c94b62afdb9da0bf27dabe6afd0241e65ea7c8a88ed271aeb0dda
-  data.tar.gz: 35e29cfe0431f04c0b5e2c01a41c5d2dd04e0b65561086dbb461c83a96047a6f6e91e081eccf6a391e8a85c494d2e20c1072378338dd0295fa80e9c01f80830f
+  metadata.gz: 48adc6fdab84f9347f174352227ae8e3ee9504f9a88f3774a22d0a556b9d97cd4278a8ca5d0f23ccfe1d34f5a194b8cb13ae0f1a44f95c5f19e2b5b5950a1693
+  data.tar.gz: dada3ca815f8a0643103f834a62a29e5078f5aa84b2b3a824bb8e88188683c2983034a0775bfd7daec014b0d565f84120a13653b21ae83b8166a96e3bbdd8e88

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# A Log of Changes!
+
+## [0.1.1] - 2015-10-12
+
+- Restrict locking behavior by process type. Default is "web".
+
+## [0.1.0]
+
+- First version.

data/README.md

@@ -2,7 +2,7 @@
 
 # TheLoneDyno
 
-Isolate code to only run on a certain number of Heroku dynos. Using and Postgres [advisory locks](http://www.postgresql.org/docs/9.1/static/explicit-locking.html). You can later trigger events using Postgres listen/notify.
+Isolate code to only run on a certain number of Heroku dynos. Uses Postgres [advisory locks](http://www.postgresql.org/docs/9.1/static/explicit-locking.html) to isolate behavior and Postgres [LISTEN/NOTIFY](http://www.postgresql.org/docs/9.1/static/sql-notify.html) to trigger custom events.
 
 [![Build Status](https://travis-ci.org/schneems/the_lone_dyno.svg?branch=master)](https://travis-ci.org/schneems/the_lone_dyno)
 
@@ -12,7 +12,7 @@ Why would you want to run code on only one dyno? Maybe you want to add some perf
 
 Why is this needed? All Heroku dynos operate independently of one another. Once one is running you can't change it. You can `$ heroku run bash` but this gives you a new dyno that doesn't receieve any web traffic. If you want to run code on only a certain number of dynos it's been difficult to do so until now.
 
-> Be warned, only changing behavior on 1 dyno in your app, could cause difficult to reproduce problems. "I'm getting an error but only once fore every 20 requests". Using this library is an advanced technique and should be implemented with care. Make sure to tell the rest of your team what you're doing, and remove the code from your codebase as soon as you're done.
+> Be warned, only changing behavior on 1 dyno in your app, could cause difficult to reproduce problems. "I'm getting an error, but only once fore every 20 requests". Using this library is an advanced technique and should be implemented with care. Make sure to tell the rest of your team what you're doing, and remove the code from your codebase as soon as you're done.
 
 ## Installation
 
@@ -46,7 +46,7 @@ end
 puts "Does not block future code execution"
 ```
 
-This code will only run on one dyno. By default code passed into the block will run in the background and the lock will be held for as long as your process is alive. For example if we run the above code we should get:
+This code will only run on one dyno (by default in a "web" process type). The code passed into the block will run in the background and the lock will be held for as long as your process is alive. For example if we run the above code we should get:
 
 ```
 Does not block future code execution
@@ -105,7 +105,19 @@ TheLoneDyno.exclusive do |signal|
 end
 ```
 
-## Config
+## Restricting to Process Type
+
+By default `the_lone_dyno` is restricted to only run in the `web` process type dynos. It does this using the [DYNO environment variable](https://devcenter.heroku.com/articles/dynos#local-environment-variables). You can set this to another process type:
+
+```ruby
+TheLoneDyno.exclusive(process_type: "worker") do
+  # Code you only want to run on 5 dyno
+end
+```
+
+This will attempt to lock any DYNO environment variable containing "worker" string. You can use a string or a regex. if the `$DYNO` environment variable isn't present or if `process_type` is set to `false` then the check will be skipped and the first process to boot will aquire the lock regardless of dyno type. This behavior is purposful so you can aquire and lock on your local develoment machine.
+
+## Running on more than 1 Dyno
 
 You can control the number of dynos you run code on by passing in an integer:
 
@@ -115,6 +127,8 @@ TheLoneDyno.exclusive(dynos: 5) do
 end
 ```
 
+## Using multiple locks on the same app
+
 Under the hood this uses PG advisory locks. If you need to customize the default advisory key, for instance if you want to have multiple processes you want to isolate to a set of dynos you can use the `key_base:` key, for example:
 
 ```ruby

data/lib/the_lone_dyno.rb

@@ -3,10 +3,14 @@ require "pg_lock"
 
 module TheLoneDyno
   DEFAULT_KEY = "the_lone_dyno_hi_ho_silver"
+  WEB_PROCESS_TYPE_REGEX = /\Aweb/
 
   # Use to ensure only `dynos` count of dynos are exclusively running
   # the given block
-  def self.exclusive(background: true, dynos: 1, key_base: DEFAULT_KEY, connection: ::PgLock::DEFAULT_CONNECTION_CONNECTOR.call, &block)
+  def self.exclusive(background: true, dynos: 1, process_type: WEB_PROCESS_TYPE_REGEX, key_base: DEFAULT_KEY, connection: ::PgLock::DEFAULT_CONNECTION_CONNECTOR.call, &block)
+
+    return if process_type && ENV["DYNO"] && !ENV["DYNO"].match(process_type)
+
     if background
       Thread.new do
         forever_block = Proc.new { |*args| block.call(*args); while true do; sleep 180 ; end; }

data/lib/the_lone_dyno/version.rb

@@ -1,3 +1,3 @@
 module TheLoneDyno
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_lone_dyno
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - schneems
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_lock
@@ -104,6 +104,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt