concurrent_worker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 678beb9ed4ddb2d3c4595a4b286e6ebd195a4c5f645460619f5725af3d3064a7
-  data.tar.gz: 6877a4d045f8dc820175bed7ada367a553ac4be85db3390903b7fbb50291ab53
+  metadata.gz: f99d3718f404a7e77a8b8184db783b4dc94826480e67ff32411e07fe248d69a2
+  data.tar.gz: 2f568f170d9bb93aef611ec3d85170dba00077f0fbd9232ff75d105ddef640c3
 SHA512:
-  metadata.gz: 7215dd0d8019ee6e20ff3416ec9efff7f5ead7c4144b92b8cf45e43234c96de8189651d23db08a3384d1e55676c0ad7e5216e5da611eb7d1456d568ad0129a8c
-  data.tar.gz: b62ec465175412dede959aa285b4610b43b20b7e843d107f893318576b06decef8f41ff9ec57dd76be6189f7bf612b758563e13e629447443a51fb24c5df6d9a
+  metadata.gz: 5258be0aefc96435579d2444aca60721ef1839b5955f8a52b921814bf8ebd95717b0a3022edc52680e4558e61fee5fd69354e1d2ce71f20dc29793ede29e94b6
+  data.tar.gz: 7c20fcd0be6e27af4582fde0802adccffb8636cae1607ce9fd8bfb19bc17222e30ed8922838e494ebe3bed0ac885b7b27f414cb9e02ed45b6cee5f6cd403ed02

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    concurrent_worker (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  concurrent_worker!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -1,8 +1,6 @@
 # ConcurrentWorker
 
-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/concurrent_worker`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +20,77 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Worker
+
+You can define worker block executed in other thread, and send requests to the worker.
+
+```ruby
+require 'concurrent_worker'
+Thread.abort_on_exception = true
+
+# define a work block.
+logger = ConcurrentWorker::Worker.new do |args|
+  printf(*args)
+  $stdout.flush
+  nil
+end
+
+...
+# call work block asynchronously with 'req' method.
+logger.req("thread%d n=%d\n",0, 1)
+
+logger.join
+```
+
+If you need some preparation for the worker block, you can define 'base block':
+
+```ruby
+logger = ConcurrentWorker::Worker.new do |args|
+  # share object with 'base block' by instance variable(@xxx). 
+  printf(@file, *args)
+  @file.flush
+  nil
+end
+
+# define 'base block' for some preparation of 'work block'.
+logger.set_block(:base_block) do
+  open( "log.txt" , "w" ) do |file|
+    @file = file
+    # 'yield_loop_block' must be called in 'base block'.
+    # 'work block' will be called in this call.
+    yield_loop_block 
+  end
+end
+...
+```
+
+The 'work blick' and 'base block' are executed in a worker's instance scope, in a same thread, so that they can share object with the worker's instance variable.
+
+### WorkerPool
+You can exec work block in some process concurrently.
+
+```ruby
+#define a pool of 8 workers , executed in other process.
+pw = ConcurrentWorker::WorkerPool.new(type: :process, pool_max: 8) do
+  |n|
+  [n , n.times.inject(:+)]
+end
+
+# you can receive the result of work block with callback block.
+pw.add_callback do |n, result|
+  logger.log( "n=%d,result=%d", n, result)
+end
+
+(10000000..10000200).each do |n|
+  pw.req(n)
+end
+
+pw.join
+
+```
+
+Worker uses `Marshal::dump/load` to transport ruby object to other process. So, request arguments and result objects must be able to be Marshal dumped. 
+
 
 ## Development
 
@@ -32,7 +100,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/concurrent_worker.
+Bug reports and pull requests are welcome on GitHub at https://github.com/murjp/concurrent_worker.
 
 ## License
 

data/README.md.backup

@@ -0,0 +1,107 @@
+# ConcurrentWorker
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'concurrent_worker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install concurrent_worker
+
+## Usage
+
+### Worker
+
+You can define worker block executed in other thread, and send request for the worker.
+
+```ruby
+require 'concurrent_worker'
+Thread.abort_on_exception = true
+
+# define a work block.
+logger = ConcurrentWorker::Worker.new do |args|
+  printf(*args)
+  $stdout.flush
+  nil
+end
+
+...
+# call work block asynchronously with 'req' method.
+logger.req("thread%d n=%d\n",0, 1)
+
+logger.join
+```
+
+If you want to write log in a file, you can define 'base block':
+
+```ruby
+logger = ConcurrentWorker::Worker.new do |args|
+  # share object with 'base block' by instance variable(@xxx). 
+  printf(@file, *args)
+  @file.flush
+  nil
+end
+
+# define 'base block' for some preparation of 'work block'.
+logger.set_block(:base_block) do
+  open( "log.txt" , "w" ) do |file|
+    @file = file
+    # 'yield_loop_block' must be called in 'base block'.
+    # 'work block' will be called in this call.
+    yield_loop_block 
+  end
+end
+...
+```
+
+The 'work blick' and 'base block' are executed in a worker's instance scope, in a same thread, so that they can share object with the worker's instance variable.
+
+### WorkerPool
+You can exec work block in some process concurrently.
+
+```ruby
+#define a pool of 8 workers , executed in other process.
+pw = ConcurrentWorker::WorkerPool.new(type: :process, pool_max: 8) do
+  |n|
+  [n , n.times.inject(:+)]
+end
+
+# you can receive the result of work block with callback block.
+pw.add_callback do |n, result|
+  logger.log( "n=%d,result=%d", n, result)
+end
+
+(10000000..10000200).each do |n|
+  pw.req(n)
+end
+
+pw.join
+
+```
+
+Worker uses `Marshal::dump/load` to transport ruby object to other process. So, request arguments and result objects must be able to be Marshal dumped. 
+
+
+## Development
+
+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.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/murjp/concurrent_worker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/concurrent_worker/version.rb

@@ -1,3 +1,3 @@
 module ConcurrentWorker
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: concurrent_worker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - mur
@@ -62,8 +62,10 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
+- README.md.backup
 - Rakefile
 - bin/console
 - bin/setup