thread_so_safe 0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gem
+
+## PROJECT::SPECIFIC

data/LICENSE

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

@@ -0,0 +1,30 @@
+h1. thread_so_safe
+
+thread_so_safe is a very simple gem to help keep multi-threaded environments synced.
+
+h2. Examples
+
+<code><pre>
+# Starting thread-safety is easy!
+ThreadSoSafe.safeguard('My.Application')
+ThreadSoSafe.safeguard('My.Second.Application')
+
+# Time to check if our data is till up to date
+unless ThreadSoSafe.safe?('My.Application')
+  puts "Updating data..."
+  ThreadSoSafe.update!('My.Application')
+end
+
+unless ThreadSoSafe.safe?('My.Second.Application')
+  # update second set of data
+  ThreadSoSafe.update!('My.Second.Application')
+end
+
+# If you're working with only one application you can use the slightly shorter-hand
+unless ThreadSoSafe.safe?
+  # bring your code up to date
+  ThreadSoSafe.update!
+end
+</pre></code>
+
+Copyright (c) 2010 Dane Harrigan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "thread_so_safe"
+    gem.version = "0.1"
+    gem.summary = %Q{thread_so_safe is a very simple gem to help keep multi-threaded environments synced.}
+    gem.email = "dane.harrigan@gmail.com"
+    gem.homepage = "http://github.com/daneharrigan/thread_so_safe"
+    gem.authors = ["Dane Harrigan"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = ['--exclude', 'gem,spec']
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "thread_so_safe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/thread_so_safe.rb

@@ -0,0 +1,62 @@
+require 'digest/md5'
+require 'fileutils'
+
+class ThreadSoSafe
+  @@threads = {}
+  @@current_thread = nil
+
+  class << self
+    def safeguard(name)
+      @@current_thread = name
+      name = file_name(name)
+
+      file = File.new(full_path(name),'w+')
+      @@threads[name] = file.mtime
+
+      file.close
+      return
+    end
+
+    def safe?(name=@@current_thread)
+      @@current_thread = name
+      name = file_name(name)
+
+      @@threads[name] == File.mtime("#{full_path name}")
+    end
+
+    def update!(name=@@current_thread)
+      name = file_name(name)
+      file = full_path(name)
+
+      FileUtils.touch(file) if @@threads[name] == File.mtime(file)
+      @@threads[name] = File.mtime(file)
+    end
+
+    private
+    def file_name(name)
+      Digest::MD5.hexdigest(name)
+    end
+
+    def full_path(name)
+      "#{directory}/#{name}"
+    end
+
+    def directory
+      use_default_directory? ? default_directory : gem_directory
+    end
+
+    def use_default_directory?
+      File.writable?(default_directory)
+    end
+
+    #:nordoc:
+    def default_directory
+      '/tmp/thread_so_safe'
+    end
+
+    #:nordoc:
+    def gem_directory
+      File.expand_path(File.dirname(__FILE__)+'/../tmp')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'digest/md5'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'thread_so_safe'

data/spec/thread_so_safe_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe ThreadSoSafe do
+  before(:all) do
+    @app_name = 'My.Application'
+    @default_directory = '/tmp/thread_so_safe'
+  end
+
+  it "should be safe without passing the application name" do
+    ThreadSoSafe.safeguard(@app_name)
+    ThreadSoSafe.safe?.should == true
+  end
+
+  it "should be safe with the application name passed" do
+    ThreadSoSafe.safeguard(@app_name)
+    ThreadSoSafe.safe?(@app_name).should == true    
+  end
+
+  it "should encode the application name with md5" do
+    ThreadSoSafe.send(:file_name,@app_name).should == Digest::MD5.hexdigest(@app_name)  
+  end
+
+  it "should return /tmp/thread_so_safe as the default directory" do
+    ThreadSoSafe.send(:default_directory).should == @default_directory
+  end
+
+  it "should return <gem-path>/tmp as the default directory" do
+    path_from_class = File.expand_path ThreadSoSafe.send(:gem_directory)
+    path_from_test = File.expand_path(File.dirname(__FILE__) + '/../tmp')
+    path_from_class.should == path_from_test
+  end
+
+  it "should return default directory" do
+    ThreadSoSafe.send(:directory).should == @default_directory
+  end
+
+  it "should return the full path to the /tmp file" do
+    file_name = ThreadSoSafe.send(:file_name, @app_name)
+    ThreadSoSafe.send(:full_path, file_name).should == "#{@default_directory}/#{file_name}"
+  end
+
+  context "when another thread updates the thread-safe token" do
+    before(:each) do
+      ThreadSoSafe.safeguard(@app_name)
+
+      file_name = ThreadSoSafe.send(:file_name, @app_name)
+      full_path = ThreadSoSafe.send(:full_path, file_name)
+
+      File.stub!(:mtime).and_return(Time.now+100)
+    end
+
+    it "should not be safe without passing the application name" do
+      ThreadSoSafe.safe?.should == false
+    end
+
+    it "should be safe with the application name passed" do
+      ThreadSoSafe.safe?(@app_name).should == false
+    end
+  end
+
+  context "when updating the thread-safe token" do
+    before(:each) do
+      ThreadSoSafe.safeguard(@app_name)
+      file_name = ThreadSoSafe.send(:file_name, @app_name)
+      @full_path = ThreadSoSafe.send(:full_path, file_name)
+
+      @mtime = File.mtime @full_path
+      File.stub!(:mtime).and_return(Time.now+100)
+    end
+
+    it "should update the mtime on the /tmp file with the application name passed" do
+      ThreadSoSafe.update!(@app_name)
+      File.mtime(@full_path).should_not == @mtime
+    end
+
+    it "should update the mtime on the /tmp file without the application name passed" do
+      ThreadSoSafe.update!
+      File.mtime(@full_path).should_not == @mtime
+    end
+  end
+
+  context "when the /tmp directory is not available or writable" do
+    before(:each) do
+      ThreadSoSafe.stub!(:use_default_directory?).and_return(false)
+    end
+
+    it "should return gem directory" do
+      path_from_class = ThreadSoSafe.send(:directory)
+      path_from_test = File.expand_path(File.dirname(__FILE__) + '/../tmp')
+      path_from_class.should == path_from_test
+    end    
+  end
+end

data/thread_so_safe.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{thread_so_safe}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dane Harrigan"]
+  s.date = %q{2010-06-27}
+  s.email = %q{dane.harrigan@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "lib/thread_so_safe.rb",
+     "spec/spec_helper.rb",
+     "spec/thread_so_safe_spec.rb",
+     "thread_so_safe.gemspec"
+  ]
+  s.homepage = %q{http://github.com/daneharrigan/thread_so_safe}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{thread_so_safe is a very simple gem to help keep multi-threaded environments synced.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/thread_so_safe_spec.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
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: thread_so_safe
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Dane Harrigan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-27 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: 
+email: dane.harrigan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- lib/thread_so_safe.rb
+- spec/spec_helper.rb
+- spec/thread_so_safe_spec.rb
+- thread_so_safe.gemspec
+has_rdoc: true
+homepage: http://github.com/daneharrigan/thread_so_safe
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: thread_so_safe is a very simple gem to help keep multi-threaded environments synced.
+test_files: 
+- spec/spec_helper.rb
+- spec/thread_so_safe_spec.rb