request_queue 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a10f3af02e29a0ec1827add198e48d432d07995
-  data.tar.gz: 871a34a4e00c631f4c7531cf4ae8371f8b0d5682
+  metadata.gz: 4b645c28623badcb0436259ca4400b1dad1c85d7
+  data.tar.gz: 318d9ec8bc059e9e3e08fedf761f58305622ebf5
 SHA512:
-  metadata.gz: fd7018e8f2bda2e985ba37639e8f6a4f114a5b78c10420902e372a22e8b083e572618a19554f9be26a49d0b4217898438b64e93972ff6c2f245e3a09a2c339b1
-  data.tar.gz: 98b22b6934c4a3a1e0847588fba47eef13596794a841ebc7bfb067b72a87428433e0ba33bf3b412eebf016d8ee15a16af32c1b47d0865f10d6f801b6873f76b8
+  metadata.gz: 0e3947b656877a088d25302444999e97562f47410b36a051452f1a9fa33a77a50d2cb7def7092ea6381c4dda6656376bab0ab8901b8785d9a3444da56847cafd
+  data.tar.gz: 946b80b4979423cae20fb8bf0b848511d7e6faea2e7b1320117b463ecc077d525937c8d389ef871aa9b3785e15d8178ea889b3342e81f6c6f249a4b8adae6ea4

data/README.md

@@ -1,8 +1,10 @@
 # RequestQueue
 
-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/request_queue`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a utility for deduping work on a per-request basis. It works like this:
 
-TODO: Delete this and the text above, and describe your gem
+1. When the request starts, create a queue.
+2. Add some work to the queue by calling `RequestQueue.enqueue(some_job)`.
+3. Before the request ends, you'll have opportunity to dedupe the work.
 
 ## Installation
 
@@ -22,7 +24,79 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+A a job can be any callable, so for example:
+
+```
+job = proc { puts 'Hello' }
+
+RequestQueue.enqueue(job)
+RequestQueue.enqueue(job)
+```
+
+This would output 'Hello' once at the end of the request.
+
+#### Using objects
+
+Because `RequestQueue` accepts any callable, you can also use an object.
+
+```ruby
+class Job
+  def initialize(message)
+    @message = message
+  end
+
+  def call
+    puts @message
+  end
+end
+
+job = Job.new('Hello')
+RequestQueue.enqueue(job)
+RequestQueue.enqueue(job)
+```
+
+#### Advanced Deduping
+
+Sometimes, you need a little more control over the deduping.
+
+```ruby
+class Job
+  def self.filter(jobs)
+    jobs.uniq_by(&:message)
+  end
+
+  attr_reader :message
+
+  def initialize(message)
+    @message = message
+  end
+
+  def call
+    puts message
+  end
+end
+
+RequestQueue.enqueue Job.new('Hello')
+RequestQueue.enqueue Job.new('Hello')
+```
+
+In this example, the job instances are unique, so they wouldn't be automatically deduped. But, when the class of a message responds to `filter`, it will be called and give you the opportunity to provide custom dedupe logic.
+
+## Testing
+
+When testing, sometimes you want a little more control. As such, `RequestQueue` offers multiple queue backends:
+
+* `:default` - Runs jobs at the end of the request.
+* `:fake` - Never runs jobs, and allows you to inspect the queue with `RequestQueue.queue.queue`.
+* `:inline` - Runs jobs immediately and never adds them to the queue.
+
+To change the queueing backend, you can just say `RequestQueue.use`:
+
+```ruby
+RequestQueue.use :inline
+```
+
+**NOTE:** Only use the `use` method in the testing environment. It is not thread-safe.
 
 ## Development
 
@@ -38,4 +112,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Ray Za
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/request_queue/queue.rb

@@ -11,7 +11,7 @@ module RequestQueue
     end
 
     def process!
-      filter.each(&:process)
+      filter.each(&:call)
     end
     alias process process!
 

data/lib/request_queue/version.rb

@@ -1,3 +1,3 @@
 module RequestQueue
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_queue
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ray Zane