https://github.com/yegor256/syncem

A simple Ruby decorator to make all methods of your object thread-safe
https://github.com/yegor256/syncem

ruby ruby-gem thread-safety threading

Last synced: about 1 year ago
JSON representation

A simple Ruby decorator to make all methods of your object thread-safe

• Host: GitHub
• URL: https://github.com/yegor256/syncem
• Owner: yegor256
• License: mit
• Created: 2019-03-06T19:14:51.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-15T15:39:49.000Z (over 1 year ago)
• Last Synced: 2024-10-16T19:34:16.582Z (over 1 year ago)
• Topics: ruby, ruby-gem, thread-safety, threading
• Language: Ruby
• Homepage: https://rubygems.org/gems/syncem
• Size: 91.8 KB
• Stars: 11
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          


[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)

[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/syncem)](http://www.rultor.com/p/yegor256/syncem)

[![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)

[![rake](https://github.com/yegor256/syncem/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/syncem/actions/workflows/rake.yml)

[![Gem Version](https://badge.fury.io/rb/syncem.svg)](http://badge.fury.io/rb/syncem)

[![Maintainability](https://api.codeclimate.com/v1/badges/5528e182bb5e4a2ecc1f/maintainability)](https://codeclimate.com/github/yegor256/syncem/maintainability)

[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/yegor256/syncem/master/frames)

[![Hits-of-Code](https://hitsofcode.com/github/yegor256/syncem)](https://hitsofcode.com/view/github/yegor256/syncem)

[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/syncem/blob/master/LICENSE.txt)

Read this blog post:

[_SyncEm: Thread-Safe Decorators in Ruby_](https://www.yegor256.com/2019/06/26/syncem.html).

Sometimes you have an object that is not thread-safe,

but you need to make sure each of its methods is thread-safe, because they

deal with some resources, like files or databases and you want them to

manage those resources sequentially. This small gem will help you achieve

exactly that without any re-design of the objects you already have. Just

decorate them with `SyncEm` [thread-safe decorator](https://www.yegor256.com/2017/01/17/synchronized-decorators.html)

and that is it.

First, install it:

```bash

$ gem install syncem

```

Then, use it like this:

```ruby

require 'syncem'

obj = SyncEm.new(obj)

```

That's it.

## How to contribute

Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).

Make sure your build is green before you contribute

your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and

[Bundler](https://bundler.io/) installed. Then:

```

$ bundle update

$ bundle exec rake

```

If it's clean and you don't see any error messages, submit your pull request.