with_locking 0.0.1 → 1.0.1

data/README.md

@@ -16,13 +16,13 @@ Or install it yourself as:
 
 A block of code can be executed like so:
 
-    WithLocking.do { puts "While I'm running other code run through WithLocking cannot run!" }
+    WithLocking.run { puts "While I'm running other code run through WithLocking cannot run!" }
 
 Alternatively, run the block of code with an optional name (recommended), that way multiple WithLocking blocks with different names can be invoked without conflicting:
 
-    WithLocking.do(:name => "sleeper") { sleep 60 }
-    WithLocking.do(:name => "sleeper") { puts "I won't execute and will return false because 'sleeper' is still running the first block." }
-    WithLocking.do(:name => "other_name") { puts "But I will run because 'other_name' isn't running!" }
+    WithLocking.run(:name => "sleeper") { sleep 60 }
+    WithLocking.run(:name => "sleeper") { puts "I won't execute and will return false because 'sleeper' is still running the first block." }
+    WithLocking.run(:name => "other_name") { puts "But I will run because 'other_name' isn't running!" }
     # => "But I will run because 'other_name' isn't running!"
 
 To simply test if a named block is still running without executing a block use the `locked?` method:
@@ -32,7 +32,7 @@ To simply test if a named block is still running without executing a block use t
 
 To raise an exception when the block isn't run (rather than simply returning false), use the `do!` method:
 
-    WithLocking.do!(:name => "sleeper") { puts "Blah" }
+    WithLocking.run!(:name => "sleeper") { puts "Blah" }
     # => raises an error if 'sleeper' block is still running from before
 
 ## Contributing

data/lib/with_locking.rb

@@ -2,7 +2,7 @@ require "with_locking/version"
 
 module WithLocking 
 
-  def self.do(options = {}, &block)
+  def self.run(options = {}, &block)
     raise "No block given" unless block_given?
 
     name = options[:name] || "locking_service_task"
@@ -27,8 +27,8 @@ module WithLocking
     return true
   end
 
-  def self.do!(options = {}, &block)
-    raise "locked process still running" unless self.do(options, &block)
+  def self.run!(options = {}, &block)
+    raise "locked process still running" unless self.run(options, &block)
   end
 
   def self.locked?(name)

data/lib/with_locking/version.rb

@@ -1,3 +1,3 @@
 module WithLocking
-  VERSION = "0.0.1"
+  VERSION = "1.0.1"
 end

data/spec/with_locking_spec.rb

@@ -9,36 +9,36 @@ describe WithLocking do
     File.stub(:delete)
   end
 
-  describe "#do" do
+  describe "#run" do
 
     it "writes a pid file" do
       File.should_receive(:open).with(path, "w")
-      WithLocking.do(:name => file_name) { }
+      WithLocking.run(:name => file_name) { }
     end
 
     it "executes the given block" do
       my_test_array = []
-      WithLocking.do { my_test_array << 1 }
+      WithLocking.run { my_test_array << 1 }
       my_test_array.count.should == 1
     end
 
     it "deletes the pid file" do
       File.should_receive(:delete).with(path)
-      WithLocking.do(:name => file_name) {}
+      WithLocking.run(:name => file_name) {}
     end
 
     it "should not execute the block if the pid file already exists" do
       File.stub(:exists?).and_return(true)
-      WithLocking.do {}.should == false
+      WithLocking.run {}.should == false
     end
 
   end
 
-  describe "#do!" do
+  describe "#run!" do
 
     it "raises an exception if the pid file already exists" do
       File.stub(:exists?).and_return(true)
-      lambda { WithLocking.do! {} }.should raise_error(RuntimeError, 'locked process still running')
+      lambda { WithLocking.run! {} }.should raise_error(RuntimeError, 'locked process still running')
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: with_locking
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors: