temppath 0.1.1 → 0.2.0

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 html
 gems
+vendor

data/.simplecov

@@ -4,4 +4,5 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
 ]
+SimpleCov.command_name 'bacon'
 SimpleCov.start {add_filter 'test'}

data/README.md

@@ -13,10 +13,30 @@ deleted when Ruby exits.
 
 ## Usage
 
+#### Create a path
+
 ```ruby
 path = Temppath.create
 #=> #<Pathname:/tmp/ruby-temppath-20130407-5775-w5k77l/f41bd6c5-fc99-4b7a-8f68-95b7ae4a6b22>
 path.exist? #=> false
+path.open("w")
+"%o" % path.stat.mode #=> "100600" (default permission 0600)
+```
+
+#### Create a directory
+
+```ruby
+path = Temppath.mkdir
+path.directory? #=> true
+"%o" % path.stat.mode #=> "40700"
+```
+
+#### Create an empty file
+
+```ruby
+path = Temppath.touch
+path.file? #=> true
+"%o" % path.stat.mode #=> "100600"
 ```
 
 ## Documentation

data/Rakefile

@@ -2,7 +2,7 @@ require "bundler/gem_tasks"
 
 desc 'Test specs'
 task 'test' do
-  sh "bundle exec bacon -a"
+  sh "bundle exec bacon -a -rsimplecov"
 end
 
 desc 'Generate API document'

data/lib/temppath.rb

@@ -8,15 +8,74 @@ require 'fileutils'
 # that this library generates Pathname objects with no files and filenames are
 # based on UUID. Files in paths generated by this are deleted when Ruby exits.
 #
-# @example
+# @example Create a temporary path
 #   path = Temppath.create
 #   #=> #<Pathname:/tmp/ruby-temppath-20130407-5775-w5k77l/f41bd6c5-fc99-4b7a-8f68-95b7ae4a6b22>
 #   path.exist? #=> false
+#   path.open("w")
+#   "%o" % path.stat.mode #=> "100600" (default permission 0600)
+# @example Touch a temporary file
+#   path = Temppath.touch
+#   path.file? #=> true
+#   "%o" % path.stat.mode #=> "100600"
+# @example Create a temporary directory
+#   path = Temppath.mkdir
+#   path.directory? #=> true
+#   "%o" % path.stat.mode #=> "40700"
 module Temppath
+  # OriginalMethodHolder keeps some original methods of Pathname.
+  module OriginalMethodHolder
+    # @api private
+    def self.extended(obj)
+      # keep original methods
+      obj.instance_exec do
+        class << self
+          alias :orig_open :open
+          alias :orig_mkdir :mkdir
+          alias :orig_mkpath :mkpath
+          alias :orig_sysopen :sysopen
+        end
+      end
+    end
+  end
+
+  # SecurePermissionMethods provides some Pathname methods with secure default
+  # permission.
+  module SecurePermissionMethods
+    # Open file with permission 0600 by default. Otherwise, this is same as
+    # Pathname#open.
+    def open(*args, &b)
+      args[1] = 0600 unless args[1]
+      orig_open(*args, &b)
+    end
+
+    # Make a directory with permission 0700 by defautl. Otherwise, this is same
+    # as Pathname#mkdir.
+    def mkdir(*args)
+      args[0] = 0700 unless args[0]
+      orig_mkdir(*args)
+    end
+
+    # Make paths with permission 0700 by defautl. Otherwise, this is same as
+    # Pathname#mkpath.
+    def mkpath(*args)
+      args[0] = {} unless args[0]
+      args[0] = args[0].merge(mode: 0700) unless args[0][:mode]
+      FileUtils.mkpath(self.to_s, *args)
+    end
+
+    # Open file with permission 0600 by default. Otherwise, this is same as
+    # Pathname#sysopen.
+    def sysopen(*args)
+      args[1] = 0600 unless args[1]
+      orig_sysopen(*args)
+    end
+  end
+
   class << self
     # @return [Pathname]
-    #   defalut temporary directory for paths created by Temppath
-    attr_reader :dir
+    #   defalut base directory for paths created by Temppath
+    attr_reader :basedir
 
     # @return [Boolean]
     #   true if unlink mode is enabled
@@ -24,42 +83,63 @@ module Temppath
 
     # Create a temporary path. This method creates no files.
     #
-    # @param basename [String]
+    # @param option [Hash]
+    # @option option [String] :basename
     #   prefix of filename
-    # @param tmpdir [Pathname]
-    #   pathname of temporary directory
-    def create(basename="", tmpdir=dir)
-      path = Pathname.new(tmpdir) + (basename.to_s + generate_uuid)
-      if tmpdir != dir
+    # @option option [Pathname] :basedir
+    #   pathname of base directory
+    def create(option={})
+      basename = option[:basename] || ""
+      _basedir = option[:basedir] || basedir
+      path = Pathname.new(_basedir) + (basename.to_s + generate_uuid)
+      path.extend OriginalMethodHolder
+      path.extend SecurePermissionMethods
+      if _basedir != basedir
         Kernel.at_exit {FileUtils.remove_entry_secure(path) rescue Errno::ENOENT}
       end
       return path
     end
 
