stubborn_queue 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd521876afe1fe93b9c321a2e327d6febafbffca
+  data.tar.gz: 4ec69ba695ae13d3ae15ab0be2f97a20c46f1b3f
+SHA512:
+  metadata.gz: 9711271fa224a1a5790fc96d902da9909585ec4a0feeaa46984582e43df7067dd88ebcd912cfd42160df91ae6522017b1795ed1f824699e6e05c8efad3a97e50
+  data.tar.gz: ef3826b2a010680d2b0bcf4b9a164b8ef4d5f6e15505b0d585d0e426561316ea48ca64ebfddcf473cdbd3a60c1553902ec470c464f0bdcbb71661f6cbd226b13

data/.gitignore

@@ -0,0 +1,39 @@
+.*.db
+
+# ---
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    stubborn_queue (0.1.0)
+      bundler
+      daybreak
+      moneta
+      redislike
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    daybreak (0.3.0)
+    docile (1.1.5)
+    json (1.8.2)
+    kintama (0.1.13)
+    moneta (0.8.0)
+    rake (10.4.2)
+    redislike (0.2.5)
+      moneta (~> 0.8)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  kintama
+  rake
+  simplecov
+  stubborn_queue!

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Justin Scott
+
+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,3 @@
+This is in no way inherently thread- or process-safe. It's built for one process owning one queue file and not interacting with it asynchronously.
+
+Huge props to [Chris Olstrom](https://github.com/colstrom) who helped me understand the idea and was a good sport when I implemented my own version instead of waiting for him to finish his.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'simplecov'
+
+task :test do
+  SimpleCov.command_name 'Kintama Tests'
+  SimpleCov.start do
+    add_filter "/vendor/"
+    add_filter "/test/"
+  end
+  require_relative 'test/queueing_spec'
+end

data/lib/stubborn_queue.rb

@@ -0,0 +1,87 @@
+require 'moneta'
+require 'daybreak'
+require 'redislike'
+
+class StubbornQueue
+  attr_reader :db
+  def initialize(options = {})
+    @name = options.fetch :name, 'default'
+    @timeout = options.fetch :timeout, 60
+    @db = Moneta.new :Daybreak, expires: true, file: ".#{@name}.db"
+  end
+
+  def key_for(type, with_id: 0)
+    key = case type
+    when :pending_list
+      "#{@name}:pending"
+    when :claimed_list
+      "#{@name}:claimed"
+    when :claimed_flag
+      "#{@name}:task:#{with_id}:claimed"
+    when :finished_flag
+      "#{@name}:task:#{with_id}:finished"
+    when :item_store
+      "#{@name}:@{id}"
+    when :id_count
+      "#{@name}:id_count"
+    else
+      raise "Key for '#{type}' is unrecognized."
+    end
+    "#{@name}:#{key}"
+  end
+
+  def create_id
+    @db.increment key_for(:id_count)
+  end
+
+  def lookup(id)
+    @db.fetch key_for(:item_store, with_id: id), nil
+  end
+
+  def claims
+    @db.fetch key_for(:claimed_list), []
+  end
+
+  def recent_claim?(id)
+    @db.fetch key_for(:claimed_flag, with_id: id), false
+  end
+
+  def finished?(id)
+    @db.fetch key_for(:finished_flag, with_id: id), false
+  end
+
+  def remove_claim_on(id)
+    @db.lrem key_for(:claimed_list), 0, id
+    @db.delete key_for(:claimed_flag, with_id: id)
+  end
+
+  def enqueue(item)
+    process_expired_claims
+    id = create_id
+    @db.store key_for(:item_store, with_id: id), item
+    @db.lpush key_for(:pending_list), id
+  end
+
+  def dequeue
+    process_expired_claims
+    id = @db.rpoplpush key_for(:pending_list), key_for(:claimed_list)
+    @db.store key_for(:claimed_flag, with_id: id), true, expires: @timeout
+    id
+  end
+
+  def requeue(id)
+    @db.lpush key_for(:pending_list), id
+  end
+
+  def finish(id)
+    @db.store key_for(:finished_flag, with_id: id), true
+  end
+
+  def process_expired_claims
+    claims.each do |id|
+      next if recent_claim? id
+      remove_claim_on id
+      requeue id unless finished? id
+    end
+  end
+end

data/stubborn_queue.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |gem|
+  gem.name        = 'stubborn_queue'
+  gem.version     = '1.0.0'
+  gem.licenses    = 'MIT'
+  gem.authors     = ['Justin Scott']
+  gem.email       = 'jvscott@gmail.com'
+  gem.homepage    = 'http://www.github.com/jscott/stubborn_queue/'
+  gem.summary     = 'Stubborn Queue'
+  gem.description = 'Queueing that keeps on kicking until you tell it to stop.'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- test/**/*`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 2.1'
+
+  gem.add_runtime_dependency 'bundler'
+  gem.add_runtime_dependency 'moneta'
+  gem.add_runtime_dependency 'daybreak'
+  gem.add_runtime_dependency 'redislike'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'kintama'
+  gem.add_development_dependency 'simplecov'
+end

data/test/queueing_spec.rb

@@ -0,0 +1,33 @@
+require 'bundler/setup'
+require 'kintama'
+require 'stubborn_queue'
+
+context 'queueing' do
+  setup do
+    @timeout = 1
+    @queue = StubbornQueue.new name: 'test', timeout: @timeout
+    @queue.db.clear
+    @item = 'test_item'
+  end
+
+  should 'add and remove items' do
+    assert_equal 1, @queue.enqueue(@item)
+    id = @queue.dequeue
+    assert_equal @item, @queue.lookup(id)
+  end
+
+  should 'requeue items that don\'t finish' do
+    assert_equal 1, @queue.enqueue(@item)
+    @queue.dequeue
+    sleep (@timeout+1)
+    assert_equal 2, @queue.enqueue(@item)
+  end
+
+  should 'be able to finish items and not requeue them' do
+    assert_equal 1, @queue.enqueue(@item)
+    id = @queue.dequeue
+    @queue.finish id
+    sleep (@timeout+1)
+    assert_equal 1, @queue.enqueue(@item)
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: stubborn_queue
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Justin Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: daybreak
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redislike
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kintama
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Queueing that keeps on kicking until you tell it to stop.
+email: jvscott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/stubborn_queue.rb
+- stubborn_queue.gemspec
+- test/queueing_spec.rb
+homepage: http://www.github.com/jscott/stubborn_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: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Stubborn Queue
+test_files: []
+has_rdoc: