facets 2.9.3 → 3.0.0

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

@@ -6,13 +6,17 @@ class Array
   # If two arguments are given it calls #store.
   # If a single argument is given it calls slice!.
   #
+  # Examples
+  #
   #   a = [1,2,3]
   #   a.splice(1)    #=> 2
   #   a              #=> [1,3]
   #
   #   a = [1,2,3]
   #   a.splice(1,4)  #=> 4
-  #   a              #=>[1,4,3]
+  #   a              #=> [1,4,3]
+  #
+  # Returns [Array].
   #
   # CREDIT: Trans
 

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

@@ -1,11 +1,14 @@
 class Array
 
-  # Split on matching pattern. Unlike #divide this does not include matching elements.
+  # Split on matching pattern. Unlike #divide this does not include matching
+  # elements.
+  #
+  # Examples
   #
   #   ['a1','a2','b1','a3','b2','a4'].split(/^b/)
   #   #=> [['a1','a2'],['a3'],['a4']]
   #
-  # CREDIT: Trans
+  # Returns list of split-up arrays. [Array<Array>]
 
   def split(pattern)
     memo = []

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

@@ -0,0 +1,23 @@
+require 'facets/enumerable/squeeze'
+
+class Array
+
+  # Destructive version of Enumerable#squeeze.
+  #
+  #   a = [1,2,2,3,3,2,1]
+  #   a.squeeze!
+  #   a #=> [1,2,3,2,1]
+  #
+  #   a = [1,2,2,3,3,2,1]
+  #   a.squeeze!(*[3])
+  #   a #=> [1,2,2,3,2,1]
+  #
+  # Returns the receiver. [Array]
+  #
+  # CREDIT: T. Yamada
+
+  def squeeze!(*limited_to)
+    replace(squeeze(*limited_to))
+  end
+
+end

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

@@ -0,0 +1,31 @@
+class Array
+
+  # Iterate over every nth element of an array.
+  #
+  #   r = []
+  #   [:a, :b, :c, :d].step(2) { |x| r << x }
+  #   r   #=> [:b, :d]
+  #   
+  # Without a block it returns an Enumerator.
+  #
+  #   [:a, :b, :c, :d].step(1).to_a   #=> [:a, :b, :c, :d]
+  #   [:a, :b, :c, :d].step(2).to_a   #=> [:b, :d]
+  #   [:a, :b, :c, :d].step(3).to_a   #=> [:c]
+  #   [:a, :b, :c, :d].step(5).to_a   #=> []
+  #
+  # CREDIT: Ryan Duryea
+
+  def step(n) #:yield:
+    if block_given?
+      ((n - 1)...size).step(n).each do |i|
+        yield(fetch(i))
+      end
+    else
+      Enumerator.new(size / n) do |y|
+        ((n - 1)...self.size).step(n).each { |i| y << fetch(i) }  
+      end
+    end
+  end
+end
+
+

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

@@ -2,10 +2,14 @@ class Array
 
   # Store a value at a given index. Store is an alias for #[]=.
   #
+  # Example:
+  #
   #   a = []
   #   a.store(1, "A")
   #   a[1] #=> "A"
   #
+  # Returns the stored object.
+
   alias_method :store, :[]=
 
 end

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

@@ -0,0 +1,22 @@
+class Array
+
+  # Convert an associative array to a Hash.
+  #
+  # Examples
+  #
+  #   [[:a, 1], [:b, 2]].to_h
+  #   #=> {:a=>1, :b=>2}
+  #
+  #   [[:a, 1], :b].to_h
+  #   #=> {:a=>1, :b=>nil}
+  #
+  # Returns [Hash].
+  #
+  def to_h
+    h = {}
+    each{ |(k,v)| h[k] = v }
+    h
+  end unless method_defined?(:to_h)
+
+end
+

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

@@ -1,18 +1,21 @@
 class Array
 
-  # Returns a new array created by traversing the array and its
+  # Construct a new array created by traversing the array and its
   # sub-arrays, executing the given block on the elements.
   #
-  #   h = ["A", "B", ["X", "Y"]]
+  # Examples
   #
+  #   h = ["A", "B", ["X", "Y"]]
   #   g = h.traverse{ |e| e.downcase }
-  #
   #   g  #=> ["a", "b", ["x", "y"]]
   #
   # This is the same as <code>recursive.map</code> and will
   # likely be deprecated in the future because of it.
   #
+  # Returns new array. [Array]
+  #
   # CREDIT: Trans
+
   def traverse(&block)
     if block_given?
       map do |e|
@@ -29,13 +32,16 @@ class Array
 
   # Like #recursive_map, but will change the array in place.
   #
-  #   h = ["A", "B", ["X", "Y"]]
+  # Examples:
   #
+  #   h = ["A", "B", ["X", "Y"]]
   #   h.traverse!{ |e| e.downcase }
-  #
   #   h  #=> ["a", "b", ["x", "y"]]
   #
+  # Returns self. [Array]
+  #
   # CREDIT: Trans
+
   def traverse!(&block)
     replace(traverse(&block))
   end

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

@@ -1,12 +1,16 @@
 class Array
 
   # Like #uniq, but determines uniqueness based on a given block.
+  # As can be seen in the following examples, order is significant.
+  #
+  # Examples
   #
   #   a = (-5..5).to_a
   #   a.uniq_by!{ |i| i*i }
   #   a #=> [-5, -4, -3, -2, -1, 0]
   #
-  # As can be seen in the example, order is significant.
+  # Returns [Array] of unique elements.
+  #
   def uniq_by! #:yield:
     h = {}
     replace( inject([]){|a,x| h[yield(x)] ||= a << x} )

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

@@ -0,0 +1,29 @@
+class Array
+
+  # Enumerates permutation of Array.
+  # Unlike Array#permutation, there are no duplicates in generated permutations.
+  # Instead, elements must be comparable.
+  #
+  #   [1,1,2,2,3].unique_permutation(2).to_a
+  #   #=> [[1, 1], [1, 2], [1, 3], [2, 1], [2, 2], [2, 3], [3, 1], [3, 2]]
+  #   # Note: [1,1,2,2,3].permutation(2).to_a
+  #   #=> [[1, 1], [1, 2], [1, 2], [1, 3], [1, 1], [1, 2], [1, 2], [1, 3], [2, 1], [2, 1], [2, 2], [2, 3], [2, 1], [2, 1], [2, 2], [2, 3], [3, 1], [3, 1], [3, 2], [3, 2]]
+  #
+  # CREDIT: T. Yamada
+  def unique_permutation(n=self.size)
+    return to_enum(:unique_permutation,n) unless block_given?
+    return if n<0||self.size<n
+    a=self.sort # sort is O(nlogn), so I believe this is not so costly. (Also sort is not destructive)
+    yield a[0,n]
+    loop{
+      a=a[0,n]+a[n..-1].reverse
+      k=(a.size-2).downto(0).find{|i|a[i]<a[i+1]}
+      break if !k
+      l=(a.size-1).downto(k+1).find{|i|a[k]<a[i]}
+      a[k],a[l]=a[l],a[k]
+      a=a[0,k+1]+a[k+1..-1].reverse
+      yield a[0,n]
+    }
+  end
+ 
+end

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

@@ -0,0 +1,21 @@
+class Array
+
+  # Class level rendition of Array#zip.
+  #
+  # arrays - List of arrays to zip. [Array<Array>]
+  #
+  # Example:
+  #
+  #   Array.zip([1,2],[3,4]]
+  #   #=> [[1,3],[2,4]]
+  #
+  # Returns arranged array of arrays. [Array<Array>]
+  #
+  # Returns an empty array if no arguments are given. [Array]
+
+  def self.zip(*arrays)
+    return [] if arrays.empty?
+    return arrays[0].zip(*arrays[1..-1])
+  end
+
+end

data/lib/core/facets/binding.rb

@@ -1,10 +1,7 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'binding/caller.rb'
 require_relative 'binding/callstack.rb'
 require_relative 'binding/call_stack.rb'
 require_relative 'binding/defined.rb'
-require_relative 'binding/eval.rb'
 #require_relative 'binding/local_variables.rb'  # uncommon
 require_relative 'binding/op.rb'
 require_relative 'binding/op_get.rb'

data/lib/core/facets/binding/call_stack.rb

@@ -1 +1 @@
-require 'facets/kernel/call_stack'
+require 'facets/kernel/callstack'

data/lib/core/facets/binding/caller.rb

@@ -1,6 +1,4 @@
-require 'facets/binding/eval'
-require 'facets/binding/call_stack'
-require 'facets/kernel/__method__'
+require 'facets/binding/callstack'
 
 class Binding
 

data/lib/core/facets/binding/callstack.rb

@@ -1 +1 @@
-require 'facets/binding/call_stack'
+require 'facets/kernel/callstack'

data/lib/core/facets/binding/defined.rb

@@ -1,5 +1,3 @@
-require 'facets/binding/eval'
-
 class Binding
 
   # Returns the nature of something within the context of the binding.

data/lib/core/facets/binding/local_variables.rb

@@ -1,5 +1,3 @@
-require 'facets/binding/eval'
-
 class Binding
 
   # Returns the local variables defined in the binding context:

data/lib/core/facets/binding/op_get.rb

@@ -1,5 +1,3 @@
-require 'facets/binding/eval'
-
 class Binding
 
   # Returns the value of some variable.

data/lib/core/facets/binding/self.rb

@@ -1,8 +1,6 @@
-require 'facets/binding/eval'
-
 class Binding
 
-  # already defined by Rubinius
+  # This is already defined by Rubinius:
   #   Kernel.eval('Rubinius::VariableScope.current.self', self)
   unless method_defined?(:self)
 

data/lib/core/facets/cattr.rb

@@ -0,0 +1 @@
+require 'facets/class/cattr'

data/lib/core/facets/class.rb

@@ -1,5 +1,3 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'class/descendants.rb'
 #require_relative 'class/hierarchically'  # uncommon
 require_relative 'class/methodize.rb'

data/lib/core/facets/class/cattr.rb

@@ -0,0 +1 @@
+require 'facets/module/cattr'

data/lib/core/facets/class/singleton.rb

@@ -1,13 +1 @@
-class Class 
-
-  # Return true if a class is the singleton class of
-  # an object.
-  #
-  # @uncommon
-  #   require 'facets/class/singleton'
-  #
-  def singleton? 
-    ! ancestors.include?( self ) rescue false 
-  end
-
-end 
+require 'facets/class/singleton_class'

data/lib/core/facets/class/singleton_class.rb

@@ -0,0 +1,16 @@
+class Class 
+
+  # Return true if a class is the singleton class of
+  # an object.
+  #
+  # @uncommon
+  #   require 'facets/class/singleton_class'
+  #
+  def singleton_class? 
+    ! ancestors.include?( self ) rescue false 
+  end
+
+  # @deprecated
+  alias :singleton? :singleton_class?
+
+end 

data/lib/core/facets/comparable.rb

@@ -1,5 +1,3 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'comparable/at_least.rb'
 require_relative 'comparable/at_most.rb'
 require_relative 'comparable/bound.rb'

data/lib/core/facets/dir.rb

@@ -1,5 +1,3 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'dir/ascend.rb'
 require_relative 'dir/descend.rb'
 require_relative 'dir/each_child.rb'

data/lib/core/facets/dir/ascend.rb

@@ -14,8 +14,8 @@ class Dir
   #
   # CREDIT: Daniel Berger, Jeffrey Schwab
   #
-  # TODO: make it work with windows too
-  # use FileTest.root?
+  # TODO: Make it work with windows too
+  #       use FileTest.root?
 
   def self.ascend(dir, inclusive=true, &blk)
     dir = dir.dup

data/lib/core/facets/dir/lookup.rb

@@ -0,0 +1,20 @@
+class Dir
+
+  # Lookup directory tree for a path.
+  #
+  # TODO: Make a non class method version of this?
+  #
+  # Returns full path or `nil` if not found. [String,nil]
+
+  def self.lookup(rel_path, parent_path='.')
+    while true
+      path = File.expand_path(rel_path, parent_path)
+
+      return path if File.exists?(path)
+      return nil if path == '/'
+
+      parent_path = File.expand_path('..', parent_path)
+    end
+  end
+
+end

data/lib/core/facets/enumerable.rb

@@ -1,13 +1,10 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'enumerable/accumulate.rb'
-require_relative 'enumerable/cluster_by.rb'
+#require_relative 'enumerable/associate.rb'
+require_relative 'enumerable/cluster.rb'
 require_relative 'enumerable/collect_with_index.rb'
 require_relative 'enumerable/compact_map.rb'
-require_relative 'enumerable/count.rb'
 require_relative 'enumerable/defer.rb'
 require_relative 'enumerable/each_by.rb'
-require_relative 'enumerable/each_with_object.rb'
 require_relative 'enumerable/every.rb'
 require_relative 'enumerable/ewise.rb'
 require_relative 'enumerable/exclude.rb'
@@ -16,8 +13,9 @@ require_relative 'enumerable/filter.rb'
 require_relative 'enumerable/find_yield.rb'
 require_relative 'enumerable/frequency.rb'
 require_relative 'enumerable/graph.rb'
-require_relative 'enumerable/group_by.rb'
+#require_relative 'enumerable/hashify.rb'
 require_relative 'enumerable/incase.rb'
+require_relative 'enumerable/key_by'
 require_relative 'enumerable/map_by.rb'
 require_relative 'enumerable/map_detect.rb'
 require_relative 'enumerable/map_send.rb'
@@ -25,14 +23,17 @@ require_relative 'enumerable/map_with.rb'
 require_relative 'enumerable/map_with_index.rb'
 require_relative 'enumerable/mash.rb'
 require_relative 'enumerable/modulate.rb'
-require_relative 'enumerable/none.rb'
 require_relative 'enumerable/occur.rb'
-require_relative 'enumerable/one.rb'
+require_relative 'enumerable/organize_by.rb'
+require_relative 'enumerable/only.rb'
+require_relative 'enumerable/pair.rb'
 require_relative 'enumerable/per.rb'
 require_relative 'enumerable/purge.rb'
 require_relative 'enumerable/recursively.rb'
+require_relative 'enumerable/squeeze.rb'
 require_relative 'enumerable/sum.rb'
-require_relative 'enumerable/take.rb'
+require_relative 'enumerable/value_by'
+#require_relative 'enumerable/unassociate.rb'
 require_relative 'enumerable/uniq_by.rb'
 require_relative 'enumerable/visit.rb'
 require_relative 'enumerable/zip_map.rb'