facets 3.0.0 → 3.1.0

data/demo/core/string/{margin.rdoc → trim.md}

@@ -1,47 +1,47 @@
-== String#margin
+## String#trim
 
-    require 'facets/string/margin'
+    require 'facets/string/trim'
 
     s = %q{
           |ABC
           |123
           |TEST
-          }.margin
+          }.trim
     s.assert == "ABC\n123\nTEST"
 
     s = %q{
             |ABC
           |123
                 |TEST
-          }.margin
+          }.trim
     s.assert == "ABC\n123\nTEST"
 
     s = %q{|ABC
           |123
           |TEST
-    }.margin
+    }.trim
     s.assert == "ABC\n123\nTEST"
 
     s = %q{
           |ABC
           |123
-          |TEST}.margin
+          |TEST}.trim
     s.assert == "ABC\n123\nTEST"
 
     s = %q{|ABC
           |123
-          |TEST}.margin
+          |TEST}.trim
     s.assert == "ABC\n123\nTEST"
 
     s = %q{   |ABC
           |123
-          |TEST}.margin
+          |TEST}.trim
     s.assert == "ABC\n123\nTEST"
 
     s = %q{ABC
           |123
           |TEST
-          }.margin
+          }.trim
     s.assert == "ABC\n123\nTEST"
 
 spacing
@@ -50,27 +50,27 @@ spacing
           | ABC
           | 123
           | TEST
-          }.margin
+          }.trim
     s.assert == " ABC\n 123\n TEST"
 
     s = %q{
           |ABC
           |123
           |TEST
-          }.margin(1)
+          }.trim(1)
     s.assert == " ABC\n 123\n TEST"
 
     s = %q{
           |ABC
           |123
           |TEST
-          }.margin(2)
+          }.trim(2)
     s.assert == "  ABC\n  123\n  TEST"
 
     s = %q{ ABC
           - 123
           - TEST
-          }.margin
+          }.trim
     s.assert == " ABC\n 123\n TEST"
 
 random placement
@@ -87,6 +87,6 @@ random placement
     }
 
     @volly.each{ |k,v|
-      k.margin.assert == v
+      k.trim.assert == v
     }
 

data/demo/core/string/unbracket.md

@@ -0,0 +1,24 @@
+## String#unbracket
+
+    require 'facets/string/unbracket'
+
+Remove matched paits of brackets from a string
+
+    s = "{unwrap me}"
+    z = s.unbracket('{')
+    z.assert == "unwrap me"
+
+    s = "--unwrap me!"
+    z = s.unbracket('--','!')
+    z.assert == "unwrap me"
+
+## String#unbracket!
+
+    s = "{unwrap me}"
+    s.unbracket!('{')
+    s.assert == "unwrap me"
+
+    s = "--unwrap me!"
+    s.unbracket!('--','!')
+    s.assert == "unwrap me"
+

data/demo/core/string/underscore.md

