Skip to content

Commit 1b202ad

Browse files
committed
Modernize gem.
1 parent d6ae408 commit 1b202ad

File tree

4 files changed

+19
-25
lines changed

4 files changed

+19
-25
lines changed

.editorconfig

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@ root = true
33
[*]
44
indent_style = tab
55
indent_size = 2
6-

README.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,21 @@
22

33
Provides containers which implement concurrency policy for high-level servers (and potentially clients).
44

5-
[![Actions Status](https://github.com/socketry/async-container/workflows/Development/badge.svg)](https://github.com/socketry/async-container/actions?workflow=Development)
6-
[![Code Climate](https://codeclimate.com/github/socketry/async-container.svg)](https://codeclimate.com/github/socketry/async-container)
7-
[![Coverage Status](https://coveralls.io/repos/socketry/async-container/badge.svg)](https://coveralls.io/r/socketry/async-container)
5+
[![Development Status](https://github.com/socketry/async-container/workflows/Development/badge.svg)](https://github.com/socketry/async-container/actions?workflow=Development)
86

97
## Installation
108

11-
Add this line to your application's Gemfile:
12-
13-
```ruby
14-
gem "async-container"
9+
``` bash
10+
$ bundle add async-container
1511
```
1612

17-
And then execute:
18-
19-
$ bundle
20-
21-
Or install it yourself as:
22-
23-
$ gem install async
24-
2513
## Usage
2614

2715
### Container
2816

2917
A container represents a set of child processes (or threads) which are doing work for you.
3018

31-
```ruby
19+
``` ruby
3220
require 'async/container'
3321

3422
Async.logger.debug!
@@ -50,7 +38,7 @@ Async.logger.debug "Finished."
5038

5139
The controller provides the life-cycle management for one or more containers of processes. It provides behaviour like starting, restarting, reloading and stopping. You can see some [example implementations in Falcon](https://github.com/socketry/falcon/blob/master/lib/falcon/controller/). If the process running the controller receives `SIGHUP` it will recreate the container gracefully.
5240

53-
```ruby
41+
``` ruby
5442
require 'async/container'
5543

5644
Async.logger.debug!
@@ -77,7 +65,7 @@ controller.run
7765

7866
`SIGINT` is the interrupt signal. The terminal sends it to the foreground process when the user presses **ctrl-c**. The default behavior is to terminate the process, but it can be caught or ignored. The intention is to provide a mechanism for an orderly, graceful shutdown.
7967

80-
`SIGQUIT` is the dump core signal. The terminal sends it to the foreground process when the user presses **ctrl-\**. The default behavior is to terminate the process and dump core, but it can be caught or ignored. The intention is to provide a mechanism for the user to abort the process. You can look at `SIGINT` as "user-initiated happy termination" and `SIGQUIT` as "user-initiated unhappy termination."
68+
`SIGQUIT` is the dump core signal. The terminal sends it to the foreground process when the user presses **ctrl-\\**. The default behavior is to terminate the process and dump core, but it can be caught or ignored. The intention is to provide a mechanism for the user to abort the process. You can look at `SIGINT` as "user-initiated happy termination" and `SIGQUIT` as "user-initiated unhappy termination."
8169

8270
`SIGTERM` is the termination signal. The default behavior is to terminate the process, but it also can be caught or ignored. The intention is to kill the process, gracefully or not, but to first allow it a chance to cleanup.
8371

@@ -109,11 +97,11 @@ WantedBy=multi-user.target
10997

11098
## Contributing
11199

112-
1. Fork it
113-
2. Create your feature branch (`git checkout -b my-new-feature`)
114-
3. Commit your changes (`git commit -am 'Add some feature'`)
115-
4. Push to the branch (`git push origin my-new-feature`)
116-
5. Create new Pull Request
100+
1. Fork it
101+
2. Create your feature branch (`git checkout -b my-new-feature`)
102+
3. Commit your changes (`git commit -am 'Add some feature'`)
103+
4. Push to the branch (`git push origin my-new-feature`)
104+
5. Create new Pull Request
117105

118106
## License
119107

async-container.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
1212
spec.homepage = "https://github.com/socketry/async-container"
1313

1414
spec.files = Dir.glob('{lib}/**/*', File::FNM_DOTMATCH, base: __dir__)
15-
15+
1616
spec.required_ruby_version = "~> 2.5"
1717

1818
spec.add_dependency "async", "~> 1.0"

gems.rb

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,10 @@
44

55
# Specify your gem's dependencies in utopia.gemspec
66
gemspec
7+
8+
group :maintenance, optional: true do
9+
gem "bake-bundler"
10+
gem "bake-modernize"
11+
12+
gem "utopia-project"
13+
end

0 commit comments

Comments
 (0)