rubysl-ftools 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74b4dfc8ddaf27b36022f78e7253893aa3f6a700
+  data.tar.gz: e5e8f66accf3b1610355fcf5c1bb1f612a5f1558
+SHA512:
+  metadata.gz: 3d45833925ee35c79188d5e4af0a9b360fa01048dc36f423d8efecbf1995eec9b8739d1be524b2b0f81fc2f8786b8868488e20d80c5f27a48e039099258973ec
+  data.tar.gz: 2ddf2e33d6d8dcb34d4f5a6da6ac99f8b63226d8cb84c43c335480396904f526b72f0dd33b4dba7aa6b3753848f27c7f29592989a514dd1014cadf63f331cf78

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+env:
+  - RUBYLIB=lib
+script: bundle exec mspec
+rvm:
+  - 1.8.7
+  - rbx-nightly-18mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubysl-ftools.gemspec
+gemspec

data/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.

data/README.md

@@ -0,0 +1,29 @@
+# Rubysl::Ftools
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubysl-ftools'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubysl-ftools
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/ftools.rb

@@ -0,0 +1 @@
+require "rubysl/ftools"

data/lib/rubysl/ftools.rb

@@ -0,0 +1,2 @@
+require "rubysl/ftools/ftools"
+require "rubysl/ftools/version"

data/lib/rubysl/ftools/ftools.rb

