orbitalqueue 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1209a43eaeb6c2de53893b2c58ee64c42f7a14b8339f750443124d0a0c26fa08
+  data.tar.gz: 9cd589726e3198cb7ab20676b7c1151eea9331106653a5ffa250c40a2adae83e
+SHA512:
+  metadata.gz: 9fcb2e82342484b0334fc4e95469e017ba633211547e93c4f171fbe6861d0403b22c7a07f66f14a30c3e756f455c65737671f91e6090822f51e1b91d6b38992e
+  data.tar.gz: 9235c90069bdabbbd359499914a92599ce3782329369980e9ade49b630619f4f04abd6ebf32e19baece2c4a9b28b124f33e5c00320455361e070671f13bb6753

data/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Masaki Haruka
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,56 @@
+# 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)
+
+## Synopsis
+
+File-based queue library for orbital design pattern.
+
+## Usage
+
+### Initialize queue
+
+```ruby
+require 'orbitalqueue'
+
+queue = OrbitalQueue.new("/path/to/queue")
+```
+
+`.new` raises an `OrbitalQueue::QueueUnexisting` exception if the specified directory does not exist. If `true` is passed as the second argument, the directory is created recursively when missing.
+
+### Enqueue
+
+```ruby
+require 'orbitalqueue'
+
+queue = OrbitalQueue.new("/path/to/queue")
+data = {foo: 123}
+
+queue.push(data)
+```
+
+Calling `#push` enqueues the given object into the queue. The object's class can be arbitrary.
+
+Since enqueued objects are serialized using `Marshal` and persisted as files, caution is required when using custom classes.
+
+### Dequeue
+
+```ruby
+require 'orbitalqueue'
+
+queue = OrbitalQueue.new("/path/to/queue")
+data = queue.pop
+
+# Something, something...
+
+queue.complete data[:queue_id]
+```
+
+Calling `#pop` retrieves a single item from the queue in no particular order.
+
+The retrieved item enters a checkout state, and must be finalized by calling `#complete` once processing is finished.
+
+If guaranteed completion is not required and the item should be removed immediately upon retrieval, use `#pop!` instead.
+
+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.
+

data/lib/orbitalqueue.rb

@@ -0,0 +1,94 @@
+#!/bin/env ruby
+require 'securerandom'
+
+class OrbitalQueue
+  ##
+  # File-based queue for Orbital design pattern.
+
+  class QueueError < StandardError
+  end
+
+  class QueueRemoveError < QueueError
+  end
+
+  class QueueUnexisting < QueueError
+  end
+
+  # Create queue master in presented dir.
+  #
+  # dir: Queue directory
+  # create: If true is given, creates the queue directory when it is missing
+  def initialize dir, create=false
+    @queue_dir = dir
+
+    unless File.exist?(File.join(dir, ".checkout"))
+      if create
+        require 'fileutils'
+        FileUtils.mkdir_p(File.join(dir, ".checkout"))
+      else
+        raise QueueUnexisting.new("Queue directory #{dir} does not exist.")
+      end
+    end
+  end
+
+  # Push data to queue.
+  def push data
+    queue_id = sprintf("%d-%d-%s", Time.now.to_i ,$$ , SecureRandom.hex(3))
+    queue_filepath = File.join(@queue_dir, (queue_id + ".marshal"))
+
+    File.open(queue_filepath, "w") do |f|
+      Marshal.dump data, f
+    end
+
+    queue_id
+  end
+  
+  # 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.
+  def pop
+    queue_data = nil
+    queue_id = nil
+    queue_files = Dir.children(@queue_dir)
+    queue_files.each do |qf|
+      next if qf[0] == "."
+      begin
+        File.rename(File.join(@queue_dir, qf), File.join(@queue_dir, ".checkout", qf))
+      rescue Errno::ENOENT
+        next
+      end
+
+      queue_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
+      break
+    end
+
+    queue_data
+  end
+
+  # Pop data from queue and remove it from queue.
+  def pop!
+    queue_data = pop
+    if queue_data
+      complete queue_data[:queue_id]
+    end
+
+    queue_data
+  end
+
+  # Remove checked out queue item.
+  def complete queue_id
+    begin
+      File.delete(File.join(@queue_dir, ".checkout", (queue_id + ".marshal")))
+    rescue SystemCallError => e
+      raise QueueRemoveError, "Failed to complete queue #{queue_id}: #{e.class}"
+    end
+
+    queue_id
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: orbitalqueue
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Masaki Haruka
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: OrbitalQueue is a lightweight Ruby library that implements the Orbital
+  Design Pattern via a file-based queuing mechanism. Ideal for modular systems requiring
+  isolated message handling.
+email:
+- yek@reasonset.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/orbitalqueue.rb
+homepage: https://github.com/reasonset/orbital-queue
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/reasonset/orbital-queue
+  homepage_uri: https://github.com/reasonset/orbital-queue
+  bug_tracker_uri: https://github.com/reasonset/orbital-queue/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: File-based queue system for Orbital Design Pattern
+test_files: []