batch_queue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b95fc0b74f01e311f6054edca52d5e914caeb0e
+  data.tar.gz: 4698c96901a2a66c2b8f7a61b960fc3b87097da5
+SHA512:
+  metadata.gz: def8c8a4612de2b9bc4d4e484a20ab0e500391b5c98a33056001710019c86cfe2c55159248b44873cccd8e370e762b21fc9796c75f3020d65e28e239d4a1ae0f
+  data.tar.gz: b00f65b31ef402135eb2f0630878e80cd66a1d2e4eab4cc5d36efbbee6e71d0d6aafe55402c7f49b1f8f6ab900283341bd7dad66adde2febc86ed556dacd98ca

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/.idea
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/batch_queue-0.1.0.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.10
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in batch_queue.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    batch_queue (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    minitest (5.12.0)
+    minitest-reporters (1.4.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (10.5.0)
+    ruby-progressbar (1.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  batch_queue!
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.4)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Felix Livni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'batch_queue'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install batch_queue
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/batch_queue.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/batch_queue.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "batch_queue/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "batch_queue"
+  spec.version       = BatchQueue::VERSION
+  spec.authors       = ["Felix Livni"]
+  spec.email         = ["flivni@gmail.com"]
+
+  spec.summary       = 'An in-memory queue that takes data and allows you to process it, in batches, on a background thread.'
+  # spec.description   = ''
+  spec.homepage      = 'https://github.com/flivni/batch_queue'
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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 "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", '~> 1.4'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "batch_queue"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/batch_queue.rb

@@ -0,0 +1,3 @@
+require "batch_queue/version"
+require "batch_queue/batch_queue"
+

data/lib/batch_queue/batch_queue.rb

@@ -0,0 +1,95 @@
+class BatchQueue
+  # 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)
+    if max_batch_size.nil? && max_interval_seconds.nil?
+      raise 'either max_batch_size or max_interval_seconds or both must be set'
+    end
+    @is_running = true
+    @queue = Queue.new
+    @block = block
+    @max_batch_size = max_batch_size
+    @max_interval_seconds = max_interval_seconds
+    @mutex = Mutex.new
+    @cond_var = ConditionVariable.new
+    @runner = Thread.new { run }
+
+    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
+      @queue.push(object)
+      @cond_var.signal
+    end
+    object
+  end
+  alias << push
+
+  def size
+    @mutex.synchronize do
+      @queue.size
+    end
+  end
+
+  # stops the queue and signals to flush remaining queue, blocking until done.
+  def stop
+    @mutex.synchronize do
+      @is_running = false
+      @cond_var.signal
+    end
+    @runner.join
+  end
+
+  private
+
+  def run
+    @mutex.synchronize do
+      t0 = Time.now
+      while @is_running do
+        while (@queue.size >= @max_batch_size) ||
+            (!@max_interval_seconds.nil? && @queue.size > 0 && Time.now >= t0 + @max_interval_seconds) do
+          arr = take_batch
+          process_batch(arr)
+        end
+        t0 = Time.now
+        @cond_var.wait(@mutex, @max_interval_seconds)
+      end
+
+      # exiting
+      while @queue.size > 0
+        arr = take_batch
+        process_batch(arr)
+      end
+    end
+  end
+
+
+  def take_batch
+    arr = []
+    [@queue.size, @max_batch_size].min.times do
+      arr << @queue.pop
+    end
+    arr
+  end
+
+  # we assume that we have the mutex lock before calling
+  def process_batch(arr)
+    @mutex.unlock
+    begin
+      @block.call(arr)
+    rescue StandardError => exc
+      @on_error.call(exc) if @on_error
+    ensure
+      @mutex.lock
+    end
+  end
+end

data/lib/batch_queue/version.rb

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: batch_queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felix Livni
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: 
+email:
+- flivni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- batch_queue.gemspec
+- bin/console
+- bin/setup
+- lib/batch_queue.rb
+- lib/batch_queue/batch_queue.rb
+- lib/batch_queue/version.rb
+homepage: https://github.com/flivni/batch_queue
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+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.
+test_files: []