@@ -0,0 +1,17 @@
+## String#underscore
+
+    require 'facets/string/underscore'
+
+Underscore a string such that camelcase, dashes and spaces are
+replaced by underscores. This is the reverse of {#camelcase},
+albeit not an exact inverse.
+
+Note, this method no longer converts `::` to `/`, in that case
+use the {#pathize} method instead.
+
+    'my_name'.underscore.assert == 'my_name'
+
+    'MyName'.underscore.assert == 'my_name'
+
+    'URI'.underscore.assert == 'uri'
+

data/demo/core/string/unfold.md

@@ -0,0 +1,9 @@
+## String#unfold
+
+    require 'facets/string/unfold'
+
+    str = "This is a test of\nparagraph folding."
+    res = str.unfold
+    exp = "This is a test of paragraph folding."
+    res.assert == exp
+

data/demo/core/string/unindent.md

@@ -0,0 +1,65 @@
+## String#unindent
+
+    require 'facets/string/unindent'
+
+We will use these two strings as a common basis for demonstration.
+
+    ex1 = <<-EOF.gsub(/^\s*\|/,'')
+    |    I must go down to the seas again
+    |      The lonely sea and the sky
+    |    And all I want is a tall ship
+    |      And a star to steer her by
+    EOF
+
+    ex2 = <<-EOF.gsub(/^\s*\|/,'')
+    |     "Eek!"
+    |  She cried
+    |    As the mouse quietly scurried
+    |by.
+    EOF
+
+simple examples
+
+    "   xyz".unindent(-1).assert == "    xyz"
+    "   xyz".unindent(0).assert  == "   xyz"
+    "   xyz".unindent(1).assert  == "  xyz"
+    "   xyz".unindent(2).assert  == " xyz"
+    "   xyz".unindent(3).assert  == "xyz"
+    "   xyz".unindent(4).assert  == "xyz"
+
+large example unindented one space
+
+    expected = <<-EOF.gsub(/^\s*\|/,'')
+    |   I must go down to the seas again
+    |     The lonely sea and the sky
+    |   And all I want is a tall ship
+    |     And a star to steer her by
+    EOF
+
+    actual = ex1.unindent(1)
+    actual.assert == expected
+
+large example unindented four spaces
+
+    expected = <<-EOF.gsub(/^\s*\|/,'')
+    |I must go down to the seas again
+    |  The lonely sea and the sky
+    |And all I want is a tall ship
+    |  And a star to steer her by
+    EOF
+
+    actual = ex1.unindent(4)
+    actual.assert == expected
+
+unindent larger than current indention
+
+    expected = <<-EOF.gsub(/^\s*\|/,'')
+    |"Eek!"
+    |She cried
+    |As the mouse quietly scurried
+    |by.
+    EOF
+
+    actual = ex2.unindent(100)
+    actual.assert == expected
+

data/demo/core/string/unquote.md

@@ -0,0 +1,6 @@
+## String#unquote
+
+    require 'facets/string/unquote'
+
+    "'this'".unquote.assert == "this"
+

data/demo/core/string/uppercase.md

@@ -0,0 +1,15 @@
+## String#uppercase
+
+    require 'facets/string/uppercase'
+
+Upcase the first letter.
+
+    s = 'bob'
+    s.uppercase.assert == 'Bob'
+
+    s = 'boB'
+    s.uppercase.assert == 'BoB'
+
+    s = 'BoB'
+    s.uppercase.assert == 'BoB'
+

data/demo/core/string/variablize.md

@@ -0,0 +1,7 @@
+## String#variablize
+
+    require 'facets/string/variablize'
+
+    s = "a"
+    s.variablize.assert == "@a"
+

data/demo/core/string/word_wrap.md

@@ -0,0 +1,54 @@
+## String#word_wrap
+
+    require 'facets/string/word_wrap'
+
+    e = "abcde\n12345\nxyzwu\n"
+    r = "abcde 12345 xyzwu".word_wrap(5)
+    r.assert == e
+
+    e = "abcd\n1234\nxyzw\n"
+    r = "abcd 1234 xyzw".word_wrap(4)
+    r.assert == e
+
+    e = "abc\n123\n"
+    r = "abc 123".word_wrap(4)
+    r.assert == e
+
+    e = "abc \n123\n"
+    r = "abc  123".word_wrap(4)
+    r.assert == e
+
+    e = "abc \n123\n"
+    r = "abc     123".word_wrap(4)
+    r.assert == e
+
+## String#word_wrap!
+
+    w = "abcde 12345 xyzwu"
+    w.word_wrap!(5)
+    w.assert == "abcde\n12345\nxyzwu\n"
+
+    w = "abcd 1234 xyzw"
+    w.word_wrap!(4)
+    w.assert == "abcd\n1234\nxyzw\n"
+
+    w = "abc 123"
+    w.word_wrap!(4)
+    w.assert == "abc\n123\n"
+
+    w = "abc  123"
+    w.word_wrap!(4)
+    w.assert == "abc \n123\n"
+
+    w = "abc     123"
+    w.word_wrap!(4)
+    w.assert == "abc \n123\n"
+
+    # Unit :word_wrap do
+    #   assert_equal "abcde-\n12345-\nxyzwu\n", "abcde12345xyzwu".word_wrap(6,2)
+    #   assert_equal "abcd-\n1234-\nxyzw\n", "abcd1234xyzw".word_wrap(5,2)
+    #   assert_equal "abc \n123\n", "abc 123".word_wrap(4,2)
+    #   assert_equal "abc \n123\n", "abc  123".word_wrap(4,2)
+    #   assert_equal "abc \n123\n", "abc     123".word_wrap(4,2)
+    # end
+

data/demo/core/string/words.md

@@ -0,0 +1,13 @@
+## String#words
+
+    require 'facets/string/words'
+
+    x = "a b c\nd e"
+    x.words.assert == ['a','b','c','d','e']
+
+    x = "ab cd\nef"
+    x.words.assert == ['ab','cd','ef']
+
+    x = "ab cd \n ef-gh"
+    x.words.assert == ['ab','cd','ef-gh']
+

data/demo/core/string/xor.md

@@ -0,0 +1,8 @@
+## String#^
+
+    require 'facets/string/xor'
+
+    r = "try this out" ^ "puddingsnacks"
+    x = "\004\a\035D\035\006\016\000N\016\026\037"
+    r.assert == x
+

data/lib/core/facets.yml

@@ -12,24 +12,28 @@ organizations:
 requirements:
 - groups:
   - test
-  version: '>= 0'
+  version: ">= 0"
   name: lemon
 - groups:
   - test
-  version: '>= 0'
+  version: ">= 0"
   name: qed
 - groups:
   - test
-  version: '>= 0'
+  version: ">= 0"
   name: rubytest-cli
 - groups:
   - test
-  version: '>= 0'
+  version: ">= 0"
   name: rake
 - groups:
   - test
-  version: '>= 0'
+  version: ">= 0"
   name: simplecov
+- groups:
+  - guard
+  version: ">= 0"
+  name: guard
 conflicts: []
 alternatives: []
 resources:
@@ -63,7 +67,7 @@ paths:
   - lib/standard
 name: facets
 title: Ruby Facets
-version: 3.0.0
+version: 3.1.0
 summary: The orginal well curated collection of extension methods for Ruby.
 slogan: ALL YOUR BASE ARE BELONG TO RUBY!
 description: Facets is the premier collection of extension methods for the Ruby programming
@@ -73,4 +77,4 @@ description: Facets is the premier collection of extension methods for the Ruby
   applications.
 scm_uri: https://github.com/rubyworks/facets/tree/master
 created: '2004-12-16'
-date: '2014-12-20'
+date: '2016-05-09'

data/lib/core/facets/array.rb

@@ -1,5 +1,6 @@
 require_relative 'array/after.rb'
 #require_relative 'array/arrange.rb'            # too new
+require_relative 'array/average.rb'
 require_relative 'array/before.rb'
 require_relative 'array/collapse.rb'
 require_relative 'array/collisions.rb'

data/lib/core/facets/array/average.rb

@@ -0,0 +1,16 @@
+class Array
+
+  # Calculate the average of an array of numbers
+  #
+  # Examples
+  #
+  #   [].average #=> nil
+  #   [1, 2, 3].average #=> 2
+  #   [3, 12, 57, 85, 15, 89, 33, 7, 22, 54].average #=> 37.7
+  #   [1,[2,nil,[3]],nil,4].collapse  #=> [1,2,3,4]
+  #
+  def average
+    return nil if empty?
+    self.reduce(:+)/length.to_f
+  end
+end

data/lib/core/facets/array/collapse.rb

@@ -10,5 +10,9 @@ class Array
     flatten.compact
   end
 
+  def collapse!
+    flatten!.compact!
+  end
+
 end
 

data/lib/core/facets/array/delete_values_at.rb

@@ -0,0 +1 @@
+require 'facets/array/delete_values'

data/lib/core/facets/array/divide.rb

@@ -5,10 +5,17 @@ class Array
   #   ['a1','b1','a2','b2'].divide(/^a/)
   #   #=> [['a1','b1'],['a2','b2']]
   #
+  #   ['a1','b1','a2','b2'].divide(/^b/)
+  #   #=> [['a1',['b1','a2'],[]'b2']]
+  #
+  #   ['a1','b1','a2','b2'].divide(/^c/)
+  #   #=> [['a1','b1','a2','b2']]
+  #
   # CREDIT: Trans
 
   def divide(pattern)
     memo = []
+    memo.push [] unless pattern === first
     each do |obj|
       memo.push [] if pattern === obj
       memo.last << obj

data/lib/core/facets/array/duplicates.rb

@@ -8,6 +8,8 @@ class Array
   #
   #   [1,1,2,3].duplicates #=> [1]
   #
+  #   [1,1,2,3,2,4,5,4,2].duplicates(3) #=> [2]
+  #
   # CREDIT: Rebort Dober (current implementation)
   # CREDIT: Thibaut Barrère