@@ -0,0 +1,261 @@
+# 
+# = ftools.rb: Extra tools for the File class
+#
+# Author:: WATANABE, Hirofumi
+# Documentation:: Zachary Landau
+#
+# This library can be distributed under the terms of the Ruby license.
+# You can freely distribute/modify this library.
+#
+# It is included in the Ruby standard library.
+#
+# == Description
+#
+# ftools adds several (class, not instance) methods to the File class, for
+# copying, moving, deleting, installing, and comparing files, as well as
+# creating a directory path.  See the File class for details.
+#
+# FileUtils contains all or nearly all the same functionality and more, and
+# is a recommended option over ftools 
+#
+# When you
+#
+#   require 'ftools'
+#
+# then the File class aquires some utility methods for copying, moving, and
+# deleting files, and more.
+#
+# See the method descriptions below, and consider using FileUtils as it is
+# more comprehensive.
+#
+class File
+end
+
+class << File
+
+  BUFSIZE = 8 * 1024
+
+  #
+  # If +to+ is a valid directory, +from+ will be appended to +to+, adding
+  # and escaping backslashes as necessary. Otherwise, +to+ will be returned.
+  # Useful for appending +from+ to +to+ only if the filename was not specified
+  # in +to+. 
+  #
+  def catname(from, to)
+    if directory? to
+      join to.sub(%r([/\\]$), ''), basename(from)
+    else
+      to
+    end
+  end
+
+  #
+  # Copies a file +from+ to +to+. If +to+ is a directory, copies +from+
+  # to <tt>to/from</tt>.
+  #
+  def syscopy(from, to)
+    to = catname(from, to)
+
+    fmode = stat(from).mode
+    tpath = to
+    not_exist = !exist?(tpath)
+
+    from = open(from, "rb")
+    to = open(to, "wb")
+
+    begin
+      while true
+	to.syswrite from.sysread(BUFSIZE)
+      end
+    rescue EOFError
+      ret = true
+    rescue
+      ret = false
+    ensure
+      to.close
+      from.close
+    end
+    chmod(fmode, tpath) if not_exist
+    ret
+  end
+
+  #
+  # Copies a file +from+ to +to+ using #syscopy. If +to+ is a directory,
+  # copies +from+ to <tt>to/from</tt>. If +verbose+ is true, <tt>from -> to</tt>
+  # is printed.
+  #
+  def copy(from, to, verbose = false)
+    $stderr.print from, " -> ", catname(from, to), "\n" if verbose
+    syscopy from, to
+  end
+
+  alias cp copy
+
+  #
+  # Moves a file +from+ to +to+ using #syscopy. If +to+ is a directory,
+  # copies from +from+ to <tt>to/from</tt>. If +verbose+ is true, <tt>from ->
+  # to</tt> is printed.
+  #
+  def move(from, to, verbose = false)
+    to = catname(from, to)
+    $stderr.print from, " -> ", to, "\n" if verbose
+
+    if RUBY_PLATFORM =~ /djgpp|(cyg|ms|bcc)win|mingw/ and file? to
+      unlink to
+    end
+    fstat = stat(from)
+    begin
+      rename from, to
+    rescue
+      begin
+        symlink readlink(from), to and unlink from
+      rescue
+	from_stat = stat(from)
+	syscopy from, to and unlink from
+	utime(from_stat.atime, from_stat.mtime, to)
+	begin
+	  chown(fstat.uid, fstat.gid, to)
+	rescue
+	end
+      end
+    end
+  end
+
+  alias mv move
+
+  #
+  # Returns +true+ if and only if the contents of files +from+ and +to+ are
+  # identical. If +verbose+ is +true+, <tt>from <=> to</tt> is printed.
+  #
+  def compare(from, to, verbose = false)
+    $stderr.print from, " <=> ", to, "\n" if verbose
+
+    return false if stat(from).size != stat(to).size
+
+    from = open(from, "rb")
+    to = open(to, "rb")
+
+    ret = false
+    fr = tr = ''
+
+    begin
+      while fr == tr
+	fr = from.read(BUFSIZE)
+	if fr
+	  tr = to.read(fr.size)
+	else
+	  ret = to.read(BUFSIZE)
+	  ret = !ret || ret.length == 0
+	  break
+	end
+      end
+    rescue
+      ret = false
+    ensure
+      to.close
+      from.close
+    end
+    ret
+  end
+
+  alias cmp compare
+
+  #
+  # Removes a list of files. Each parameter should be the name of the file to
+  # delete. If the last parameter isn't a String, verbose mode will be enabled.
+  # Returns the number of files deleted.
+  #
+  def safe_unlink(*files)
+    verbose = if files[-1].is_a? String then false else files.pop end
+    files.each do |file|
+      begin
+        unlink file
+        $stderr.print "removing ", file, "\n" if verbose
+      rescue Errno::EACCES # for Windows
+        continue if symlink? file
+        begin
+          mode = stat(file).mode
+          o_chmod mode | 0200, file
+          unlink file
+          $stderr.print "removing ", file, "\n" if verbose
+        rescue
+          o_chmod mode, file rescue nil
+        end
+      rescue
+      end
+    end
+  end
+
+  alias rm_f safe_unlink
+
+  #
+  # Creates a directory and all its parent directories.
+  # For example,
+  #
+  #	File.makedirs '/usr/lib/ruby'
+  #
+  # causes the following directories to be made, if they do not exist.
+  #	* /usr
+  #	* /usr/lib
+  #	* /usr/lib/ruby
+  #
+  # You can pass several directories, each as a parameter. If the last
+  # parameter isn't a String, verbose mode will be enabled.
+  #
+  def makedirs(*dirs)
+    verbose = if dirs[-1].is_a? String then false else dirs.pop end
+    mode = 0755
+    for dir in dirs
+      parent = dirname(dir)
+      next if parent == dir or directory? dir
+      makedirs parent unless directory? parent
+      $stderr.print "mkdir ", dir, "\n" if verbose
+      if basename(dir) != ""
+        begin
+          Dir.mkdir dir, mode
+        rescue SystemCallError
+          raise unless directory? dir
+        end
+      end
+    end
+  end
+
+  alias mkpath makedirs
+
+  alias o_chmod chmod
+
+  vsave, $VERBOSE = $VERBOSE, false
+
+  #
+  # Changes permission bits on +files+ to the bit pattern represented
+  # by +mode+. If the last parameter isn't a String, verbose mode will
+  # be enabled.
+  #
+  #   File.chmod 0755, 'somecommand'
+  #   File.chmod 0644, 'my.rb', 'your.rb', true
+  #
+  def chmod(mode, *files)
+    verbose = if files[-1].is_a? String then false else files.pop end
+    $stderr.printf "chmod %04o %s\n", mode, files.join(" ") if verbose
+    o_chmod mode, *files
+  end
+  $VERBOSE = vsave
+
+  #
+  # If +src+ is not the same as +dest+, copies it and changes the permission
+  # mode to +mode+. If +dest+ is a directory, destination is <tt>dest/src</tt>.
+  # If +mode+ is not set, default is used. If +verbose+ is set to true, the
+  # name of each file copied will be printed.
+  #
+  def install(from, to, mode = nil, verbose = false)
+    to = catname(from, to)
+    unless exist? to and cmp from, to
+      safe_unlink to if exist? to
+      cp from, to, verbose
+      chmod mode, to, verbose if mode
+    end
+  end
+
+end
+
+# vi:set sw=2:

data/lib/rubysl/ftools/version.rb

@@ -0,0 +1,5 @@
+module RubySL
+  module FTools
+    VERSION = "1.0.0"
+  end
+end

data/rubysl-ftools.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+require './lib/rubysl/ftools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubysl-ftools"
+  spec.version       = RubySL::FTools::VERSION
+  spec.authors       = ["Brian Shirai"]
+  spec.email         = ["brixen@gmail.com"]
+  spec.description   = %q{Ruby standard library ftools.}
+  spec.summary       = %q{Ruby standard library ftools.}
+  spec.homepage      = "https://github.com/rubysl/rubysl-ftools"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "rubysl-prettyprint", "~> 1.0"
+end

