facets 3.1.0 → 3.2.1

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

@@ -1,25 +1,21 @@
 class Binding
 
-  # Returns the value of some variable.
+  # Returns the value of a local variable.
   #
   #   a = 2
-  #   binding["a"]  #=> 2
+  #   binding[:a]  #=> 2
   #
-  def []( x )
-    eval( x.to_s )
+  def [](name)
+    local_variable_get(name.to_sym)
   end
 
   # Set the value of a local variable.
   #
-  #   binding["a"] = 4
+  #   binding[:a] = 4
   #   a  #=> 4
   #
-  # @deprecated No longer wortks in Ruby 1.9+.
-  #
-  # @see Binding#with for an alternative.
-  def []=( l, v )
-    eval( "lambda {|v| #{l} = v}").call( v )
+  def []=(name, value)
+    local_variable_set(name.to_sym, value)
   end
 
 end
-

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

@@ -1,15 +1,9 @@
 class Binding
 
-  # This is already defined by Rubinius:
-  #   Kernel.eval('Rubinius::VariableScope.current.self', self)
-  unless method_defined?(:self)
-
-    # Returns self of the binding's context.
-    def self
-      eval('self')
-    end
-
+  # @deprecated Use Binding#receiver instead (built-in since Ruby 2.6).
+  def self
+    warn "Binding#self is deprecated. Use Binding#receiver instead.", uplevel: 1
+    receiver
   end
 
 end
-

data/lib/core/facets/boolean.rb

@@ -86,7 +86,7 @@ class String
   #
   # All other strings return false.
   #
-  # Here are some exmamples.
+  # Here are some examples.
   #
   #   "true".to_b   #=> true
   #   "yes".to_b    #=> true

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

@@ -1,5 +1,3 @@
-require 'facets/class/subclasses'
-
 class Class
 
   # List all descedents of this class.

data/lib/core/facets/class.rb

@@ -3,7 +3,7 @@ require_relative 'class/descendants.rb'
 require_relative 'class/methodize.rb'
 require_relative 'class/pathize.rb'
 #require_relative 'class/preallocate.rb'  # uncommon
-#require_relative 'class/singleton.rb'    # uncommon
-require_relative 'class/subclasses.rb'
+#require_relative 'class/singleton.rb'    # removed, use Ruby's singleton_class
+#require_relative 'class/subclasses.rb'   # removed, use Ruby's subclasses
 require_relative 'class/to_proc.rb'
 

data/lib/core/facets/comparable/bound.rb

@@ -1 +1,13 @@
-require 'facets/comparable/clip'
+module Comparable
+
+  # Alias for Comparable#clamp. Reads more naturally in some contexts.
+  #
+  #   4.bound(2, 7)  #=> 4
+  #   9.bound(2, 7)  #=> 7
+  #   1.bound(2, 7)  #=> 2
+  #
+  def bound(lower, upper=nil)
+    upper ? clamp(lower, upper) : clamp(lower..)
+  end
+
+end

data/lib/core/facets/comparable/clip.rb

@@ -1,38 +1,9 @@
 module Comparable
 
-  # Returns self if above the given lower bound, or
-  # within the given lower and upper bounds,
-  # otherwise returns the the bound of which the
-  # value falls outside.
-  #
-  #   4.clip(3)    #=> 4
-  #   4.clip(5)    #=> 5
-  #   4.clip(2,7)  #=> 4
-  #   9.clip(2,7)  #=> 7
-  #   1.clip(2,7)  #=> 2
-  #
-  # CREDIT Florian Gross, Trans
-
+  # @deprecated Use Comparable#clamp instead (built-in since Ruby 2.4).
   def clip(lower, upper=nil)
-    return lower if self < lower
-    return self unless upper
-    return upper if self > upper
-    return self
+    warn "Comparable#clip is deprecated. Use Comparable#clamp instead.", uplevel: 1
+    upper ? clamp(lower, upper) : clamp(lower..)
   end
 
-  # Returns self if above the given lower bound, or
-  # within the given lower and upper bounds,
-  # otherwise returns the the bound of which the
-  # value falls outside.
-  #
-  #   4.bound(3)    #=> 4
-  #   4.bound(5)    #=> 5
-  #   4.bound(2,7)  #=> 4
-  #   9.bound(2,7)  #=> 7
-  #   1.bound(2,7)  #=> 2
-  #
-  # CREDIT: Florian Gross
-
-  alias_method :bound, :clip
-
 end

data/lib/core/facets/denumerable.rb

@@ -1,6 +1,3 @@
-require 'facets/enumerator'
-#require 'facets/enumerable/take'
-
 # Classes which include Denumerable will get versions of map,
 # select, and so on, which return a Denumerator, so that they
 # work horizontally without creating intermediate arrays.

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

@@ -0,0 +1,20 @@
+require 'find'
+
+class Dir
+
+  # Recursively traverse a directory, yielding each file and directory path.
+  # Supports Find.prune to skip subtrees.
+  #
+  #   Dir.find('.') do |path|
+  #     puts path
+  #   end
+  #
+  # Returns an enumerator if no block is given.
+  #
+  # This is a convenience wrapper around Ruby's Find.find.
+
+  def self.find(*paths, ignore_error: true, &block)
+    Find.find(*paths, ignore_error: ignore_error, &block)
+  end
+
+end

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

@@ -1,35 +1,17 @@
+require 'facets/dir/find'
+
 class Dir
 
-  # Recursively scan a directory and pass each file to the given block.
-  #
-  #   Dir.recurse('.') do |path|
-  #     # ...
-  #   end
-  #
-  # CREDIT: George Moschovitis
-  #
-  # TODO: If fully compatible, reimplement as alias of Find.find,
-  # or just copy and paste Find.find code here if it looks more robust.
-  #
+  # @deprecated Use Dir.find or Find.find instead.
   def self.recurse(path='.', &block)
-    list = []
-    stoplist = ['.', '..']
-    Dir.foreach(path) do |f|
-      next if stoplist.include?(f)
-      filename = (path == '.' ? f : path + '/' + f)
-      list << filename
-      block.call(filename) if block
-      if FileTest.directory?(filename) and not FileTest.symlink?(filename)
-        list.concat(Dir.recurse(filename, &block))
-      end
-    end
-    list
+    warn "Dir.recurse is deprecated. Use Dir.find or Find.find instead.", uplevel: 1
+    Dir.find(path, &block)
   end
 
-  # Same as Dir#recurse.
+  # @deprecated Use Dir.find or Find.find instead.
   def self.ls_r(path='.', &block)
-    recurse(path, &block)
+    warn "Dir.ls_r is deprecated. Use Dir.find or Find.find instead.", uplevel: 1
+    Dir.find(path, &block)
   end
 
 end
-

data/lib/core/facets/dir.rb

@@ -1,6 +1,6 @@
 require_relative 'dir/ascend.rb'
 require_relative 'dir/descend.rb'
-require_relative 'dir/each_child.rb'
+#require_relative 'dir/each_child.rb'  # removed: now provided by Ruby
 require_relative 'dir/multiglob.rb'
 require_relative 'dir/parent.rb'
 require_relative 'dir/recurse.rb'

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

@@ -15,18 +15,8 @@ module Enumerable
   # does almost the same thing and enum.map{}.compact works too.
 
   def compact_map(&block)
-    y = []
-    if block_given?
-      each do |*a|
-        r = yield(*a)
-        y << r unless r.nil?
-      end
-    else
-      each do |r|
-        y << r unless r.nil?
-      end
-    end
-    y
+    warn "Enumerable#compact_map is deprecated. Use Enumerable#filter_map instead.", uplevel: 1
+    filter_map(&block)
   end
 
   #

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

@@ -27,19 +27,8 @@ module Enumerable
   # to output each result and discard it.
   #
   def defer(&blk)
-    if block_given?
-      Denumerator.new do |output|
-        each do |*input|
-          yield(output, *input)
-        end
-      end
-    else
-      Denumerator.new do |output|
-        each do |*input|
-          output.yield(*input)
-        end
-      end
-    end
+    warn "Enumerable#defer is deprecated. Use Enumerable#lazy instead.", uplevel: 1
+    lazy
   end
 
 end

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

@@ -1,5 +1,3 @@
-require 'facets/enumerator'
-
 module Enumerable
 
   # Iterate through slices. If slice +steps+ is not

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

@@ -16,8 +16,8 @@ module Enumerable
   #++
 
   def frequency
-    p = Hash.new(0); each{ |v| p[v] += 1 }; p
-
+    warn "Enumerable#frequency is deprecated. Use Enumerable#tally instead.", uplevel: 1
+    tally
   end
 
 end

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

@@ -9,10 +9,9 @@ module Enumerable
   #
   # TODO: Enumerable#hinge will get a new name.
   #
-  def hinge(init={})
-    h = init
-    each{ |v| yield(h,v) }
-    h
+  def hinge(init={}, &block)
+    warn "Enumerable#hinge is deprecated. Use Enumerable#each_with_object instead (note: block args are reversed).", uplevel: 1
+    each_with_object(init) { |e, obj| block.call(obj, e) }
   end
 
 end

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

@@ -7,12 +7,9 @@ module Enumerable
   #
   # CREDIT: Gavin Sinclair
 
-  def map_with_index
-    r = []
-    each_with_index do |e, i|
-      r << yield(e, i)
-    end
-    r
+  def map_with_index(&block)
+    warn "Enumerable#map_with_index is deprecated. Use Enumerable#map.with_index instead.", uplevel: 1
+    map.with_index(&block)
   end
 
   # Alias for map_with_index.

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

@@ -1,34 +1,11 @@
-module Enumerable
+require 'facets/enumerable/graph'
 
-  # Like `#map`/`#collect`, 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: Andrew Dudzik (adudzik), Trans
+module Enumerable
 
+  # @deprecated Use Enumerable#graph instead.
   def mash(&yld)
-    if yld
-      h = {}
-      each do |*kv|
-        r = yld[*kv]
-        case r
-        when Hash
-          nk, nv = *r.to_a[0]
-        when Range
-          nk, nv = r.first, r.last
-        else
-          nk, nv = *r
-        end
-        h[nk] = nv
-      end
-      h
-    else
-      Enumerator.new(self,:graph)
-    end
+    warn "Enumerable#mash is deprecated. Use Enumerable#graph instead.", uplevel: 1
+    graph(&yld)
   end
 
 end
-

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

@@ -1,13 +1,9 @@
 module Enumerable
 
-  # Like #uniq, but determines uniqueness based on a given block.
-  #
-  #   (-5..5).to_a.uniq_by {|i| i*i }
-  #   #=> [-5, -4, -3, -2, -1, 0]
-  #
-  def uniq_by #:yield:
-    h = {}; inject([]) {|a,x| h[yield(x)] ||= a << x}
+  # @deprecated Use Enumerable#uniq with a block instead (Ruby 1.9.2+).
+  def uniq_by(&block)
+    warn "Enumerable#uniq_by is deprecated. Use Enumerable#uniq(&block) instead.", uplevel: 1
+    uniq(&block)
   end
 
 end
-

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

@@ -0,0 +1,58 @@
+
+module Enumerable
+	class Position
+		def initialize
+			@first = true
+			@last = false
+		end
+		
+		def after_first!
+			@first = false
+		end
+		
+		def at_end!
+			@last = true
+		end
+		
+		def first?
+			@first
+		end
+		
+		def middle?
+			not (@first or @last)
+		end
+		
+		def last?
+			@last
+		end
+	end
+	
+	# Allows one to know the position of the enumeration easily.
+	#
+	#    5.times.collect.with_position do |i, position|
+	#        $stdout.write "#{i}#{position.middle? ? ',' : ''}"
+	#    end
+	#
+	# Where this becomes more useful, is when it's easy to determine the position of elements, e.g.
+	#
+	#    10.times.select(&:odd?).with_position{|n,p| ... }
+	#
+	def with_position
+		return to_enum(:with_position) unless block_given?
+		
+		position = Position.new
+		
+		while item = self.next
+			begin
+				self.peek
+			rescue StopIteration
+				position.at_end!
+			end
+			
+			yield item, position.dup
+			
+			position.after_first!
+		end
+	rescue StopIteration
+	end
+end

data/lib/core/facets/enumerable.rb

@@ -9,7 +9,7 @@ require_relative 'enumerable/every.rb'
 require_relative 'enumerable/ewise.rb'
 require_relative 'enumerable/exclude.rb'
 require_relative 'enumerable/expand.rb'
-require_relative 'enumerable/filter.rb'
+#require_relative 'enumerable/filter.rb'  # removed: now provided by Ruby
 require_relative 'enumerable/find_yield.rb'
 require_relative 'enumerable/frequency.rb'
 require_relative 'enumerable/graph.rb'
@@ -31,7 +31,7 @@ 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/sum.rb'  # removed: now provided by Ruby
 require_relative 'enumerable/value_by'
 #require_relative 'enumerable/unassociate.rb'
 require_relative 'enumerable/uniq_by.rb'

data/lib/core/facets/enumerator.rb

@@ -1,75 +1,2 @@
-if RUBY_VERSION < '1.9'
-
-  require 'enumerator'
-
-  # for Ruby 1.8 -> 1.9 transition
-  Enumerator = Enumerable::Enumerator unless defined?(::Enumerator)
-
-  class Enumerator
-
-    private
-
-    alias :old_initialize :initialize
-
-    # Provides the ruby-1.9 block form of Enumerator, where you can write:
-    #
-    #    obj = Enumerator.new do |yielder|
-    #      # ...
-    #      yielder.yield(data)  # or: yielder << data
-    #      # ...
-    #    end
-    #
-    # When obj.each is called, the block is run once. It should call
-    # yielder.yield with each item it wishes to generate.
-    #
-    # Example:
-    #
-    #   fib = Enumerator.new { |y|
-    #     a = b = 1
-    #     loop {   
-    #       y << a
-    #       a, b = b, a + b
-    #     }
-    #   }  
-    #
-    #   fib.take(10)  #=> [1, 1, 2, 3, 5, 8, 13, 21, 34, 55]
-    #                                                 
-    def initialize(*args, &block)
-      if block
-        @body = block
-        old_initialize(self, :_start)
-      else
-        old_initialize(*args)
-      end
-    end
-
-    def _start(*args,&receiver) #:nodoc:
-      @body.call(Yielder.new(&receiver), *args)
-    end
-
-    # Wrapper to allow yielder.yield(output) or yielder << output
-    # in the same way as ruby-1.9
-    #
-    # TODO: Why can't Yielder take a block instead of a proc argument?
-
-    class Yielder #:nodoc:
-      def initialize(&proc)
-        @proc = proc
-      end
-      def yield(*args)
-        @proc[*args]
-      end
-      alias :<< :yield
-    end
-
-  end
-
-end
-
-path = __FILE__.chomp('.rb')
-base = File.basename(path)
-Dir[File.join(path, '*.rb')].each do |lib|
-  #require lib # why is this so much slower?
-  require "facets/#{base}/#{File.basename(lib)}"
-end
-
+require_relative 'enumerator/fx'
+require_relative 'enumerator/lazy/squeeze'

data/lib/core/facets/essentials.rb

@@ -16,7 +16,7 @@ require_relative 'kernel/false'
 require_relative 'kernel/true'
 
 ### Object
-require_relative 'object/itself'
+#require_relative 'object/itself'  # removed: now provided by Ruby
 
 ### Array
 require_relative 'array/delete_values'
@@ -37,11 +37,11 @@ require_relative 'enumerable/graph'
 require_relative 'enumerable/value_by'
 
 ### File
-require_relative 'file/write'
+#require_relative 'file/write'  # removed: now provided by Ruby
 
 ### Hash
 require_relative 'hash/autonew'
-require_relative 'hash/compact'
+#require_relative 'hash/compact'  # removed: now provided by Ruby
 #require_relative 'hash/data'
 require_relative 'hash/delete_values'
 require_relative 'hash/except'

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

@@ -1,80 +1,15 @@
 class Exception
 
-  # Formats the Exception so that it looks *familiar*,
-  # i.e. exactly like your interpreter does it.
-  #
-  # Port of MRI native `error_print` function.
-  #
-  # @author Evgeniy Dolzhenko
-
+  # @deprecated Use Exception#full_message instead (built-in since Ruby 2.5).
   def self.error_print(e)
-    warn_print = ""
-    backtrace = e.backtrace
-    backtrace = [ backtrace ] if backtrace.is_a?(String) # 1.9 returns single String for SystemStackError
-
-    warn_print << backtrace[0]
-    if e.is_a?(RuntimeError) && e.message.empty?
-      warn_print << ": unhandled exception\n"
-    else
-      if e.message.empty?
-        warn_print << ": #{ e.class.name }\n"
-      else
-        split_message = e.message.split("\n")
-        warn_print << ": "
-        if split_message.size == 1
-          warn_print << "#{ e.message } (#{ e.class.name })\n"
-        else
-          warn_print << split_message[0]
-          warn_print << " (#{ e.class.name })\n"
-          warn_print << split_message[1..-1].join("\n").chomp << "\n"
-        end
-      end
-    end
-
-    len = backtrace.size
-
-    ## int skip = eclass == rb_eSysStackError;
-    skip = e.is_a?(SystemStackError)
-
-    ## #define TRACE_MAX (TRACE_HEAD+TRACE_TAIL+5)
-    ## #define TRACE_HEAD 8
-    ## #define TRACE_TAIL 5
-    trace_head = 8
-    trace_tail = 5
-    trace_max = (trace_head + trace_tail + 5)
-    ##
-    ##	for (i = 1; i < len; i++) {
-    i = 1
-    while i < len
-      ##	    if (TYPE(ptr[i]) == T_STRING) {
-      ##		warn_printf("\tfrom %s\n", RSTRING_PTR(ptr[i]));
-      ##	    }
-      warn_print << "\tfrom %s\n" % e.backtrace[i]
-
-      ##	    if (skip && i == TRACE_HEAD && len > TRACE_MAX) {
-      if skip && i == trace_head && len > trace_max
-      ##		warn_printf("\t ... %ld levels...\n",
-      ##			    len - TRACE_HEAD - TRACE_TAIL);
-        warn_print << "\t ... %d levels...\n" % (len - trace_head - trace_tail)
-      ##		i = len - TRACE_TAIL;
-        i = len - trace_tail
-      ##	    }
-      end
-      ##	}
-      i += 1
-    end
-    warn_print
+    warn "Exception.error_print is deprecated. Use Exception#full_message instead.", uplevel: 1
+    e.full_message
   end
 
-  # Formats the Exception so that it looks *familiar*,
-  # i.e. exactly like your interpreter does it.
-  #
-  # @author Evgeniy Dolzhenko
-  #
-  # @todo Anyone have a better name for this method?
+  # @deprecated Use Exception#full_message instead (built-in since Ruby 2.5).
   def error_print
-    Exception.error_print(self)
+    warn "Exception#error_print is deprecated. Use Exception#full_message instead.", uplevel: 1
+    full_message
   end
 
 end
-

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

@@ -1,21 +1,9 @@
 class File
 
-  # Platform dependent null device.
-  #
-  # CREDIT: Daniel Burger
-
+  # @deprecated Use File::NULL constant instead (built-in since Ruby 1.9.3).
   def self.null
-    case RUBY_PLATFORM
-    when /mswin/i
-      'NUL'
-    when /amiga/i
-      'NIL:'
-    when /openvms/i
-      'NL:'
-    else
-      '/dev/null'
-    end
+    warn "File.null is deprecated. Use File::NULL instead.", uplevel: 1
+    File::NULL
   end
 
 end
-