tmptation 1.1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2009 Martin Aumont (mynyml)
+
+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,54 @@
+Summary
+-------
+Tmptation provides classes that help safely manipulate temporary files and
+directories. Especially useful for use in tests.
+
+Features
+--------
+* garbage collection of all created tmp files and dirs
+* safe deletion - will refuse to delete non-tmp paths (where tmp within `Dir.tmpdir`)
+
+Examples
+--------
+
+    # TmpFile is a subclass of Tempfile, with a few additions
+
+    file = TmpFile.new('name', 'contents')
+
+    file.path.exist?  #=> true
+    file.closed?      #=> false
+    file.read         #=> "contents"
+
+    TmpFile.delete_all
+
+    file.path.exist?  #=> false
+    file.closed?      #=> true
+
+
+    # TmpDir is a subclass of Pathname, with a few additions
+
+    path = TmpDir.new
+    path.exist?  #=> true
+
+    TmpDir.delete_all
+    path.exist?  #=> false
+
+Mixins
+------
+
+Tmptation also contains two mixins, `SafeDeletable` and `SubclassTracking`.
+They might be useful on their own. See the inline docs for more details.
+
+Protip
+------
+
+If you use Tmptation in specs, add `TmpFile.delete_all` and `TmpDir.delete_all`
+to your global teardown method:
+
+    class MiniTest::Unit::TestCase
+      def teardown
+        TmpFile.delete_all
+        TmpDir.delete_all
+      end
+    end
+

data/Rakefile

@@ -0,0 +1,7 @@
+task :default => :test
+
+desc "Run tests"
+task :test do
+  system "ruby -rubygems -I.:lib:test -e'%w( #{Dir['test/**/*_test.rb'].join(' ')} ).each {|p| require p }'"
+end
+

data/lib/tmptation.rb

@@ -0,0 +1,171 @@
+require 'pathname'
+require 'tempfile'
+require 'tmpdir'
+require 'fileutils'
+
+module Tmptation
+  VERSION = 1.1
+
+  # Adds a #safe_delete method that will delete the object's associated path
+  # (either #path or #to_s, if it exists) only if it lives within the system's
+  # temporary directory (as defined by Dir.tmpdir)
+  #
+  # @example
+  #
+  #     path = Pathname.new('~/Documents')
+  #     path.extend(SafeDeletable)
+  #
+  #     path.to_s #=> '~/Documents'
+  #     path.safe_delete #=> raises UnsafeDelete
+  #
+  #     # however:
+  #
+  #     path = Pathname(Dir.mktmpdir).expand_path
+  #
+  #     Dir.tmpdir  #=> /var/folders/l8/l8EJIxZoHGGj+y1RvV0r6U+++TM/-Tmp-/
+  #     path.to_s   #=> /var/folders/l8/l8EJIxZoHGGj+y1RvV0r6U+++TM/-Tmp-/20101103-94996-1iywsjo
+  #
+  #     path.exist? #=> true
+  #     path.safe_delete
+  #     path.exist? #=> false
+  #
+  module SafeDeletable
+    UnsafeDelete = Class.new(RuntimeError)
+
+    # Delete `#path` or `#to_s` if it exists, and only if it lives within
+    # `Dir.tmpdir`. If the path is a directory, it is deleted recursively.
+    #
+    # @raises SafeDeletable::UnsafeDelete if directory isn't within `Dir.tmpdir`
+    #
+    def safe_delete
+      path = self.respond_to?(:path) ? self.path : self.to_s
+      path = Pathname(path).expand_path
+
+      unless path.to_s.match(/^#{Regexp.escape(Dir.tmpdir)}/)
+        raise UnsafeDelete.new("refusing to remove non-tmp directory '#{path}'")
+      end
+      FileUtils.remove_entry_secure(path.to_s)
+    end
+  end
+
+  # Keep track of a class's instances
+  #
+  # @example
+  #
+  #     class Foo
+  #       include InstanceTracking
+  #     end
+  #
+  #     a, b, c = Foo.new, Foo.new, Foo.new
+  #
+  #     [a,b,c] == Foo.instances #=> true
+  #
+  module InstanceTracking
+    def self.included(base)
+      base.class_eval do
+        extend  ClassMethods
+        include InstanceMethods
+      end
+    end
+
+    module ClassMethods
+      def instances
+        @instances ||= []
+      end
+    end
+
+    module InstanceMethods
+      def initialize(*args)
+        super
+        self.class.instances << self
+      end
+    end
+  end
+
+  # Subclass of core lib's Tempfile that allows safely deleting all of its
+  # instances. It also provides a convenient way to add content to the file.
+  #
+  # @example
+  #
+  #     file = TmpFile.new('name', 'contents')
+  #
+  #     file.path.class   #=> Pathname
+  #     file.path.exist?  #=> true
+  #     file.closed?      #=> false
+  #     file.read         #=> "contents"
+  #
+  #     TmpFile.delete_all
+  #
+  #     file.path.exist?  #=> false
+  #     file.closed?      #=> true
+  #
+  class TmpFile < Tempfile
+    include SafeDeletable
+    include InstanceTracking
+
+    class << self
+
+      # Safe deletes and closes all instances
+      def delete_all
+        instances.each do |instance|
+          instance.safe_delete
+          instance.close
+        end
+      end
+      alias -@ delete_all
+    end
+
+    # @param name<String> optional
+    #   prefix name of file
+    #
+    # @param body<String> optional
+    #   contents of file
+    #
+    def initialize(name='anon', body='')
+      super(name)
+      self << body
+      self.rewind
+    end
+
+    # File's path as a Pathname
+    #
+    # @return path<Pathname>
+    #
+    def path
+      Pathname(super)
+    end
+  end
+
+  # Subclass of core lib's Pathname that allows safely deleting all of its
+  # instances.
+  #
+  # @example
+  #
+  #     path = TmpDir.new
+  #     path.exist?  #=> true
+  #
+  #     TmpDir.delete_all
+  #     path.exist?  #=> false
+  #
+  class TmpDir < Pathname
+    include SafeDeletable
+    include InstanceTracking
+
+    class << self
+
+      # Safe deletes and closes all instances
+      def delete_all
+        instances.each {|instance| instance.safe_delete }
+      end
+      alias -@ delete_all
+    end
+
+    # @param prefix<String> optional
+    #   prefix of directory name
+    #
+    def initialize(prefix='TmpDir-')
+      super(Pathname(Dir.mktmpdir(prefix)).expand_path)
+    end
+  end
+end
+

data/specs.watchr

@@ -0,0 +1,35 @@
+#!/usr/bin/env watchr
+
+# --------------------------------------------------
+# Rules
+# --------------------------------------------------
+watch( '^test.*_test\.rb'      ) {|m| ruby m[0] }
+watch( '^lib/(.*)\.rb'         ) {|m| ruby "test/#{m[1]}_test.rb" }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+Signal.trap('QUIT') { ruby tests  } # Ctrl-\
+Signal.trap('INT' ) { abort("\n") } # Ctrl-C
+
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+def ruby(*paths)
+  paths = paths.flatten.select {|p| File.exist?(p) && !File.directory?(p) }.join(' ')
+  run "ruby #{gem_opt} -I.:lib:test -e'%w( #{paths} ).each {|p| require p }'" unless paths.empty?
+end
+
+def tests
+  Dir['test/**/*_test.rb']
+end
+
+def run( cmd )
+  puts   cmd
+  system cmd
+end
+
+def gem_opt
+  defined?(Gem) ? "-rubygems" : ""
+end
+

data/test/tmptation_test.rb

@@ -0,0 +1,256 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'rr'
+
+begin require 'ruby-debug'; rescue LoadError; end
+begin require 'redgreen'  ; rescue LoadError; end
+begin require 'phocus'    ; rescue LoadError; end
+
+class MiniTest::Unit::TestCase
+  include RR::Adapters::TestUnit
+end
+
+require 'tmptation'
+include  Tmptation
+
+describe Tmptation do
+  it "should have a version" do
+    assert_kind_of Float, Tmptation::VERSION
+  end
+end
+
+describe Tmptation::SafeDeletable do
+
+  it "should delete a tmp directory" do
+    begin
+      dir = Pathname(Dir.mktmpdir('SafeDeletable-')).expand_path
+      dir.extend(SafeDeletable)
+      
+      assert dir.exist?
+      assert_match /^#{Regexp.quote(Dir.tmpdir)}/, dir.to_s
+
+      dir.safe_delete
+
+      refute dir.exist?
+    ensure
+      dir.rmdir if dir.directory?
+    end
+  end
+
+  it "should refuse to delete a non-tmp directory" do
+    begin
+      dir = Pathname(Dir.mktmpdir('SafeDeletable-')).expand_path
+      dir.extend(SafeDeletable)
+
+      stub(dir).to_s { '/not/a/tmp/dir' }
+      refute_match /^#{Regexp.quote(Dir.tmpdir)}/, dir.to_s
+
+      assert_raises(SafeDeletable::UnsafeDelete) { dir.safe_delete }
+    ensure
+      dir.rmdir if dir.directory?
+    end
+  end
+
+  it "should hanled relative paths" do
+    begin
+      dir = Pathname(Dir.mktmpdir('SafeDeletable-')).relative_path_from(Pathname(Dir.pwd))
+      dir.extend(SafeDeletable)
+
+      assert_match /^#{Regexp.quote(Dir.tmpdir)}/, dir.expand_path.to_s
+      assert dir.relative?
+
+      dir.safe_delete
+
+      refute dir.exist?
+    ensure
+      dir.rmdir if dir.directory?
+    end
+  end
+
+  it "should use an object's #path if it exists" do
+    begin
+      file = Tempfile.new('safe_deletable')
+      file.extend(SafeDeletable)
+
+      assert File.exist?(file.path)
+      assert_match /^#{Regexp.quote(Dir.tmpdir)}/, file.path.to_s
+
+      file.safe_delete
+
+      refute File.exist?(file.path)
+    ensure
+      file.delete if File.exist?(file)
+    end
+  end
+end
+
+describe Tmptation::InstanceTracking do
+
+  before do
+    TmpFile.instance_variable_set(:@instances, nil)
+  end
+
+  it "should keep track of class instances" do
+    klass = Class.new
+    klass.class_eval { include InstanceTracking }
+
+    assert_empty klass.instances
+
+    foo, bar = klass.new, klass.new
+    assert_equal [foo,bar], klass.instances
+  end
+end
+
+describe Tmptation::TmpFile do
+
+  before do
+    TmpFile.instance_variable_set(:@instances, nil)
+  end
+
+  it "should implement SafeDeletable" do
+    assert_includes TmpFile.included_modules, SafeDeletable
+  end
+
+  it "should implement InstanceTracking" do
+    assert_includes TmpFile.included_modules, InstanceTracking
+  end
+
+  it "should create a new temporary file on init" do
+    begin
+      foo  = TmpFile.new
+
+      assert File.exist?(foo.path)
+      assert_match /^#{Regexp.quote(Dir.tmpdir)}/, foo.path.to_s
+    ensure
+      foo.delete if foo.path.exist?
+    end
+  end
+
+  it "should provide a path as Pathname" do
+    begin
+      foo  = TmpFile.new
+      assert_kind_of Pathname, foo.path
+    ensure
+      foo.delete if foo.path.exist?
+    end
+  end
+
+  it "should allow setting a name and body on init" do
+    begin
+      foo  = TmpFile.new('name', 'body')
+
+      assert_match /^name/, foo.path.basename.to_s
+      assert_equal 'body',  foo.read
+    ensure
+      foo.delete if foo.path.exist?
+    end
+  end
+
+  it "should delete all instances" do
+    begin
+      foo, bar = TmpFile.new, TmpFile.new
+      
+      assert foo.path.exist?
+      assert bar.path.exist?
+
+      TmpFile.delete_all
+      
+      refute foo.path.exist?
+      refute bar.path.exist?
+    ensure
+      foo.delete if foo.path.exist?
+      bar.delete if bar.path.exist?
+    end
+  end
+
+  it "should use #safe_delete" do
+    begin
+      foo = TmpFile.new
+
+      mock(foo).safe_delete
+      TmpFile.delete_all
+
+      RR.verify
+    ensure
+      foo.delete if foo.path.exist?
+    end
+  end
+
+  it "should close files when deleting all instances" do
+    begin
+      foo = TmpFile.new
+      refute foo.closed?
+
+      TmpFile.delete_all
+      assert foo.closed?
+    ensure
+      foo.delete if foo.path.exist?
+    end
+  end
+end
+
+describe Tmptation::TmpDir do
+
+  before do
+    TmpDir.instance_variable_set(:@instances, nil)
+  end
+
+  it "should implement SafeDeletable" do
+    assert_includes TmpDir.included_modules, SafeDeletable
+  end
+
+  it "should implement InstanceTracking" do
+    assert_includes TmpFile.included_modules, InstanceTracking
+  end
+
+  it "should create a temporary directory on init" do
+    begin
+      foo = TmpDir.new
+
+      assert foo.exist?
+      assert_match /^#{Regexp.quote(Dir.tmpdir)}/, foo.to_s
+    ensure
+      foo.rmdir if foo.exist?
+    end
+  end
+
+  it "should allow setting a prefix on init" do
+    begin
+      foo  = TmpDir.new('prefix-')
+      assert_match /^prefix/, foo.to_s.split('/').last
+    ensure
+      foo.rmdir if foo.exist?
+    end
+  end
+
+  it "should delete all instances" do
+    begin
+      foo, bar = TmpDir.new, TmpDir.new
+      
+      assert foo.exist?
+      assert bar.exist?
+
+      TmpDir.delete_all
+      
+      refute foo.exist?
+      refute bar.exist?
+    ensure
+      foo.rmdir if foo.exist?
+      bar.rmdir if foo.exist?
+    end
+  end
+
+  it "should use #safe_delete" do
+    begin
+      foo = TmpDir.new
+
+      mock(foo).safe_delete
+      TmpDir.delete_all
+
+      RR.verify
+    ensure
+      foo.rmdir if foo.exist?
+    end
+  end
+end
+

data/tmptation.gemspec

@@ -0,0 +1,17 @@
+require 'lib/tmptation'
+
+Gem::Specification.new do |s|
+  s.name                = "tmptation"
+  s.version             =  Tmptation::VERSION
+  s.summary             = "Classes that help safely manipulate temporary files and directories"
+  s.description         = "Classes that help safely manipulate temporary files and directories."
+  s.author              = "Martin Aumont"
+  s.email               = "mynyml@gmail.com"
+  s.homepage            = "http://github.com/mynyml/tmptation"
+  s.rubyforge_project   = ""
+  s.require_path        = "lib"
+  s.files               = `git ls-files`.strip.split("\n")
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rr'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: tmptation
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  version: "1.1"
+platform: ruby
+authors: 
+- Martin Aumont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Classes that help safely manipulate temporary files and directories.
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- lib/tmptation.rb
+- specs.watchr
+- test/tmptation_test.rb
+- tmptation.gemspec
+has_rdoc: true
+homepage: http://github.com/mynyml/tmptation
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: Classes that help safely manipulate temporary files and directories
+test_files: []
+