data/spec/catname_spec.rb

@@ -0,0 +1,18 @@
+ruby_version_is ""..."1.9" do
+
+  require 'ftools'
+
+  describe "File.catname" do
+    it "returns the 2nd arg if it's not a directory" do
+      File.catname("blah", "/etc/passwd").should == "/etc/passwd"
+    end
+
+    it "uses File.join with the args" do
+      File.catname("passwd", ".").should == "./passwd"
+    end
+
+    it "uses File.basename on the 1st arg before joining" do
+      File.catname("etc/passwd", ".").should == "./passwd"
+    end
+  end
+end

data/spec/chmod_spec.rb

@@ -0,0 +1,28 @@
+ruby_version_is ""..."1.9" do
+
+  # the tests below are windows-hostile
+  platform_is_not :windows do
+    require 'ftools'
+
+    describe "File.chmod" do
+      before(:each) do
+        (1..2).each do |n|
+          system "echo 'hello rubinius' > chmod_test_#{n}"
+          system "chmod 0777 chmod_test_#{n}"
+        end
+      end
+
+      after(:each) do
+        (1..2).each { |n| File.unlink "chmod_test_#{n}" rescue nil }
+      end
+
+      it "changes the mode to 1st arg for files in 2nd arg" do
+        `ls -l chmod_test_1`.should =~ /^-rwxrwxrwx/
+        `ls -l chmod_test_2`.should =~ /^-rwxrwxrwx/
+        File.chmod 0644, "chmod_test_1", "chmod_test_2"
+        `ls -l chmod_test_1`.should =~ /^-rw-r--r--/
+        `ls -l chmod_test_2`.should =~ /^-rw-r--r--/
+      end
+    end
+  end
+end

data/spec/compare_spec.rb

@@ -0,0 +1,29 @@
+ruby_version_is ""..."1.9" do
+
+  require 'ftools'
+
+  describe "File.compare" do
+    before(:each) do
+      (1..3).to_a.each do |n|
+        if n == 3
+          system "echo 'hello mri' > compare_test_#{n}"
+        else
+          system "echo 'hello rubinius' > compare_test_#{n}"
+        end
+        system "chmod a+x compare_test_#{n}"
+      end
+    end
+
+    after(:each) do
+      (1..3).to_a.each { |n| File.unlink "compare_test_#{n}" }
+    end
+
+    it "compares the file at 1st arg to the file at 2nd arg" do
+      File.compare("compare_test_1", "compare_test_2").should == true
+      File.compare("compare_test_2", "compare_test_1").should == true
+
+      File.compare("compare_test_1", "compare_test_3").should == false
+      File.compare("compare_test_2", "compare_test_3").should == false
+    end
+  end
+end

data/spec/copy_spec.rb

@@ -0,0 +1,33 @@
+ruby_version_is ""..."1.9" do
+
+  require 'ftools'
+
+  describe "File.copy" do
+    before(:each) do
+      File.open('copy_test', 'w+') do |f|
+        f.puts('hello rubinius')
+      end
+      platform_is_not :windows do
+        system "chmod a+x copy_test"
+      end
+    end
+
+    after(:each) do
+      File.unlink "copy_test"
+      File.unlink "copy_test_dest" rescue nil
+    end
+
+    it "copies the file at 1st arg to the file at 2nd arg" do
+      File.copy("copy_test", "copy_test_dest")
+      fd = File.open("copy_test_dest")
+      data = fd.read
+      data.should == "hello rubinius\n"
+      fd.close
+
+      omode = File.stat("copy_test").mode
+      mode = File.stat("copy_test_dest").mode
+
+      omode.should == mode
+    end
+  end
+end

data/spec/install_spec.rb

@@ -0,0 +1,24 @@
+ruby_version_is ""..."1.9" do
+
+  require 'ftools'
+
+  # the tests below are windows-hostile
+  platform_is_not :windows do
+    describe "File.install" do
+      before(:each) do
+        system "echo 'hello rubinius' > install_test_1"
+        system "chmod 0777 install_test_1"
+      end
+
+      after(:each) do
+        (1..2).each { |n| File.unlink "install_test_#{n}" rescue nil }
+      end
+
+      it "changes the mode to 1st arg for files in 2nd arg" do
+        `ls -l install_test_1`.should =~ /^-rwxrwxrwx/
+        File.install "install_test_1", "install_test_2", 0644
+        `ls -l install_test_2`.should =~ /^-rw-r--r--/
+      end
+    end
+  end
+end

data/spec/makedirs_spec.rb

