facets 2.1.3 → 2.2.0

data/lib/core/facets/hash/at.rb

@@ -1,44 +1,14 @@
-# TITLE:
-#
-#   Hash At
-#
-# SUMMARY:
-#
-#   Alias #at and #/ to #[].
-#
-# CREDITS:
-#
-#   - Thomas Sawyer
-
-#
 class Hash
 
-  # Use division as a fetch notation.
+  # Use division operator as a fetch notation.
+  #
+  #   h = {:a=>1}
+  #   h / :a  #=> 1
+
   alias_method :/, :[]
 
-  # For greater polymorphism with Array.
+  # Alias for fetch for greater polymorphism with Array.
+  #
   alias_method :at, :[]
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestHashAt < Test::Unit::TestCase
-
-    def test_at
-      h = { :a=>1, :b=>2 }
-      assert_equal( 1, h.at(:a) )
-      assert_equal( 2, h.at(:b) )
-    end
-  end
-
-=end

data/lib/core/facets/hash/delete.rb

@@ -1,42 +1,30 @@
-# TITLE:
-#
-#   Hash Deletion Extensions
-#
-# SUMMARY:
-#
-#   General manipulation extensions for Hash class.
-#
-# CREDITS:
-#
-#   - Daniel Schierbeck
-#   - Thomas Sawyer
-
-#
 class Hash
 
   alias_method :delete_at, :delete
 
-  # CREDIT Daniel Schierbeck
+  # Inverse of #delete_if.
+  #
+  #
+  #
+  #   CREDIT: Daniel Schierbeck
 
   def delete_unless #:yield:
     delete_if{ |key, value| ! yield(key, value) }
   end
 
-  # CREDIT Daniel Schierbeck
-
   # Minor modification to Ruby's Hash#delete method
   # allowing it to take multiple keys.
   #
   #   hsh = { :a => 1, :b => 2 }
   #   hsh.delete_values(1)
   #   hsh  #=> { :b => 2 }
+  #
+  #   CREDIT: Daniel Schierbeck
 
   def delete_values(*values)
     keys.map{ |key| delete(key) if values.include?(fetch(key)) }
   end
 
-  # CREDIT Daniel Schierbeck
-
   # Minor modification to Ruby's Hash#delete method
   # allowing it to take multiple keys.
   #
@@ -48,48 +36,11 @@ class Hash
   #
   #    [a, b, c]  #=> [1, 2, 3]
   #    hsh        #=> {}
+  #
+  #   CREDIT: Daniel Schierbeck
 
   def delete_values_at(*keys, &yld)
     keys.map{|key| delete(key, &yld) }
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestHashDelete < Test::Unit::TestCase
-
-    def test_delete_unless
-      a = { :a => 1, :b => 2, :c => 3 }
-      e = { :a => 1 }
-      r = a.delete_unless{|k,v| v == 1}
-      assert_equal( e, a )
-    end
-
-    def test_delete_values
-      a = { :a => 1, :b => 2, :c => 3 }
-      e = { :b => 2, :c => 3 }
-      r = a.delete_values(1)
-      assert_equal( e, a )
-    end
-
-    def test_delete_values_at
-      a = { :a => 1, :b => 2, :c => 3 }
-      e = { :b => 2, :c => 3 }
-      r = a.delete_values_at(:a)
-      assert_equal( e, a )
-    end
-
-  end
-
-=end

data/lib/core/facets/hash/has_keys.rb

@@ -1,16 +1,3 @@
-# TITLE:
-#
-#   Hash Comparison Extensions
-#
-# SUMMARY:
-#
-#   Hash comparison extensions.
-#
-# CREDITS:
-#
-#   - Thomas Sawyer
-#
-
 class Hash
 
   # Returns true or false whether the hash
@@ -19,6 +6,8 @@ class Hash
   #   h = { :a => 1, :b => 2 }
   #   h.has_keys?( :a )   #=> true
   #   h.has_keys?( :c )   #=> false
