facets 2.1.3 → 2.2.0

data/lib/core/facets/symbol.rb

@@ -1,6 +1,8 @@
 require 'facets/symbol/shadow.rb'
-require 'facets/symbol/succ.rb'
 require 'facets/symbol/not.rb'
 require 'facets/symbol/generate.rb'
 require 'facets/symbol/chomp.rb'
+
+# remove for 1.9
+require 'facets/symbol/succ.rb'
 require 'facets/symbol/to_proc.rb'

data/lib/core/facets/symbol/chomp.rb

@@ -1,41 +1,23 @@
-#--
-# CREDIT Thomas Sawyer
-#++
-
 class Symbol
 
   # Just like String#chomp.
   #
-  def chomp(seperator=nil)
+  #   :ab.chomp(:b)  #=> :a
+  #
+  #   CREDIT: Trans
+
+  def chomp(seperator)
     to_s.chomp(seperator.to_s).to_sym
   end
 
   # Just like String#lchomp.
   #
-  def lchomp(str)
-    to_s.reverse.chomp(str).reverse.to_sym
-  end
-
-end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestSymbol < Test::Unit::TestCase
-
-    def test_chomp
-      assert_equal( :a, :ab.chomp(:b) )
-    end
+  #   :ab.lchomp(:a)  #=> :b
+  #
+  #   CREDIT: Trans
 
+  def lchomp(seperator)
+    to_s.reverse.chomp(seperator.to_s).reverse.to_sym
   end
 
-=end
-
+end

data/lib/core/facets/symbol/generate.rb

@@ -1,21 +1,3 @@
-# TITLE:
-#
-#   Symbol Generation
-#
-# DESCRIPTION:
-#
-#    Symbol generation extensions.
-#
-# AUTHORS:
-#
-#   CREDIT Thomas Sawyer
-#
-# NOTES:
-#
-#   TODO Is Symbol#chomp worth having? Are the any other
-#        String methods that Symbols really should have too?
-
-#
 class Symbol
 
   # Generate a unique symbol.
@@ -26,34 +8,13 @@ class Symbol
   #
   #   Symbol.generate(:this) => :<2>this
   #
-  #--
-  # TODO Is the generated symbol format acceptable?
-  #++
+  #   TODO: Is the generated symbol format acceptable?
+  #
+  #   CREDIT: Trans
+
   def self.generate(suffix=nil)
     @symbol_generate_counter ||= 0
     ("<%X>#{suffix}" % @symbol_generate_counter += 1).to_sym
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestSymbol < Test::Unit::TestCase
-
-    def test_generate
-      assert_equal( Symbol.generate, :'<1>' )
-    end
-
-  end
-
-=end
-

data/lib/core/facets/symbol/not.rb

@@ -1,10 +1,22 @@
-
 class Symbol
 
+  # Does a symbol have a "not" sign?
+  #
+  #   "friend".to_sym.not?   #=> false
+  #   "~friend".to_sym.not?  #=> true
+  #
+  #   CREDIT: Trans
+
   def not?
     self.to_s.slice(0,1) == '~'
   end
 
+  # Add a "not" sign to the front of a symbol.
+  #
+  #   ~:friend    #=> :"~friend"
+  #
+  #   CREDIT: Trans
+
   def ~@
     if self.to_s.slice(0,1) == '~'
       "#{self.to_s[1..-1]}".to_sym
@@ -14,27 +26,3 @@ class Symbol
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TCSymbol < Test::Unit::TestCase
-
-    def test_not
-      assert_equal( :"~a", ~:a )
-      a = :a
-      n = ~a
-      assert( n.not? )
-    end
-
-  end
-
-=end

data/lib/core/facets/symbol/shadow.rb

@@ -1,21 +1,3 @@
-# TITLE:
-#
-#   Symbol Generation
-#
-# DESCRIPTION:
-#
-#    Symbol generation extensions.
-#
-# AUTHORS:
-#
-#   CREDIT Thomas Sawyer
-#
-# NOTES:
-#
-#   TODO Is Symbol#chomp worth having? Are the any other
-#        String methods that Symbols really should have too?
-
-#
 class Symbol
 
   # Easily manipulate undercores on symbols.
@@ -23,6 +5,8 @@ class Symbol
   #   :a.pad(2)         #=> :__a__
   #   :__a__.pad(-1)    #=> :_a_
   #
+  #   CREDIT: Trans
+
   def shadow(i=1)
     return self if i == 0
     s = self.to_s
@@ -37,25 +21,3 @@ class Symbol
   alias :pad :shadow
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestSymbol < Test::Unit::TestCase
-
-    def test_shadow
-      assert_equal( :__a__, :a.shadow(2) )
-      assert_equal( :_a_, :__a__.shadow(-1) )
-    end
-
-  end
-
-=end

data/lib/core/facets/symbol/succ.rb

@@ -1,18 +1,19 @@
-class Symbol
+# DEPRECATE for 1.9
+unless (RUBY_VERSION[0,3] == '1.9')
 
-  # Successor method for symobol. This simply converts
-  # the symbol to a string uses String#succ and then
-  # converts it back to a symbol.
-  #
-  #   :a.succ => :b
-  #
-  #--
-  # In the future I would like this to work more like
-  # a simple character dial.
-  #++
+  class Symbol
 
