filequeue 0.0.2 → 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bda8a00a34e6b94e1bf22199e00f0d9cf2c6d60
+  data.tar.gz: 3dd04b0390120f9d3891c91cac7712be948ff79d
+SHA512:
+  metadata.gz: 3352418e0db83c98cff93e94ab161b4665c23629b851fd4909d6d445ba03dbac93ca33f706cff02218c82e7bcd02d46970fb17da93c1ac68035bb19d5c28fcd2
+  data.tar.gz: f52b0790ba5dc1212465a3891e27d76d52541f98d213bb250c459338f3ce650a63820aa858e951e25563073ebee1f9cb139858fd34ff3efa82cc474b6c91b382

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -1,3 +1,3 @@
+--format documentation
 --color
---format=nested
---backtrace
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+  - ruby
+  - ruby-head
+  - jruby
+  - rbx-3
+sudo: false
+gemfile: Gemfile.ci
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pezra@barelyenough.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 filequeue.gemspec
+gemspec

data/Gemfile.ci

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in filequeue.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    filequeue (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  filequeue!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Peter Williams
+
+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

@@ -1,5 +1,7 @@
-## FileQueue 
-...is a simple file based queue written in Ruby that uses the Ruby `File` class in standard library to push and pop items into a queue.
+
+
+## FileQueue [![Build Status](https://travis-ci.org/pezra/filequeue.svg)](https://travis-ci.org/pezra/filequeue)
+...is a simple file based queue written in Ruby that uses the Ruby `File` class in standard library to push and pop items into a queue. It's not web scale but is nice for lightweight async queuing apps.
 
 Originally written by [daddz](http://www.github.com/daddz) and found in [this gist](https://gist.github.com/352509). Thanks, daddz!
 
@@ -17,4 +19,8 @@ Originally written by [daddz](http://www.github.com/daddz) and found in [this gi
     queue.pop
       => "an item"
       
-See `spec/filequeue_spec.rb` for more usage details
+See `spec/filequeue_spec.rb` for more usage details
+
+## Continuous Integration
+
+[![Build Status](http://travis-ci.org/maxogden/filequeue.png)](http://travis-ci.org/maxogden/filequeue)

data/Rakefile

@@ -1,23 +1,6 @@
-require 'rubygems'
-require 'rake'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "filequeue"
-    gem.summary = %Q{A simple file based queue in Ruby}
-    gem.description = %Q{A simple file based queue in Ruby}
-    gem.email = "max@maxogden.com"
-    gem.homepage = "http://github.com/maxogden/filequeue"
-    gem.authors = ["Max Ogden", "daddz"]
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
-task :test => :spec

data/VERSION

@@ -1 +1 @@
-0.0.2
+1.0.2

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "filequeue"
+
+# 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/filequeue.gemspec

@@ -1,51 +1,27 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
 
-Gem::Specification.new do |s|
-  s.name = %q{filequeue}
-  s.version = "0.0.2"
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "filequeue/version"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Max Ogden", "daddz"]
-  s.date = %q{2011-04-05}
-  s.description = %q{A simple file based queue in Ruby}
-  s.email = %q{max@maxogden.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    ".gemtest",
-    ".rspec",
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "file_queue.rb",
-    "filequeue.gemspec",
-    "lib/filequeue.rb",
-    "pkg/filequeue-0.0.2.gem",
-    "spec/filequeue_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/maxogden/filequeue}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.2}
-  s.summary = %q{A simple file based queue in Ruby}
-  s.test_files = [
-    "spec/filequeue_spec.rb",
-    "spec/spec_helper.rb"
-  ]
+Gem::Specification.new do |spec|
+  spec.name          = "filequeue"
+  spec.version       = Filequeue::VERSION
+  spec.authors       = ["Peter Williams", "Max Ogden", "daddz"]
+  spec.email         = ["pezra@barelyenough.org"]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  spec.summary       = "Simple file based queue"
+  spec.description   = "File based queue for coordinating multiple processes."
+  spec.homepage      = "https://github.com/pezra/filequeue"
+  spec.license       = "MIT"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
   end
-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 "rspec", "~> 3.0"
+end

data/lib/filequeue.rb

@@ -1,9 +1,12 @@
+require 'timeout'
+
 class FileQueue
-	attr_accessor :file_name, :delimiter
-	
-  def initialize(file_name, delimiter="\n")
+  attr_accessor :file_name, :delimiter, :lock_timeout
+
+  def initialize(file_name, delimiter="\n", lock_timeout: 10)
     @delimiter = delimiter
     @file_name = file_name
+    @lock_timeout = lock_timeout
   end
 
   def push(obj)
@@ -16,22 +19,24 @@ class FileQueue
   end
 
   alias << push
-	
+
   def pop
     value = nil
-    rest = nil
-    safe_open 'r' do |file|
+    safe_open 'r+' do |file|
       value = file.gets @delimiter
       rest = file.read
-    end
-    safe_open 'w+' do |file|
-      file.write rest
+      file.rewind
+      file.truncate(0)
+      file.write(rest)
     end
     value ? value[0..-(@delimiter.length) - 1] : nil
   end
 
   def length
     count = 0
+    unless(File.exist?(@file_name))
+      return 0
+    end
     safe_open 'r' do |file|
       count = file.read.count @delimiter
     end
@@ -45,13 +50,33 @@ class FileQueue
   def clear
     safe_open 'w' do |file| end
   end
-	
-  private
+
+  protected
+
   def safe_open(mode)
     File.open(@file_name, mode) do |file|
-      file.flock File::LOCK_EX
+      lock file
       yield file
-      file.flock File::LOCK_UN
     end
   end
-end
+
+  DELAY_RANGE = (0..0.01).freeze
+
+  # Locks the queue file for exclusive access. This will gives up
+  # after `lock_timeout` seconds.
+  #
+  # Raises `FileLockError` if unable to acquire a lock.
+  #
+  # Return is undefined.
+  def lock(file)
+    deadline = (Time.now + lock_timeout)
+
+    until Time.now >= deadline || lock_acquired = file.flock(File::LOCK_NB|File::LOCK_EX)
+      sleep(rand(DELAY_RANGE))
+    end
+
+    (raise FileLockError, "Queue file appears to be permanently locked") unless lock_acquired
+  end
+
+  FileLockError = Class.new(Timeout::Error)
+end

data/lib/filequeue/version.rb

@@ -0,0 +1,3 @@
+module Filequeue
+  VERSION = "1.0.3"
+end

metadata

@@ -1,81 +1,107 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: filequeue
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 1.0.3
 platform: ruby
-authors: 
+authors:
+- Peter Williams
 - Max Ogden
 - daddz
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-
-date: 2011-04-05 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
-description: A simple file based queue in Ruby
-email: max@maxogden.com
+date: 2018-07-31 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: File based queue for coordinating multiple processes.
+email:
+- pezra@barelyenough.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.md
-files: 
-- .gemtest
-- .rspec
+extra_rdoc_files: []
+files:
+- ".gemtest"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.ci
+- Gemfile.lock
 - LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
 - VERSION
-- file_queue.rb
+- bin/console
+- bin/setup
 - filequeue.gemspec
 - lib/filequeue.rb
-- pkg/filequeue-0.0.2.gem
-- spec/filequeue_spec.rb
-- spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/maxogden/filequeue
-licenses: []
-
+- lib/filequeue/version.rb
+homepage: https://github.com/pezra/filequeue
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 2.6.13
 signing_key: 
-specification_version: 3
-summary: A simple file based queue in Ruby
-test_files: 
-- spec/filequeue_spec.rb
-- spec/spec_helper.rb
+specification_version: 4
+summary: Simple file based queue
+test_files: []

data/file_queue.rb

@@ -1,52 +0,0 @@
-class FileQueue
-	
-  def initialize(file_name)
-    @file_name = file_name
-  end
-
-  def push(obj)
-    safe_open('a') do |file|
-      file.write(obj + "\n")
-    end
-  end
-
-  alias << push
-	
-  def pop
-    value = nil
-    rest = nil
-    safe_open('r') do |file|
-      value = file.gets
-      rest = file.read
-    end
-    safe_open('w+') do |file|
-      file.write(rest)
-    end
-    value
-  end
-
-  def length
-    count = 0
-    safe_open('r') do |file|
-      count = file.read.count("\n")
-    end
-    count
-  end
-
-  def empty?
-    return length == 0
-  end
-
-  def clear
-    safe_open('w') do |file| end
-  end
-	
-  private
-  def safe_open(mode)
-    File.open(@file_name, mode) do |file|
-      file.flock(File::LOCK_EX)
-      yield file
-      file.flock(File::LOCK_UN)
-    end
-  end
-end

data/spec/filequeue_spec.rb

@@ -1,96 +0,0 @@
-require 'spec_helper'
-
-test_file = "pizza.waffle"
-
-describe FileQueue do
-  subject do
-    FileQueue.new test_file
-  end
-  
-  after :each do
-    File.open(test_file, 'w') {|file| file.truncate 0 }
-  end
-  
-  after :all do
-    File.delete test_file
-  end
-
-  describe '#initialize' do
-    it 'should have a file name and default delimiter' do
-      subject.file_name.should == test_file
-      subject.delimiter.should == "\n"
-    end
-    
-    it 'should let you specify your own queue delimiter' do
-      FileQueue.new(test_file, ",").delimiter.should == ","
-    end
-  end
-  
-  describe '#push' do
-    it 'should add an entry to the queue' do
-      subject.push "bacon"
-      File.open(test_file, 'r').read.should == "bacon\n"
-    end
-    
-    it 'should add multiple entries to the queue' do
-      subject.push "cats"
-      subject.push "are awesome"
-      File.open(test_file, 'r').read.should == "cats\nare awesome\n"
-    end
-    
-    it 'should use the delimiter to separate entries in the queue' do
-      FileQueue.new(test_file, ",").push "jello"
-      File.open(test_file, 'r').read.should == "jello,"
-    end
-    
-    it 'should raise if your object contains the delimiter' do
-      lambda { subject.push "yee\nhaw" }.should raise_error(StandardError, "Queue objects cannot contain the queue delimiter")
-    end
-    
-    it 'should let you use the << syntax to add things to the queue' do
-      subject << "angle brackets!"
-      subject.pop.should == "angle brackets!"
-    end
-  end
-  
-  describe '#pop' do
-    it 'should retrieve an item from the queue' do
-      subject.push "important document"
-      subject.pop.should == "important document"
-    end
-    
-    it 'should return the oldest item in the queue' do
-      subject.push "old thing"
-      subject.push "new thing"
-      subject.pop.should == "old thing"
-    end
-    
-    it 'should return nil if the queue is empty' do
-      subject.pop.should be_nil
-    end
-  end
-  
-  describe '#length' do
-    it 'should tell you the size of the queue' do
-      subject.length.should == 0
-      subject.push "content"
-      subject.length.should == 1
-    end
-  end
-  
-  describe '#empty' do
-    it 'should tell you if the queue is empty or not' do
-      subject.empty?.should be_true
-      subject.push "content"
-      subject.empty?.should be_false
-    end
-  end
-  
-  describe '#clear' do
-    it 'should empty the queue' do
-      subject.push "content"
-      subject.clear
-      subject.empty?.should be_true
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,4 +0,0 @@
-require 'rubygems'
-require 'rspec'
-require 'rspec/autorun'
-require 'filequeue'