tlopo-futex 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b51aaa540ac3d6cb14a0eefb6d906a84aa11481044b19ca454531d49570cd209
-  data.tar.gz: f96afdc48e141e80ef6f7d1513ef8b8eb4da89cb4ad6f5af88c1cbe0c56f8aa8
+  metadata.gz: 5ec8a84e0e591eb7b334bb93e18ea64b461897df65ba32bedeca4559e66df78f
+  data.tar.gz: ed879b97b4bce2c9c2fa8f4a3fc825d442dc4ed6b30a57d6df0119ba5576f2c4
 SHA512:
-  metadata.gz: 1d1b04a20c69bf970ce9002f84da033dec7c8738dc9c6dda3403fd773c3b3cde9cbc63a06f019f4b468b5cc4877c3aee9a4802cabb6006ee73973685b639cf7e
-  data.tar.gz: 62cb5d5d659b40811a298b4315651f718761bd5f74246d8cc6cd164ce0e723a76dbc9ecc76b90d498af357a5e609133d14f4c740e304fdb5a3dd46b9b12a885a
+  metadata.gz: 15ed9bb3c7f84b18030f7f5c54ba03ecc88913f98e2249ba7efd14927ea38c9dff0f269643eb199600c9a92524ef1b7fa2813fab9abd892844643c2e7b07d6b1
+  data.tar.gz: 332b4abe57e58d430c7df7b0cdfa3a8a370341ebf6ad2cbb275b3bbff38adc2cc4bcbd6354dfc5c7b891cf3faadc9c77bf6f9dfef4842233d579b8ea04b01ac1

data/README.md

@@ -1,34 +1,83 @@
-# Tlopo::Futex
+# TLOPO-Futex
 
-TODO: Delete this and the text below, and describe your gem
+**tlopo-futex** is a Ruby gem providing a simple interface for file-based locking. It enables mutual exclusion between processes to ensure safe access to shared resources.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tlopo/futex`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Features
+
+- File-based locking mechanism
+- `lock`, `release`, and `synchronize` methods for efficient, non-blocking resource handling
+- Lightweight and reliable
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your Gemfile:
+
+```ruby
+gem 'tlopo-futex'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+Then run:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+bundle install
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install directly with:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+gem install tlopo-futex
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Lock and Unlock Example
+
+```ruby
+require 'tlopo/futex'
+
+# Initialize the lock with a path to a lock file
+lock = Tlopo::Futex.new('/tmp/my_lock_file')
+
+# Lock, execute critical code, then release
+lock.lock
+# Critical section code goes here
+lock.release
+```
+
+### Checking Lock Status
+
+You can check if the lock is currently active:
 
-## Development
+```ruby
+if lock.locked?
+  puts "Resource is locked by another process"
+else
+  lock.lock
+  # Critical section code
+  lock.release
+end
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Using `synchronize` for Automatic Locking
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+The `synchronize` method locks and releases automatically, ensuring that the lock is properly released even if an error occurs.
+
+```ruby
+lock.synchronize do
+  # Critical section code that needs exclusive access
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/tlopo-ruby/tlopo-futex](https://github.com/tlopo-ruby/tlopo-futex).
+
+## License
 
+This gem is available under the MIT License.
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tlopo-futex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tlopo-futex/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/tlopo-ruby/tlopo-futex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tlopo-ruby/tlopo-futex/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/tlopo/futex/version.rb

@@ -2,6 +2,6 @@
 
 module Tlopo
   class Futex
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/tlopo/futex.rb

@@ -25,6 +25,7 @@ module Tlopo
     def release
       @fh.flock File::LOCK_UN
       @fh.close
+      rescue IOError
     end
 
     def synchronize

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tlopo-futex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - tlopo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-28 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies: []
 description: File based mutual exclusive lock
 email: