facets 2.4.5 → 2.5.0

data/lib/core/facets/enumerable/entropy.rb

@@ -9,7 +9,7 @@ module Enumerable
   #
   #   %w{ a b c d e e e }.entropy  #=>
   #
-  #   CREDIT: Derek
+  # CREDIT: Derek
 
   def entropy
     arr = to_a
@@ -25,7 +25,7 @@ module Enumerable
   # with given size assuming that it is an "order-0" source
   # (each element is selected independently of the next).
   #
-  #   CREDIT: Derek
+  # CREDIT: Derek
 
   def ideal_entropy
     arr = to_a

data/lib/core/facets/enumerable/frequency.rb

@@ -3,7 +3,7 @@ module Enumerable
   # Generates a hash mapping each unique symbol in the array
   # to the absolute frequency it appears.
   #
-  #  CREDIT: Brian Schröder
+  # CREDIT: Brian Schröder
 
   def frequency
     #probs = Hash.new(0)

data/lib/core/facets/enumerable/graph.rb

@@ -0,0 +1 @@
+require 'facets/enumerable/mash'

data/lib/core/facets/enumerable/group_by.rb

@@ -12,7 +12,7 @@ module Enumerable
     #   ["I had", 1, "dollar and", 50, "cents"].group_by { |e| e.class }
     #        #=> { String => ["I had","dollar and","cents"], Fixnum => [1,50] }
     #
-    #  CREDIT: Erik Veenstra
+    # CREDIT: Erik Veenstra
 
     def group_by #:yield:
       #h = k = e = nil

data/lib/core/facets/enumerable/inject.rb

@@ -1,6 +1,6 @@
 module Enumerable
 
-  # A small variation of #Inject that save one from having to 
+  # A small variation of #Inject that save one from having to
   # return the aggregating or memo argument.
   #
   # Say you want to count letters.
@@ -11,8 +11,7 @@ module Enumerable
   #
   #    some_text.inject(Hash.new(0)) {|h,l| h[l] +=1; h}
   #
-  #  CREDIT: David Black
-  #  CREDIT: Louis J Scoras
+  # CREDIT: David Black, Louis J Scoras
 
   def inject!(s)
     k = s

data/lib/core/facets/enumerable/map_send.rb

@@ -1,12 +1,24 @@
 module Enumerable
 
-   # Send a message to each element and collect the result.
-   #
-   #  CREDIT: Sean O'Halpin
+  # Send a message to each element and collect the result.
+  #
+  # CREDIT: Sean O'Halpin
 
   def map_send(meth, *args, &block)
     map{|e| e.send(meth, *args, &block)}
   end
 
+  # Send a message to each element and collect the result.
+  #
+  # CREDIT: Sean O'Halpin
+  #
+  #def map_send(meth, *args) #:yield:
+  #  if block_given?
+  #    map{|e| yield(e.send(meth, *args))}
+  #  else
+  #    map{|e| e.send(meth, *args)}
+  #  end
+  #end
+
 end
 

data/lib/core/facets/enumerable/mash.rb

@@ -1,16 +1,15 @@
 module Enumerable
 
-  # Like <tt>#map</tt>/<tt>#collect</tt>, but generates a Hash.  The block
+  # Like <tt>#map</tt>/<tt>#collect</tt>, but generates a Hash. The block
   # is expected to return two values: the key and the value for the new hash.
   #
   #   numbers  = (1..3)
   #   squares  = numbers.mash { |n| [n, n*n] }   # { 1=>1, 2=>4, 3=>9 }
   #   sq_roots = numbers.mash { |n| [n*n, n] }   # { 1=>1, 4=>2, 9=>3 }
   #
-  # CREDIT: Trans
-  # CREDIT: Andrew Dudzik (adudzik)
+  # The name "mash" stands for "map hash".
   #
-  # NOTE: Would #correlate would be better?
+  # CREDIT: Andrew Dudzik (adudzik), Trans
 
   def mash(&yld)
     if yld
