rasteira 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16b463d33f2b21c137a649b55da3bd8df4be259e
-  data.tar.gz: d9c353cbe174e9ede5a5c927f9671ddf0273c23e
+  metadata.gz: 860a472e8ee099a7fe0c47a89ca7a9efac747d55
+  data.tar.gz: 274abd1b5e39129a011df5b5821440880152e1e4
 SHA512:
-  metadata.gz: 0a47ffd160905a5da8df674662a1e4721edc6767218bd44b173f3a62e5fdb264b529311230b3929d7f67e606c11f2fadace4fe89e9f6a4bc507e9a33ef0a6f42
-  data.tar.gz: f5734c5c5841e68a3909979d5f8ac9332fca7f3e691df3570c935ff45e55a81c68111cf2c605d56ebf1e94553691f3a6ed0a8d39a1b785e0cbc605fd97fc073a
+  metadata.gz: 617692a78f56e64883653099f14ad4659a27ba99149f77b42c038bd7f8aa7fcbd09f8bddc488c2dfd395ec1d2f419278204311c692a0048cdd1c80b5e68dc189
+  data.tar.gz: 872e05a9264d6aab21f22572f809265032f7cfccf2e356a322a5fa82fb3794cfc52bde94f4e0588e01c8498a8fe4c4289482cc2cbcd2beea31bbb997fb67fd8c

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/serihiro/rasteira.svg?branch=master)](https://travis-ci.org/serihiro/rasteira)
+[![Gem Version](https://badge.fury.io/rb/rasteira.svg)](https://badge.fury.io/rb/rasteira)
 
 # Rasteira
 
@@ -41,7 +42,7 @@ And start Embed Worker Manager and enqueue a job.
 
 ```ruby
 manager = Rasteira::EmbedWorker::Manager.run
-manager.enqueue_job!('HelloWorker', 'example/hello_worker.rb', 'serihiro')
+manager.enqueue_job!('HelloWorker', worker_file_path: 'example/hello_worker.rb', args: ['serihiro', 'hogetarou'])
 ```
 
 ## Development

data/example/hello_worker.rb

@@ -1,10 +1,16 @@
 # To test with bin/console, execute like this:
 #
 # 2.4.0 :001 > m = Rasteira::EmbedWorker::Manager.run
-# 2.4.0 :002 > m.enqueue_job!('HelloWorker', 'example/hello_worker.rb', 'serihiro')
+# 2.4.0 :002 > m.enqueue_job!('HelloWorker', worker_file_path: 'example/hello_worker.rb', args: ['serihiro', 'hogetarou'])
+#
+# OR
+#
+# 2.4.0 :001 > m = Rasteira::EmbedWorker::Manager.run
+# 2.4.0 :002 > require './example/hello_worker.rb'
+# 2.4.0 :003 > m.enqueue_job!('HelloWorker', args: ['serihiro', 'hogetarou'])
 #
 class HelloWorker
-  def perform(name)
-    puts "Hello, #{name}"
+  def perform(name1, name2)
+    puts "Hello, #{name1}, #{name2}"
   end
 end

data/lib/rasteira/core/job.rb

@@ -2,23 +2,26 @@ module Rasteira
   module Core
     class Job
       attr_reader :worker_name, :worker_file_path, :args, :status
-      
+
       STATUSES = {
         ready: 0,
         in_process: 1,
         finished: 2,
         failed: 3
       }.freeze
-    
-      def initialize(worker_name, worker_file_path, *args)
-        @worker_file_path = File.expand_path(worker_file_path, Dir.pwd)
-        unless File.exists?(@worker_file_path)
-          raise ArgumentError.new("#{@worker_file_path} could not be found")
+
+      def initialize(worker_name, options = {})
+        if !options[:worker_file_path].nil?
+          @worker_file_path = File.expand_path(options[:worker_file_path], options[:current_directory] || Dir.pwd)
+          unless File.exists?(@worker_file_path)
+            raise ArgumentError.new("#{@worker_file_path} could not be found")
+          end
+
+          require(@worker_file_path)
         end
-      
-        require(@worker_file_path)
+
         @worker_name = worker_name
-        @args = args
+        @args = options[:args]
         @status = STATUSES[:ready]
       end
     

data/lib/rasteira/embed_worker/manager.rb

@@ -9,6 +9,8 @@ module Rasteira
         @mutex = Mutex.new
       end
       
+      # Create manager instance and run
+      # @return [Rasteira::EmbedWorker::Manager] an instance of a running manager
       def self.run
         this = new
         this.run
@@ -18,6 +20,8 @@ module Rasteira
       # TODO to be specifiable
       MIN_THREAD_SIZE = 5
 
+      # Create thread pool and start all threads
+      # @return [nil]
       def run
         @thread_pool = MIN_THREAD_SIZE.times.map do
           Thread.start { worker_thread_process }
@@ -38,17 +42,28 @@ module Rasteira
         end
       end
 
-      def enqueue_job!(worker_name, worker_file_path, *args)
+      # Enqueue new job
+      # @param [String] worker_name the name of worker class
+      # @param [Hash] options
+      # @option options [String] :worker_file_path the file path of worker script
+      # @option options [String] :current_directory the directory where you want to handle as a current directory
+      # @option options [Object] :args the arguments for the perform method in the worker class
+      # @return [Rasteira::Core::Job] job created job
+      def enqueue_job!(worker_name, options = {})
         @mutex.synchronize do
-          @job_pool << ::Rasteira::Core::Job.new(worker_name, worker_file_path, *args)
+          @job_pool << ::Rasteira::Core::Job.new(worker_name, options)
         end
       end
       
+      # Kill all worker threads
+      # @return nil
       def shutdown_workers!
         @thread_pool.each(&:kill)
         @thread_manager.kill
       end
       
+      # Return current worker threads id and status hashes
+      # @return [Array<Hash>]
       def worker_statuses
         @thread_pool.map do |thread|
           { id: thread.object_id, status: thread.status }

data/lib/rasteira/version.rb

@@ -1,3 +1,3 @@
 module Rasteira
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/rasteira.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rasteira
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kazuhiro Serizawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2017-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: simple, on memory, and thread base job queue worker
 email:
 - nserihiro@gmail.com