-    # Remove curren temporary directory and create a new temporary directory and
+    # Create a temporary directory.
+    def mkdir(option={})
+      mode = option[:mode] || 0700
+      path = create(option)
+      path.mkdir(mode)
+      return path
+    end
+
+    # Create a empty file.
+    def touch(option={})
+      mode = option[:mode] || 0600
+      path = create(option)
+      path.open("w", mode)
+      return path
+    end
+
+    # Remove current base directory, create a new base directory, and
     # use it.
     #
     # @return [Pathname]
-    #   new temporary directory
-    def update_tempdir
-      remove_tempdir
-      @dir = create_tempdir
+    #   new base directory
+    def update_basedir
+      remove_basedir
+      @basedir = create_basedir
     end
 
     # Remove current temporary directory.
     #
     # @return [void]
-    def remove_tempdir
-      FileUtils.remove_entry_secure(@dir) if @dir.exist?
+    def remove_basedir
+      FileUtils.remove_entry_secure(@basedir) if @basedir.exist?
     end
 
     private
 
-    # Create a new temporary directory.
+    # Create a new base directory.
     #
     # @return [Pathname]
-    #   temporary directory
-    def create_tempdir
+    #   base directory
+    def create_basedir
       Pathname.new(Dir.mktmpdir("ruby-temppath-"))
     end
 
@@ -72,13 +152,13 @@ module Temppath
     end
   end
 
-  @dir = create_tempdir
+  @basedir = create_basedir
   @unlink = true
 end
 
 # Remove Temppath's temporary directory.
 Kernel.at_exit do
   if Temppath.unlink
-    Temppath.remove_tempdir rescue Errno::ENOENT
+    Temppath.remove_basedir rescue Errno::ENOENT
   end
 end

data/lib/temppath/version.rb

@@ -1,4 +1,4 @@
 module Temppath
   # version of temppath gem
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/spec_temppath.rb

@@ -1,9 +1,8 @@
-require 'simplecov'
 require 'temppath'
 
 describe 'Temppath' do
   before do
-    Temppath.update_tempdir
+    Temppath.update_basedir
   end
 
   it 'should get temporary path' do
@@ -12,28 +11,28 @@ describe 'Temppath' do
   end
 
   it 'should get temporary path with basename' do
-    Temppath.create("A_").basename.to_s[0,2].should == "A_"
+    Temppath.create(basename: "A_").basename.to_s[0,2].should == "A_"
   end
 
-  it 'should get temporary path with tmpdir' do
-    dir = Dir.tmpdir
-    Temppath.create(nil, dir).dirname.should == Pathname.new(dir)
+  it 'should get base directory path with basedir' do
+    dir = Dir.mktmpdir
+    Temppath.create(basedir: dir).dirname.should == Pathname.new(dir)
   end
 
-  it 'should be in the temporary directory' do
-    Temppath.create.dirname.should == Temppath.dir
+  it 'should be in the base directory' do
+    Temppath.create.dirname.should == Temppath.basedir
   end
 
-  it 'should update current temporary directory' do
-    old_dir = Temppath.dir
-    new_dir = Temppath.update_tempdir
+  it 'should update current base directory' do
+    old_dir = Temppath.basedir
+    new_dir = Temppath.update_basedir
     old_dir.should != new_dir
     old_dir.should.not.exist
   end
 
-  it 'should remove current temporary directory' do
-    dir = Temppath.dir
-    Temppath.remove_tempdir
+  it 'should remove current base directory' do
+    dir = Temppath.basedir
+    Temppath.remove_basedir
     dir.should.not.exist
   end
 
@@ -46,4 +45,64 @@ describe 'Temppath' do
     Temppath.unlink.should == false
     Temppath.unlink = true
   end
+
+  it 'should create a file with permission 0600 by default' do
+    path = Temppath.create
+    path.open("w")
+    ("%o" % path.stat.mode).should == "100600"
+  end
+
+  it 'should create a file with permission 0644 explicitly' do
+    path = Temppath.create
+    path.open("w", 0644)
+    ("%o" % path.stat.mode).should == "100644"
+  end
+
+  it 'should create a directory with permission 0700 by default' do
+    path = Temppath.create
+    path.mkdir
+    ("%o" % path.stat.mode).should == "40700"
+  end
+
+  it 'should create a directory with permission 0755 explicitly' do
+    path = Temppath.create
+    path.mkdir(0755)
+    ("%o" % path.stat.mode).should == "40755"
+  end
+
+  it 'should do mkpath with permission 0700 by default' do
+    path = Temppath.create
+    path.mkpath
+    ("%o" % path.stat.mode).should == "40700"
+  end
+
+  it 'should do mkpath with permission 0755 explicitly' do
+    path = Temppath.create
+    path.mkpath(mode: 0755)
+    ("%o" % path.stat.mode).should == "40755"
+  end
+
+  it 'should do sysopen with permission 0600 by default' do
+    path = Temppath.create
+    path.sysopen("w")
+    ("%o" % path.stat.mode).should == "100600"
+  end
+
+  it 'should do sysopen with permission 0644 explicitly' do
+    path = Temppath.create
+    path.sysopen("w", 0644)
+    ("%o" % path.stat.mode).should == "100644"
+  end
+
+  it 'should make a directory' do
+    path = Temppath.mkdir
+    path.should.directory
+    ("%o" % path.stat.mode).should == "40700"
+  end
+
+  it 'should touch a file' do
+    path = Temppath.touch
+    path.should.file
+    ("%o" % path.stat.mode).should == "100600"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: temppath
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-03 00:00:00.000000000 Z
+date: 2013-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -121,12 +121,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3285866796712180964
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3285866796712180964
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25