facets 2.1.3 → 2.2.0

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

@@ -1,22 +1,11 @@
-# TITLE:
-#
-#   String Range Extension
-#
-# SUMMARY:
-#
-#   Extensions to string for localing ranges of substrings.
-#
-# CREDIT:
-#
-#   - Thomas Sawyer
-
-#
 class String
 
   # Like #index but returns a Range.
   #
   #   "This is a test!".range('test')  #=> 10..13
   #
+  #   CREDIT: Trans
+
   def range(s, offset=0)
     if index(s, offset)
       return ($~.begin(0))..($~.end(0)-1)
@@ -28,9 +17,10 @@ class String
   #
   #   "abc123abc123".range_all('abc')  #=> [0..2, 6..8]
   #
-  #--
-  # Note: should add offset ?
-  #++
+  #   TODO: Add offset, perhaps ?
+  #
+  #   CREDIT: Trans
+
   def range_all(s, reuse=false)
     r = []; i = 0
     while i < self.length
@@ -51,6 +41,8 @@ class String
   #   "this\nis\na\ntest".range_of_line
   #   #=> [0..4, 5..7, 8..9, 10..13]
   #
+  #   CREDIT: Trans
+
   def range_of_line
     offset=0; charmap = []
     self.each do |line|
@@ -60,36 +52,3 @@ class String
     charmap
   end
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringRange < Test::Unit::TestCase
-
-    def test_range
-      assert_equal( (1..3), "a123a567a9".range(/123/) )
-      assert_equal( (0..0), "a123a567a9".range(/a/) )
-    end
-
-    def test_range_all
-      assert_equal( [ (1..3), (5..7) ], "a123a123a9".range_all(/123/) )
-      assert_equal( [ (0..0), (4..4), (8..8) ], "a123a567a9".range_all(/a/) )
-    end
-
-    def test_range_of_line
-      a = "0123\n456\n78"
-      ltcm = a.range_of_line
-      assert_equal( [0..4, 5..8, 9..10], ltcm )
-    end
-
-  end
-
-=end

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

@@ -1,19 +1,10 @@
-# TITLE:
-#
-#   Regesc
-#
-# SUMMARY:
-#
-#   Qucik and easy Regular expression from string.
-#
-# CREDIT:
-#
-#   - Thomas Sawyer
-
-#
 class String
 
   # Escape string for Regexp use.
+  #
+  #   "H..LO".regesc  #=> "H\\.\\.LO"
+  #
+  #   CREDIT: Trans
 
   def regesc
     Regexp.escape(self)
@@ -26,38 +17,14 @@ module Kernel
 
   # Provides a shortcut to the Regexp.escape module method.
   #
-  # Will be deprecated in favor of String#regesc.
+  #   resc("H..LO")   #=> "H\\.\\.LO"
+  #
+  #   TODO: Should this be deprecated in favor of String#regesc ?
+  #
+  #   CREDIT: Trans
 
   def resc(str)
     Regexp.escape(str)
   end
 
 end
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringRegesc < Test::Unit::TestCase
-
-    def test_regesc
-      a = "?"
-      b = /#{a.regesc}/
-      assert( b =~ "?" )
-    end
-
-    def test_resc
-      assert_equal( Regexp.escape("'jfiw0[]4"), resc("'jfiw0[]4") )
-      assert_equal( Regexp.escape("/////"), resc("/////") )
-    end
-
-  end
-
-=end
-

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

@@ -1,16 +1,3 @@
-# TITLE:
-#
-#   String Scan-like Extensions
-#
-# SUMMARY:
-#
-#   Extensions providing alternate methods akin to scanning.
-#
-# CREDIT:
-#
-#   - Thomas Sawyer
-
-#
 class String
 
   # Breaks a string up into an array based on a regular expression.
@@ -23,6 +10,8 @@ class String
   #
   #   ["<p>This", "<b>is", "</b>a test.", "</p>"]
   #
+  #   CREDIT: Trans
+
   def divide( re )
     re2 = /#{re}.*?(?=#{re}|\Z)/
     scan(re2) #{re}(?=#{re})/)
@@ -31,6 +20,8 @@ class String
   # Like #scan but returns MatchData ($~) rather
   # then matched string ($&).
   #
+  #   CREDIT: Trans
+
   def mscan(re) #:yield:
     if block_given?
       scan(re) { yield($~) }
@@ -51,6 +42,8 @@ class String
   #
   #   ["<p>", "This", "<b>", "is", "</b>", "a test.", "</p>"]
   #
+  #   CREDIT: Trans
+
   def shatter( re )
     r = self.gsub( re ){ |s| "\1" + s + "\1" }
     while r[0,1] == "\1" ; r[0] = '' ; end
@@ -59,42 +52,3 @@ class String
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringScan < Test::Unit::TestCase
-
-    def test_mscan
-      r = 'abc,def,gh'.mscan(/[,]/)
-      assert( r.all?{ |md| MatchData === md } )
-      assert_equal( 2, r.to_a.length )
-      assert_equal( ',', r[0][0] )
-      assert_equal( ',', r[1][0] )
-    end
-
-    def test_divide
-      s = "<p>This<b>is</b>a test.</p>"
-      d = s.divide( /<.*?>/ )
-      e = ["<p>This", "<b>is", "</b>a test.", "</p>"]
-      assert_equal(e, d)
-    end
-
-    def test_shatter
-      s = "<p>This<b>is</b>a test.</p>"
-      sh = s.shatter( /<.*?>/ )
-      e = ["<p>", "This", "<b>", "is", "</b>", "a test.", "</p>"]
-      assert_equal(e, sh)
-    end
-
-  end
-
-=end

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

