[Truffle] Added the 'tempfile' standard library.

jruby · Apr 15, 2015 · 2d7c3a8 · 2d7c3a8
1 parent 470e578
commit 2d7c3a8
Showing 17 changed files with 448 additions and 1 deletion.
diff --git a/lib/ruby/truffle/rubysl/README.md b/lib/ruby/truffle/rubysl/README.md
@@ -9,3 +9,4 @@ Commits for each library are:
 * rubysl-stringio `4b2977296eceef83084146c73d9ddef8d7e8f1af`
 * rubysl-complex `ccdb6e86aed5eaada64808f85d03d08d2834294a`
 * rubysl-pathname `cdf215804c4349353a60226b5c1d71f695d45570`
+* rubysl-tempfile `97c4464b4d235f773aab537fbc80608a730a58fc`
diff --git a/lib/ruby/truffle/rubysl/rubysl-tempfile/LICENSE b/lib/ruby/truffle/rubysl/rubysl-tempfile/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2013, Brian Shirai
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. Neither the name of the library nor the names of its contributors may be
+   used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/lib/ruby/truffle/rubysl/rubysl-tempfile/lib/rubysl/tempfile.rb b/lib/ruby/truffle/rubysl/rubysl-tempfile/lib/rubysl/tempfile.rb
@@ -0,0 +1,2 @@
+require "rubysl/tempfile/version"
+require "rubysl/tempfile/tempfile"
diff --git a/lib/ruby/truffle/rubysl/rubysl-tempfile/lib/rubysl/tempfile/tempfile.rb b/lib/ruby/truffle/rubysl/rubysl-tempfile/lib/rubysl/tempfile/tempfile.rb
@@ -0,0 +1,389 @@
+#
+# tempfile - manipulates temporary files
+#
+# $Id$
+#
+
+require 'delegate'
+require 'tmpdir'
+require 'thread'
+
+# A utility class for managing temporary files. When you create a Tempfile
+# object, it will create a temporary file with a unique filename. A Tempfile
+# objects behaves just like a File object, and you can perform all the usual
+# file operations on it: reading data, writing data, changing its permissions,
+# etc. So although this class does not explicitly document all instance methods
+# supported by File, you can in fact call any File instance method on a
+# Tempfile object.
+#
+# == Synopsis
+#
+#   require 'tempfile'
+#
+#   file = Tempfile.new('foo')
+#   file.path      # => A unique filename in the OS's temp directory,
+#                  #    e.g.: "/tmp/foo.24722.0"
+#                  #    This filename contains 'foo' in its basename.
+#   file.write("hello world")
+#   file.rewind
+#   file.read      # => "hello world"
+#   file.close
+#   file.unlink    # deletes the temp file
+#
+# == Good practices
+#
+# === Explicit close
+#
+# When a Tempfile object is garbage collected, or when the Ruby interpreter
+# exits, its associated temporary file is automatically deleted. This means
+# that's it's unnecessary to explicitly delete a Tempfile after use, though
+# it's good practice to do so: not explicitly deleting unused Tempfiles can
+# potentially leave behind large amounts of tempfiles on the filesystem
+# until they're garbage collected. The existence of these temp files can make
+# it harder to determine a new Tempfile filename.
+#
+# Therefore, one should always call #unlink or close in an ensure block, like
+# this:
+#
+#   file = Tempfile.new('foo')
+#   begin
+#      ...do something with file...
+#   ensure
+#      file.close
+#      file.unlink   # deletes the temp file
+#   end
+#
+# === Unlink after creation
+#
+# On POSIX systems, it's possible to unlink a file right after creating it,
+# and before closing it. This removes the filesystem entry without closing
+# the file handle, so it ensures that only the processes that already had
+# the file handle open can access the file's contents. It's strongly
+# recommended that you do this if you do not want any other processes to
+# be able to read from or write to the Tempfile, and you do not need to
+# know the Tempfile's filename either.
+#
+# For example, a practical use case for unlink-after-creation would be this:
+# you need a large byte buffer that's too large to comfortably fit in RAM,
+# e.g. when you're writing a web server and you want to buffer the client's
+# file upload data.
+#
+# Please refer to #unlink for more information and a code example.
+#
+# == Minor notes
+#
+# Tempfile's filename picking method is both thread-safe and inter-process-safe:
+# it guarantees that no other threads or processes will pick the same filename.
+#
+# Tempfile itself however may not be entirely thread-safe. If you access the
+# same Tempfile object from multiple threads then you should protect it with a
+# mutex.
+class Tempfile < DelegateClass(File)
+  include Dir::Tmpname
+
+  # call-seq:
+  #    new(basename, [tmpdir = Dir.tmpdir], [options])
+  #
+  # Creates a temporary file with permissions 0600 (= only readable and
+  # writable by the owner) and opens it with mode "w+".
+  #
+  # The +basename+ parameter is used to determine the name of the
+  # temporary file. You can either pass a String or an Array with
+  # 2 String elements. In the former form, the temporary file's base
+  # name will begin with the given string. In the latter form,
+  # the temporary file's base name will begin with the array's first
+  # element, and end with the second element. For example:
+  #
+  #   file = Tempfile.new('hello')
+  #   file.path  # => something like: "/tmp/hello2843-8392-92849382--0"
+  #
+  #   # Use the Array form to enforce an extension in the filename:
+  #   file = Tempfile.new(['hello', '.jpg'])
+  #   file.path  # => something like: "/tmp/hello2843-8392-92849382--0.jpg"
+  #
+  # The temporary file will be placed in the directory as specified
+  # by the +tmpdir+ parameter. By default, this is +Dir.tmpdir+.
+  # When $SAFE > 0 and the given +tmpdir+ is tainted, it uses
+  # '/tmp' as the temporary directory. Please note that ENV values
+  # are tainted by default, and +Dir.tmpdir+'s return value might
+  # come from environment variables (e.g. <tt>$TMPDIR</tt>).
+  #
+  #   file = Tempfile.new('hello', '/home/aisaka')
+  #   file.path  # => something like: "/home/aisaka/hello2843-8392-92849382--0"
+  #
+  # You can also pass an options hash. Under the hood, Tempfile creates
+  # the temporary file using +File.open+. These options will be passed to
+  # +File.open+. This is mostly useful for specifying encoding
+  # options, e.g.:
+  #
+  #   Tempfile.new('hello', '/home/aisaka', :encoding => 'ascii-8bit')
+  #
+  #   # You can also omit the 'tmpdir' parameter:
+  #   Tempfile.new('hello', :encoding => 'ascii-8bit')
+  #
+  # === Exceptions
+  #
+  # If Tempfile.new cannot find a unique filename within a limited
+  # number of tries, then it will raise an exception.
+  def initialize(basename, *rest)
+    if block_given?
+      warn "Tempfile.new doesn't call the given block."
+    end
+    @data = []
+    @clean_proc = Remover.new(@data)
+    ObjectSpace.define_finalizer(self, @clean_proc)
+
+    create(basename, *rest) do |tmpname, n, opts|
+      mode = File::RDWR|File::CREAT|File::EXCL
+      perm = 0600
+      if opts
+        mode |= opts.delete(:mode) || 0
+        opts[:perm] = perm
+        perm = nil
+      else
+        opts = perm
+      end
+      @data[1] = @tmpfile = File.open(tmpname, mode, opts)
+      @data[0] = @tmpname = tmpname
+      @mode = mode & ~(File::CREAT|File::EXCL)
+      perm or opts.freeze
+      @opts = opts
+    end
+
+    super(@tmpfile)
+  end
+
+  # Opens or reopens the file with mode "r+".
+  def open
+    @tmpfile.close if @tmpfile
+    @tmpfile = File.open(@tmpname, @mode, @opts)
+    @data[1] = @tmpfile
+    __setobj__(@tmpfile)
+  end
+
+  def _close    # :nodoc:
+    begin
+      @tmpfile.close if @tmpfile
+    ensure
+      @tmpfile = nil
+      @data[1] = nil if @data
+    end
+  end
+  protected :_close
+
+  # Closes the file. If +unlink_now+ is true, then the file will be unlinked
+  # (deleted) after closing. Of course, you can choose to later call #unlink
+  # if you do not unlink it now.
+  #
+  # If you don't explicitly unlink the temporary file, the removal
+  # will be delayed until the object is finalized.
+  def close(unlink_now=false)
+    if unlink_now
+      close!
+    else
+      _close
+    end
+  end
+
+  # Closes and unlinks (deletes) the file. Has the same effect as called
+  # <tt>close(true)</tt>.
+  def close!
+    _close
+    unlink
+  end
+
+  # Unlinks (deletes) the file from the filesystem. One should always unlink
+  # the file after using it, as is explained in the "Explicit close" good
+  # practice section in the Tempfile overview:
+  #
+  #   file = Tempfile.new('foo')
+  #   begin
+  #      ...do something with file...
+  #   ensure
+  #      file.close
+  #      file.unlink   # deletes the temp file
+  #   end
+  #
+  # === Unlink-before-close
+  #
+  # On POSIX systems it's possible to unlink a file before closing it. This
+  # practice is explained in detail in the Tempfile overview (section
+  # "Unlink after creation"); please refer there for more information.
+  #
+  # However, unlink-before-close may not be supported on non-POSIX operating
+  # systems. Microsoft Windows is the most notable case: unlinking a non-closed
+  # file will result in an error, which this method will silently ignore. If
+  # you want to practice unlink-before-close whenever possible, then you should
+  # write code like this:
+  #
+  #   file = Tempfile.new('foo')
+  #   file.unlink   # On Windows this silently fails.
+  #   begin
+  #      ... do something with file ...
+  #   ensure
+  #      file.close!   # Closes the file handle. If the file wasn't unlinked
+  #                    # because #unlink failed, then this method will attempt
+  #                    # to do so again.
+  #   end
+  def unlink
+    return unless @tmpname
+    begin
+      File.unlink(@tmpname)
+    rescue Errno::ENOENT
+    rescue Errno::EACCES
+      # may not be able to unlink on Windows; just ignore
+      return
+    end
+    # remove tmpname from remover
+    @data[0] = @data[1] = nil
+    @tmpname = nil
+    ObjectSpace.undefine_finalizer(self)
+  end
+  alias delete unlink
+
+  # Returns the full path name of the temporary file.
+  # This will be nil if #unlink has been called.
+  def path
+    @tmpname
+  end
+
+  # Returns the size of the temporary file.  As a side effect, the IO
+  # buffer is flushed before determining the size.
+  def size
+    if @tmpfile
+      @tmpfile.flush
+      @tmpfile.stat.size
+    elsif @tmpname
+      File.size(@tmpname)
+    else
+      0
+    end
+  end
+  alias length size
+
+  # :stopdoc:
+  def inspect
+    "#<#{self.class}:#{path}>"
+  end
+
+  class Remover
+    def initialize(data)
+      @pid = $$
+      @data = data
+    end
+
+    def call(*args)
+      return if @pid != $$
+
+      path, tmpfile = *@data
+
+      STDERR.print "removing ", path, "..." if $DEBUG
+
+      tmpfile.close if tmpfile
+
+      if path
+        begin
+          File.unlink(path)
+        rescue Errno::ENOENT
+        end
+      end
+
+      STDERR.print "done\n" if $DEBUG
+    end
+  end
+  # :startdoc:
+
+  class << self
+    # Creates a new Tempfile.
+    #
+    # If no block is given, this is a synonym for Tempfile.new.
+    #
+    # If a block is given, then a Tempfile object will be constructed,
+    # and the block is run with said object as argument. The Tempfile
+    # object will be automatically closed after the block terminates.
+    # The call returns the value of the block.
+    #
+    # In any case, all arguments (+*args+) will be passed to Tempfile.new.
+    #
+    #   Tempfile.open('foo', '/home/temp') do |f|
+    #      ... do something with f ...
+    #   end
+    #
+    #   # Equivalent:
+    #   f = Tempfile.open('foo', '/home/temp')
+    #   begin
+    #      ... do something with f ...
+    #   ensure
+    #      f.close
+    #   end
+    def open(*args)
+      tempfile = new(*args)
+
+      if block_given?
+        begin
+          yield(tempfile)
+        ensure
+          tempfile.close
+        end
+      else
+        tempfile
+      end
+    end
+  end
+end
+
+# Creates a temporally file as usual File object (not Tempfile).
+# It don't use finalizer and delegation.
+#
+# If no block is given, this is similar to Tempfile.new except
+# creating File instead of Tempfile.
+# The created file is not removed automatically.
+# You should use File.unlink to remove it.
+#
+# If a block is given, then a File object will be constructed,
+# and the block is invoked with the object as the argument.
+# The File object will be automatically closed and
+# the temporally file is removed after the block terminates.
+# The call returns the value of the block.
+#
+# In any case, all arguments (+*args+) will be treated as Tempfile.new.
+#
+#   Tempfile.create('foo', '/home/temp') do |f|
+#      ... do something with f ...
+#   end
+#
+def Tempfile.create(basename, *rest)
+  tmpfile = nil
+  Dir::Tmpname.create(basename, *rest) do |tmpname, n, opts|
+    mode = File::RDWR|File::CREAT|File::EXCL
+    perm = 0600
+    if opts
+      mode |= opts.delete(:mode) || 0
+      opts[:perm] = perm
+      perm = nil
+    else
+      opts = perm
+    end
+    tmpfile = File.open(tmpname, mode, opts)
+  end
+  if block_given?
+    begin
+      yield tmpfile
+    ensure
+      tmpfile.close if !tmpfile.closed?
+      File.unlink tmpfile
+    end
+  else
+    tmpfile
+  end
+end
+
+if __FILE__ == $0
+#  $DEBUG = true
+  f = Tempfile.new("foo")
+  f.print("foo\n")
+  f.close
+  f.open
+  p f.gets # => "foo\n"
+  f.close!
+end
diff --git a/lib/ruby/truffle/rubysl/rubysl-tempfile/lib/rubysl/tempfile/version.rb b/lib/ruby/truffle/rubysl/rubysl-tempfile/lib/rubysl/tempfile/version.rb
@@ -0,0 +1,5 @@
+module RubySL
+  module Tempfile
+    VERSION = "2.0.1"
+  end
+end
diff --git a/lib/ruby/truffle/rubysl/rubysl-tempfile/lib/tempfile.rb b/lib/ruby/truffle/rubysl/rubysl-tempfile/lib/tempfile.rb
@@ -0,0 +1 @@
+require "rubysl/tempfile"
diff --git a/spec/truffle/tags/library/tempfile/_close_tags.txt b/spec/truffle/tags/library/tempfile/_close_tags.txt
@@ -0,0 +1,2 @@
+fails:Tempfile#_close is protected
+fails:Tempfile#_close closes self
diff --git a/spec/truffle/tags/library/tempfile/close_tags.txt b/spec/truffle/tags/library/tempfile/close_tags.txt
@@ -0,0 +1,5 @@
+fails:Tempfile#close when passed no argument or [false] closes self
+fails:Tempfile#close when passed [true] closes self
+fails:Tempfile#close when passed [true] unlinks self
+fails:Tempfile#close! closes self
+fails:Tempfile#close! unlinks self
diff --git a/spec/truffle/tags/library/tempfile/delete_tags.txt b/spec/truffle/tags/library/tempfile/delete_tags.txt
@@ -0,0 +1 @@
+fails:Tempfile#delete unlinks self
diff --git a/spec/truffle/tags/library/tempfile/initialize_tags.txt b/spec/truffle/tags/library/tempfile/initialize_tags.txt
@@ -0,0 +1,2 @@
+fails:Tempfile#initialize opens a new tempfile with the passed name in the passed directory
+fails:Tempfile#initialize sets the permisssions on the tempfile to 0600
diff --git a/spec/truffle/tags/library/tempfile/length_tags.txt b/spec/truffle/tags/library/tempfile/length_tags.txt
@@ -0,0 +1,2 @@
+fails:Tempfile#length returns the size of self
+fails:Tempfile#length returns the size of self even if self is closed
diff --git a/spec/truffle/tags/library/tempfile/open_tags.txt b/spec/truffle/tags/library/tempfile/open_tags.txt
@@ -0,0 +1,7 @@
+fails:Tempfile#open reopens self
+fails:Tempfile#open reopens self in read and write mode and does not truncate
+fails:Tempfile.open returns a new, open Tempfile instance
+fails:Tempfile.open is passed an array [base, suffix] as first argument
+fails:Tempfile.open when passed a block yields a new, open Tempfile instance to the block
+fails:Tempfile.open when passed a block returns the value of the block
+fails:Tempfile.open when passed a block closes the yielded Tempfile after the block
diff --git a/spec/truffle/tags/library/tempfile/path_tags.txt b/spec/truffle/tags/library/tempfile/path_tags.txt
@@ -0,0 +1 @@
+fails:Tempfile#path returns the path to the tempfile
diff --git a/spec/truffle/tags/library/tempfile/size_tags.txt b/spec/truffle/tags/library/tempfile/size_tags.txt
@@ -0,0 +1,2 @@
+fails:Tempfile#size returns the size of self
+fails:Tempfile#size returns the size of self even if self is closed
diff --git a/spec/truffle/tags/library/tempfile/unlink_tags.txt b/spec/truffle/tags/library/tempfile/unlink_tags.txt
@@ -0,0 +1 @@
+fails:Tempfile#unlink unlinks self
diff --git a/spec/truffle/truffle.mspec b/spec/truffle/truffle.mspec
@@ -98,6 +98,7 @@ class MSpecScript
     "spec/ruby/library/singleton",
     "spec/ruby/library/strscan",
     "spec/ruby/library/stringio",
