facets 3.1.0 → 3.2.0

data/.index

@@ -1,80 +0,0 @@
----
-revision: 2013
-type: ruby
-sources:
-- Indexfile
-- Gemfile
-authors:
-- name: Thomas Sawyer
-  email: transfire@gmail.com
-organizations:
-- name: Rubyworks
-requirements:
-- groups:
-  - test
-  version: ">= 0"
-  name: lemon
-- groups:
-  - test
-  version: ">= 0"
-  name: qed
-- groups:
-  - test
-  version: ">= 0"
-  name: rubytest-cli
-- groups:
-  - test
-  version: ">= 0"
-  name: rake
-- groups:
-  - test
-  version: ">= 0"
-  name: simplecov
-- groups:
-  - guard
-  version: ">= 0"
-  name: guard
-conflicts: []
-alternatives: []
-resources:
-- type: home
-  uri: http://rubyworks.github.com/facets
-  label: Homepage
-- type: code
-  uri: http://github.com/rubyworks/facets
-  label: Source Code
-- type: docs
-  uri: http://rubyworks.github.com/facets/learn.html
-  label: Documentation
-- type: wiki
-  uri: http://wiki.github.com/rubyworks/facets
-  label: User Guide
-- type: talk
-  uri: http://groups.google.com/group/facets-universal
-repositories:
-- name: upstream
-  scm: git
-  uri: git@github.com:rubyworks/facets.git
-categories: []
-copyrights:
-- holder: Rubyworks
-  year: '2004'
-  license: BSD-2-Clause
-customs: []
-paths:
-  load:
-  - lib/core
-  - lib/standard
-name: facets
-title: Ruby Facets
-version: 3.1.0
-summary: The orginal well curated collection of extension methods for Ruby.
-slogan: ALL YOUR BASE ARE BELONG TO RUBY!
-description: Facets is the premier collection of extension methods for the Ruby programming
-  language. Facets extensions are unique by virtue of thier atomicity. They are stored
-  in individual files allowing for highly granular control of requirements. In addition,
-  Facets includes a few additional classes and mixins suitable to wide variety of
-  applications.
-scm_uri: https://github.com/rubyworks/facets/tree/master
-created: '2004-12-16'
-date: '2016-05-09'

data/.yardopts

@@ -1,10 +0,0 @@
---title "Ruby Facets"
---readme README.rdoc
---protected
---private
---tag uncommon:Uncommon
---tag standard:Standard
-lib/core
-lib/standard
--
-[A-Z]*.*

data/NOTICE.rdoc