+  #
+  #   CREDIT: Trans
 
   def has_keys?(*check_keys)
     unknown_keys = check_keys - self.keys
@@ -31,6 +20,8 @@ class Hash
   #   h = { :a => 1, :b => 2 }
   #   h.has_only_keys?( :a, :b )   #=> true
   #   h.has_only_keys?( :a )       #=> false
+  #
+  #   CREDIT: Trans
 
   def has_only_keys?(*check_keys)
     unknown_keys = self.keys - check_keys
@@ -38,33 +29,3 @@ class Hash
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestHashHasKeys < Test::Unit::TestCase
-
-    # TODO Write test for Hash#diff.
-
-    def test_has_keys?
-      assert( { :a=>1,:b=>2,:c=>3 }.has_keys?(:a,:b) )
-      assert( ! { :a=>1,:b=>2,:c=>3 }.has_keys?(:a,:b,:d) )
-    end
-
-    def test_has_only_keys?
-      assert( { :a=>1,:b=>2,:c=>3 }.has_only_keys?(:a,:b,:c) )
-      assert( ! { :a=>1,:b=>2,:c=>3 }.has_only_keys?(:a,:b) )
-    end
-
-  end
-
-=end

data/lib/core/facets/hash/insert.rb

@@ -1,23 +1,12 @@
-# TITLE:
-#
-#   Hash Insert
-#
-# SUMMARY:
-#
-#   As with #store but only if the key isn't already in the hash.
-#
-# CREDITS:
-#
-#   - Thomas Sawyer
-
-#
 class Hash
 
   # As with #store but only if the key isn't
   # already in the hash.
-  #--
-  # ??? Would #store? be a better name?
-  #++
+  #
+  # TODO: Would #store? be a better name?
+  #
+  #   CREDIT: Trans
+
   def insert(name, value)
     if key?(name)
       false
@@ -28,25 +17,3 @@ class Hash
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestHashInsert < Test::Unit::TestCase
-
-    def test_insert
-      h = { :a=>1, :b=>2 }
-      assert_equal( true  , h.insert(:c,3) )
-      assert_equal( false , h.insert(:a,0) )
-    end
-  end
-
-=end

data/lib/core/facets/hash/inverse.rb

@@ -1,21 +1,5 @@
-# TITLE:
-#
-#   Hash Inverse
-#
-# SUMMARY:
-#
-#   Create a "true" inverse hash by storing mutliple values
-#   in Arrays.
-#
-# CREDITS:
-#
-#   - Tilo Sloboda
-
-#
 class Hash
 
-  # CREDIT Tilo Sloboda
-
   # Create a "true" inverse hash by storing mutliple values
   # in Arrays.
   #
@@ -25,6 +9,8 @@ class Hash
   #   h.inverse               #=> {2=>"d", 3=>["f", "c", "b", "a"], 9=>["g", "e"]}
   #   h.inverse.inverse       #=> {"a"=>3, "b"=>3, "c"=>3, "d"=>2, "e"=>9, "f"=>3, "g"=>9}
   #   h.inverse.inverse == h  #=> true
+  #
+  #   CREDIT: Tilo Sloboda
 
   def inverse
     i = Hash.new
@@ -39,28 +25,3 @@ class Hash
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestHashInverse < Test::Unit::TestCase
-
-    def test_inverse
-      h1 = { :a=>1, :b=>2, :c=>2 }
-      h2 = h1.inverse
-      assert_equal( :a, h2[1] )
-      assert( h2[2].include?(:b) )
-      assert( h2[2].include?(:c) )
-    end
-
-  end
-
-=end

data/lib/core/facets/hash/iterate.rb

@@ -1,20 +1,9 @@
-# TITLE:
-#
-#   Hash Iteration Extensions
-#
-# SUMMARY:
-#
-#   Iteration related extensions for Hash class.
-#
-# CREDIT:
-#
-#   - Thomas Sawyer
-
-#
 class Hash
 
   # Each with key is like each_pair but reverses the order
   # the parameters to [value,key] instead of [key,value].
+  #
+  #   CREDIT: Trans
 
   def each_with_key( &yld )
     each_pair{ |k,v| yld.call(v,k) }
@@ -29,41 +18,11 @@ class Hash
   #   {:a=>1,:b=>2}.pairs_at(:a,:c)  #=> {:a=>1, :c=>nil}
   #
   # The later form is equivalent to #pairs_at.
+  #
+  #   CREDIT: Trans
 
   def pairs_at( *keys )
     keys.inject({}) {|h,k| h[k] = self[k]; h}
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestHashIterate < Test::Unit::TestCase
-
-    def test_each_with_key
-      h1 = { :a=>1, :b=>2 }
-      h2 = {}
-      h1.each_with_key { |v,k| h2[v] = k }
-      assert_equal( {1=>:a, 2=>:b}, h2 )
-    end
-
-    def test_each_with_key
-      h1 = { :a=>1, :b=>2 }
-      h2 = {}
-      h1.each_with_index { |v,k| h2[v] = k }
-      assert_equal( {1=>:a, 2=>:b}, h2 )
-    end
-
-  end
-
-=end

data/lib/core/facets/hash/keyize.rb

@@ -1,25 +1,9 @@
-# TITLE:
-#
-#   Hash Key-ize Extensions
-#
-# SUMMARY:
-#
-#   Extensions of Hash for converting keys.
-#
-# CREDIT:
-#
-#   - David H. H.
-#   - Thomas Sawyer
-#
-# NOTES:
-#
-#   - These methods are largely usurped by Hash#rekey.
-#     They remain available for the time being for improved
-#     intercompability with Rail's ActiveSupport library.
-
-#
 class Hash
 
+  # NOTE: These methods are largely usurped by Hash#rekey.
+  #       They remain available for the time being for improved
+  #       intercompability with Rail's ActiveSupport library.
+
   # Converts all keys in the Hash accroding to the given block.
   # If the block return +nil+ for given key, then that key will be
   # left intact.
@@ -28,9 +12,8 @@ class Hash
   #   foo.normalize_keys{ |k| k.to_s }  #=>  { "name"=>"Gavin", "wife"=>:Lisa }
   #   foo.inspect                       #=>  { :name =>"Gavin", :wife=>:Lisa }
   #
-  #--
-  # Adapted from Gavin Sinclair's #convert_keys.
-  #++
+  #   CREDIT: Trans
+  #   CREDIT: Gavin Sinclair
 
   def normalize_keys( &block )
     dup.send(:normalize_keys!, &block)
@@ -42,9 +25,8 @@ class Hash
   #   foo.normalize_keys!{ |k| k.to_s }  #=>  { "name"=>"Gavin", "wife"=>:Lisa }
   #   foo.inspect                        #=>  { "name"=>"Gavin", "wife"=>:Lisa }
   #
