reentrant_flock 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d20c3216b95cf824f521614caca8e048843f649
-  data.tar.gz: 8957df239f692bfa3703545431070fd8f311c606
+  metadata.gz: '0578b8a600fc577d9c97dc5e1a97b287d164142a'
+  data.tar.gz: fabd3a6bfd101c6388456d81eeac11d69c12fdbd
 SHA512:
-  metadata.gz: 178c166ac4fc276c43ebc1c59160e6787ddfb92b52ad9dc3715343c2c61819f2de1a1e8270c02191071ba2f96cbfbdc0e56133b641c9559838f5c3ed4ada9a2d
-  data.tar.gz: bf0f978871509dab41c0192f7191530fc07eeec7f349dc33cf3d92cc84433ef96ef1064d5932c20105541fdd72fed0ca48605adfc2e86a1f756cd4b07ad891ee
+  metadata.gz: 46bf52c3fb8ef838c54f910cbb16bf1a34f0fb3bd61af2eb7b4e8c775e5864f1dc4ea1531eca950eb65bb1401cf1e21b16dec2d2cd1afd8c4f71e729d2e4fea1
+  data.tar.gz: caec8d9f8c038cefdc523284ce670b945461e7d7f18b656fc875affc44a23228083044906f5e88b3f0727ae49bb7ac09008e11134bccb193312cb471bb05131e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.1.1 (2017-11-25)
+
+* Add LICENSE file
+
 # 0.1.0 (2017-09-05)
 
-initial version
+* Initial version

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Naotoshi Seo
+
+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

@@ -26,7 +26,7 @@ require 'reentrant_flock'
 File.open('/tmp/lock', File::RDWR | File::CREAT) do |fp|
   ReentrantFlock.synchronize(fp, File::LOCK_EX) do
     ReentrantFlock.synchronize(fp, File::LOCK_EX) do
-      # not to be blocked by myself
+      # Not blocked by myself
     end
   end
 end
@@ -35,15 +35,15 @@ end
 ```ruby
 require 'reentrant_flock'
 
-def with_lock(&block)
+def with_rlock(&block)
   File.open('/tmp/lock', File::RDWR | File::CREAT) do |fp|
     ReentrantFlock.synchronize(fp, File::LOCK_EX, &block)
   end
 end
 
-with_lock do
-  with_lock do
-    # not to be blocked by myself
+with_rlock do
+  with_rlock do
+    # Not blocked by myself
   end
 end
 ```

data/example/process.rb

@@ -0,0 +1,18 @@
+require 'reentrant_flock'
+
+def with_rlock(&block)
+  File.open('/tmp/lock', File::RDWR | File::CREAT) do |fp|
+    ReentrantFlock.synchronize(fp, File::LOCK_EX | File::LOCK_NB, &block)
+  end
+end
+
+# Should raise AlreadyLocked
+fork do
+  with_rlock do
+    sleep 0.5
+  end
+end
+sleep 0.1
+with_rlock do
+  sleep 0.5
+end

data/example/reentrant.rb

@@ -0,0 +1,13 @@
+require 'reentrant_flock'
+
+def with_rlock(&block)
+  File.open('/tmp/lock', File::RDWR | File::CREAT) do |fp|
+    ReentrantFlock.synchronize(fp, File::LOCK_EX, &block)
+  end
+end
+
+with_rlock do
+  with_rlock do
+    puts 'Not blocked by myself'
+  end
+end

data/example/thread.rb

@@ -0,0 +1,19 @@
+require 'reentrant_flock'
+
+def with_rlock(&block)
+  File.open('/tmp/lock', File::RDWR | File::CREAT) do |fp|
+    ReentrantFlock.synchronize(fp, File::LOCK_EX | File::LOCK_NB, &block)
+  end
+end
+
+# Should raise AlreadyLocked
+th = Thread.new do
+  with_rlock do
+    sleep 0.5
+  end
+end
+sleep 0.1
+with_rlock do
+  sleep 0.5
+end
+th.join

data/lib/reentrant_flock.rb

@@ -11,9 +11,7 @@ class ReentrantFlock
     # when a file is closed. Use ReentrantFlock.synchronize to assure
     # decrementing internal counts.
     #
-    # @param fp [File]
-    # @param operation [PARAM]
-    # @see File#flock for more details
+    # @param [File] fp
     # @param [PARAM] operation See File#flock
     # @return see File#flock
     def flock(fp, operation)
@@ -50,7 +48,7 @@ class ReentrantFlock
     private
 
     # @return [0] if current thread holds the lock
-    # @return [false] if current thread holds the lock
+    # @return [false] if another already locked (LOCK_NB)
     def lock(fp, operation)
       c = incr(key(fp))
       if c <= 1
@@ -91,7 +89,7 @@ class ReentrantFlock
   end
 end
 
-# There is a fact that
+# Please note that:
 #
 # ```
 # fp = File.open('a', 'w')
@@ -101,10 +99,11 @@ end
 # fp.flock(File::LOCK_EX) # block
 # ```
 #
-# That is, File#flock is orginally reentrant for the same
-# file object because its file descriptor has lock information
-# on kernel layer. So, this instance version, which holds an
-# instance of File, may not worth to be prepared.
+# That is, File#flock is orginally reentrant for the same file
+# object. On linux, file lock is associated with file descriptor,
+# so another file descriptor is required to get blocked.
+# This version holds the same file object, so might be useless.
+# I may delete this. Using flock directly should be enough.
 class ReentrantFlock
   attr_reader :fp
 

data/lib/reentrant_flock/version.rb

@@ -1,3 +1,3 @@
 class ReentrantFlock
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/reentrant_flock.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{A reentrant/recursive flock.}
   spec.description   = %q{A reentrant/recursive flock.}
   spec.homepage      = "https://github.com/sonots/reentrant_flock"
+  spec.licenses      = ["MIT"]
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reentrant_flock
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2017-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,15 +77,20 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- example/process.rb
+- example/reentrant.rb
+- example/thread.rb
 - lib/reentrant_flock.rb
 - lib/reentrant_flock/version.rb
 - reentrant_flock.gemspec
 homepage: https://github.com/sonots/reentrant_flock
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []