kissifer-utils 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 kissifer
+
+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.rdoc

@@ -0,0 +1,9 @@
+= utils
+
+Library of potentially useful stuff that I haven't (yet) found elsewhere
+Contains:
+utils/flock - simple cross-process Mutex-like functionality based on FLOCK. Not the full Mutex API.
+
+== Copyright
+
+Copyright (c) 2009 kissifer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "utils"
+    gem.summary = %Q{Library of potentially useful stuff that I haven't (yet) found elsewhere}
+    gem.email = "tierneydrchris@gmail.com"
+    gem.homepage = "http://github.com/kissifer/utils"
+    gem.authors = ["kissifer"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options spec/spec.opts']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "utils #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

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

data/lib/utils.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << File.dirname(__FILE__)
+
+require "utils/flock_mutex"

data/lib/utils/flock_mutex.rb

@@ -0,0 +1,19 @@
+module Utils
+  class FlockMutex
+    def initialize(filename)
+      @filename = filename
+      FileUtils.touch(@filename)
+    end
+    
+    def synchronize
+      open(@filename, 'w+') do |f|
+        f.flock(File::LOCK_EX)
+        begin 
+          yield
+        ensure
+          f.flock(File::LOCK_UN)
+        end
+      end
+    end
+  end
+end

data/spec/flock_mutex_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Utils::FlockMutex" do
+  before(:each) do
+    FileUtils.rm_f(".mylockfile")
+  end
+
+  context "(on instantiation)" do
+    it "should not accept an empty initialiser" do
+      lambda{Utils::FlockMutex.new}.should raise_error
+    end
+
+    it "should accept a filename as initialiser" do
+      lambda{Utils::FlockMutex.new(".mylockfile")}.should_not raise_error
+    end
+
+    it "should create a specified file if not present" do
+      lambda{Utils::FlockMutex.new(".mylockfile")}.should_not raise_error
+      File.exists?(".mylockfile").should be_true
+    end
+
+    it "should not complain if the specified file is present" do
+      FileUtils.touch(".mylockfile")
+      lambda{Utils::FlockMutex.new(".mylockfile")}.should_not raise_error
+    end
+
+    it "should not complain if the specified file is present and is locked" do
+      FileUtils.touch(".mylockfile")
+      File.open('.mylockfile', 'w+') do |f|
+        f.flock(File::LOCK_EX)
+        begin 
+          lambda{Utils::FlockMutex.new(".mylockfile")}.should_not raise_error
+        ensure
+          f.flock(File::LOCK_UN)
+        end
+      end
+    end
+  end
+  
+  context "(an instance)" do
+    it "should allow locking (against another process) around a code block" do
+      # TODO: this is a crap test. Rewrite (and split it up).
+      lock = Utils::FlockMutex.new(".mylockfile")
+      lock.synchronize do
+        IO.popen("-","w+") do |io|
+          File.open('.mylockfile', 'w+') do |f|
+            f.flock(File::LOCK_EX | File::LOCK_NB)
+          end
+        end.should be_false
+      end
+
+      IO.popen("-","w+") do |io|
+        File.open('.mylockfile', 'w+') do |f|
+          f.flock(File::LOCK_EX | File::LOCK_NB)
+        end
+      end.should be_true
+      
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'utils'
+
+Spec::Runner.configure do |config|
+  
+end

data/utils.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{utils}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kissifer"]
+  s.date = %q{2009-05-22}
+  s.email = %q{tierneydrchris@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/utils.rb",
+     "lib/utils/flock_mutex.rb",
+     "spec/flock_mutex_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "utils.gemspec"
+  ]
+  s.homepage = %q{http://github.com/kissifer/utils}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Library of potentially useful stuff that I haven't (yet) found elsewhere}
+  s.test_files = [
+    "spec/flock_mutex_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: kissifer-utils
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- kissifer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tierneydrchris@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/utils.rb
+- lib/utils/flock_mutex.rb
+- spec/flock_mutex_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- utils.gemspec
+has_rdoc: false
+homepage: http://github.com/kissifer/utils
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Library of potentially useful stuff that I haven't (yet) found elsewhere
+test_files: 
+- spec/flock_mutex_spec.rb
+- spec/spec_helper.rb