+    "spec/ruby/library/tempfile",
     "spec/ruby/library/thread",
     "spec/ruby/library/tmpdir",
     "spec/ruby/library/uri",

diff --git a/truffle/src/main/java/org/jruby/truffle/TruffleBridgeImpl.java b/truffle/src/main/java/org/jruby/truffle/TruffleBridgeImpl.java
@@ -140,7 +140,7 @@ public void init() {
         loadPath.slowPush(truffleContext.makeString(new File(home, "lib/ruby/truffle/mri").toString()));
 
         // Libraries from RubySL
-        for (String lib : Arrays.asList("rubysl-strscan", "rubysl-stringio","rubysl-complex","rubysl-date","rubysl-pathname")) {
+        for (String lib : Arrays.asList("rubysl-strscan", "rubysl-stringio", "rubysl-complex", "rubysl-date", "rubysl-pathname", "rubysl-tempfile")) {
             loadPath.slowPush(truffleContext.makeString(new File(home, "lib/ruby/truffle/rubysl/" + lib + "/lib").toString()));
         }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		require "rubysl/tempfile/version"
		require "rubysl/tempfile/tempfile"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		fails:Tempfile#_close is protected
		fails:Tempfile#_close closes self
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		fails:Tempfile#initialize opens a new tempfile with the passed name in the passed directory
		fails:Tempfile#initialize sets the permisssions on the tempfile to 0600
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		fails:Tempfile#length returns the size of self
		fails:Tempfile#length returns the size of self even if self is closed
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		fails:Tempfile#path returns the path to the tempfile
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		fails:Tempfile#size returns the size of self
		fails:Tempfile#size returns the size of self even if self is closed