facets 2.1.3 → 2.2.0

data/lib/core/facets/string.rb

@@ -16,3 +16,5 @@ require 'facets/string/nchar.rb'
 require 'facets/string/bracket.rb'
 require 'facets/string/case.rb'
 require 'facets/string/natcmp.rb'
+require 'facets/string/op'
+

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

@@ -1,23 +1,27 @@
-# TITLE:
-#
-#   String Alignment Extensions
-#
-# SUMMARY:
-#
-#   String extensions for alignment.
-#
-# CREDIT:
-#
-#   - Thomas Sawyer
-
 class String
 
   # Align a string to the right.
   # The defualt alignment seperation is a new line ("/n")
   # This can be changes as can be the padding string which
   # defaults to a single space (' ').
+  #
+  #   s = <<-EOS
+  #   This is a test
+  #     and
+  #     so on
+  #   EOS
+  #
+  #   puts s.align_right(2)
+  #
+  # _produces_
+  #
+  #     This is a test
+  #                and
+  #              so on
+  #
+  #   CREDIT: Trans
 
-  def align_right( n, sep="\n", c=' ' )
+  def align_right(n, sep="\n", c=' ')
     return rjust(n.to_i,c.to_s) if sep==nil
     q = split(sep.to_s).collect { |line|
       line.rjust(n.to_i,c.to_s)
@@ -26,11 +30,28 @@ class String
   end
 
   # Align a string to the left.
+  #
   # The defualt alignment seperation is a new line ("/n")
   # This can be changes as can be the padding string which
   # defaults to a single space (' ').
+  #
+  #   s = <<-EOS
+  #   This is a test
+  #     and
+  #     so on
+  #   EOS
+  #
+  #   puts s.align_left(2)
+  #
+  # _produces_
+  #
+  #     This is a test
+  #     and
+  #     so on
+  #
+  #   CREDIT: Trans
 
-  def align_left( n, sep="\n", c=' ' )
+  def align_left(n, sep="\n", c=' ')
     return ljust(n.to_i,c.to_s) if sep==nil
     q = split(sep.to_s).collect { |line|
       line.ljust(n.to_i,c.to_s)
@@ -40,11 +61,16 @@ class String
 
   # Centers each line of a string.
   #
+  # The defualt alignment seperation is a new line ("/n")
+  # This can be changed as can be the padding string which
+  # defaults to a single space (' ').
+  #
   #   s = <<-EOS
-  #   This is a test
-  #   and
-  #   so on
+  #     This is a test
+  #     and
+  #     so on
   #   EOS
+  #
   #   puts s.align_center(14)
   #
   # _produces_
@@ -53,12 +79,9 @@ class String
   #        and
   #       so on
   #
-  # Align a string to the center.
-  # The defualt alignment seperation is a new line ("/n")
-  # This can be changed as can be the padding string which
-  # defaults to a single space (' ').
+  #   CREDIT: Trans
 
-  def align_center( n, sep="\n", c=' ' )
+  def align_center(n, sep="\n", c=' ')
     return center(n.to_i,c.to_s) if sep==nil
     q = split(sep.to_s).collect { |line|
       line.center(n.to_i,c.to_s)
@@ -66,37 +89,4 @@ class String
     q.join(sep.to_s)
   end
 
-  # Deprecated alias for #align_center.
-  #alias_method :center_lines, :align_center
 end
-
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringAlign < Test::Unit::TestCase
-
-    def test_align_right
-      assert_equal( "      xxx", "xxx".align_right(9) )
-    end
-
-    def test_align_left
-      assert_equal( "xxx      ", "xxx".align_left(9) )
-    end
-
-    def test_align_center
-      assert_equal( "   xxx   ", "xxx".align_center(9) )
-    end
-
-  end
-
-=end

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

@@ -1,29 +1,11 @@
-# TITLE:
-#
-#   String Blank Extension
-#
-# SUMMARY:
-#
-#   String blank extensions.
-#
-# CREDIT:
-#
-#   - Martin Pool
-#   - Alan Davies
-#   - Derek Lewis
-#   - Peter Vanbroekhoven
-#
-# TODO:
-#
-#   - Does #blank? really belong here?
-
-#
 class String
 
   # Is this string just whitespace?
   #
   #   "abc".blank?  #=> false
   #   "   ".blank?  #=> true
+  #
+  #   CREDIT: ?
 
   def blank?
     self !~ /\S/
@@ -32,29 +14,3 @@ class String
   alias whitespace? blank?
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringBlank < Test::Unit::TestCase
-
-    def test_blank?
-      assert( ! "xyz".blank? )
-      assert( "     ".blank? )
-    end
-
-    def test_whitespace?
-      assert( ! "xyz".whitespace? )
-      assert( "     ".whitespace? )
-    end
-  end
-
-=end

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

@@ -1,16 +1,3 @@
-# TITLE:
-#
-#   String Bracketing Extensoins
-#
-# SUMMARY:
-#
-#   String extension methods which enclose on unenclose a striong.
-#
-# CREDITS:
-#
-#   - Thomas Sawyer
-
-#
 class String
 
   BRA2KET = { '['=>']', '('=>')', '{'=>'}', '<'=>'>' }
@@ -21,6 +8,8 @@ class String
   #
   #   "wrap me".bracket('{')        #=> "{wrap me}"
   #   "wrap me".bracket('--','!')   #=> "--wrap me!"
+  #
+  #   CREDIT: Trans
 
   def bracket(bra, ket=nil)
     #ket = String.bra2ket[$&] if ! ket && /^[\[({<]$/ =~ bra
@@ -29,6 +18,8 @@ class String
   end
 
   # Inplace version of #braket.
+  #
+  #   CREDIT: Trans
 
   def bracket!(bra, ket=nil)
     self.replace(bracket(bra, ket))
@@ -40,6 +31,8 @@ class String
   #
   #   "{unwrap me}".debracket('{')        #=> "unwrap me"
   #   "--unwrap me!".debracket('--','!')  #=> "unwrap me!"
+  #
+  #   CREDIT: Trans
 
   def unbracket(bra=nil, ket=nil)
     if bra
@@ -58,6 +51,8 @@ class String
   end
 
   # Inplace version of #debraket.
+  #
+  #   CREDIT: Trans
 
   def unbracket!(bra=nil, ket=nil)
     self.replace( unbracket(bra, ket) )
@@ -68,6 +63,8 @@ class String
   #
   #   "quote me".quote     #=> "'quote me'"
   #   "quote me".quote(2)  #=> "\"quote me\""
+  #
+  #   CREDIT: Trans
 
   def quote(type=:s)
     case type.to_s.downcase
@@ -83,6 +80,10 @@ class String
   end
 
   # Remove quotes from string.
+  #
+  #   "'hi'".dequite    #=> "hi"
+  #
+  #   CREDIT: Trans
 
   def dequote
     s = self.dup
@@ -100,77 +101,3 @@ class String
     return s
   end
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringBracket < Test::Unit::TestCase
-
-    def test_bracket
-      assert_equal( '#X#', 'X'.bracket('#') )
-      assert_equal( 'xX!', 'X'.bracket('x','!') )
-      assert_equal( '{X}', 'X'.bracket('{','}') )
-      assert_equal( '<X>', 'X'.bracket('<') )
-      assert_equal( '(X)', 'X'.bracket('(') )
-      assert_equal( '[X]', 'X'.bracket('[') )
-      assert_equal( '{X}', 'X'.bracket('{') )
-    end
-
-    def test_braket!
-      a = 'X' ; a.bracket!('#')
-      assert_equal( '#X#', a )
-      a = 'X' ; a.bracket!('x','!')
-      assert_equal( 'xX!', a )
-      a = 'X' ; a.bracket!('{','}')
-      assert_equal( '{X}', a )
-      a = 'X' ; a.bracket!('<')
-      assert_equal( '<X>', a )
-      a = 'X' ; a.bracket!('(')
-      assert_equal( '(X)', a )
-      a = 'X' ; a.bracket!('[')
-      assert_equal( '[X]', a )
-      a = 'X' ; a.bracket!('{')
-      assert_equal( '{X}', a )
-    end
-
-    def test_quote_01
-      a =  "hi"
-      assert_raises( ArgumentError ) { a.quote(1,2) }
-    end
-
-    def test_quote_02
-      a =  "hi"
-      assert_equal( %{'hi'}, a.quote )
-    end
-
-    def test_quote_03
-      a =  "hi"
-      assert_equal( %{"hi"}, a.quote(:d) )
-      assert_equal( %{"hi"}, a.quote(:double) )
-    end
-
-    def test_quote_04
-      a =  "hi"
-      assert_equal( %{'hi'}, a.quote(:s) )
-      assert_equal( %{'hi'}, a.quote(:single) )
-    end
-
-    def test_quote_05
-      a =  "hi"
-      assert_equal( %{`hi`}, a.quote(:b) )
-      assert_equal( %{`hi`}, a.quote(:back) )
-    end
-
-  end
-
-=end
-

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

@@ -1,54 +1,31 @@
-# TITLE:
-#
-#  String Case Extensions
-#
-# SUMMARY:
-#
-#   String case-related extensions.
-#
-# CREDIT:
-#
-#   - Phil Tomson
-#   - Thomas Sawyer
-#
-# TODO:
-#
-#   - Perhaps add camelcase methods.
-
-#
 class String
 
-  # Title case.
-
-  def titlecase
-    gsub(/\b\w/){$&.upcase}
-  end
-
   # Return true if the string is capitalized, otherwise false.
   #
   #   "THIS".capitalized?  #=> true
   #   "This".capitalized?  #=> true
   #   "this".capitalized?  #=> false
   #
-  # CREDIT: Phil Tomson
+  #   CREDIT: Phil Tomson
 
   def capitalized?
     self =~ /^[A-Z]/
   end
 
-
   # Return true if the string is lowercase (downcase), otherwise false.
   #
   #   "THIS".downcase?  #=> false
   #   "This".downcase?  #=> false
   #   "this".downcase?  #=> true
   #
-  # CREDIT Phil Tomson
+  #   CREDIT: Phil Tomson
 
   def downcase?
     downcase == self
   end
 
+  # Alias for #downcase? method.
+  alias_method :lowercase?, :downcase?
 
   # Is the string upcase/uppercase?
   #
@@ -56,16 +33,52 @@ class String
   #   "This".upcase?  #=> false
   #   "this".upcase?  #=> false
   #
-  # CREDIT Phil Tomson
+  #   CREDIT: Phil Tomson
 
   def upcase?
     self.upcase == self
   end
 
-  # Alias for #downcase? method.
-  alias_method :lowercase?, :downcase?
-
   # Alias for #upcase? method.
   alias_method :uppercase?, :upcase?
-end
 
+  # Title case.
+  #
+  #   "this is a string".titlecase
+  #   => "This Is A String"
+  #
+  #   CREDIT: Eliazar Parra
+
+  def titlecase
+    gsub(/\b\w/){$&.upcase}
+  end
+
+  # Converts a string to camelcase. By default capitalization
+  # occurs on whitespace and underscores. By setting the first
+  # parameter to <tt>true</tt> the first character can also be
+  # captizlized. The second parameter can be assigned a valid
+  # Regualr Expression characeter set to determine which
+  # characters to match for capitalizing subsequent parts of
+  # the string.
+  #
+  #   "this_is a test".camelcase             #=> "thisIsATest"
+  #   "this_is a test".camelcase(true)       #=> "ThisIsATest"
+  #   "this_is a test".camelcase(true, ' ')  #=> "This_isATest"
+  #
+  #   CREDIT: Trans
+
+  def camelcase(first=false, on='_\s')
+    if first
+      gsub(/(^|[#{on}]+)([A-Za-z])/){ $2.upcase }
+    else
+      gsub(/([#{on}]+)([A-Za-z])/){ $2.upcase }
+    end
+  end
+
+  # Snakecase (underscore) string based on camelcase characteristics.
+
+  def snakecase #(camel_cased_word)
+    gsub(/([A-Z]+)([A-Z])/,'\1_\2').gsub(/([a-z])([A-Z])/,'\1_\2').downcase
+  end
+
+end