facets 0.9.0 → 1.0.0

data/lib/facet/file/self/read_list.rb

@@ -1 +1,47 @@
-require 'nano/file/self/read_list.rb'
+
+# Reads in a file, removes blank lines and remarks
+# (lines starting with '#') and then returns
+# an array of all the remaining lines.
+#
+def File.read_list(filepath, chomp_string='')
+  farr = nil
+  farr = File.read(filepath).split("\n")
+  farr.collect! { |line|
+    l = line.strip.chomp(chomp_string)
+    (l.empty? or l[0,1] == '#') ? nil : l
+  }
+  farr.compact
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  # FIND TEST DIRECTORY
+  paths = File.expand_path(File.dirname(__FILE__)).split('/')
+  paths.size.downto(1) do |i|
+    f = (paths.slice(0..i)+['test']).join('/')
+    $TESTDIR = File.join(f,'FIXTURE') if File.directory?(f)
+  end
+  raise unless $TESTDIR
+
+  class TC_READ_LIST < Test::Unit::TestCase
+
+    def test_read_list
+      f = File.join( $TESTDIR, 'read_list_file' )
+      s = File.read_list( f )
+      r = ['A','B','C']
+      assert_equal( r, s )
+    end
+
+  end
+
+=end

data/lib/facet/file/self/sanitize.rb

@@ -1 +1,50 @@
-require 'nano/file/self/sanitize.rb'
+
+# Cleans up a filename to ensure it will work on filesystem.
+def File.sanitize(filename)
+  filename = File.basename(filename.gsub("\\", "/")) # work-around for IE
+  filename.gsub!(/[^a-zA-Z0-9\.\-\+_]/,"_")
+  filename = "_#{filename}" if filename =~ /^\.+$/
+  filename
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+=begin test
+
+  require 'test/unit'
+
+  class TCFile < Test::Unit::TestCase
+
+    def test_01_001
+      assert_equal( "This_is_a_test", File.sanitize('This is a test') )
+    end
+
+    def test_01_001
+      assert_equal( "test", File.sanitize('This\is\test') )
+    end
+
+    def test_01_001
+      assert_equal( "test", File.sanitize('This/is/test') )
+    end
+
+    def test_01_001
+      assert_equal( "te_____st", File.sanitize('This/te#$#@!st') )
+    end
+
+    def test_01_001
+      assert_equal( "_.", File.sanitize('.') )
+    end
+
+    def test_01_001
+      assert_equal( "_....", File.sanitize('....') )
+    end
+
+  end
+
+=end

data/lib/facet/file/self/split_all.rb

@@ -1 +1,36 @@
-require 'nano/file/self/split_all.rb'
+
+# Splits a file path into an array of individual path components.
+# This differs from <tt>File.split</tt>, which divides the path into
+# only two parts, directory path and basename.
+#
+#   split_all("a/b/c") =>  ['a', 'b', 'c']
+#
+def File.split_all(path)
+  head, tail = File.split(path)
+  return [tail] if head == '.' || tail == '/'
+  return [head, tail] if head == '/'
+  return split_all(head) + [tail]
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCFile < Test::Unit::TestCase
+
+    def test_split_all
+      fp = "this/is/test"
+      assert_equal( ['this', 'is', 'test'], File.split_all(fp) )
+    end
+
+  end
+
+=end

data/lib/facet/fileutils.rb

@@ -1 +0,0 @@
-require 'nano/fileutils.rb'

data/lib/facet/fileutils/head.rb

@@ -1 +1,2 @@
-require 'nano/fileutils/head.rb'
+# stub
+require 'facet/fileutils/slice'

data/lib/facet/fileutils/safe_ln.rb

@@ -1 +1,38 @@
-require 'nano/fileutils/safe_ln.rb'
+#--
+# Credit goes to Jim Weirich
+#++
+
+require 'fileutils'
+
+module FileUtils
+
+  module_function
+
+  LINKING_SUPPORTED = [true]
+
+  # Attempt to do a normal file link, but fall back
+  # to a copy if the link fails.
+  def safe_ln(*args)
+    unless LINKING_SUPPORTED[0]
+      cp(*args)
+    else
+      begin
+        ln(*args)
+      rescue Errno::EOPNOTSUPP
+        LINKING_SUPPORTED[0] = false
+        cp(*args)
+      end
+    end
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+# TODO

data/lib/facet/fileutils/slice.rb