@@ -25,7 +24,7 @@ module Enumerable
     end
   end
 
-  # Alias for #mash. This is the original name for this method.
+  # Alias for #mash. This is the original name of this method.
   alias_method :graph, :mash
 
 end

data/lib/core/facets/enumerable/mode.rb

@@ -3,7 +3,7 @@ module Enumerable
   # In Statistics mode is the value that occurs most
   # frequently in a given set of data.
   #
-  #  CREDIT: Robert Klemme
+  # CREDIT: Robert Klemme
 
   def mode
     max = 0

data/lib/core/facets/enumerable/modulate.rb

@@ -4,9 +4,9 @@ module Enumerable
   #
   # [2,4,6,8].modulate(2)  #=> [[2,6],[4,8]]
   #
-  #  CREDIT: Trans
+  # CREDIT: Trans
   #
-  # NOTE: Would this be better named 'collate'?
+  # NOTE: Would the better name for this be 'collate'?
 
   def modulate(modulo)
     return to_a if modulo == 1

data/lib/core/facets/enumerable/none.rb

@@ -16,7 +16,7 @@ unless (RUBY_VERSION[0,3] == '1.9')
     #   (1...10).none? { |n| n < 0 }  # true
     #   (1...10).none? { |n| n > 0 }  # false
     #
-    #   CREDIT: Gavin Sinclair
+    # CREDIT: Gavin Sinclair
 
     def none?  # :yield: e
       if block_given?

data/lib/core/facets/enumerable/occur.rb

@@ -13,8 +13,6 @@ module Enumerable
   #   [1,1,2,3,3,4,5,5].occur { |n| n == 1 } #=> [2,4]
   #   [1,1,2,3,3,4,5,5].occur { |n| n > 1 }  #=> [1,3,5]
   #
-  #   CREDIT: ?
-
   def occur(n=nil) #:yield:
     result = Hash.new { |hash, key| hash[key] = Array.new }
     self.each do |item|

data/lib/core/facets/enumerable/one.rb

@@ -16,7 +16,7 @@ unless (RUBY_VERSION[0,3] == '1.9')
     #   (1...10).one? { |n| n == 5 } # true
     #   (1...10).one? { |n| n < 5 }  # false
     #
-    #   CREDIT: Gavin Sinclair
+    # CREDIT: Gavin Sinclair
 
     def one?  # :yield: e
       matches = 0

data/lib/core/facets/enumerable/probability.rb

@@ -4,7 +4,7 @@ module Enumerable
   # to the relative frequency, i.e. the probablity, of
   # it appearence.
   #
-  #   CREDIT: Brian Schröder
+  # CREDIT: Brian Schröder
 
   def probability
     probs = Hash.new(0.0)

data/lib/core/facets/enumerable/sum.rb

@@ -4,7 +4,7 @@ module Enumerable
   #
   #   [1,2,3].sum  #=> 6
   #   [3,3,3].sum  #=> 9
-
+  #
   def sum(identity = 0, &block)
     if block_given?
       map(&block).sum

data/lib/core/facets/enumerable/take.rb

@@ -0,0 +1,20 @@
+module Enumerable
+
+  if RUBY_VERSION < "1.9"
+
+    # Return the first n items from the collection
+    #
+    def take(n)
+      res = []
+      count = 0
+      each do |e|
+        break if count >= n
+        res << e
+        count += 1
+      end
+      res
+    end
+
+  end
+
+end

data/lib/core/facets/enumerable/uniq_by.rb

@@ -8,8 +8,6 @@ module Enumerable
   #
   #   [-5, -4, -3, -2, -1, 0]
   #
-  #   CREDIT: ?
-
   def uniq_by #:yield:
     h = {}; inject([]) {|a,x| h[yield(x)] ||= a << x}
   end

data/lib/core/facets/exception/detail.rb

@@ -9,7 +9,7 @@ class Exception
   # Output:
   # The pretty printed string
   #
-  #  CREDIT: George Moschovitis
+  # CREDIT: George Moschovitis
 
   def detail
     return %{#{message}\n  #{backtrace.join("\n  ")}\n  LOGGED FROM: #{caller[0]}}

data/lib/core/facets/exception/suppress.rb

@@ -2,8 +2,7 @@ class Exception
 
   # Supress errors while executing a block, with execptions.
   #
-  #  CREDIT: Trans
-  #  CREDIT: David Heinemeier Hansson
+  # CREDIT: David Heinemeier Hansson, Thomas Sawyer
 
   def self.suppress(*exception_classes)
     exception_classes.each do |e|

data/lib/core/facets/file/append.rb

@@ -2,7 +2,7 @@ class File
 
   # Append to a file.
   #
-  #   CREDIT: George Moschovitis
+  # CREDIT: George Moschovitis
 
   def self.append( file, str )
     File.open( file, 'ab' ) { |f|

data/lib/core/facets/file/create.rb

@@ -8,7 +8,7 @@ class File
   #   str = 'The content for the file'
   #   File.create('myfile.txt', str)
   #
-  #   CREDIT: George Moschovitis
+  # CREDIT: George Moschovitis
 
   def self.create(path, str='', &blk)
     open(path, 'wb') do |f|

data/lib/core/facets/file/null.rb

@@ -2,7 +2,7 @@ class File
 
   # Platform dependent null device.
   #
-  #   CREDIT: Daniel Burger
+  # CREDIT: Daniel Burger
 
   def self.null
     case RUBY_PLATFORM

data/lib/core/facets/file/read.rb

@@ -2,7 +2,7 @@ class File
 
   # Cleans up a filename to ensure it will work on filesystem.
   #
-  #  CREDIT: George Moschovitis
+  # CREDIT: George Moschovitis
 
   def self.sanitize(filename)
     filename = File.basename(filename.gsub("\\", "/")) # work-around for IE
@@ -13,7 +13,7 @@ class File
 
   # Read in a file as binary data.
   #
-  #  CREDIT: George Moschovitis
+  # CREDIT: George Moschovitis
 
   def self.read_binary(fname)
     open(fname, 'rb') {|f|
@@ -25,7 +25,7 @@ class File
   # (lines starting with '#') and then returns
   # an array of all the remaining lines.
   #
-  #   CREDIT: Trans
+  # CREDIT: Trans
 
   def self.read_list(filepath, chomp_string='')
     farr = nil

data/lib/core/facets/file/rewrite.rb

@@ -23,7 +23,7 @@ class File
   # of the file string. The new version will write whatever the block
   # returns instead!!!
   #
-  #  CREDIT: George Moschovitis
+  # CREDIT: George Moschovitis
   #
   def self.rewrite(name, mode = "") #:yield:
     unless block_given?

data/lib/core/facets/file/rootname.rb

@@ -7,7 +7,7 @@ class File
   #   File.rootname('/jump.rb')     #=> '/'
   #   File.rootname('jump.rb')      #=> '.'
   #
-  #   CREDIT: Trans
+  # CREDIT: Trans
   #
   def self.rootname(path)
     # this should be fairly robust

data/lib/core/facets/file/split_all.rb

@@ -0,0 +1,19 @@
+class File
+
+  # Splits a file path into an array of individual path components.
+  # This differs from <tt>File.split</tt>, which divides the path into
+  # only two parts, directory path and basename.
+  #
+  #   File.split_all("a/b/c") =>  ['a', 'b', 'c']
+  #
+  # CREDIT: Trans
+
+  def self.split_all(path)
+    head, tail = File.split(path)
+    return [tail] if head == '.' || tail == '/'
+    return [head, tail] if head == '/'
+    return split_all(head) + [tail]
+  end
+
+end
+

data/lib/core/facets/file/split_root.rb

@@ -1,5 +1,8 @@
 class File
 
+  # Return the head of path from the rest of the path.
+  #
+  #   File.split_root('etc/xdg/gtk')  #=> ['etc', 'xdg/gtk']
   #
   def self.split_root(path)
     path_re = Regexp.new('[' + Regexp.escape(File::Separator + %q{\/}) + ']')

data/lib/core/facets/file/write.rb

@@ -10,7 +10,7 @@ class File
   #
   # Returns the number of bytes written.
   #
-  #   CREDIT: Gavin Sinclair
+  # CREDIT: Gavin Sinclair
 
   def self.write(path, data)
     File.open(path, "wb") do |file|

data/lib/core/facets/file/writelines.rb

@@ -11,8 +11,7 @@ class File
   #
   # Returns +nil+.
   #
-  #   CREDIT: Noah Gibbs
-  #   CREDIT: Gavin Sinclair
+  # CREDIT: Noah Gibbs, Gavin Sinclair
 
   def self.writelines(path, data)
     File.open(path, "wb") do |file|

data/lib/core/facets/filetest/root.rb

@@ -4,7 +4,7 @@ module FileTest
 
   # Is the specified directory the root directory?
   #
-  #  CREDIT: Jeffrey Schwab
+  # CREDIT: Jeffrey Schwab
 
   def root?(dir=nil)
     pth = File.expand_path(dir||Dir.pwd)

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

@@ -18,7 +18,7 @@ class Hash
   # Note that if the _oldkey_ is reassigned, the reference will no longer exist,
   # and the _newkey_ will remain as it was.
   #
-  #  CREDIT: Gavin Sinclair
+  # CREDIT: Gavin Sinclair
   #
   # TODO: Rename to #aliaskey or something else.
 

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

@@ -14,8 +14,7 @@ class Hash
   #   p ah['section one'].keys
   #   # ["param one", "param four", "param three", "param two"]
   #
-  #  CREDIT: Trans
-  #  CREDIT: Jan Molic
+  # CREDIT: Trans, Jan Molic
 
   def self.autonew(*args)
     #new(*args){|a,k| a[k] = self.class::new(*args)}
@@ -23,20 +22,5 @@ class Hash
     new(*args,&leet)
   end
 
-  # Creates a new hash from two arrays --a keys array and
-  # a values array.
-  #
-  #   Hash.zipnew(["a","b","c"], [1,2,3])
-  #     #=> { "a"=>1, "b"=>2, "c"=>3 }
-  #
-  #  CREDIT: Trans
-  #  CREDIT: Ara T. Howard
-
-  def self.zipnew(keys,values) # or some better name
-    h = {}
-    keys.size.times{ |i| h[ keys[i] ] = values[i] }
-    h
-  end
-
 end
 

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

@@ -6,7 +6,7 @@ class Hash
   #   { :a=>1, :b=>2 }.collate :a=>3, :b=>4, :c=>5
   #   #=> { :a=>[1,3], :b=>[2,4], :c=>[5] }
   #
-  #  CREDIT: Gavin Kistner (Phrogz)
+  # CREDIT: Gavin Kistner (Phrogz)
 
   def collate(other_hash)
     dup.collate!(other_hash)

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

@@ -6,7 +6,7 @@ class Hash
   #
   #
   #
-  #   CREDIT: Daniel Schierbeck
+  # CREDIT: Daniel Schierbeck
 
   def delete_unless #:yield:
     delete_if{ |key, value| ! yield(key, value) }
@@ -19,7 +19,7 @@ class Hash
   #   hsh.delete_values(1)
   #   hsh  #=> { :b => 2 }
   #
-  #   CREDIT: Daniel Schierbeck
+  # CREDIT: Daniel Schierbeck
 
   def delete_values(*values)
     keys.map{ |key| delete(key) if values.include?(fetch(key)) }
@@ -37,7 +37,7 @@ class Hash
   #    [a, b, c]  #=> [1, 2, 3]
   #    hsh        #=> {}
   #
-  #   CREDIT: Daniel Schierbeck
+  # CREDIT: Daniel Schierbeck
 
   def delete_values_at(*keys, &yld)
     keys.map{|key| delete(key, &yld) }