filequeue 0.0.1

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Max Ogden and daddz
+
+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,20 @@
+## 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.
+
+Originally written by [daddz](http://www.github.com/daddz) and found in [this gist](https://gist.github.com/352509). Thanks, daddz!
+
+## Install
+
+    gem install filequeue
+
+## Usage
+
+    queue = FileQueue.new 'queue_party.txt'
+    
+    queue.push "an item"
+      => true
+      
+    queue.pop
+      => "an item"
+      
+See `spec/filequeue_spec.rb` for more usage details

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rake'
+
+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

@@ -0,0 +1 @@
+0.0.1

data/file_queue.rb

@@ -0,0 +1,52 @@
+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/filequeue.gemspec

@@ -0,0 +1,49 @@
+# 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.1"
+
+  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 = [
+    ".rspec",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "file_queue.rb",
+    "filequeue.gemspec",
+    "lib/filequeue.rb",
+    "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"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/filequeue.rb

@@ -0,0 +1,57 @@
+class FileQueue
+	attr_accessor :file_name, :delimiter
+	
+  def initialize(file_name, delimiter="\n")
+    @delimiter = delimiter
+    @file_name = file_name
+  end
+
+  def push(obj)
+    if obj.match Regexp.new @delimiter
+      raise "Queue objects cannot contain the queue delimiter"
+    end
+    safe_open 'a' do |file|
+      file.write(obj + @delimiter)
+    end
+  end
+
+  alias << push
+	
+  def pop
+    value = nil
+    rest = nil
+    safe_open 'r' do |file|
+      value = file.gets @delimiter
+      rest = file.read
+    end
+    safe_open 'w+' do |file|
+      file.write rest
+    end
+    value ? value[0..-(@delimiter.length) - 1] : nil
+  end
+
+  def length
+    count = 0
+    safe_open 'r' do |file|
+      count = file.read.count @delimiter
+    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

@@ -0,0 +1,96 @@
+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

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

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: filequeue
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Max Ogden
+- daddz
+autorequire: 
+bindir: bin
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .rspec
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- file_queue.rb
+- filequeue.gemspec
+- lib/filequeue.rb
+- spec/filequeue_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/maxogden/filequeue
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A simple file based queue in Ruby
+test_files: 
+- spec/filequeue_spec.rb
+- spec/spec_helper.rb