@@ -1 +1,152 @@
-require 'nano/fileutils/slice.rb'
+
+require 'fileutils'
+
+module FileUtils
+
+  module_function
+
+  # In block form, yields the first number of ((*lines*)) of file ((*filename*)).
+  # In non-block form, it returns an array of the first number of ((*lines*)).
+  #
+  #   # Returns first 10 lines of 'myfile'
+  #   FileUtils.head("myfile")
+  #
+  def head(filename,lines=10) #:yield:
+    a = []
+    IO.foreach(filename){|line|
+        break if lines <= 0
+        lines -= 1
+        if block_given?
+          yield line
+        else
+          a << line
+        end
+    }
+    return a.empty? ? nil : a
+  end
+
+  # In block form, yields the last number of ((*lines*)) of file ((*filename*)).
+  # In non-block form, it returns the lines as an array.
+  #
+  # Note that this method slurps the entire file, so I don't recommend it
+  # for very large files.  If you want an advanced form of ((*tail*)), I
+  # suggest using file-tail, by Florian Frank (available on the RAA).
+  # And no tail -f.
+  #
+  #   # Returns last 3 lines of 'myfile'
+  #   FileUtils.tail("myfile",3)
+  #
+  def tail(filename,lines=10) #:yield
+    IO.readlines(filename).reverse[0..lines-1].reverse
+  end
+
+  # In block form, yields lines ((*from*))-((*to*)).  In non-block form,
+  # returns an array of lines ((*from*))-((*to*)).
+  #
+  #   # Returns lines 8-12 of 'myfile'
+  #   FileUtils.body("myfile",8,12)
+  #
+  #--
+  # Credit goes to Shashank Date, via Daniel Berger.
+  #++
+  def slice(filename,from,to) #:yield:
+    IO.readlines(filename)[from-1..to-1]
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+# TODO This test have been remarked out until such time
+#      as a mock FileSystem can be used to test it against.
+
+=begin #test
+
+  require 'test/unit'
+
+  # FIND TEST DIRECTORY
+  paths = File.expand_path(File.dirname(__FILE__)).split('/')
+  paths.size.downto(1) do |i|
+    f = (paths.slice(0..i)+['test']).join('/')
+    $TESTDIR = File.join(f,'FIXTURE') if File.directory?(f)
+  end
+  raise unless $TESTDIR
+
+  class TC_FileUtils_HeadTail < Test::Unit::TestCase
+
+    def setup
+      @workdir = Dir.getwd
+      @thisdir = $TESTDIR
+
+      @tfile = 'test_file.txt'
+
+      @expected_head1 = ["line1\n","line2\n","line3\n","line4\n","line5\n"]
+      @expected_head1.push("line6\n","line7\n","line8\n","line9\n","line10\n")
+      @expected_head2 = ["line1\n","line2\n","line3\n","line4\n","line5\n"]
+
+      @expected_tail1 = ["line16\n","line17\n","line18\n","line19\n","line20\n"]
+      @expected_tail1.push("line21\n","line22\n","line23\n","line24\n","line25\n")
+      @expected_tail2 = ["line21\n","line22\n","line23\n","line24\n","line25\n"]
+
+      @expected_body1 = ["line10\n", "line11\n", "line12\n", "line13\n", "line14\n"]
+      @expected_body1.push("line15\n","line16\n", "line17\n", "line18\n", "line19\n","line20\n")
+      @expected_body2 = ["line14\n","line15\n","line16\n","line17\n","line18\n","line19\n","line20\n"]
+      @expected_body3 = ["line5\n","line6\n","line7\n","line8\n","line9\n","line10\n"]
+    end
+
+    def test_method
+      assert_respond_to( FileUtils, :head )
+      assert_respond_to( FileUtils, :tail )
+      assert_respond_to( FileUtils, :slice )
+    end
+
+    # head
+
+    def test_head
+      Dir.chdir @thisdir
+      begin
+      assert_nothing_raised{ FileUtils.head(@tfile) }
+      assert_nothing_raised{ FileUtils.head(@tfile,5) }
+      assert_equal(@expected_head1,FileUtils.head(@tfile))
+      assert_equal(@expected_head2,FileUtils.head(@tfile,5))
+      ensure
+        Dir.chdir @workdir
+      end
+    end
+
+    # slice
+
+    def test_slice
+      Dir.chdir @thisdir
+      begin
+        assert_nothing_raised{ FileUtils.slice(@tfile,5,10) }
+        assert_equal(@expected_body3,FileUtils.slice(@tfile,5,10))
+      ensure
+        Dir.chdir @workdir
+      end
+    end
+
+    # tail
+
+    def test_tail
+      Dir.chdir @thisdir
+      begin
+        assert_nothing_raised{ FileUtils.tail(@tfile) }
+        assert_nothing_raised{ FileUtils.tail(@tfile,5) }
+        assert_equal(@expected_tail1,FileUtils.tail(@tfile))
+        assert_equal(@expected_tail2,FileUtils.tail(@tfile,5))
+      ensure
+        Dir.chdir @workdir
+      end
+    end
+
+  end
+
+=end

data/lib/facet/fileutils/split_all.rb

@@ -1 +1,29 @@
-require 'nano/fileutils/split_all.rb'
+
+module FileUtils
+
+  module_function
+
+  # Splits a file path into an array of individual path components.
+  # This differs from <tt>File.split</tt>, which divides the path into
+  # only two parts, directory path and basename.
+  #
+  #   split_all("a/b/c") =>  ['a', 'b', 'c']
+  #
+  def split_all(path)
+    head, tail = File.split(path)
+    return [tail] if head == '.' || tail == '/'
+    return [head, tail] if head == '/'
+    return split_all(head) + [tail]
+  end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+# TODO
+

data/lib/facet/fileutils/tail.rb

@@ -1 +1,2 @@
-require 'nano/fileutils/tail.rb'
+# stub
+require 'facet/fileutils/slice'

data/lib/facet/fileutils/wc.rb

@@ -1 +1,128 @@
-require 'nano/fileutils/wc.rb'
+#--
+# Credit goes to Daniel J. Berger.
+#++
+require 'fileutils'
+
+module FileUtils
+
+  module_function
+
+  # With no arguments, returns a four element array consisting of the number
+  # of bytes, characters, words and lines in _filename_, respectively.
+  #
+  # Valid options are <tt>bytes</tt>, <tt>characters</tt> (or just 'chars'),
+  # <tt>words</tt> and <tt>lines</tt>.
+  #
+  #   # Return the number of words in 'myfile'
+  #   FileUtils.wc("myfile",'words')  
+  #
+  def wc(filename,option='all')
+    option.downcase!
+    valid = %w/all bytes characters chars lines words/
+
+    unless valid.include?(option)
+        raise "Invalid option: '#{option}'"
+    end
+
+    n = 0
+    if option == 'lines'
+        IO.foreach(filename){ n += 1 }
+        return n
+    elsif option == 'bytes'
+        File.open(filename){ |f|
+          f.each_byte{ n += 1 }
+        }
+        return n
+    elsif option == 'characters' || option == 'chars'
+        File.open(filename){ |f|
+          while f.getc
+              n += 1
+          end
+        }
+        return n
+    elsif option == 'words'
+        IO.foreach(filename){ |line|
+          n += line.split.length
+        }
+        return n
+    else
+        bytes,chars,lines,words = 0,0,0,0
+        IO.foreach(filename){ |line|
+          lines += 1
+          words += line.split.length
+          chars += line.split('').length
+        }
+        File.open(filename){ |f|
+          while f.getc
+              bytes += 1
+          end
+        }
+        return [bytes,chars,words,lines]
+    end
+  end # def
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  # FIND TEST DIRECTORY
+  paths = File.expand_path(File.dirname(__FILE__)).split('/')
+  paths.size.downto(1) do |i|
+    f = (paths.slice(0..i)+['test']).join('/')
+    $TESTDIR = File.join(f,'FIXTURE') if File.directory?(f)
+  end
+  raise unless $TESTDIR
+
+  class TC_FileUtils_WC < Test::Unit::TestCase
+
+    def setup
+      @workdir = Dir.getwd
+      @thisdir = $TESTDIR
+
+      @file = 'test_file.txt'
+    end
+
+    def test_method
+      assert_respond_to( FileUtils, :wc )
+    end
+
+    def test_wc
+      Dir.chdir @thisdir
+      begin
+        assert_nothing_raised{ FileUtils.wc(@file) }
+        assert_nothing_raised{ FileUtils.wc(@file,'bytes') }
+        assert_nothing_raised{ FileUtils.wc(@file,'chars') }
+        assert_nothing_raised{ FileUtils.wc(@file,'words') }
+        assert_nothing_raised{ FileUtils.wc(@file,'lines') }
+        assert_raises(RuntimeError){ FileUtils.wc(@file,'bogus') }
+      ensure
+        Dir.chdir @workdir
+      end
+    end
+
+    def test_wc_results
+      Dir.chdir @thisdir
+      begin
+        assert_equal([166,166,25,25],FileUtils.wc(@file))
+        assert_equal(166,FileUtils.wc(@file,'bytes'),"Wrong number of bytes")
+        assert_equal(166,FileUtils.wc(@file,'chars'),"Wrong number of chars")
+        assert_equal(25,FileUtils.wc(@file,'words'),"Wrong number of words")
+        assert_equal(25,FileUtils.wc(@file,'lines'),"Wrong number of lines")
+      ensure
+        Dir.chdir @workdir
+      end
+    end
+
+  end
+
+=end