@@ -1,167 +0,0 @@
-= COPYRIGHT NOTICES
-
-== Ruby Facets
-
-Copyright:: (c) 2005,2011 Thomas Sawyer
-
-  Copyright (c) 2005,2011 Thomas Sawyer
-
-  You may distribute this software under the same terms as Ruby.
-
-
-== Ruby/Extensions
-
-Copyright:: (c) 2004 Gavin Sinclair
-License:: Ruby
-
-  Copyright (c) 2004 Gavin Sinclair
-
-  Ruby/Extensions (extensions.rubyforge.org) is copyrighted free software
-  created and maintained by Gavin Sinclair (gsinclair@soyabean.com.au) and
-  released under the same license as Ruby.
-
-  THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-  IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-  PURPOSE.
-
-
-==  Nitro/Glue
-
-Copyright:: (c) 2006, George Moschovitis
-License:: BSD-3-Clause
-
-  Copyright (c) 2006, George Moschovitis
-  All rights reserved.
-
-  Redistribution and use in source and binary forms, with or without
-  modification, are permitted provided that the following conditions
-  are met:
-
-  * Redistributions of source code must retain the above copyright notice,
-    this list of conditions and the following disclaimer.
-
-  * Redistributions in binary form must reproduce the above copyright notice,
-    this list of conditions and the following disclaimer in the documentation
-    and/or other materials provided with the distribution.
-
-  * Neither the name of the <ORGANIZATION> nor the names of its contributors
-    may be used to endorse or promote products derived from this software
-    without specific prior written permission.
-
-  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-  POSSIBILITY OF SUCH DAMAGE.
-
-
-== ActiveSupport
-
-Copyright:: (c) 2005-2011 David Heinemeier Hansson
-License:: MIT
-Website:: http://rails.org
-
-  Copyright (c) 2005-2011 David Heinemeier Hansson
-
-  Permission is hereby granted, free of charge, to any person obtaining
-  a copy of this software and associated documentation files (the
-  "Software"), to deal in the Software without restriction, including
-  without limitation the rights to use, copy, modify, merge, publish,
-  distribute, sublicense, and/or sell copies of the Software, and to
-  permit persons to whom the Software is furnished to do so, subject to
-  the following conditions:
-
-  The above copyright notice and this permission notice shall be
-  included in all copies or substantial portions of the Software.
-
-  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-== Ruby Treasures
-
-Copyright:: (c) 2001 Paul Brannan
-License:: Ruby License
-
-  Ruby Treasures 0.1
-  Copyright (c) 2001 Paul Brannan <paul@atdesk.com>
-
-  You may distribute this software under the same terms as Ruby (see the file
-  RUBY.txt that was distributed with this library).
-
-
-== Metaid
-
-Copyright:: (c) why the lucky stiff
-
-  Copyright (c) why the lucky stiff
-
-
-== CLAP
-
-Copyright:: (c) 2010 Michel Martens
-License:: MIT
-Website:: https://github.com/soveran/clap
-
-  Copyright (c) 2010 Michel Martens
-
-  Permission is hereby granted, free of charge, to any person obtaining a copy
-  of this software and associated documentation files (the "Software"), to deal
-  in the Software without restriction, including without limitation the rights
-  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-  of the Software, and to permit persons to whom the Software is furnished to
-  do so, subject to the following conditions:
-
-  The above copyright notice and this permission notice shall be included in all
-  copies or substantial portions of the Software.
-
-  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-  IN THE SOFTWARE.
-
-
-== String#natcmp
-
-Copyright:: (c) 2003 by Alan Davies
-License:: Custom
-
-  String#natcmp is based on Martin Pool's "Natural Order String Comparison"
-  originally written in C. (see http://sourcefrog.net/projects/natsort/)
-
-  This implementation is Copyright (C) 2003 by Alan Davies
-  <cs96and_AT_yahoo_DOT_co_DOT_uk>
-
-  This software is provided 'as-is', without any express or implied
-  warranty.  In no event will the authors be held liable for any damages
-  arising from the use of this software.
-
-  Permission is granted to anyone to use this software for any purpose,
-  including commercial applications, and to alter it and redistribute it
-  freely, subject to the following restrictions:
-
-  1. The origin of this software must not be misrepresented; you must not
-     claim that you wrote the original software. If you use this software
-     in a product, an acknowledgment in the product documentation would be
-     appreciated but is not required.
-
-  2. Altered source versions must be plainly marked as such, and must not be
-     misrepresented as being the original software.
-
-  3. This notice may not be removed or altered from any source distribution.
-

data/demo/applique/assertion_framework.rb

@@ -1 +0,0 @@
-require 'ae'

data/demo/applique/file_helpers.rb

@@ -1,34 +0,0 @@
-require 'fileutils'
-require 'pathname'
-
-def temporary_directory
-  @temporary_directory ||= 'tmp'
-end
-
-Before :document do
-  if File.exist?(temporary_directory)
-    FileUtils.rm_r(temporary_directory)
-  end
-  FileUtils.mkdir(temporary_directory)
-end
-
-When /Given a directory '(.*?)' containing/ do |dir, text|
-  #abort unless /^#{temporary_directory}/ =~ dir
-  text.lines.each do |file|
-    next if file =~ /^\s*$/
-    file = File.join(dir, file.strip)
-    path = File.dirname(file)
-    FileUtils.mkdir_p(path)
-    File.open(file, 'w'){ |f| f << "SPINICH" }
-  end
-end
-
-# Return project root directory by looking for +lib+ directory.
-def root_directory
-  @root_directory ||= (
-    Pathname.new(Dir.pwd).ascend do |root|
-      break root if root.join('lib').directory?
-    end
-  )
-end
-

data/demo/core/array/after.md

@@ -1,13 +0,0 @@
-## Array#after
-
-    require 'facets/array/after'
-
-`Array#after` returns the first value that comes after a given value. The
-value after the last is the first. Returns `nil` if the given value is not
-in the array.
-
-    sequence = ['a', 'b', 'c']
-    sequence.after('a').assert == 'b'
-    sequence.after('b').assert == 'c'
-    sequence.after('c').assert == 'a'
-    sequence.after('d').assert == nil

data/demo/core/array/arrange.md

@@ -1,17 +0,0 @@
-## Array#arrange
-
-    require 'facets/array/arrange'
-
-The `arrange` method produces appropriate ranges from the objects in the array.
-It assumes inclusive ranges (i.e. `1..4`) and `range.first <= range.last`.
-
-Works with integers, dates and strings. However, all the objects in the array must
-be of the same class.
-
-    [1,2,3,6,7,8].arrange.assert == [1..3, 6..8]
-
-    [10..15, 16..20, 21, 22].arrange.assert == [10..22]
-
-    a = %w{a b c g h i j k  m o}
-    a.arrange.assert == ['a'..'c','g'..'k', 'm' , 'o']
-

data/demo/core/array/before.md

@@ -1,14 +0,0 @@
-## Array#before
-
-    require 'facets/array/before'
-
-Returns the value prior to the given value. The value previous
-to the first is the last. Returns nil if the given value is not
-in the array.
-
-    sequence = ['a', 'b', 'c']
-    sequence.before('a').assert == 'c'
-    sequence.before('b').assert == 'a'
-    sequence.before('c').assert == 'b'
-    sequence.before('d').assert == nil
-

data/demo/core/array/collapse.md

@@ -1,15 +0,0 @@
-## Array#collapse
-
-    require 'facets/array/collapse'
-
-Simplify an array by flattening it then compacting it.
-
-    [1,[2,nil,[3]],nil,4].collapse.assert == [1,2,3,4]
-
-## Array#collapse!
-
-Simplify an array by flattening it in place then compacting it in place.
-
-    a = [1, nil, [1, 2], nil, [[3]]]
-    a.collapse!
-    a.assert == [1, 1, 2, 3]

data/demo/core/array/collisions.md

@@ -1,30 +0,0 @@
-## Array#collisions
-
-_alias for Array#commonality_.
-
-    require 'facets/array/collisions'
-
-Get a list of all items that have something in common in terms of the
-supplied block. If no block is given objects are considered to be in
-common if they return the same value for Object#hash and if obj1 == obj2.
-
-This can be useful, for instance, in determining all persons that share
-their last name with another person.
-
-    Person = Struct.new(:name)
-    persons = %w{Wayne Pennyworth Grayson Wayne Pennyworth}.map{|n| Person.new(n)}
-    persons.collisions { |person| person.name }.keys.assert == ["Wayne","Pennyworth"]
-
-The method is similar to #group_by which is a standard Ruby method as of 1.9.
-To get effectively the same results with #group_by use `select{ |k,v| v.size > 1 }`.
-
-    expected = { 2 => [2, 2], 4 => [4, 4] }
-
-    [1, 2, 2, 3, 4, 4].group_by{ |e| e }.
-                       select{ |k,v| v.size > 1 }.assert == expected
-
-    [1, 2, 2, 3, 4, 4].collisions.assert == expected
-
-    %w{foo bar baz}.collisions{|str| str[0]}.assert == {'b' =>["bar", "baz"] }
-
-Returns a Hash mapping common attribute to those elements.

data/demo/core/array/commonality.md

@@ -1,31 +0,0 @@
-## Array#commonality
-
-    require 'facets/array/commonality'
-
-Get a list of all items that have something in common in terms of the
-supplied block. If no block is given objects are considered to be in
-common if they return the same value for Object#hash and if obj1 == obj2.
-
-This can be useful, for instance, in determining all persons that share
-their last name with another person.
-
-    Person = Struct.new(:name)
-    persons = %w{Wayne Pennyworth Grayson Wayne Pennyworth}.map{|n| Person.new(n)}
-    persons.commonality { |person| person.name }.keys # => ["Wayne","Pennyworth"]
-
-The method is similar to #group_by which is a standard Ruby method as of 1.9.
-To get effectively the same results with #group_by use `select{ |k,v| v.size > 1 }`.
-
-    expected = { 2 => [2, 2], 4 => [4, 4] }
-
-    [1, 2, 2, 3, 4, 4].group_by{ |e| e }.
-                       select{ |k,v| v.size > 1 }.assert == expected
-
-    [1, 2, 2, 3, 4, 4].commonality.assert == expected
-
-
-    %w{foo bar baz}.commonality{|str| str[0]}.assert == {'b' =>["bar", "baz"] }
-
-Returns a Hash mapping common attribute to those elements.
-
-

data/demo/core/array/conjoin.md

@@ -1,47 +0,0 @@
-## Array#conjoin
-
-    require 'facets/array/conjoin'
-
-This is more advanced form of #join. It allows for fine control
-of separators.
-
-NOTE: The old version used to default its separator to ", " and
-default the terminating separator to " and ". This is no longer
-the case. You must specifically provide these parameters.
-
-If no parameters are given, it acts like #join but will a space
-separator.
-
-    [1,2,3].conjoin.assert == "1 2 3"
-
-Use comma+space and 'and' on tail.
-
-    [1,2,3].conjoin(', ', ' and ').assert == "1, 2 and 3"
-
-Use comma+space and 'or' on tail using :last option.
-
-    [1,2,3].conjoin(', ', :last => ' or ').assert == "1, 2 or 3"
-
-Use semicolon+space and ampersand on tail using index.
-
-    [1,2,3].conjoin('; ', -1 => ' & ').assert == "1; 2 & 3"
-
-Can take a block to determine separator.
-
-    [1,2,3,4].conjoin{ |i, a, b| i % 2 == 0 ? '.' : '-' }.assert == "1.2-3.4"
-
-This makes very esoteric transformation possible.
-
-    [1,1,2,2].conjoin{ |i, a, b| a == b ? '=' : ' != ' }.assert == "1=1 != 2=2"
-
-    [1,2,3,4].conjoin{ |i, x, y| "<#{i} #{x} #{y}>" }.assert == "1<0 1 2>2<1 2 3>3<2 3 4>4"
-
-There are also spacing options. Providing the :space option
-pads the separators.
-
-    [1,2,3].conjoin(',', '&', :space=>2).assert == "1  ,  2  &  3"
-
-And the :spacer option can set an alternate spacing string.
-
-    [1,2,3].conjoin('|', '>', :space=>2, :spacer=>'-').assert == "1--|--2-->--3"
-

data/demo/core/array/contains.md

@@ -1,9 +0,0 @@
-## Array#contains?
-
-_alias of Array#include? _
-
-    require 'facets/array/contains'
-
-    [1,2,3,4].assert.contains?(2)
-    [1,2,3,4].refute.contains?(9)
-

data/demo/core/array/delete_unless.md

@@ -1,13 +0,0 @@
-## Array#delete_unless
-
-    require 'facets/array/delete_unless'
-
-The method `#delete_unless` is the inverse of `#delete_if`.
-
-    a = [1,2,3]
-    a.delete_unless{ |e| e == 2 }
-    a.assert == [2]
-
-    [1,2,3].delete_unless{ |x| x < 2 }.assert == [1]
-    [1,2,3].delete_unless(&:even?).assert == [2]
-

data/demo/core/array/delete_values.md

@@ -1,10 +0,0 @@
-## Array#delete_values
-
-    require 'facets/array/delete_values'
-
-Delete multiple values from array.
-
-    a = [1,2,3,4]
-    a.delete_values(1,2)   #=> [1,2]
-    a                      #=> [3,4]
-

data/demo/core/array/delete_values_at.md

@@ -1,15 +0,0 @@
-## Array#delete_values_at
-
-    require 'facets/array/delete_values_at'
-
-Delete multiple values from array given
-indexes or index range.
-
-    a = [1,2,3,4]
-    a.delete_values_at(1,2).assert == [2,3]
-    a.assert                       == [1,4]
-
-    a = [1,2,3,4]
-    a.delete_values_at(0..2).assert == [1,2,3]
-    a.assert                        == [4]
-

data/demo/core/array/divide.md

@@ -1,14 +0,0 @@
-## Array#divide
-
-    require 'facets/array/divide'
-
-Divide into sub arrays at elemetns matching given pattern
-
-    r = ['a1','b1','a2','b2'].divide(/^a/)
-    r.assert == [['a1','b1'],['a2','b2']]
-
-    r = ['a1','b1','a2','b2'].divide(/^b/)
-    r.assert == [['a1'],['b1','a2'],['b2']]
-
-    r = ['a1','b1','a2','b2'].divide(/c/)
-    r.assert = [['a1','b1','a2','b2']]

data/demo/core/array/duplicates.md

@@ -1,14 +0,0 @@
-## Array#duplicates
-
-    require 'facets/array/duplicates'
-
-Return list of duplicate elements.
-
-    [1,1,2,3].duplicates #=> [1]
-
-Return list of those duplicated min times.
-
-    [1,1,2,3,2,4,5,4,2].duplicates(3) #=> [2]
-
-
-

data/demo/core/array/each_overlap.md

@@ -1,12 +0,0 @@
-## Array#each_overlap
-
-    require 'facets/array/each_overlap'
-
-Iterate over each slice where the last n values of a preceding slice
-overlap with the first n values of the following slice. The value of n
-is specified by the second `overlap` argument.
-
-    a, r = [1,2,3,4,5], []
-    a.each_overlap(2,1) { |x,y| r << [x,y] }
-    r.assert == [[1,2],[2,3],[3,4],[4,5]]
-

data/demo/core/array/each_pair.md

@@ -1,13 +0,0 @@
-## Array#each_pair
-
-    require 'facets/array/each_pair'
-
-Iterate over an array yielding with index and value.
-
-    result = {}
-    a = [:a,:b,:c,:d]
-    a.each_pair{|i,e| result[e] = i + 1}
-    result.assert == {a: 1, b: 2, c: 3, d: 4}
-
-*NOTE* this is the inverse of `Array#each_with_index`, and is intended to provide
-polymorphism with `Hash#each_pair`.

data/demo/core/array/each_value.md

@@ -1,12 +0,0 @@
-## Array#each_value
-
-    require 'facets/array/each_value'
-
-This is an alias of Alias#each, and is provided to provide polymorphism with
-Hash#each_value.
-
-    a = [ "a", "b", "c" ]
-    out = ''
-    a.each_value {|x| out +=  "#{x} -- " }
-    out.assert == 'a -- b -- c -- '
-

data/demo/core/array/entropy.md

@@ -1,13 +0,0 @@
-## Array#entropy
-
-    require 'facets/array/entropy'
-
-Shannon's entropy for an array - returns the average
-bits per symbol required to encode the array.
-Lower values mean less "entropy" - i.e. less unique
-information in the array.
-
-    e = %w{ a b c d e e e }.entropy
-
-    ("%.3f" % e)  #=> "2.128"
-

data/demo/core/array/extract_options.md

@@ -1,13 +0,0 @@
-## Array#extract_options!
-
-    require 'facets/array/extract_options'
-
-Extracts options from a set of arguments. Removes and returns the last
-element in the array if it's a hash, otherwise returns a blank hash.
-
-    def options(*args)
-      args.extract_options!
-    end
-
-    options(1, 2).assert           == {}
-    options(1, 2, :a => :b).assert == {:a=>:b}

data/demo/core/array/first.md

@@ -1,11 +0,0 @@
-## Array#first!
-
-    require 'facets/array/indexable'
-
-Alias for shift, which removes and returns the first element in an array
-  
-    a = ['a','y','z']
-    a.first!.assert == 'a'
-    a.assert ['y','z']
-    
-    

data/demo/core/array/from.md

@@ -1,11 +0,0 @@
-## Array#thru
-
-    require 'facets/array/from'
-
-Returns elements from index i until the end.
-
-    %w{W o r l d}.from(3).assert == %w{l d}
-
-Returns entire array for i > length
-
-    %w{W o r l d}.from(7).assert == nil

data/demo/core/array/ideal_entropy.md

@@ -1,11 +0,0 @@
-## Array#ideal_entropy
-
-    require 'facets/array/entropy'
-
-Returns the maximum possible Shannon entropy of the array
-with given size assuming that it is an "order-0" source
-(each element is selected independently of the next).
-
-    %w{ a b }.ideal_entropy.assert == 1.0
-    %w{ a a b b }.ideal_entropy.assert == 2.0
-

data/demo/core/array/intersection.md

@@ -1,11 +0,0 @@
-## Array#intersection
-
-    require 'facets/array/intersection'
-    
-Returns the values in common for an array set (nil, single value/object, or range).
-
-    [1,2].intersection.assert == nil
-    [1..10,11..20].intersection.assert == nil
-    [10,1..10].intersection.assert == 10
-    [1..10,5,5..8,4..8].intersection.assert == 5
-    [1..10, 5..8, 5..10 ].intersection.assert == (5..8)