threasy 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24769445131b62b227817a4cd7eacf4682e3855e
-  data.tar.gz: f5d317aee9b0de3f7b4989526b8716738f9f45fb
+  metadata.gz: ec726270eb6e569d255112041fd86e32edba66a7
+  data.tar.gz: fc7b534b55f290a4f74de5559488a2496b0a19d6
 SHA512:
-  metadata.gz: a2b47d68b23493aa3a66e6ef6a5369c06d5301a07cb952a9a1b77f322991176f7d4052ec9dd97f533be0fb31391460fce429d6cdda3abf95be8e7b84db728c6e
-  data.tar.gz: db3c0cebce5e18bc13854112782d91c273c34f3a14c0e6b1a9a2c94360f6b0d6ecd4e5e2173bf8fa30ca8bc2e514a3292ce6fbfcfd0d80b2700d6f12d4440cc9
+  metadata.gz: 37aea98e1bf6102d0bd31a9c9e312ce5c8df512c18cbf66abcdb755af3997b0aa61cdf014ed91768ab8c063ad0801345eb0ed463dbfbe20b9e87480718aa56f7
+  data.tar.gz: e2be7cc6c78f8e06d81ecc6ed18426fdbfaf63eaf59ccc2192e856252f3f6f5b798b029e25f8203277e4a9b08667c99dbfe2c5d7ebd37c159e274d83eb739dac

data/README.md

@@ -49,12 +49,14 @@ Or install it yourself as:
 
 ```ruby
 # Use a block
-Threasy.enqueue{ puts "This will happen in the background" }
+Threasy.enqueue { puts "This will happen in the background" }
 
-# Use an object that responds to #perform or #call
+# Use an object that responds to `perform` or `call`
 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`
 
 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.
@@ -75,9 +77,35 @@ Threasy.schedule(:in => 5.minutes) { puts "In the background, 5 minutes from now
 Threasy.schedule(MyJob.new(1,2,3), every: 5.minutes)
 ```
 
+### `schedules`
+
+Returns the default instance of [`Threasy::Schedule`][schedule], which manages scheduled jobs.
+
+### `work`
+
+Returns the default instance of [`Threasy::Work`][work], which manages the work queue and worker threads.
+
+### `config`
+
+Returns the default instance of [`Threasy::Config`][config], which manages runtime configuration options.
+
+`Threasy.config` can also accept a block and will yield the [`Threasy::Config`][config] instance.
+
+```ruby
+Threasy.config do |c|
+  c.max_sleep   = 5.minutes
+  c.max_overdue = 1.hour
+  c.max_workers = 8
+end
+```
+
+[schedule]: lib/threasy/schedule.rb
+[work]:     lib/threasy/work.rb
+[config]:   lib/threasy/config.rb
+
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/threasy/fork )
+1. Fork it ( http://github.com/carlzulauf/threasy/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

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
+    attr_accessor :schedule, :work, :job, :at, :repeat, :times
 
     def initialize(job, options = {})
       self.schedule = options.fetch(:schedule) { Threasy.schedules }
@@ -20,6 +20,7 @@ module Threasy
       self.repeat   = options[:every]
       seconds       = options.fetch(:in) { repeat || 60 }
       self.at       = options.fetch(:at) { Time.now + seconds }
+      self.times    = options[:times]
     end
 
     def repeat?
@@ -47,12 +48,20 @@ module Threasy
     end
 
     def work!
+      return unless times_remaining?
+
       if once? || overdue < max_overdue
         work.enqueue job
+        self.times -= 1 if times
       end
+
       self.at = at + repeat if repeat?
     end
 
+    def times_remaining?
+      times.nil? || times > 0
+    end
+
     def remove
       schedule.remove_entry self
     end

data/lib/threasy/version.rb

@@ -1,3 +1,3 @@
 module Threasy
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/spec/threasy/schedule/entry_spec.rb

@@ -17,6 +17,12 @@ describe Threasy::Schedule::Entry do
       entry = subject.new(job, work: work, in: hour/2, every: hour)
       Timecop.travel(Time.now + hour) { entry.work! }
     end
+
+    it "should not execute a job after the max specified times" do
+      entry = subject.new(job, work: work, times: 2)
+      expect(work).to receive(:enqueue).with(job).twice
+      3.times { entry.work! }
+    end
   end
 
   describe "#at" do

metadata

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