-  #--
-  # Adapted from Gavin Sinclair's #convert_keys.
-  #++
+  #   CREDIT: Trans
+  #   CREDIT: Gavin Sinclair
 
   def normalize_keys!( &block )
     keys.each{ |k|
@@ -61,9 +43,8 @@ class Hash
   #   foo.stringify_keys    #=>  { "name"=>"Gavin", "wife"=>:Lisa }
   #   foo.inspect           #=>  { :name =>"Gavin", :wife=>:Lisa }
   #
-  #--
-  # Adapted from Gavin Sinclair's #convert_keys.
-  #++
+  #   CREDIT: Trans
+  #   CREDIT: Gavin Sinclair
 
   def stringify_keys( &filter )
     if filter
@@ -82,9 +63,9 @@ class Hash
   #   foo.stringify_keys!    #=>  { "name"=>"Gavin", "wife"=>:Lisa }
   #   foo.inspect            #=>  { "name"=>"Gavin", "wife"=>:Lisa }
   #
-  #--
-  # Adapted from Gavin Sinclair's #convert_keys.
-  #++
+  #   CREDIT: Trans
+  #   CREDIT: Gavin Sinclair
+
   def stringify_keys!( &filter )
     if filter
       normalize_keys!{ |k| filter[k] ? k.to_s : nil }
@@ -102,9 +83,8 @@ class Hash
   #   foo.symbolize_keys    #=>  { :name=>"Gavin", :wife=>:Lisa }
   #   foo.inspect           #=>  { "name" =>"Gavin", "wife"=>:Lisa }
   #
-  #--
-  # Adapted from Gavin Sinclair's graceous work #symbolify_keys.
-  #++
+  #   CREDIT: Trans
+  #   CREDIT: Gavin Sinclair
 
   def symbolize_keys( &filter )
     if filter
@@ -129,9 +109,8 @@ class Hash
   #   foo.symbolize_keys!    #=>  { :name=>"Gavin", :wife=>:Lisa }
   #   foo.inspect            #=>  { :name=>"Gavin", :wife=>:Lisa }
   #
-  #--
-  # Adapted from Gavin Sinclair's graceous work #symbolify_keys!
-  #++
+  #   CREDIT: Trans
+  #   CREDIT: Gavin Sinclair
 
   def symbolize_keys!( &filter )
     if filter
@@ -157,6 +136,10 @@ class Hash
   #   foo = { :name=>'Gavin', :wife=>:Lisa }
   #   foo.variablize_keys    #=>  { "@name"=>"Gavin", "@wife"=>:Lisa }
   #   foo.inspect            #=>  { :name =>"Gavin", :wife=>:Lisa }
+  #
+  #   CREDIT: Trans
+  #   CREDIT: David Hansson
+
 
   def variablize_keys( of_class=nil )
     self.dup.variablize_keys!( of_class )
@@ -169,6 +152,9 @@ class Hash
   #   foo = { :name=>'Gavin', :wife=>:Lisa }
   #   foo.variablize_keys!   #=>  { "@name"=>"Gavin", "@wife"=>:Lisa }
   #   foo.inspect            #=>  { "@name"=>"Gavin", "@wife"=>:Lisa }
+  #
+  #   CREDIT: Trans
+  #   CREDIT: David Hansson
 
   def variablize_keys!( of_class=nil )
     raise ArgumentError, "Parameter must be a class" unless of_class.kind_of?(Class) if of_class
@@ -193,57 +179,3 @@ class Hash
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestHashKeyize < Test::Unit::TestCase
-
-    def test_normalize_keys_01
-      foo = { :a=>1, :b=>2 }
-      assert_equal( { "a"=>1, "b"=>2 }, foo.normalize_keys{|k|k.to_s} )
-      assert_equal( { :a =>1, :b=>2 }, foo  )
-    end
-
-    def test_normalize_keys_02
-      foo = { :a=>1, :b=>2 }
-      assert_equal( { "a"=>1, "b"=>2 }, foo.normalize_keys!{|k|k.to_s}  )
-      assert_equal( { "a"=>1, "b"=>2 }, foo )
-    end
-
-    def test_keys_to_s
-      foo = { :a=>1, :b=>2 }
-      assert_equal( { "a"=>1, "b"=>2 }, foo.stringify_keys )
-      assert_equal( { :a =>1, :b=>2 }, foo  )
-    end
-
-    def test_keys_to_s!
-      foo = { :a=>1, :b=>2 }
-      assert_equal( { "a"=>1, "b"=>2 }, foo.stringify_keys!  )
-      assert_equal( { "a"=>1, "b"=>2 }, foo )
-    end
-
-    def test_keys_to_sym
-      foo = { 'a'=>1, 'b'=>2 }
-      assert_equal( { :a=>1, :b=>2 }, foo.symbolize_keys )
-      assert_equal( { "a" =>1, "b"=>2 }, foo )
-    end
-
-    def test_keys_to_sym!
-      foo = { 'a'=>1, 'b'=>2 }
-      assert_equal( { :a=>1, :b=>2 }, foo.symbolize_keys! )
-      assert_equal( { :a=>1, :b=>2 }, foo  )
-    end
-
-  end
-
-=end