threasy 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1bc950437e631aa8c150efa45db53103b63c72a
-  data.tar.gz: 3b9635b78869d69cb260f77cf63242055b3effab
+  metadata.gz: 11e5f8c6348eca49829c58687a62ce48a414b97c
+  data.tar.gz: 94b1c10c04d5a9ec92e66d592c8ab694d4ddc625
 SHA512:
-  metadata.gz: 45c57665f96db2520e878aa5e43145ee16f0f6165109c2e8ffcc5a181e82bf7cdda02aae55c24fd47ad15c19698f944a51fd10f1caa8069b47e0d03af860b60b
-  data.tar.gz: 09223ebffbaccd54f059ab5dce971fd96c03fecf9f31d5cdf67890aa720f5e12524e16d8fb819a202d545b74822cdb07407fb4b9134e149b406a43f6a148ed52
+  metadata.gz: 1523591989b79b83ea7e94eeb158d365b80ffb6fbb32d2ac4ee5109414b9124fa49862f1d9b0b860c63d704b277f31432f37327b4957ae14a71b9404f0ce2b8e
+  data.tar.gz: 36e4ff11898c517f8f5196d011dc1538bd8d405933446d955d36a67a31034d9bdc968ff7ae64b939324dd4005545db7bbc65b96d8099f1274813b920de70e589

data/README.md

@@ -3,15 +3,15 @@
 [travis-image]: https://secure.travis-ci.org/carlzulauf/threasy.png?branch=master
 [travis-link]: http://travis-ci.org/carlzulauf/threasy
 
-Dead simple in-process threaded background job solution.
+**Thr**eaded, **easy** to use scheduling and background job solution.
 
-Includes scheduling for jobs in the future and/or recurring jobs.
+Schedules are managed by a watcher thread and enqueued as background jobs when they are due.
 
-Work waiting to be processed is stored in a thread-safe `Queue` and worked on by a small pool of worker threads.
+Background work is stored in a thread-safe `Queue` and worked on by a pool of worker threads.
 
 ### What to expect
 
-* Dead simple-ness
+* Simple API
 * Ability to queue or schedule ruby blocks for asynchronus execution
 * Extremely light-weight
 * No dependencies (outside ruby stdlib)
@@ -45,7 +45,7 @@ Or install it yourself as:
 
 ## Usage
 
-### `enqueue`
+### `Threasy.enqueue`
 
 ```ruby
 # Use a block
@@ -57,7 +57,7 @@ Threasy.enqueue MyJob.new(1,2,3)
 
 Jobs are placed in a work queue. Worker threads are spun up to process jobs as the queue grows.
 
-### `schedule`
+### `Threasy.schedule`
 
 Puts a job onto the schedule. Once the scheduler sees a job is due for processessing, it is enqueued into the work queue to be processed like any other job.
 
@@ -66,6 +66,7 @@ Available options:
 * `:every`: number of seconds between repetition. Can be combined with `:at` or `:in`.
 * `:in`: number of seconds until job is (next) triggered.
 * `:at`: `Time` job is (next) triggered.
+* `:times`: number of times to trigger job before removing it from the schedule.
 
 Example:
 
@@ -77,15 +78,15 @@ Threasy.schedule(:in => 5.minutes) { puts "In the background, 5 minutes from now
 Threasy.schedule(MyJob.new(1,2,3), every: 5.minutes)
 ```
 
-### `schedules`
+### `Threasy.schedules`
 
 Returns the default instance of [`Threasy::Schedule`][schedule], which manages scheduled jobs.
 
-### `work`
+### `Threasy.work`
 
 Returns the default instance of [`Threasy::Work`][work], which manages the work queue and worker threads.
 
-### `config`
+### `Threasy.config`
 
 Returns the default instance of [`Threasy::Config`][config], which manages runtime configuration options.
 

data/lib/threasy/config.rb

@@ -1,9 +1,11 @@
 module Threasy
   class Config
-    attr_accessor :work, :schedule, :max_workers, :max_sleep, :max_overdue
+    attr_accessor :work, :schedule
+    attr_accessor :min_workers, :max_workers, :max_sleep, :max_overdue
     attr_writer :logger
 
     def initialize
+      self.min_workers  = 1
       self.max_workers  = 4
       self.max_sleep    = 60.0
       self.max_overdue  = 300.0

data/lib/threasy/schedule/entry.rb

@@ -11,7 +11,7 @@ module Threasy
     # and should not be created by hand.
     #
     # See `Threasy::Schedule#add`
-    attr_accessor :schedule, :work, :job, :at, :repeat, :times
+    attr_accessor :schedule, :work, :job, :args, :at, :repeat, :times
 
     def initialize(job, options = {})
       self.schedule = options.fetch(:schedule) { Threasy.schedules }
