batch_queue 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2b95fc0b74f01e311f6054edca52d5e914caeb0e
-  data.tar.gz: 4698c96901a2a66c2b8f7a61b960fc3b87097da5
+SHA256:
+  metadata.gz: 3b0f824265dd97a0c9992e49bb276d1131a79851ee6392c477941aa2c34261f4
+  data.tar.gz: 3f4067e301015ee56ba0263d8da5ef79b5b2a897bac6ffc863e14b31a5fdd4b9
 SHA512:
-  metadata.gz: def8c8a4612de2b9bc4d4e484a20ab0e500391b5c98a33056001710019c86cfe2c55159248b44873cccd8e370e762b21fc9796c75f3020d65e28e239d4a1ae0f
-  data.tar.gz: b00f65b31ef402135eb2f0630878e80cd66a1d2e4eab4cc5d36efbbee6e71d0d6aafe55402c7f49b1f8f6ab900283341bd7dad66adde2febc86ed556dacd98ca
+  metadata.gz: eab99b1882c61b1ae01d68ece1680e055f5818e979869c6bd9f38e505f388e1768350468c8ac344326c5d7baf96968bd61bd3f74abaad144f3563f8c449e515d
+  data.tar.gz: 5101491e33aca1f85e1d614ff6dabe3c825b68cc131164dbf4f4cc43074ee17aeb2868d26e62645aa6a617395e50a42d8834fe65d21274a690d0fab11bf7708f

data/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        # Could consider adding head, jruby-head, jruby in the future
+        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3', truffleruby, truffleruby-head]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake

data/.gitignore

@@ -7,4 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
-/batch_queue-0.1.0.gem
+/batch_queue-*.gem

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [1.1.0] - 2024-11-03
+### Added
+- Support for error handling
+- attr_readers for `max_batch_size` and `max_interval_seconds`
+- update to support more recent minitest
+
+## [1.0.0] - 2019-09-01
+### Added
+- Initial release of the gem.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    batch_queue (0.1.0)
+    batch_queue (1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,18 +14,19 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    rake (10.5.0)
+    rake (13.0.1)
     ruby-progressbar (1.10.0)
 
 PLATFORMS
   ruby
+  universal-darwin-24
 
 DEPENDENCIES
   batch_queue!
-  bundler (~> 1.16)
+  bundler (~> 2.2)
   minitest (~> 5.0)
   minitest-reporters (~> 1.4)
-  rake (~> 10.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
-   1.16.2
+   2.3.26

data/README.md

@@ -1,8 +1,25 @@
 # BatchQueue
 
-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/batch_queue`. To experiment with that code, run `bin/console` for an interactive prompt.
+BatchQueue is queue that takes jobs and runs them, in aggregate, via a callback on a background thread.  You can process a “batch” of N jobs at a time or after T seconds whichever comes sooner.
 
-TODO: Delete this and the text above, and describe your gem
+## Example
+You want to send metrics to Amazon’s AWS CloudWatch service every 60 seconds or when the batch size reaches 20, whichever comes first. You might write code like this:
+
+```
+# Create the AWS CloudWatch Client
+cw_client = Aws::CloudWatch::Client.new(...)
+
+# Set up the BatchQueue
+BatchQueue.new(max_batch_size: 20, max_interval_seconds: 60) do |batch_metric_data|
+    cw_client.put_metric_data(:metric_data => batch_metric_data)
+end
+
+# Add to the BatchQueue
+@bq << {
+    metric_name: 'Widgets',
+    value: 1
+}
+```
 
 ## Installation
 
@@ -22,7 +39,51 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### 1. Set up the BatchQueue
+Each BatchQueue gets its own background thread that executes jobs.
+```
+bq = BatchQueue.new(max_batch_size: 20, max_interval_seconds: 60) do |batch_metric_data|
+    # Put your code that you want to execute here.
+end
+```
+
+### 2. Add a job to the queue
+You can add any object to the queue.
+```
+bq << {
+    # your object here.
+}
+
+```
+or
+```
+bq << MyJob.new(...)
+
+```
+### 3. Error handling
+You have two options for handling errors in `BatchQueue`:
+
+* Rescue exceptions within the processing block:
+
+  ```
+  bq = BatchQueue.new(max_batch_size: 20, max_interval_seconds: 60) do |batch_metric_data|
+    begin
+        # Put your code that you want to execute here.
+    rescue => e
+        # Handle the exception here.
+    end
+  end
+
+  ```
+
+* Set a global error handler:
+
+  ```
+  bq.on_error = ->(e) { puts e.message }
+  ```
+
+If neither method is used, `BatchQueue` will catch the exception and print it to 
+the standard console output.
 
 ## Development
 
@@ -32,7 +93,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/batch_queue.
+Bug reports and pull requests are welcome on GitHub at https://github.com/flivni/batch_queue.
 
 ## License
 

data/batch_queue.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-reporters", '~> 1.4'
 end

data/lib/batch_queue/batch_queue.rb

@@ -1,4 +1,7 @@
 class BatchQueue
+  attr_reader :max_batch_size
+  attr_reader :max_interval_seconds
+
   # starts the queue
   # either max_batch_size or interval_milliseconds or both must be set
   def initialize(max_batch_size: nil, max_interval_seconds: nil, &block)
@@ -13,17 +16,13 @@ class BatchQueue
     @mutex = Mutex.new
     @cond_var = ConditionVariable.new
     @runner = Thread.new { run }
+    @on_error_callback = nil
 
     at_exit do
       stop
     end
   end
 
-  # a block taking taking an exception as a parameter
-  def on_error(&block)
-    @on_error = block
-  end
-
   def push(object)
     @mutex.synchronize do
       raise 'BatchQueue is stopped' unless @is_running
@@ -49,6 +48,10 @@ class BatchQueue
     @runner.join
   end
 
+  def on_error(&block)
+    @on_error_callback = block
+  end
+
   private
 
   def run
@@ -86,8 +89,12 @@ class BatchQueue
     @mutex.unlock
     begin
       @block.call(arr)
-    rescue StandardError => exc
-      @on_error.call(exc) if @on_error
+    rescue StandardError => e
+      if @on_error_callback
+        @on_error_callback.call(e)
+      else
+        puts "BatchQueue: Unhandled exception #{exc.inspect}"
+      end
     ensure
       @mutex.lock
     end

data/lib/batch_queue/version.rb

@@ -1,3 +1,3 @@
 class BatchQueue
-  VERSION = "0.1.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: batch_queue
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Felix Livni
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-16 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,15 +66,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-description: 
+description:
 email:
 - flivni@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -90,7 +92,7 @@ homepage: https://github.com/flivni/batch_queue
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,9 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: An in-memory queue that takes data and allows you to process it, in batches,
   on a background thread.