https://github.com/yegor256/obk

Ruby decorator to throttle object method calls: there will be fixed delays between them
https://github.com/yegor256/obk

ruby ruby-gem

Last synced: about 1 year ago
JSON representation

Ruby decorator to throttle object method calls: there will be fixed delays between them

• Host: GitHub
• URL: https://github.com/yegor256/obk
• Owner: yegor256
• License: mit
• Created: 2021-03-07T07:42:08.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T10:54:22.000Z (over 1 year ago)
• Last Synced: 2024-09-16T12:27:49.372Z (over 1 year ago)
• Topics: ruby, ruby-gem
• Language: Ruby
• Homepage: https://rubygems.org/gems/obk
• Size: 93.8 KB
• Stars: 10
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Throttle Ruby Method Calls

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

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

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

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

[![Test Coverage](https://img.shields.io/codecov/c/github/obk/cobench.svg)](https://codecov.io/github/yegor256/obk?branch=master)

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

[![Maintainability](https://api.codeclimate.com/v1/badges/e1be4e43e125fdc1e454/maintainability)](https://codeclimate.com/github/yegor256/obk/maintainability)

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

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

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

First, install it:

```bash

gem install obk

```

Then, use it like this:

```ruby

require 'obk'

obj = Obk.new(obj, pause: 500)

obj.foo

# Forced 500ms delay here

obj.bar

```

There will be a forced delay of 500 milliseconds between `.foo` and `.bar` calls.

Keep in mind that `Obk` is _not_ thread-safe.

## 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:

```bash

bundle update

bundle exec rake

```

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