@@ -1,22 +1,17 @@
-# TITLE:
-#
-#   Splice
-#
-# SUMMARY:
-#
-#   Like #slice, but writes rather than reads.
-#
-# CREDIT:
-#
-#   - Thomas Sawyer
-
-#
 class String
 
+  # Alias for []=.
   alias_method :store, :[]=
 
+  # Like #slice, but writes rather than reads.
   # Like #store, but acts like slice!
   # when given only one argument.
+  #
+  #   a = "HELLO"
+  #   a.splice(1)    #=> "E"
+  #   a              #=> "HLLO"
+  #
+  #   CREDIT: Trans
 
   def splice(*args)
     if args.size == 1

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

@@ -1,25 +1,14 @@
-# TITLE:
-#
-#   String Tab Extensions
-#
-# SUMMARY:
-#
-#   Tabs, indention and margin extensions for String.
-#
-# CREDIT:
-#
-#   - Thomas Sawyer
-
-#
 class String
 
   # Aligns each line n spaces.
-  # (This used to be #taballto.)
+  #
+  #   CREDIT: Gavin Sinclair
 
   def tab(n)
     gsub(/^ */, ' ' * n)
   end
 
+  # Alias will be deprecated.
   alias_method :taballto, :tab
 
   # Expands tabs to +n+ spaces.  Non-destructive.  If +n+ is 0, then tabs are
@@ -27,9 +16,9 @@ class String
   #
   # Thanks to GGaramuno for a more efficient algorithm.  Very nice.
   #
-  #   CREDIT Noah Gibbs
-  #   CREDIT Gavin Sinclair
-  #   CREDIT GGaramuno
+  #   CREDIT: Gavin Sinclair
+  #   CREDIT: Noah Gibbs
+  #   CREDIT: GGaramuno
 
   def expand_tabs(n=8)
     n = n.to_int
@@ -48,6 +37,8 @@ class String
 
   # Preserves relative tabbing.
   # The first non-empty line ends up with n spaces before nonspace.
+  #
+  #   CREDIT: Gavin Sinclair
 
   def tabto(n)
     if self =~ /^( *)\S/
@@ -59,6 +50,9 @@ class String
 
   # Indent left or right by n spaces.
   # (This used to be called #tab and aliased as #indent.)
+  #
+  #   CREDIT: Gavin Sinclair
+  #   CREDIT: Trans
 
   def indent(n)
     if n >= 0
@@ -70,7 +64,7 @@ class String
 
   # Outdent just indents a negative number of spaces.
   #
-  # CREDIT Noah Gibbs
+  # CREDIT: Noah Gibbs
 
   def outdent(n)
     indent(-n)
@@ -84,9 +78,10 @@ class String
   #         |     margin controlled!
   #         }.margin
   #
-  #--
-  # This may still need a bit of tweaking.
-  #++
+  #
+  #   NOTE: This may still need a bit of tweaking.
+  #
+  #   CREDIT: Trans
 
   def margin(n=0)
     #d = /\A.*\n\s*(.)/.match( self )[1]
@@ -102,135 +97,3 @@ class String
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringTabs < Test::Unit::TestCase
-
-    def test_tab
-      a = "xyz".tab(4)
-      assert_equal( '    ', a[0..3] )
-      # Need to expand on this
-    end
-
-    def test_tabto
-      a = "xyz".tabto(4)
-      assert_equal( '    ', a[0..3] )
-      # Need to expand on this
-    end
-
-    def test_indent
-      a = "xyz".indent(4)
-      assert_equal( '    ', a[0..3] )
-      # Need to expand on this
-    end
-
-    def test_margin
-      s = %q{
-            |ABC
-            |123
-            |TEST
-            }.margin
-      assert_equal( "ABC\n123\nTEST", s )
-
-      s = %q{
-              |ABC
-            |123
-                  |TEST
-            }.margin
-      assert_equal( "ABC\n123\nTEST", s )
-
-      s = %q{|ABC
-            |123
-            |TEST
-      }.margin
-      assert_equal( "ABC\n123\nTEST", s )
-
-      s = %q{
-            |ABC
-            |123
-            |TEST}.margin
-      assert_equal( "ABC\n123\nTEST", s )
-
-      s = %q{|ABC
-            |123
-            |TEST}.margin
-      assert_equal( "ABC\n123\nTEST", s )
-
-      s = %q{   |ABC
-            |123
-            |TEST}.margin
-      assert_equal( "ABC\n123\nTEST", s )
-
-      s = %q{ABC
-            |123
-            |TEST
-            }.margin
-      assert_equal( "ABC\n123\nTEST", s )
-    end
-
-    #
-
-    def test_spacing
-      s = %q{
-            | ABC
-            | 123
-            | TEST
-            }.margin
-      assert_equal( " ABC\n 123\n TEST", s )
-
-      s = %q{
-            |ABC
-            |123
-            |TEST
-            }.margin(1)
-      assert_equal( " ABC\n 123\n TEST", s )
-
-      s = %q{
-            |ABC
-            |123
-            |TEST
-            }.margin(2)
-      assert_equal( "  ABC\n  123\n  TEST", s )
-
-      s = %q{ ABC
-            - 123
-            - TEST
-            }.margin
-      assert_equal( " ABC\n 123\n TEST", s )
-    end
-
-    #
-
-    def test_random_placement
-      @volly = {}
-      100.times{ |n|
-        k = []
-        a = []
-        5.times{ |i|
-          k << ( ( ' ' * Integer(rand*10) ) + '|' + i.to_s )
-          a << ( i.to_s )
-        }
-        @volly[k.join("\n")] = a.join("\n")
-      }
-      @volly.each{ |k,v|
-        assert_equal( v, k.margin )
-      }
-    end
-
-  end
-
-=end
-
-
-
-