sponges 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -22
  3. data/lib/sponges/version.rb +1 -1
  4. metadata +5 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 7bc1020da5a609d654d69a21d51fc0b77d05ea5c
4
- data.tar.gz: bf1a641c5e4a66379fd9e0bcf58cf067a951c129
3
+ metadata.gz: f0cac568a3c8a62e54982cfc0f148a3364ce621d
4
+ data.tar.gz: b43a3a61760b50152a5822530f40164cc3a8929d
5
5
  SHA512:
6
- metadata.gz: 60249ea5adc99e00704121e52eec82ba4edb4f4275467e89f9f0f6cc3bf5c395ade5991b22704f84996e4ef0e5d5eec66285060dfc7dc265c53817fedaf1bf14
7
- data.tar.gz: fee8bbcee7199bfde7a19d7d4a068ef083c42c921b8856b75dae539eff44f921a0221685e8d99e49c63f077e54570dfbda575be54cb9709d50f04b148de09d09
6
+ metadata.gz: 03fc14026327a11541b3c6e64e2ace1589ef4082e99db43c3d37058ffc603a6e4639606c3cffc5ea1c8a14694183ccd753e1d6a619a24141884732bde5440dff
7
+ data.tar.gz: 21798560537ad2d3cded92ee268586a476eff76dceffd7746b7c74719dee87db4568e14a577205b276edc7aa12d8cccb7e13fefb672da6a48700948cb56ae95e
data/README.md CHANGED
@@ -5,20 +5,19 @@ Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/AF83
5
5
  [![Gem
6
6
  Version](https://fury-badge.herokuapp.com/rb/sponges.png)](http://badge.fury.io/rb/sponges)
7
7
 
8
- When I build workers, I want them to be like an army of spongebobs, always
9
- stressed and eager to work. `sponges` helps you build this army of sponges, to
10
- control them, and, well, to kill them gracefully. Making them stressed and eager
11
- to work is your job. :)
8
+ When I build workers, I want them to be much like an army of spongebobs: always
9
+ stressed and eager to work. `sponges` helps you with building this army of sponges,
10
+ controling them, and, well, eventually killing them gracefully. Hum, making them
11
+ stressed and eager to work would still be your job :)
12
12
 
13
13
  Basically, sponges is a ruby supervisor that forks processes and controls their
14
- execution and termination. For example the following will start a supervision
15
- daemon and 8 processes of "a_worker".
14
+ execution and termination. For example, the following will start a supervision
15
+ daemon and 8 processes of "a_worker":
16
16
 
17
17
  ```bash
18
18
  ruby a_worker.rb start -d -s 8
19
19
  ```
20
- If you kill the supervisor it will cleanly
21
- terminate the child processes.
20
+ If you kill the supervisor, it will cleanly terminate its child processes.
22
21
 
23
22
  Internally, `sponges` strongly relies on Unix signals.
24
23
 
@@ -28,19 +27,22 @@ Internally, `sponges` strongly relies on Unix signals.
28
27
 
29
28
  ## Installation
30
29
 
31
- Ruby 1.9.2 (or superior).
30
+ Requires Ruby 1.9.2 or newer.
32
31
 
33
32
  Install it with rubygems:
34
33
 
35
34
  gem install sponges
36
35
 
37
- With bundler, add it to your `Gemfile`:
36
+ You may use bundler. In this case, add it to your `Gemfile`:
38
37
 
39
38
  ``` ruby
40
39
  gem "sponges"
41
40
  ```
42
41
 
42
+ and run `bundle install`.
43
+
43
44
  ## Usage
45
+
44
46
  In a file called `example.rb`:
45
47
 
46
48
  ``` ruby
@@ -127,35 +129,31 @@ Stop workers with a `HUP` signal :
127
129
  ``` bash
128
130
  ruby example.rb stop -g -t 5
129
131
  ```
132
+
130
133
  In this case, you will have to trap the `HUP` signal, and handle a clean stop
131
134
  from each workers. The point is to wait for a task to be done before quitting. A
132
- timeout can be specify with the `-t` option. When this timeout is hited, the
135
+ timeout can be specify with the `-t` option. When this timeout is hit, the
133
136
  process is killed.
134
137
 
135
138
  Increment worker's pool size :
136
139
  ``` bash
137
- ruby example.rb increment # will add a worker to the pool.
140
+ ruby example.rb increment # will add a worker from the pool.
138
141
  ```
139
142
 
140
143
  Decrement worker's pool size :
141
144
  ``` bash
142
- ruby example.rb decrement # will remove a worker to the pool.
143
- ```
144
-
145
- Show a list of workers and their children.
146
- ``` bash
147
- ruby example.rb list
145
+ ruby example.rb decrement # will remove a worker from the pool.
148
146
  ```
149
147
 
150
- ## Http supervision
148
+ ## HTTP supervision
151
149
 
152
- sponges provides an http interface to supervise pool's activity, and to expose
153
- pids. Http supervision can be enable in configuration:
150
+ sponges provides an HTTP interface to supervise the pool's activity, and to expose
151
+ pids. HTTP supervision can be enabled in the configuration:
154
152
 
155
153
 
156
154
  ``` ruby
157
155
  Sponges.configure do |config|
158
- config.port = 3333
156
+ config.port = 3333
159
157
  end
160
158
  ```
161
159
 
@@ -1,4 +1,4 @@
1
1
  # encoding: utf-8
2
2
  module Sponges
3
- VERSION = "1.0.0"
3
+ VERSION = "1.0.1"
4
4
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: sponges
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - chatgris
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2013-03-14 00:00:00.000000000 Z
11
+ date: 2013-04-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: boson
@@ -30,14 +30,14 @@ dependencies:
30
30
  requirements:
31
31
  - - ~>
32
32
  - !ruby/object:Gem::Version
33
- version: 0.0.4
33
+ version: 0.1.0
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - ~>
39
39
  - !ruby/object:Gem::Version
40
- version: 0.0.4
40
+ version: 0.1.0
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: rspec
43
43
  requirement: !ruby/object:Gem::Requirement
@@ -99,3 +99,4 @@ signing_key:
99
99
  specification_version: 4
100
100
  summary: Turn any ruby object to a daemon controlling an army of sponges.
101
101
  test_files: []
102
+ has_rdoc: