orbitalqueue 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1209a43eaeb6c2de53893b2c58ee64c42f7a14b8339f750443124d0a0c26fa08
-  data.tar.gz: 9cd589726e3198cb7ab20676b7c1151eea9331106653a5ffa250c40a2adae83e
+  metadata.gz: d331ea29dd6bc80aa3c1127749f782845d1f23c2a9729f987af9128f1922bf21
+  data.tar.gz: 5f7c04a0cef45399d4726900330ac96b1714e3275545a2d1e4e209fe61aec6c9
 SHA512:
-  metadata.gz: 9fcb2e82342484b0334fc4e95469e017ba633211547e93c4f171fbe6861d0403b22c7a07f66f14a30c3e756f455c65737671f91e6090822f51e1b91d6b38992e
-  data.tar.gz: 9235c90069bdabbbd359499914a92599ce3782329369980e9ade49b630619f4f04abd6ebf32e19baece2c4a9b28b124f33e5c00320455361e070671f13bb6753
+  metadata.gz: a7d5ead3e5494a3f38808e9b363b1ceb624168e294ee6a7165630092ec3ff3a58448234f434411f865539e89d8aa5f1cdf3100adde94ca6cc26066ec5c1d0795
+  data.tar.gz: 7aab8b14af6f147b0b7276e37baee3db4324ca4052445c1fefcdd094f47e64e770f0a3357eec8a69d35ebbedd2263b7b3b5d208e457c73b5f6b3f34a5560ba39

data/README.md

@@ -1,4 +1,4 @@
-# orbital-queue
+# Orbital Queue
 
 [![CI](https://github.com/reasonset/orbital-queue/actions/workflows/ci.yml/badge.svg)](https://github.com/reasonset/orbital-queue/actions/workflows/ci.yml)
 
@@ -39,11 +39,12 @@ Since enqueued objects are serialized using `Marshal` and persisted as files, ca
 require 'orbitalqueue'
 
 queue = OrbitalQueue.new("/path/to/queue")
-data = queue.pop
+item = queue.pop
+data = item.data
 
 # Something, something...
 
-queue.complete data[:queue_id]
+item.complete
 ```
 
 Calling `#pop` retrieves a single item from the queue in no particular order.
@@ -54,3 +55,9 @@ If guaranteed completion is not required and the item should be removed immediat
 
 Both `#pop` and `#pop!` return a queue item as a `Hash`. If the original object was not a `Hash`, it will be stored under the `:data` key. Regardless of the original type, the queue ID is always stored under the `:queue_id` key.
 
+# About Orbital Design
+
+## Description
+
+## Design pattern rules
+

data/lib/orbitalqueue.rb

@@ -45,6 +45,8 @@ class OrbitalQueue
   
   # Pop data from queue.
   # Popped queue items are placed in the checkout directory. After processing is complete, +#complete+ must be called to remove the item from the queue.
+  #
+  # If block is given, complete automatically after yield.
   def pop
     queue_data = nil
     queue_id = nil
@@ -57,28 +59,29 @@ class OrbitalQueue
         next
       end
 
-      queue_data = Marshal.load(File.read File.join(@queue_dir, ".checkout", File.basename(qf)))
+      data = Marshal.load(File.read File.join(@queue_dir, ".checkout", File.basename(qf)))
       queue_id = File.basename qf, ".marshal"
 
-      if Hash === queue_data
-        queue_data[:queue_id] = queue_id
-      else
-        queue_data = {queue_id: queue_id, data: queue_data}
-      end
+      queue_data = OrbitalQueue::QueueObject.new(self, data, queue_id)
       break
     end
 
-    queue_data
+    if block_given?
+      yield queue_data.data
+      complete queue_id
+    else
+      queue_data
+    end
   end
 
   # Pop data from queue and remove it from queue.
   def pop!
-    queue_data = pop
-    if queue_data
-      complete queue_data[:queue_id]
+    queue_item = pop
+    if queue_item
+      queue_item.complete
     end
 
-    queue_data
+    queue_item
   end
 
   # Remove checked out queue item.
@@ -92,3 +95,31 @@ class OrbitalQueue
     queue_id
   end
 end
+
+# Queue item capsule.
+class OrbitalQueue::QueueObject
+  def initialize(queue, data, queue_id)
+    @queue = queue
+    @data = data
+    @queue_id = queue_id
+    @completed = false
+  end
+
+  attr_reader :data
+
+  # Another complete interface.
+  def complete
+    if @completed
+      nil
+    else
+      @queue.complete(@queue_id)
+      @completed = true
+      @queue_id
+    end
+  end
+
+  # Terrible redundunt method.
+  def complete?
+    @completed
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orbitalqueue
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Masaki Haruka