-  def succ
-    self.to_s.succ.intern
+    # Successor method for symobol. This simply converts
+    # the symbol to a string uses String#succ and then
+    # converts it back to a symbol.
+    #
+    #   :a.succ => :b
+    #
+    #   TODO: Make this  work more like a simple character dial.
+
+    def succ
+      self.to_s.succ.intern
+    end
   end
 
 end

data/lib/core/facets/symbol/to_proc.rb

@@ -1,34 +1,39 @@
-class Symbol
+# DEPRECATE for 1.9
+unless (RUBY_VERSION[0,3] == '1.9')
 
-  # Turn a symbol into a proc calling the method to
-  # which it refers.
-  #
-  #   up = :upcase.to_proc
-  #   up.call("hello")  #=> HELLO
-  #
-  # More useful is the fact that this allows <tt>&</tt>
-  # to be used to coerce Symbol into Proc. 
-  #
-  #   %w{foo bar qux}.map(&:upcase)   #=> ["FOO","BAR","QUX"]
-  #   [1, 2, 3].inject(&:+)           #=> 6
-  #
-  # And other conveniences such as:
-  #
-  #   %{john terry fiona}.map(&:capitalize)   # -> %{John Terry Fiona}
-  #   sum = numbers.inject(&:+)
-  #
-  # TODO This will be deprecated as of Ruby 1.9, since it will become standard Ruby.
-  #
-  #   CREDIT Florian Gross (orignal)
-  #   CREDIT Nobuhiro Imai (current)
+  class Symbol
 
-  def to_proc
-    Proc.new{|*args| args.shift.__send__(self, *args)}
-  end
+    # Turn a symbol into a proc calling the method to
+    # which it refers.
+    #
+    #   up = :upcase.to_proc
+    #   up.call("hello")  #=> HELLO
+    #
+    # More useful is the fact that this allows <tt>&</tt>
+    # to be used to coerce Symbol into Proc.
+    #
+    #   %w{foo bar qux}.map(&:upcase)   #=> ["FOO","BAR","QUX"]
+    #   [1, 2, 3].inject(&:+)           #=> 6
+    #
+    # And other conveniences such as:
+    #
+    #   %{john terry fiona}.map(&:capitalize)   # -> %{John Terry Fiona}
+    #   sum = numbers.inject(&:+)
+    #
+    #   TODO: This will be deprecated as of Ruby 1.9, since it will become standard Ruby.
+    #
+    #   CREDIT: Florian Gross (orignal)
+    #   CREDIT: Nobuhiro Imai (current)
+
+    def to_proc
+      Proc.new{|*args| args.shift.__send__(self, *args)}
+    end
 
-  #def to_proc
-  #  proc { |obj, *args| obj.send(self, *args) }
-  #end
+    # OLD DEFINITION
+    #def to_proc
+    #  proc { |obj, *args| obj.send(self, *args) }
+    #end
+  end
 
 end
 

data/lib/core/facets/time.rb

@@ -1,2 +1,3 @@
 require 'facets/time/change.rb'
 require 'facets/time/elapse.rb'
+require 'facets/time/stamp.rb'

data/lib/core/facets/time/change.rb

@@ -1,16 +1,3 @@
-# = FILE
-#
-#   time/change.rb
-#
-# = DESCRIPTION
-#
-#   Time extension for changing time.
-#
-# = AUTHORS
-#
-#   CREDIT Thomas Sawyer
-
-#
 class Time
 
   # Returns a new Time where one or more of the elements
@@ -19,6 +6,11 @@ class Time
   # cascadingly, so if only the hour is passed, then
   # minute, sec, and usec is set to 0. If the hour and
   # minute is passed, then sec and usec is set to 0.
+  #
+  #  t = Time.now            #=> Sat Dec 01 14:10:15 -0500 2007
+  #  t.change(:hour => 11)   #=> Sat Dec 01 11:00:00 -0500 2007
+  #
+  #  CREDIT: David Hansson (?)
 
   def change(options)
     opts={}; options.each_pair{ |k,v| opts[k] = v.to_i }
@@ -34,28 +26,3 @@ class Time
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestTimeChange < Test::Unit::TestCase
-
-    def test_change
-      t = Time.parse('4/20/2006 15:37')
-      n = Time.now
-      n = n.change( :month=>4, :day=>20, :hour=>15, :min=>37, :year=>2006 )
-      assert_equal( t, n )
-    end
-
-  end
-
-=end
-

data/lib/core/facets/time/elapse.rb

@@ -1,25 +1,11 @@
-# = FILE
-#
-#   time/change.rb
-#
-# = DESCRIPTION
-#
-#   Time extension for changing time.
-#
-# = AUTHORS
-#
-#   CREDIT Thomas Sawyer
-
-#
 class Time
 
   # Tracks the elapse time of a code block.
   #
   #   Time.elapse { sleep 1 }  #=> 0.999188899993896
   #
-  #--
-  # CREDIT Hal Fulton
-  #++
+  #   CREDIT: Hal Fulton
+
   def self.elapse
     raise "Need block" unless block_given?
     t0 = Time.now.to_f
@@ -28,28 +14,3 @@ class Time
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestTime < Test::Unit::TestCase
-
-    def test_elapse
-      #t = Time.parse('4/20/2006 15:37')
-      t = Time.elapse { sleep 1 }
-      assert( (t > 0.9) && (t < 2.1 ))
-    end
-
-  end
-
-=end
-