facets 0.9.0 → 1.0.0

data/lib/facet/string/downcase.rb

@@ -1 +1,37 @@
-require 'nano/string/downcase.rb'
+#--
+# Credit goes to Phil Tomson.
+#++
+class String
+
+  # Return true if the string is lowercase (downcase), otherwise false.
+  #
+  #   "THIS".downcase?  #=> false
+  #   "This".downcase?  #=> false
+  #   "this".downcase?  #=> true
+  #
+  def downcase?
+    downcase == self
+  end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCString < Test::Unit::TestCase
+
+    def test_downcase?
+      assert( 'abc'.downcase? )
+    end
+
+  end
+
+=end

data/lib/facet/string/dresner.rb

@@ -1 +1,49 @@
-require 'nano/string/dresner.rb'
+
+class String
+
+  # Scramble the inner characters of words leaving the text still readable 
+  # (research at Cambridge University, code by KurtDresner).
+  #
+  # For example, the above text may result in:
+  #
+  #   Srblamce the iennr cchrteaars of wodrs lvenaig the txet stlil rbeaadle
+  #   (rreceash at Cbamigdre Uverintisy, cdoe by KrneruestDr?)
+  #
+  def dresner
+    self.gsub(/\B\w+\B/){$&.split(//).sort_by{rand}} 
+  end
+
+  # Inplace version of #dresner method.
+  #
+  def dresner!
+    self.replace(dresner)
+  end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCString < Test::Unit::TestCase
+
+    def test_dresner
+      # assert_still_legible ;-)
+      assert_nothing_raised { "How are you today?".dresner }
+    end
+
+    def test_dresner
+      # assert_still_legible ;-)
+      assert_nothing_raised { "How are you today?".dresner! }
+    end
+
+  end
+
+=end

data/lib/facet/string/each_char.rb

@@ -1 +1,35 @@
-require 'nano/string/each_char.rb'
+
+class String
+
+  # Iterates through each character.
+  def each_char  # :yield:
+    split(//).each { |c|
+      yield( c )
+    }
+  end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCString < Test::Unit::TestCase
+
+    def test_each_char
+      a = []
+      i = "this"
+      i.each_char{ |w| a << w }
+      assert_equal( ['t', 'h', 'i', 's'], a )
+    end
+
+  end
+
+=end

data/lib/facet/string/each_word.rb

@@ -1 +1,50 @@
-require 'nano/string/each_word.rb'
+
+class String
+
+  # Iterate through each word of a string.
+  #
+  #   "a string".each_word { |word, range| ... }
+  #
+  def each_word( &yld )
+    rest_of_string = self
+    wordfind = /([-'\w]+)/
+    arity = yld.arity
+    offset = 0
+    while wmatch = wordfind.match(rest_of_string)
+      word = wmatch[0]
+      range = offset+wmatch.begin(0) ... offset+wmatch.end(0)
+      rest_of_string = wmatch.post_match
+      if arity == 1
+        yld.call(word)
+      else
+        yld.call(word, range)
+      end
+      offset = self.length - rest_of_string.length
+    end
+  end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCString < Test::Unit::TestCase
+
+    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

data/lib/facet/string/ends_with.rb

@@ -1 +1,2 @@
-require 'nano/string/ends_with.rb'
+# stub
+require 'facet/string/starts_with'

data/lib/facet/string/first.rb

@@ -1 +1,94 @@
-require 'nano/string/first.rb'
+
+require 'facet/string/self/patterns'
+require 'facet/string/shatter'
+require 'facet/string/last'
+
+class String
+
+  # Returns the first separation of a string.
+  # Default seperation is by character.
+  #
+  #   "Hello World".first       #=> "H"
+  #   "Hello World".first(' ')  #=> "Hello"
+  #
+  def first(separator_pattern=//)
+    pattern = self.class.patterns(separator_pattern)
+    split(separator_pattern).at(0)
+  end
+
+  # Removes the first separation from a string.
+  # Defualt separation is by characters.
+  #--
+  # If a zero-length record separator is supplied,
+  # the string is split on /\n+/. If the record
+  # separator is set to <tt>nil</tt>, then the
+  # string is split on characters.
+  #++
+  #
+  #   a = "Hello World"
+  #   a.first!       #=> "H"
+  #   a              #=> "ello World"
+  #
+  #   a = "Hello World"
+  #   a.first!(' ')  #=> "Hello"
+  #   a              #=> "World"
+  #
+  def first!(separator_pattern=//)
+    pattern = self.class.patterns(separator_pattern)
+    a = shatter(pattern)
+    r = a.first
+    a.shift
+    a.shift
+    replace( a.join('') )
+    return r
+  end
+
+  # Prepends to a string.
+  #
+  #   "Hello World".first = "Hello,"  #=> "Hello, Hello World"
+  #--
+  # Should this replace first char?
+  #++
+  def first=( x )
+    insert(0, x.to_s)
+  end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCString < Test::Unit::TestCase
+
+    def test_first
+      assert_equal( "a", "abcxyz".first )
+      assert_equal( "ax", "ax by cz".first(' ') )
+      assert_equal( "a", "a\nb\nc".first("\n") )
+    end
+
+    def test_first_eq
+      s = "abc"
+      s.first = "123"
+      assert_equal( "123abc", s )
+      s = "a\nbc"
+      s.first = "123"
+      assert_equal( "123a\nbc", s )
+    end
+
+    def test_first!
+      s = "a\nbc"
+      s.first!("\n")
+      assert_equal( "bc", s )
+    end
+
+  end
+
+=end

data/lib/facet/string/first_char.rb

@@ -1 +1,20 @@
-require 'nano/string/first_char.rb'
+require 'facet/string/last_char'
+
+class String
+  # Returns first _n_ characters.
+  #
+  #   "Hello World".first_char(3)  #=> "Hel"
+  #
+  def first_char(n=1)
+    slice(0, n.to_i)
+  end
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+# TODO

data/lib/facet/string/fold.rb

@@ -1 +1,67 @@
-require 'nano/string/fold.rb'
+
+class String
+
+  # Returns a new string with all new lines removed from
+  # adjacent lines of text.
+  #
+  #   s = "This is\na test.\n\nIt clumps\nlines of text."
+  #   s.fold
+  #
+  # _produces_
+  #
+  #   "This is a test.\n\nIt clumps lines of text. "
+  #
+  #--
+  # One possible flaw with this that might could use a fix: 
+  # if the given string ends in a newline, it is replaced with
+  # a single space.
+  #++
+  def fold(ignore_indented=false)
+    ns = ''
+    i = 0
+    br = self.scan(/(\n\s*\n|\Z)/m) do |m|
+      b = $~.begin(1)
+      e = $~.end(1)
+      nl = $&
+      tx = slice(i...b)
+      if ignore_indented and slice(i...b) =~ /^[ ]+/
+        ns << tx
+      else
+        ns << tx.gsub(/[ ]*\n+/,' ')
+      end
+      ns << nl
+      i = e
+    end
+    ns
+  end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCString < Test::Unit::TestCase
+
+    def test_fold_1
+      s = "This is\na test.\n\nIt clumps\nlines of text."
+      o = "This is a test.\n\nIt clumps lines of text."
+      assert_equal( o, s.fold )
+    end
+
+    def test_fold_2
+      s = "This is\na test.\n\n  This is pre.\n  Leave alone.\n\nIt clumps\nlines of text."
+      o = "This is a test.\n\n  This is pre.\n  Leave alone.\n\nIt clumps lines of text."
+      assert_equal( o, s.fold(true) )
+    end
+
+  end
+
+=end

data/lib/facet/string/format.rb

@@ -1 +1,17 @@
-require 'nano/string/format.rb'
+require 'facet/string/self/format'
+
+class String
+  def format( *args )
+    self.%(args)
+  end
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+# TODO
+

data/lib/facet/string/frequency.rb

@@ -1 +1,39 @@
-require 'nano/string/frequency.rb'
+
+require 'facet/string/to_arr'
+require 'facet/enumerable/frequency'
+
+class String
+
+  def frequency(*args)
+    to_arr(*args).frequency
+  end
+
+end
+
+#--
+# NOTE: add String#occur and String#occur_within in future ?
+#++
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCString < Test::Unit::TestCase
+
+    def test_frequency
+      assert_equal( {'a'=>1,'b'=>1}, "ab".frequency )
+      assert_equal( {'tom'=>1,'boy'=>1}, "tom boy".frequency(:word) )
+      assert_equal( {'tom'=>1,'boy'=>1}, "tom\nboy".frequency(:line) )
+    end
+
+  end
+
+=end

data/lib/facet/string/humanize.rb

@@ -1 +1,31 @@
-require 'nano/string/humanize.rb'
+
+class String
+
+  # Replaces underscores with spaces and capitalizes word.
+  #
+  def humanize
+    self.gsub(/_/, " ").capitalize
+  end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCString < Test::Unit::TestCase
+
+    def test_humanize
+      assert_equal( 'This is it', 'this_is_it'.humanize )
+    end
+
+  end
+
+=end