@@ -21,6 +21,7 @@ module Threasy
       seconds       = options.fetch(:in) { repeat || 60 }
       self.at       = options.fetch(:at) { Time.now + seconds }
       self.times    = options[:times]
+      self.args     = options.fetch(:args) { [] }
     end
 
     def repeat?
@@ -49,7 +50,7 @@ module Threasy
 
     def work!
       if once? || overdue < max_overdue
-        work.enqueue(job) if times_remaining?
+        work.enqueue(job, *args) if times_remaining?
         self.times -= 1 unless times.nil?
       end
 

data/lib/threasy/version.rb

@@ -1,3 +1,3 @@
 module Threasy
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/lib/threasy/work.rb

@@ -19,6 +19,7 @@ module Threasy
       @queue = TimeoutQueue.new
       @pool = Set.new
       @semaphore = Mutex.new
+      min_workers.times { add_worker }
     end
 
     # Enqueue a job into the work queue
@@ -36,8 +37,9 @@ module Threasy
     #     # Enqueue string that evals to a job object
     #     Threasy.enqueue("BackgroundJob.new")
     #
-    def enqueue(job = nil, &block)
-      queue.push(block_given? ? block : job).tap { check_workers }
+    def enqueue(*args, &block)
+      args.unshift(block) if block_given?
+      queue.push(args).tap { check_workers }
     end
 
     alias_method :enqueue_block, :enqueue
@@ -50,6 +52,10 @@ module Threasy
       queue.pop
     end
 
+    def min_workers
+      Threasy.config.min_workers
+    end
+
     def max_workers
       Threasy.config.max_workers
     end
@@ -57,17 +63,16 @@ module Threasy
     def check_workers
       sync do
         pool_size = pool.size
-        queue_size = queue.size
-        log "Checking workers. Pool: #{pool_size}, Max: #{max_workers}, Queue: #{queue_size}"
+        log "Checking workers. Pool: #{pool_size} (min: #{min_workers}, max: #{max_workers})"
         if pool_size < max_workers
-          add_worker(pool_size) if pool_size == 0 || queue_size > max_workers
+          add_worker if pool_size == 0 || queue.size > max_workers
         end
       end
     end
 
-    def add_worker(size)
+    def add_worker
       log "Adding new worker to pool"
-      worker = Worker.new(self, size)
+      worker = Worker.new(self, pool.size)
       pool.add worker
       worker.work
     end
@@ -87,18 +92,22 @@ module Threasy
       end
 
       def work
-        Thread.start do
-          while job = @work.grab
-            log.debug "Worker ##{@id} has grabbed a job"
-            begin
-              job = eval(job) if job.kind_of?(String)
-              job.respond_to?(:perform) ? job.perform : job.call
-            rescue Exception => e
-              log.error %|Worker ##{@id} error: #{e.message}\n#{e.backtrace.join("\n")}|
+        @thread = Thread.start do
+          loop do
+            if args = @work.grab
+              job = args.shift
+              log.debug "Worker ##{@id} has grabbed a job"
+              begin
+                job = eval(job) if job.kind_of?(String)
+                job.respond_to?(:perform) ? job.perform(*args) : job.call(*args)
+              rescue Exception => e
+                log.error %|Worker ##{@id} error: #{e.message}\n#{e.backtrace.join("\n")}|
+              end
+            elsif @work.pool.size > @work.min_workers
+              @work.sync { @work.pool.delete self }
+              break
             end
           end
-          log.debug "Worker ##{@id} removing self from pool"
-          @work.sync{ @work.pool.delete self }
         end
       end
 

data/spec/threasy/schedule_spec.rb

@@ -36,6 +36,16 @@ describe "Threasy::Schedule" do
       expect(subject).not_to receive(:add_entry)
       subject.add(job, at: Time.now - 100)
     end
+
+    it "should pass optional arguments onto job when its worked" do
+      async do |done|
+        args = [:foo, :bar]
+        subject.add(in: 0.01, args: args) do |*a|
+          expect(a).to eq(args)
+          done.()
+        end
+      end
+    end
   end
 
   describe "#remove" do

data/spec/threasy/work_spec.rb

@@ -3,7 +3,7 @@ class TestJob
     @resolver = resolver
   end
 
-  def perform
+  def perform(*args)
     @resolver.()
   end
 end
@@ -36,5 +36,16 @@ describe "Threasy::Work" do
         subject.enqueue { done.() }
       end
     end
+
+    it "should pass optional arguments onto job" do
+      async do |done|
+        args = [:foo, :bar]
+        job = proc do |*a|
+          expect(a).to eq(args)
+          done.()
+        end
+        subject.enqueue job, *args
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: threasy
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Carl Zulauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-29 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler