concurrent_worker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 678beb9ed4ddb2d3c4595a4b286e6ebd195a4c5f645460619f5725af3d3064a7
+  data.tar.gz: 6877a4d045f8dc820175bed7ada367a553ac4be85db3390903b7fbb50291ab53
+SHA512:
+  metadata.gz: 7215dd0d8019ee6e20ff3416ec9efff7f5ead7c4144b92b8cf45e43234c96de8189651d23db08a3384d1e55676c0ad7e5216e5da611eb7d1456d568ad0129a8c
+  data.tar.gz: b62ec465175412dede959aa285b4610b43b20b7e843d107f893318576b06decef8f41ff9ec57dd76be6189f7bf612b758563e13e629447443a51fb24c5df6d9a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in concurrent_worker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 MURATA Takahiro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# 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
+
+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
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/concurrent_worker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "concurrent_worker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/concurrent_worker.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "concurrent_worker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "concurrent_worker"
+  spec.version       = ConcurrentWorker::VERSION
+  spec.authors       = ["mur"]
+  spec.email         = ["mur@mur.jp"]
+
+  spec.summary       = %q{Concurrent worker in thread/process with preparation structure.}
+  spec.description   = %q{I will write later...}
+  spec.homepage      = "https://github.com/murjp/concurrent_worker"
+  spec.license       = "MIT"
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/concurrent_worker/version.rb

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

data/lib/concurrent_worker.rb