@@ -0,0 +1,23 @@
+ruby_version_is ""..."1.9" do
+
+  require 'ftools'
+
+  describe "File.makedirs" do
+    before :each do
+      @dir = tmp "file_makedirs"
+    end
+
+    after(:each) do
+      rm_r @dir
+    end
+
+    it "creates the dirs from arg" do
+      File.exist?(@dir).should == false
+      File.makedirs("#{@dir}/second_dir")
+      File.exist?(@dir).should == true
+      File.directory?(@dir).should == true
+      File.exist?("#{@dir}/second_dir").should == true
+      File.directory?("#{@dir}/second_dir").should == true
+    end
+  end
+end

data/spec/move_spec.rb

@@ -0,0 +1,32 @@
+ruby_version_is ""..."1.9" do
+
+  require 'ftools'
+
+  describe "File.move" do
+    before(:each) do
+      File.open('move_test', 'w+') do |f|
+        f.puts('hello rubinius')
+      end
+      platform_is_not :windows do
+        system "chmod a+x move_test"
+      end
+    end
+
+    after(:each) do
+      File.unlink "move_test_dest"
+      File.unlink "move_test" rescue nil
+    end
+
+    it "moves the file at 1st arg to the file at 2nd arg" do
+      omode = File.stat("move_test").mode
+      File.move("move_test", "move_test_dest")
+      fd = File.open("move_test_dest")
+      data = fd.read
+      data.should == "hello rubinius\n"
+      fd.close
+      mode = File.stat("move_test_dest").mode
+
+      omode.should == mode
+    end
+  end
+end

data/spec/safe_unlink_spec.rb

@@ -0,0 +1,25 @@
+ruby_version_is ""..."1.9" do
+
+  require 'ftools'
+
+  describe "File.safe_unlink" do
+    before(:each) do
+      (1..2).each do |n|
+        system "echo 'hello rubinius' > safe_unlink_test_#{n}"
+        system "chmod 0777 safe_unlink_test_#{n}"
+      end
+    end
+
+    after(:each) do
+      (1..2).each { |n| File.unlink "safe_unlink_test_#{n}" rescue nil }
+    end
+
+    it "deletes the files in arg and returns an array of files deleted" do
+      File.exist?("safe_unlink_test_1").should == true
+      File.exist?("safe_unlink_test_2").should == true
+      File.safe_unlink("safe_unlink_test_1", "safe_unlink_test_2").should == ["safe_unlink_test_1", "safe_unlink_test_2"]
+      File.exist?("safe_unlink_test_1").should == false
+      File.exist?("safe_unlink_test_2").should == false
+    end
+  end
+end

data/spec/syscopy_spec.rb

@@ -0,0 +1,33 @@
+ruby_version_is ""..."1.9" do
+
+  require 'ftools'
+
+  describe "File.syscopy" do
+    before(:each) do
+      File.open('syscopy_test', 'w+') do |f|
+        f.puts('hello rubinius')
+      end
+      platform_is_not :windows do
+        system "chmod a+x syscopy_test"
+      end
+    end
+
+    after(:each) do
+      File.unlink "syscopy_test"
+      File.unlink "syscopy_test_dest" rescue nil
+    end
+
+    it "copies the file at 1st arg to the file at 2nd arg" do
+      File.syscopy("syscopy_test", "syscopy_test_dest")
+      fd = File.open("syscopy_test_dest")
+      data = fd.read
+      data.should == "hello rubinius\n"
+      fd.close
+
+      omode = File.stat("syscopy_test").mode
+      mode = File.stat("syscopy_test_dest").mode
+
+      omode.should == mode
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rubysl-ftools
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Shirai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: mspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubysl-prettyprint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby standard library ftools.
+email:
+- brixen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ftools.rb
+- lib/rubysl/ftools.rb
+- lib/rubysl/ftools/ftools.rb
+- lib/rubysl/ftools/version.rb
+- rubysl-ftools.gemspec
+- spec/catname_spec.rb
+- spec/chmod_spec.rb
+- spec/compare_spec.rb
+- spec/copy_spec.rb
+- spec/install_spec.rb
+- spec/makedirs_spec.rb
+- spec/move_spec.rb
+- spec/safe_unlink_spec.rb
+- spec/syscopy_spec.rb
+homepage: https://github.com/rubysl/rubysl-ftools
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Ruby standard library ftools.
+test_files:
+- spec/catname_spec.rb
+- spec/chmod_spec.rb
+- spec/compare_spec.rb
+- spec/copy_spec.rb
+- spec/install_spec.rb
+- spec/makedirs_spec.rb
+- spec/move_spec.rb
+- spec/safe_unlink_spec.rb
+- spec/syscopy_spec.rb
+has_rdoc: