facets 2.1.3 → 2.2.0

data/lib/core/facets/string/interpolate.rb

@@ -1,70 +1,35 @@
-# TITLE:
-#
-#   String Interpolation
-#
-# SUMMARY:
-#
-#   Provides a method of extenally using
-#   Ruby string interpolation mechinism.
-#
-#   This library also providea a couple
-#   aliases for % as sprintf and format.
-#
-# CREDIT:
-#
-#   - Thomas Sawyer
-#
-# TODO:
-#
-#   - The String::format and String::sprintf methods
-#     really not very useful and will likely be
-#     deprecated eventually, since they are already
-#     included in Kernel.
-
-#
 class String
 
-  # Interpolate.
-
-  def self.interpolate(&str)
-    eval "%{#{str.call}}", str.binding
-  end
+  class << self
+
+    # Interpolate. Provides a means of extenally using
+    # Ruby string interpolation mechinism.
+    #
+    #   try = "hello"
+    #   str = "\#{try}!!!"
+    #   String.interpolate{ str }    #=> "hello!!!"
+    #
+    #   NOTE: The block neccessary in order to get
+    #         then binding of the caller.
+    #
+    #   CREDIT: Trans
+
+    def interpolate(&str)
+      eval "%{#{str.call}}", str.binding
+    end
 
-  #
+    # Module method tied to Kernel#format.
+    public :format
 
-  def self.format(*args)
-    Kernel.format(*args)
-  end
+    # Module method tied to Kernel#sprintf.
+    public :sprintf
 
-  def self.sprintf(*args)
-    Kernel.format(*args)
   end
 
-  #
-
+  # Alias for % as format.
   alias_method :format, :%
 
+  # Alias for % as sprintf.
   alias_method :sprintf, :%
-end
-
 
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringInterpolate < Test::Unit::TestCase
-
-    def test_interpolate
-      a = 1
-      assert_equal('this is 1', String.interpolate{ 'this is #{a}' })
-    end
-
-  end
-
-=end
+end

data/lib/core/facets/string/natcmp.rb

@@ -1,17 +1,3 @@
-# TITLE:
-#
-#   String Natural Comparison
-#
-# SUMMARY:
-#
-#   String comparison extensions.
-#
-# AUTHORS:
-#
-#   - Alan Davies
-#   - Martin Pool
-
-#
 class String
 
   # 'Natural order' comparison of strings, e.g.
@@ -24,6 +10,11 @@ class String
   #
   #   "Hello.10".natcmp("Hello.1")  #=> -1
   #
+  #   TODO: Invert case flag?
+  #
+  #   CREDIT: Alan Davies
+  #   CREDIT: Martin Pool
+  #
   #--
   # Adapted from:
   #
@@ -95,28 +86,3 @@ class String
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringCompare < Test::Unit::TestCase
-
-    def test_natcmp
-      assert( -1, "my_prog_v1.1.0".natcmp("my_prog_v1.2.0") )
-      assert( -1, "my_prog_v1.2.0".natcmp("my_prog_v1.10.0") )
-      assert( 1, "my_prog_v1.2.0".natcmp("my_prog_v1.1.0") )
-      assert( 1, "my_prog_v1.10.0".natcmp("my_prog_v1.2.0") )
-      assert( 0, "my_prog_v1.0.0".natcmp("my_prog_v1.0.0") )
-    end
-
-  end
-
-=end

data/lib/core/facets/string/nchar.rb

@@ -1,27 +1,25 @@
-# TITLE:
-#
-#   String NChar
-#
-# SUMMARY:
-#
-#   String extensions for accessing and manipulating
-#   a front or end number of characters.
-#
-# AUTHORS:
-#
-#   - Thomas Sawyer
-
-#
 class String
 
-  # CREDIT Lucas Carlson and Blaine Cook
-
+  # Does a string start with the given prefix.
   #
+  #   "hello".starts_with?("he")    #=> true
+  #   "hello".starts_with?("to")    #=> false
+  #
+  #   CREDIT: Lucas Carlson
+  #   CREDIT: Blaine Cook
+
   def starts_with?(prefix)
     self.index(prefix) == 0
   end
 
+  # Does a string end with the given suffix?
   #
+  #   "hello".ends_with?("lo")    #=> true
+  #   "hello".ends_with?("to")    #=> false
+  #
+  #   CREDIT: Lucas Carlson
+  #   CREDIT: Blaine Cook
+
   def ends_with?(suffix)
     self.rindex(suffix) == size - suffix.size
   end
@@ -33,6 +31,13 @@ class String
   # Alternatively a replacement string can be given, which will
   # replace the _n_ characters.
   #
+  #    str = "this is text"
+  #    str.nchar(4)            #=> "this"
+  #    str.nchar(4, 'that')    #=> "that"
+  #    str                     #=> "that is text"
+  #
+  #   CREDIT: ?
+
   def nchar(n, replacement=nil)
     if replacement
       s = self.dup
@@ -43,15 +48,13 @@ class String
     end
   end
 
+  # Left chomp.
   #
-  def lchomp!(match)
-    if index(match) == 0
-      self[0...match.size] = ''
-      self
-    end
-  end
-
+  #   "help".lchomp("h")  #=> "elp"
+  #   "help".lchomp("k")  #=> "help"
   #
+  #   CREDIT: Trans
+
   def lchomp(match)
     if index(match) == 0
       self[match.size..-1]
@@ -60,29 +63,18 @@ class String
     end
   end
 
-end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringIndex < Test::Unit::TestCase
+  # In-place left chomp.
+  #
+  #   "help".lchomp("h")  #=> "elp"
+  #   "help".lchomp("k")  #=> "help"
+  #
+  #   CREDIT: Trans
 
-    def test_nchar
-      assert_equal( "abc", "abcxyz".nchar(3) )
-      assert_equal( "xyz", "abcxyz".nchar(-3) )
-      assert_equal( "HIxyz", "abcxyz".nchar(3, 'HI') )
-      assert_equal( "abcHI", "abcxyz".nchar(-3, 'HI') )
+  def lchomp!(match)
+    if index(match) == 0
+      self[0...match.size] = ''
+      self
     end
-
   end
 
-=end
+end

data/lib/core/facets/string/op.rb

@@ -0,0 +1,13 @@
+class String
+
+  # Removes occurances of a string or regexp.
+  #
+  #   "HELLO HELLO" - "LL"    #=> "HEO HEO"
+  #
+  #   CREDIT: Benjamin David Oakes
+
+  def -(pattern)
+    self.gsub(pattern, '')
+  end
+
+end

data/lib/core/facets/string/partitions.rb

@@ -1,62 +1,62 @@
-# TITLE:
-#
-#   String Enumeration Extensions
-#
-# SUMMARY:
-#
-#   String extensions providing common enumerations.
-#
-# CREDIT:
-#
-#   - Thomas Sawyer
-
-#
 class String
 
-  # Upacks string into bytes.
-  #
-  def bytes
-    self.unpack('C*')
+  unless (RUBY_VERSION[0,3] == '1.9')
+
+    # Upacks string into bytes.
+    #
+    #
+
+    def bytes
+      self.unpack('C*')
+    end
+
+    # Returns an array of characters.
+    #
+    #   "abc\n123".lines  #=> ["abc","123"]
+
+    def lines
+      self.split(/\n/)
+    end
+
+    # Iterates through each character. This is a little faster than
+    # using #chars b/c it does not create the intermediate array.
+    #
+    #    a = ''
+    #   "HELLO".each_character{ |c| a << #{c.downcase} }
+    #    a  #=> 'hello'
+
+    def each_char  # :yield:
+      size.times do |i|
+        yield(self[i,1])
+      end
+    end
+
   end
 
+  # Alias for each_char.
+
+  alias_method :each_character, :each_char
+
   # Returns an array of characters.
   #
   #   "abc".chars  #=> ["a","b","c"]
-  #
+
   def chars
     self.split(//)
   end
 
-  # Returns an array of characters.
-  #
-  #   "abc\n123".lines  #=> ["abc","123"]
-  #
-  def lines
-    self.split(/\n/)
-  end
-
   # Returns an array of characters.
   #
   #   "abc 123".words  #=> ["abc","123"]
-  #
+
   def words
     self.split(/\s+/)
   end
 
-  # Iterates through each character.
-  #
-  def each_character  # :yield:
-    split(//).each { |c|
-      yield( c )
-    }
-  end
-
-  alias :each_char :each_character
-
   # Iterate through each word of a string.
   #
   #   "a string".each_word { |word, range| ... }
-  #
+
   def each_word( &yld )
     rest_of_string = self
     wordfind = /([-'\w]+)/
@@ -76,64 +76,3 @@ class String
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringPartitions < Test::Unit::TestCase
-
-    def test_bytes
-      s = "abc"
-      assert_equal( s.unpack('C*'), s.bytes )
-    end
-
-    def test_chars
-      assert_equal( ["a","b","c"], "abc".chars )
-      assert_equal( ["a","b","\n","c"], "ab\nc".chars )
-    end
-
-    def test_lines
-      assert_equal( ['a','b','c'], "a\nb\nc".lines )
-    end
-
-    def test_words_01
-      x = "a b c\nd e"
-      assert_equal( ['a','b','c','d','e'], x.words )
-    end
-
-    def test_words_02
-      x = "ab cd\nef"
-      assert_equal( ['ab','cd','ef'], x.words )
-    end
-
-    def test_words_03
-      x = "ab cd \n ef-gh"
-      assert_equal( ['ab','cd','ef-gh'], x.words )
-    end
-
-    def test_each_char
-      a = []
-      i = "this"
-      i.each_char{ |w| a << w }
-      assert_equal( ['t', 'h', 'i', 's'], a )
-    end
-
-    def test_each_word
-      a = []
-      i = "this is a test"
-      i.each_word{ |w| a << w }
-      assert_equal( ['this', 'is', 'a', 'test'], a )
-    end
-
-  end
-
-=end