facets 3.1.0 → 3.2.0

data/demo/standard/mulititon.rdoc

@@ -1,156 +0,0 @@
-= Multiton
-
-The Multion pattern is essentially the same as the Singleton pattern, but
-unlike it's fully unique brethren Multiton's are identical if their
-initialization parameters are identical.
-
-To demontrate we first need to load the Facets multiton.rb script.
-
-  require 'facets/multiton'
-
-Now for the various exmples.
-
-
-== EXAMPLE A - STANDARD USAGE
-
-    class SomeMultitonClass
-      include Multiton
-
-      attr :arg
-      def initialize(arg)
-        @arg = arg
-      end
-    end
-
-    a = SomeMultitonClass.instance(4)
-    b = SomeMultitonClass.instance(4)     # a and b are same object
-    c = SomeMultitonClass.instance(2)     # c is a different object
-
-    a.assert == b 
-
-    x = [a.arg, b.arg].max * 10 + c.arg
-    x.assert == 42
-
-
-== EXAMPLE B - MODIFY AN EXISTING CLASS
-
-We can modify an existing class (if we are so bold), for example we can
-add shared filehandles to the File class.
-
-    class ::File
-      include Multiton
-    end
-
-    lineno = __LINE__
-    # HERE1
-    # HERE2
-
-    a = File.instance(__FILE__)
-    b = File.instance(__FILE__)
-
-    b.assert == a
-
-    lineno.times{ a.gets }
-
-    a.gets.strip.assert == "# HERE1"
-    b.gets.strip.assert == "# HERE2"
-
-
-== EXAMPLE C - INHERITENCE
-
-  class A < String
-    include Multiton
-  end
-
-  # B is also a multiton - with it's OWN object cache
-  class B < A; end
-
-  # w is the same object as x, y is the same object as z
-  w,x,y,z = A.instance('A'), A.instance('A'), B.instance('B'), B.instance('B')
-
-  x.object_id.assert == w.object_id
-  z.object_id.assert == y.object_id
-
-  a = B.instance('A')
-  b = B.instance('A')
-
-  w.object_id.refute == a.object_id   # (each class has it's own pool)
-  b.object_id.assert == a.object_id
-
-
-== EXAMPLE D - MULTIPLE MODULE INCLUSION (does nothing)
-
-  class A < String
-    include Multiton
-  end
-
-  # B is also a multiton - with it's OWN object cache
-  class B < A; end
-
-
-  # w is the same object as x, y is the same object as z
-  w,x,y,z = A.instance('A'), A.instance('A'), B.instance('B'), B.instance('B')
-
-  yz_id = y.object_id || z.object_id
-
-If we include Multiton again, it will have to effect.
-
-  B.class_eval {
-    include Multiton
-  }
-
-  # y is not only the same object as z, but they are both the same object(s)
-  # as from EXAMPLE C
-
-  y,z = B.instance('B'), B.instance('B')
-
-  yz_id.assert == y.object_id
-  yz_id.assert == z.object_id
-
-
-== EXAMPLE E - SO YOU WANNA USE NEW INSTEAD OF INSTANCE
-
-  module K
-    # use an inner class which is itself a multiton
-    class K < String; include Multiton; end
-
-    # define a new which returns a mutltion using #instance...
-    class << self
-      def new(*args, &block)
-        K.instance(*args, &block)
-      end
-    end
-  end
-
-  the = K.new '4'
-  answer = K.new '2'
-
-  x = sprintf( "%s%s", the, answer )
-  x.assert == "42"
-  the.class.assert == K::K
-
-
-== EXAMPLE F - using Klass.multiton_id
-
-  class Klass
-    include Multiton
-
-    def initialize( important, not_important )
-      @important, @not_important = important, not_important
-    end
-
-    def Klass.multiton_id(*args, &block)
-      # we consider only the first arg
-      important, not_important = *args
-      important
-    end
-  end
-
-  a = Klass.instance( :a, :b )
-  b = Klass.instance( :a, :c )
-  c = Klass.instance( :b, :b )
-
-  a.assert == b
-  c.refute == a
-  c.refute == b
-

data/lib/core/facets/applique/file_helpers.rb

@@ -1,33 +0,0 @@
-#
-def temporary_directory
-  @temporary_directory ||= 'tmp'
-end
-
-When /Given a directory '(.*?)' containing/ do |dir, text|
-  @temporary_directory = File.join(@temporary_directory, dir)
-  text.lines.each do |file|
-    next if file =~ /^\s*$/
-    file = File.join(@temporary_directory, file.strip)
-    dir  = File.dirname(file)
-    FileUtils.mkdir_p(dir)
-    File.open(file, 'w'){ |f| f << "SPINICH" }
-  end
-end
-
-Before :all do
-  if File.exist?(temporary_directory)
-    FileUtils.rm_r(temporary_directory)
-  end
-  FileUtils.mkdir_p(temporary_directory)
-end
-
-# Used for File extensions
-When "had a file '(((.*?)))'" do |name|
-  name = name.sub(/^tmp\//, '')  # b/c QED now runs from tmp/qed
-  File.open(name, 'w'){|f| f << "Hello World"}
-end
-
-When "had a binary file '(((.*?)))'" do |name|
-  name = name.sub(/^tmp\//, '')  # b/c QED now runs from tmp/qed
-  File.open(name, 'wb'){|f| f << "Hello\nWorld\n"}
-end

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

@@ -1,25 +0,0 @@
-class Array
-
-	# Returns the values in common for an array set (nil, single value/object, or range).
-  #
-  # CREDIT: monocle
-
-	def intersection
-		array = uniq.sort_by { |e| Range === e ? e.first : e }
-		array.inject() do |c, e|
-			f = (Range === c ? c.last  : c)
-			v = (Range === e ? e.first : e)
-			case f <=> v
-			when -1 then return nil
-			when  0 then f
-			else
-				if Range === e
-					v..([f, e.last].min)
-				else
-					v
-				end
-			end
-		end
-	end
-
-end

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

@@ -1,12 +0,0 @@
-class Array
-  # Array#** is an alias for Array#product.
-  #
-  # NOTE: This method is not a common core extension and is not
-  # loaded automatically when using <code>require 'facets'</code>.
-  #
-  # @uncommon
-  #   require 'facets/array/op_pow'
-  #
-  alias_method :**, :product
-end
-

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

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

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

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

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

@@ -1,16 +0,0 @@
-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/class/subclasses.rb

@@ -1,28 +0,0 @@
-class Class
-
-  if defined?(Class.__subclasses__) # Rubinius
-
-    # Returns an array with the direct children of +self+.
-    #
-    #   Integer.subclasses # => [Fixnum, Bignum]
-    #
-    alias_method :subclasses, :__subclasses__
-
-  else
-
-    # Returns an array with the direct children of +self+.
-    #
-    #   Integer.subclasses # => [Fixnum, Bignum]
-    #
-    def subclasses
-      list = []
-      ObjectSpace.each_object(Class) do |c|
-        list.unshift c if c.superclass == self
-      end
-      list.uniq
-    end
-
-  end
-
-end
-

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

@@ -1,16 +0,0 @@
-class Dir
-
-  # Like #each, except the "." and ".." special files are ignored.
-  # You can use +ignore+ to override '.' and '..' and ignore 
-  # other entries via a exact match or regular expression.
-  #
-  # CREDIT: Tyler Rick
-  def each_child(*ignore)
-    ignore = ['.', '..'] if ignore.empty?
-    each do |file|
-      yield file unless ignore.any?{ |i| i === file }
-    end
-  end
-
-end
-

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

@@ -1,33 +0,0 @@
-module Enumerable
-
-  # The block acts as an arbitrary filter on the data. Unlike map,
-  # it can choose to drop elements from the result and/or add
-  # additional elements. The first object passed to the block is
-  # the receiver of the output.
-  #
-  #   x = (1..10000)
-  #   x = x.filter{ |out,i| out << i if i % 2 == 0 }   # like select
-  #   x = x.filter{ |out,i| out << i + 100 }           # like map
-  #   x = x.take(3)
-  #
-  #   x  #=> [102, 104, 106]
-  #
-  # This is very similar to #each_with_object, but #filter handles
-  # argument better by reversing their order and using the splat
-  # operator. (This was also once known as #injecting.)
-  #
-  # CREDIT: David Black, Louis J Scoras
-
-  def filter(output=[]) #:yeild:
-    if block_given?
-      each do |*input|
-        yield(output, *input)
-      end
-      output
-    else
-      to_enum(:filter)
-    end
-  end
-
-end
-

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

@@ -1,40 +0,0 @@
-module Enumerable
-
-  # Uses #+ to sum the enumerated elements.
-  #
-  #     [1,2,3].sum      #=> 6
-  #     [3,3,3].sum      #=> 9
-  #
-  # Note that Facets' sum method is completely generic -- it can work
-  # on any objects that respond to #+.
-  #
-  #     [[1],[2],[3]].sum   #=> [1,2,3]
-  #
-  # For this reason it is usually a good idea to provide a default
-  # value. Consider the difference between the two expressions below.
-  #
-  #     [].sum           #=> nil
-  #     [].sum(0)        #=> 0
-  #
-  # This default value also acts as an initial value.
-  #
-  #     [].sum(5)        #=> 5
-  #     [1,2,3].sum(10)  #=> 16
-  #
-  # A block can also be passed to coax the elements before summation.
-  # 
-  #     [1.1,2.2,3.3].sum(10.4, &:to_i)  #=> 16.4
-  #
-  # Notice the initial value is not effected by the block.
-  #
-  # @author Dawid Marcin Grzesiak
-
-  def sum(*identity, &block)
-    if block_given?
-      map(&block).sum(*identity)
-    else
-      reduce(*identity) { |sum, element| sum + element }
-    end
-  end
-
-end

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

@@ -1,10 +0,0 @@
-class Exception
-
-  # See exception message.
-  #
-  def set_message(string)
-    @mesg = string.to_s
-  end
-
-end
-

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

@@ -1,24 +0,0 @@
-class File
-
-  unless defined?(write)  # 1.9+
-
-    # Writes the given data to the given path and closes the file.  This is
-    # done in binary mode, complementing <tt>IO.read</tt> in standard Ruby.
-    #
-    #   str = 'The content for the file'
-    #   File.write('write.txt', str)
-    #
-    # Returns the number of bytes written.
-    #
-    # CREDIT: Gavin Sinclair
-
-    def self.write(path, data)
-      File.open(path, "wb") do |file|
-        return file.write(data)
-      end
-    end
-
-  end
-
-end
-

data/lib/core/facets/fixnum.rb

@@ -1,7 +0,0 @@
-class Fixnum
-  n_bits = ([42].pack('L!').size * 8)
-
-  MAX = 2 ** (n_bits - 2) - 1
-  MIN = -MAX - 1
-end
-

data/lib/core/facets/kernel/__dir__.rb

@@ -1,28 +0,0 @@
-module Kernel
-
-  # Similar to __FILE__, __DIR__ provides the directory
-  # path to the current executing script.
-  #
-  # DEPRECATED: As of Ruby 2.0, which will have #__dir__ method.
-  #
-  # CREDIT: Trans
-
-  def __DIR__(*paths)
-    c = caller.first
-    return nil unless c.rindex(/:\d+(:in `.*')?$/)
-    file = $` # File.dirname(c)
-    return nil if /\A\((.*)\)/ =~ file # eval, etc.
-    #File.expand_path(File.join(File.dirname(file), paths))
-    File.join(File.dirname(file), paths)
-  end
-
-  #--
-  # Old defintion ...
-  #
-  #  def __DIR__
-  #    (/^(.+)?:\d+/ =~ caller[0]) ? File.dirname($1) : nil
-  #  end
-  #++
-
-end
-

data/lib/core/facets/kernel/constant.rb

@@ -1,22 +0,0 @@
-module Kernel
-
-  # This is similar to +Module#const_get+ but is accessible at all levels,
-  # and, unlike +const_get+, can handle module hierarchy.
-  #
-  #   constant("Fixnum")                  # => Fixnum
-  #   constant(:Fixnum)                   # => Fixnum
-  #
-  #   constant("Process::Sys")            # => Process::Sys
-  #   constant("Regexp::MULTILINE")       # => 4
-  #
-  # TODO: As of Ruby 2.0, #constant can be deprecated, or aliased to #get_const.
-  #
-  # CREDIT: Trans
-
-  def constant(const)
-    const = const.to_s.dup
-    base = const.sub!(/^::/, '') ? Object : ( self.kind_of?(Module) ? self : self.class )
-    const.split(/::/).inject(base){ |mod, name| mod.const_get(name) }
-  end
-
-end

data/lib/core/facets/kernel/instance_exec.rb

@@ -1,47 +0,0 @@
-class Object #module Kernel
-
-  unless method_defined?(:instance_exec) # 1.9
-
-    require 'thread'
-
-    module InstanceExecMethods #:nodoc:
-    end
-
-    include InstanceExecMethods
-
-    # Evaluate the block with the given arguments within the context of
-    # this object, so self is set to the method receiver.
-    #
-    # From Mauricio's http://eigenclass.org/hiki/bounded+space+instance_exec
-    #
-    # This version has been borrowed from Rails for compatibility sake.
-    #
-    # NOTE: This is not a common core extension (due to the use of thread.rb)
-    # and is not loaded automatically when using <code>require 'facets'</code>.
-    # However it is a core method in Ruby 1.9, so this only matters for users
-    # of Ruby 1.8.x or below.
-    #
-    # @uncommon
-    #   require 'facets/kernel/instance_exec'
-    #
-    def instance_exec(*args, &block)
-      begin
-        old_critical, Thread.critical = Thread.critical, true
-        n = 0
-        n += 1 while respond_to?(method_name = "__instance_exec#{n}")
-        InstanceExecMethods.module_eval { define_method(method_name, &block) }
-      ensure
-        Thread.critical = old_critical
-      end
-
-      begin
-        __send__(method_name, *args)
-      ensure
-        InstanceExecMethods.module_eval { remove_method(method_name) } rescue nil
-      end
-    end
-
-  end
-
-end
-

data/lib/core/facets/kernel/p.rb

@@ -1,24 +0,0 @@
-module Kernel
-
-  # Alternate to standard #p method that outputs
-  # Kernel#inspect to stdout, but also passes through
-  # the orginal argument(s) ...
-  #
-  #   x = 1
-  #   r = 4 + p(1)
-  #   p r
-  #
-  # produces ...
-  #
-  #   1
-  #   5
-  #
-  # TODO: DEPRECATE as of 1.9, _if_ it will do this.
-
-  def p(*x)
-    x.each{ |e| puts e.inspect } #p(*x)
-    x.size > 1 ? x : x.last #x.last
-  end
-
-end
-

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

@@ -1,10 +0,0 @@
-module Kernel
-
-  # Easy access to an object's "special" class.
-  #
-  # NOTE: This is already defined in Ruby 1.9+.
-  def singleton_class
-    (class << self; self; end)
-  end unless method_defined?(:singleton_class)
-
-end

data/lib/core/facets/matchdata/match.rb

@@ -1,15 +0,0 @@
-class MatchData
-
-  # Return the primary match string. This is equivalent to +md[0]+.
-  #
-  #   md = /123/.match "123456"
-  #   md.match  #=> "123"
-  #
-  # CREDIT: Martin DeMello
-
-  def match(index=0)
-    self[index]
-  end
-
-end
-

data/lib/core/facets/method/curry.rb

@@ -1,13 +0,0 @@
-require 'facets/proc'
-
-class Method
-  # Curry a Method into a new Proc.
-
-  def curry(*args)
-    to_proc.curry(*args)
-  end
-end
-
-
-# TODO: The question is as to whether to integrate this into Method::Composition,
-# or if Composition should be scuttled for just converting to Proc.

data/lib/core/facets/numeric/negative.rb

@@ -1 +0,0 @@
-require 'facets/numeric/positive'

data/lib/core/facets/numeric/positive.rb

@@ -1,15 +0,0 @@
-class Numeric
-
-  # Is a number greater than zero.
-  #
-  def positive?
-    self > 0
-  end
-
-  # Is a number less than zero.
-  #
-  def negative?
-    self < 0
-  end
-
-end

data/lib/core/facets/object/itself.rb

@@ -1,16 +0,0 @@
-class Object
-
-  # An identity method that provides access to an object's 'self'.
-  #
-  # Example
-  #
-  #   [1,2,3,4,5,1,2,2,3].group_by(&:itself)
-  #   #=> {1=>[1, 1], 2=>[2, 2, 2], 3=>[3, 3], 4=>[4], 5=>[5]}
-  #
-  # CREDIT: Michael Kohl
-
-  def itself
-    self
-  end
-
-end

data/lib/core/facets/object/try_dup.rb

@@ -1 +0,0 @@
-require 'facets/object/dup'

data/lib/core/facets/process/daemon.rb

@@ -1,32 +0,0 @@
-module Process
-
-  # Turns the current script into a daemon process
-  # that detaches from the console. It can be shut
-  # down with a TERM signal.
-  #
-  # CREDIT: David Heinemeier Hansson
-
-  def self.daemon(nochdir=nil, noclose=nil)
-    exit if fork # Parent exits, child continues.
-    Process.setsid # Become session leader.
-    exit if fork # Zap session leader. See [1].
-
-    unless nochdir
-      Dir.chdir "/" # Release old working directory.
-    end
-
-    File.umask 0000 # Ensure sensible umask. Adjust as needed.
-
-    unless noclose
-      STDIN.reopen "/dev/null" # Free file descriptors and
-      STDOUT.reopen "/dev/null", "a" # point them somewhere sensible.
-      STDERR.reopen '/dev/null', 'a'
-    end
-
-    trap("TERM") { exit }
-
-    return 0
-  end unless respond_to?(:daemon)
-
-end
-

data/lib/core/facets/range/overlap.rb

@@ -1,12 +0,0 @@
-class Range
-
-  # Do two ranges overlap?
-  #
-  # CREDIT: Daniel Schierbeck, Brandon Keepers
-
-  def overlap?(other)
-    include?(other.first) or other.include?(first)
-  end
-
-end
-