@@ -0,0 +1,292 @@
+require "concurrent_worker/version"
+
+module ConcurrentWorker
+  class Error < StandardError; end
+
+  require 'thread'
+  class Worker
+    attr_accessor :channel
+    # Worker               : worker class
+    #  +cncr_block         : concurrent processing block : thread(as ConcurrentThread)/process(as ConcurrentProcess)
+    #    +base_block       : user defined preparation to exec 'work block'
+    #      +loop_block     : loop of receiving request and exec 'looped block'
+    #        +work_block   : user requested work
+    #
+    # These blocks are executed with 'instance_exec' method of worker,
+    # so that they can share instance variables:@xxxx.
+    #
+
+    attr_reader :req_queue, :req_queue_max
+    
+    def initialize(*args, **options, &work_block)
+      @args = args
+      @options = options
+      set_block(:work_block, &work_block) if work_block
+      
+      @state = :idle
+      @callbacks = []
+
+      @req_queue_max = @options[ :req_queue_max ] || 2
+      @req_queue = SizedQueue.new(@req_queue_max)
+      
+      if @options[ :type ] == :process
+        Worker.include ConcurrentProcess
+      else
+        Worker.include ConcurrentThread
+      end
+    end
+    
+    def add_callback(&callback)
+      raise "block is nil" unless callback
+      @callbacks.push(callback)
+    end
+    
+    def call_callbacks(args)
+      @callbacks.each do |callback|
+        callback.call(args)
+      end
+    end
+    
+    def set_block(symbol, &block)
+      raise "block is nil" unless block
+      
+      unless [:base_block, :loop_block, :work_block].include?(symbol)
+        raise symbol.to_s + " is not used as worker block"
+      end
+      
+      worker_block = Proc.new do |*args|
+        self.instance_exec(*args, &block)
+      end
+      instance_variable_set("@" + symbol.to_s, worker_block)
+      
+      define_singleton_method("yield_" + symbol.to_s) do |*args|
+        blk = instance_variable_get("@" + symbol.to_s)
+        if blk
+          blk.call(*args)
+        else
+          raise "block " + symbol.to_s + " is not defined"
+        end
+      end
+    end
+    
+    def run
+      @state = :run
+
+      unless @loop_block
+        set_block(:loop_block) do
+          loop do
+            break if (req = receive_req).empty?
+            (args, work_block) = req
+            if work_block
+              set_block(:work_block, &work_block)
+            end
+            send_res(yield_work_block(args))
+          end
+        end
+      end
+      
+      unless @base_block
+        set_block(:base_block) do
+          yield_loop_block
+        end
+      end
+      cncr_block
+    end
+
+    
+    def req(*args, &work_block)
+      unless @state == :run
+        run
+      end
+      send_req([args, work_block])
+    end
+    
+    def quit
+      send_req([])
+    end
+    
+    def join
+      quit
+      wait_cncr_proc
+    end
+  end
+
+
+  module ConcurrentThread
+    def cncr_block
+      @thread_channel = Queue.new
+      @thread =  Thread.new do
+        yield_base_block
+      end
+    end
+    
+    def send_req(args)
+      @req_queue.push(args)
+      @thread_channel.push(args)
+    end
+    
+    def receive_req
+      @thread_channel.pop
+    end
+
+    def send_res(args)
+      call_callbacks(args)
+      @req_queue.pop
+    end
+
+    def wait_cncr_proc
+      @thread && @thread.join
+    end
+  end
+
+
+  module ConcurrentProcess
+    class IPCDuplexChannel
+      def initialize
+        @p_pid = Process.pid
+        @p2c = IO.pipe('ASCII-8BIT', 'ASCII-8BIT')
+        @c2p = IO.pipe('ASCII-8BIT', 'ASCII-8BIT')
+      end
+
+      def choose_io
+        w_pipe, r_pipe = @p_pid == Process.pid ? [@p2c, @c2p] : [@c2p, @p2c]
+        @wio, @rio = w_pipe[1], r_pipe[0]
+        [w_pipe[0], r_pipe[1]].map(&:close)
+      end
+      
+      def send(obj)
+        begin
+          data = Marshal.dump(obj)
+          @wio.write([data.size].pack("I"))
+          @wio.write(data)
+        rescue Errno::EPIPE
+        end
+      end
+
+      def recv
+        size = @rio.read(4).unpack("I")[0]
+        Marshal.load(@rio.read(size))
+      end
+      
+      def close
+        [@wio, @rio].map(&:close)
+      end
+
+    end
+    
+    def cncr_block
+      @ipc_channel = IPCDuplexChannel.new
+      @c_pid = fork do
+        @ipc_channel.choose_io
+        yield_base_block
+        @ipc_channel.send(:worker_loop_finished)
+      end
+      @ipc_channel.choose_io
+
+      @thread = Thread.new do
+        loop do
+          result = @ipc_channel.recv
+          break if result == :worker_loop_finished
+          call_callbacks(result)
+          @req_queue.pop
+        end
+      end
+    end
+
+    def send_req(args)
+      #called from main process only
+      @req_queue.push(args)
+      @ipc_channel.send(args)
+    end
+    
+    def receive_req
+      #called from worker process only
+      @ipc_channel.recv
+    end
+    
+    def send_res(args)
+      #called from worker process only
+      @ipc_channel.send(args)
+    end
+
+    def wait_cncr_proc
+      begin
+        Process.waitpid(@c_pid)
+      rescue Errno::ECHILD
+      end
+      @thread && @thread.join
+    end
+  end
+
+
+
+  class WorkerPool < Array
+    def initialize(*args, **options, &work_block)
+      @args = args
+      
+      @options = options
+      @max_num = @options[ :pool_max ] || 8
+      @set_blocks = []
+      if work_block
+        @set_blocks.push([:work_block, work_block])
+      end
+      
+      @ready_queue = Queue.new
+      
+      @callbacks = []
+      @callback_queue = Queue.new
+      @callback_thread = Thread.new do
+        finished_count = 0
+        loop do
+          break if (result = @callback_queue.pop).empty?
+          @callbacks.each do |callback|
+            callback.call(result[0])
+          end
+        end
+      end
+    end
+    
+    def add_callback(&callback)
+      raise "block is nil" unless callback
+      @callbacks.push(callback)
+    end
+
+
+    def deploy_worker
+      w = Worker.new(*@args, type: @options[:type], &@work_block)
+      w.add_callback do |arg|
+        @callback_queue.push([arg])
+        @ready_queue.push(w)
+      end
+      @set_blocks.each do |symbol, block|
+        w.set_block(symbol, &block)
+      end
+      w.run
+      push w
+      w
+    end
+
+    def set_block(symbol, &block)
+      @set_blocks.push([symbol, block])
+    end
+    
+    def req(*args, &work_block)
+      if self.size < @max_num && select{ |w| w.req_queue.size == 0 }.empty?
+        w =  deploy_worker
+        w.req_queue_max.times do
+          @ready_queue.push(w)
+        end
+      end
+      w = @ready_queue.pop
+      w.req(*args, &work_block)
+    end
+
+    def join
+      self.map(&:quit)
+      self.map(&:join)
+      @callback_queue.push([])
+      @callback_thread.join
+    end
+  end
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: concurrent_worker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mur
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: I will write later...
+email:
+- mur@mur.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- concurrent_worker.gemspec
+- lib/concurrent_worker.rb
+- lib/concurrent_worker/version.rb
+homepage: https://github.com/murjp/concurrent_worker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Concurrent worker in thread/process with preparation structure.
+test_files: []