facets 2.9.2 → 2.9.3

data/NOTICE.rdoc

@@ -102,40 +102,17 @@ License:: Ruby License
   RUBY.txt that was distributed with this library).
 
 
-== 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.
+== Metaid
 
-  2. Altered source versions must be plainly marked as such, and must not be
-     misrepresented as being the original software.
+Copyright:: (c) why the lucky stiff
 
-  3. This notice may not be removed or altered from any source distribution.
+  Copyright (c) why the lucky stiff
 
 
 == CLAP
 
 Copyright:: (c) 2010 Michel Martens
-Licese:: MIT
+License:: MIT
 Website:: https://github.com/soveran/clap
 
   Copyright (c) 2010 Michel Martens
@@ -159,9 +136,32 @@ Website:: https://github.com/soveran/clap
   IN THE SOFTWARE.
 
 
-== Metaid
+== String#natcmp
 
-Copyright:: (c) why the lucky stiff
+Copyright:: (c) 2003 by Alan Davies
+License:: Custom
 
-  Copyright (c) why the lucky stiff
+  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/README.rdoc

@@ -17,7 +17,7 @@ which extra methods to bring into their code.
 
 In addition Facets provides a collection of extensions to Ruby standard library
 plus a small collection of add-on classes and modules. Together these
-libraries constitute an ever improving source of reusable components, suitable
+libraries constitute an reliable source of reusable components, suitable
 to a wide variety of usecases.
 
 
@@ -33,24 +33,29 @@ to a wide variety of usecases.
 == Documentation
 
 Facets has special documentation needs due to it's extensive bredth.
-The RDocs generated when installing via RubyGems are unweildly because it
-combines all of Facets in one set of docs. (Hopefully we can remedy this in
-the future). In the mean time better organized online documentation 
-is available at http://rubyworks.github.com/facets/learn.html.
+The documentation generated when installing via RubyGems, or the YARD
+docs provided by rubydoc.info can be somewhat unweildly because it
+combines all of Facets in one large set. When using these resources,
+it is important to remain aware of the source location of particular
+methods.
 
-* Core API: http://rubyworks.github.com/facets/doc/api/core/index.html
-* More API: http://rubyworks.github.com/facets/doc/api/more/index.html
-* Tour API: http://rubyworks.github.com/facets/doc/api/tour/index.html
+For better organized online documentation, generated to separate core
+extensions from standard libraries, see the {Learn Facets}[http://rubyworks.github.com/facets/learn.html] page
+on the website for links to available documentation.
 
 
 == Installation
 
+=== RubyGems
+
 The easiest way to install is via RubyGems.
 
   $ gem install facets
 
-To install manually, your will need Ruby Setup (http::/setup.rubyforge.org).
-Then download and unpack the .tar.gz package and run:
+=== Setup.rb
+
+Facets can be installed the old-fashioned way using Ruby Setup (http://rubyworks.github.com/setup).
+Download and unpack the .tar.gz package and run setup.rb, like so:
 
   $ tar -xvzf facets-2.x.x.tar.gz
   $ cd facets-2.x.x
@@ -61,7 +66,7 @@ Facets 2.8+ requires Ruby 1.8.7 or higher.
 
 == Mission
 
-Facets holds to the notion that the more we can reasonably integrate into
+Facets holds to the notion that the more we can *reasonably* integrate into
 a common foundation, directed toward general needs, the better that foundation
 will be able to serve the community. There are a number of advantages here:
 
@@ -86,19 +91,17 @@ will load automatically when issuing:
 
 This loads all the CORE functionality at once. If you plan to use more then a
 handful of Facets core methods it is recommended that you require the library in
-this way.
-
-Of course you can use the CORE library piecemeal if you prefer. And for uncommon
-extension this must be done. The general require statement for a core extensions
-library is:
+this way. However, you can also "cherry pick" the CORE library as you prefer.
+And for uncommon extensions this must be done. The general require statement for
+a core extension library is:
 
-  require 'facets/<class|module>/<method-lib>'
+  require 'facets/<class|module>/<method>'
 
 For example:
 
   require 'facets/time/stamp'
 
-Most "atoms" contain only one method, but a few exceptions occur when methods
+Most "atoms" contain only one method, but exceptions occur when methods
 are closely tied together.
 
 You can load per-class or per-module groups of core methods by requiring the
@@ -113,16 +116,10 @@ of MORE libraries. A good example is 'random.rb'. There were separated because
 they had more specialized use cases, where as CORE extensions are intended as
 general purpose.
 
-This is the recommended usage. However, you can also "cherry pick" core
-methods. While there are exceptions the rule of thumb for loading a core
-method is:
-
-  require 'facets/{class|module}/{method}'
-
 ==== Method File Names
 
-Operator method redirect files are stored using English names. For instance for
-Proc#* is 'proc/op_mul'.
+Operator method redirect files are stored using English names. For instance 
+`Proc#*` is `proc/op_mul`.
 
 For reference, here is the chart.
 
@@ -155,19 +152,20 @@ Facets simply takes the '*' and translates it into a string acceptable to all
 file systems. Also, if a method ends in '=', '?' or '!' it is simply removed.
 
 
-=== MORE Library
+=== MORE Library (aka Standard Library)
 
 On top of the extensive CORE library, Facets provides extensions for Ruby's
 standard library, as well as very small collection of additional modules and
 classes to supplement it.
 
-Use the More library like you would any other 3rd party library.
-The only difference between Facets More library and other libraries
+Use this library like you would any other 3rd party library.
+The only difference between Facet's Standard library and other libraries
 is the lack of any enclosing @Facets::@ namespace. This is becuase
-the libraries provided by Facets are considerd fairly low-level.
+the libraries provided by Facets are fairly low-level and very general 
+purpose.
 
-When using Facets' extended versions of Ruby's standard libraries,
-the More libraries have to loaded manually, of course. However you
+When using Facets extended versions of Ruby's standard libraries,
+the libraries have to loaded manually, of course. However you
 do not need to load Ruby's library first, as the Facets' library
 will do that automatically.
 
@@ -179,23 +177,16 @@ To load 'ostruct.rb' plus Facets extensions for it simply use:
 
   require 'facets/ostruct'
 
-instead.
-
-Using the Facets/MORE library of modules, classes or microframeworks is
-essentially the same. For example:
-
-  require 'facets/basicobject'
-
-Again, for details pertaining to the functionality of each feature, please see
-the API Docs.
+For details pertaining to the functionality of each feature,
+please see the API documentation.
 
 
 == Contribute
 
-This project thrives on contribution.
+This project thrives on contribution!
 
-If you have any extension methods, classes, modules or small frameworks that
-you think have general applicability and would like to see them included in
+If you have any extension methods, classes or modules that you think have
+very general applicability and would like to see them included in
 this project, don't hesitiate to submit. Also, if you have better versions
 of any thing already included or simply have a patch, they are more than
 welcome. We want Ruby Facets to be of the highest quality.
@@ -203,24 +194,22 @@ welcome. We want Ruby Facets to be of the highest quality.
 
 == Authors
 
-This collection was put together by, and largely written by Thomas Sawyer
-(aka Trans). He can be reached via email at transfire at gmail.com.
+This collection was put together by, and largely written by Trans. He can be
+reached via email at transfire at gmail.com.
 
 Some parts of this collection were written and/or inspired by other persons.
 Fortunately nearly all were copyrighted under the same open license, the Ruby
-License. In the few exceptions I have included the copyright notice with the
-source code.
-
-Any code file not specifically labeled shall fall under the Ruby License.
+License, or the more liberal BSD and MIT licenses. In the one or two exceptions
+I have included the copyright notice with the source code. Any code file not
+specifically labeled othewise shall fall under the Ruby License.
 
 In all cases, I have made every effort to give credit where credit is due.
-You will find these copyrights, thanks and acknowledgments embedded in the
-source code. You can see them in "CREDIT:" lines or as file-base "Author(s)"
-sections given in the RDocs. 
+You will find these acknowledgments embedded in the source code. You can see
+them in "CREDIT:" and/or "@author" lines. 
 
-Also see the AUTHORS file for a list of all contributing Rubyists.
-If anyone is missing from the list, please let me know and I will correct
-right away. Thanks.
+Also see the {Contibutors page}[https://github.com/rubyworks/facets/wiki/Contributors]
+on the Wiki for a list of all contributing Rubyists. If anyone is missing from
+the list, please let me know and I will correct right away. Thanks.
 
 
 == License
@@ -228,7 +217,7 @@ right away. Thanks.
 The collection PER COLLECTION is licensed as follows:
 
   Ruby Facets
-  Copyright (c) 2004,2010 Thomas Sawyer
+  Copyright (c) 2004,2010 Rubyworks
 
   Distributed under the terms of the Ruby license.
 
@@ -237,12 +226,13 @@ Complete texts of both licenses accompany this document (see LICENSE).
 
 Acknowledgments and Copyrights for particular snippets of borrowed code
 are given in their respective source. All licenses are either compatible
-with the Ruby license (namely the GPL) or the original author has given
-permission for inclusion of their code under such license.
+with the Ruby license or the original author has given permission for
+inclusion of their code under such license.
 
 
 "ALL YOUR BASE ARE BELONG TO RUBY!"
 
-Ruby Facets, Copyright (c)2005,2006,2007,2008,2009,2010 Thomas Sawyer
+Ruby Facets, Copyright (c)2005,2011 Rubyworks
 
 Do you Ruby? (http://ruby-lang.org)
+

data/lib/core/facets.rb

@@ -1,62 +1,5 @@
-module Facets
-  #
-  def self.profile
-    @profile ||= (
-      require 'yaml'
-      YAML.load(File.new(File.dirname(__FILE__) + '/facets.yml'))
-    )
-  end
+require 'facets/version.rb'
 
-  #
-  def self.const_missing(name)
-    key = name.to_s.downcase
-    profile[key] || super(name)
-  end
-
-  #
-  VERSION = '2.9.2'  # profile['version']
-end
-
-require 'facets/array.rb'
-require 'facets/binding.rb'
-require 'facets/boolean.rb'
-require 'facets/class.rb'
-require 'facets/comparable.rb'
-require 'facets/denumerable.rb'
-require 'facets/dir.rb'
-require 'facets/enumerable.rb'
-require 'facets/enumerator.rb'
-require 'facets/exception.rb'
-require 'facets/file.rb'
-require 'facets/filetest.rb'
-require 'facets/float.rb'
-require 'facets/functor.rb'
-require 'facets/hash.rb'
-require 'facets/indexable.rb'
-require 'facets/instance.rb'
-require 'facets/integer.rb'
-require 'facets/kernel.rb'
-require 'facets/lazy.rb'
-require 'facets/matchdata.rb'
-require 'facets/method.rb'
-require 'facets/module.rb'
-require 'facets/na.rb'
-require 'facets/nilclass.rb'
-require 'facets/numeric.rb'
-require 'facets/object.rb'
-require 'facets/objectspace.rb'
-require 'facets/proc.rb'
-require 'facets/process.rb'
-require 'facets/range.rb'
-require 'facets/regexp.rb'
-require 'facets/string.rb'
-require 'facets/struct.rb'
-require 'facets/symbol.rb'
-require 'facets/time.rb'
-require 'facets/to_hash.rb'
-require 'facets/unboundmethod.rb'
-
-=begin
 require 'facets/array.rb'
 require 'facets/binding.rb'
 require 'facets/boolean.rb'
@@ -95,5 +38,4 @@ require 'facets/symbol.rb'
 require 'facets/time.rb'
 require 'facets/to_hash.rb'
 require 'facets/unboundmethod.rb'
-=end
 

data/lib/core/facets/array.rb

@@ -1,94 +1,68 @@
-# Load all Array core extensions.
+require 'facets/kernel/require_relative'
 
-if RUBY_VERSION < '1.9'
-  require "facets/array/after.rb"
-  require "facets/array/before.rb"
-  require "facets/array/collapse.rb"
-  require "facets/array/collisions.rb"
-  require "facets/array/combination.rb"
-  require "facets/array/commonality.rb"
-  require "facets/array/conjoin.rb"
-  require "facets/array/contains.rb"
-  require "facets/array/delete.rb"
-  require "facets/array/delete_unless.rb"
-  require "facets/array/delete_values.rb"
-  require "facets/array/divide.rb"
-  require "facets/array/duplicates.rb"
-  require "facets/array/entropy.rb"
-  require "facets/array/extract_options.rb"
-  require "facets/array/from.rb"
-  require "facets/array/index.rb"
-  require "facets/array/indexable.rb"
-  require "facets/array/merge.rb"
-  require "facets/array/mode.rb"
-  require "facets/array/nonuniq.rb"
-  require "facets/array/not_empty.rb"
-  require "facets/array/only.rb"
-  require "facets/array/pad.rb"
-  require "facets/array/peek.rb"
-  require "facets/array/permutation.rb"
-  require "facets/array/poke.rb"
-  require "facets/array/probability.rb"
-  require "facets/array/product.rb"
-  require "facets/array/pull.rb"
-  require "facets/array/recurse.rb"
-  require "facets/array/recursively.rb"
-  require "facets/array/rotate.rb"
-  require "facets/array/select.rb"
-  require "facets/array/splice.rb"
-  require "facets/array/split.rb"
-  require "facets/array/store.rb"
-  require "facets/array/thru.rb"
-  require "facets/array/traverse.rb"
-  require "facets/array/uniq_by.rb"
-else
-  require_relative "array/after.rb"
-  require_relative "array/before.rb"
-  require_relative "array/collapse.rb"
-  require_relative "array/collisions.rb"
-  require_relative "array/combination.rb"
-  require_relative "array/commonality.rb"
-  require_relative "array/conjoin.rb"
-  require_relative "array/contains.rb"
-  require_relative "array/delete.rb"
-  require_relative "array/delete_unless.rb"
-  require_relative "array/delete_values.rb"
-  require_relative "array/divide.rb"
-  require_relative "array/duplicates.rb"
-  require_relative "array/entropy.rb"
-  require_relative "array/extract_options.rb"
-  require_relative "array/from.rb"
-  require_relative "array/index.rb"
-  require_relative "array/indexable.rb"
-  require_relative "array/merge.rb"
-  require_relative "array/mode.rb"
-  require_relative "array/nonuniq.rb"
-  require_relative "array/not_empty.rb"
-  require_relative "array/only.rb"
-  require_relative "array/pad.rb"
-  require_relative "array/peek.rb"
-  require_relative "array/permutation.rb"
-  require_relative "array/poke.rb"
-  require_relative "array/probability.rb"
-  require_relative "array/product.rb"
-  require_relative "array/pull.rb"
-  require_relative "array/recurse.rb"
-  require_relative "array/recursively.rb"
-  require_relative "array/rotate.rb"
-  require_relative "array/select.rb"
-  require_relative "array/splice.rb"
-  require_relative "array/split.rb"
-  require_relative "array/store.rb"
-  require_relative "array/thru.rb"
-  require_relative "array/traverse.rb"
-  require_relative "array/uniq_by.rb"
-end
+require_relative 'array/after.rb'
+require_relative 'array/before.rb'
+require_relative 'array/collapse.rb'
+require_relative 'array/collisions.rb'
+require_relative 'array/combination.rb'
+require_relative 'array/commonality.rb'
+require_relative 'array/conjoin.rb'
+require_relative 'array/contains.rb'
+require_relative 'array/delete.rb'
+require_relative 'array/delete_unless.rb'
+require_relative 'array/delete_values.rb'
+require_relative 'array/divide.rb'
+require_relative 'array/duplicates.rb'
+require_relative 'array/each_pair.rb'
+require_relative 'array/each_value.rb'
+require_relative 'array/entropy.rb'
+require_relative 'array/extract_options.rb'
+require_relative 'array/from.rb'
+require_relative 'array/index.rb'
+require_relative 'array/indexable.rb'
+#require_relative 'array/median.rb'             # uncommon
+require_relative 'array/merge.rb'
+require_relative 'array/mode.rb'
+require_relative 'array/nonuniq.rb'
+require_relative 'array/not_empty.rb'
+require_relative 'array/only.rb'
+require_relative 'array/pad.rb'
+require_relative 'array/peek.rb'
+#require_relative 'array/percentile.rb'         # uncommon
+require_relative 'array/permutation.rb'
+require_relative 'array/poke.rb'
+require_relative 'array/probability.rb'
+require_relative 'array/product.rb'
+require_relative 'array/pull.rb'
+require_relative 'array/occurent.rb'
+#require_relative 'array/op_pow.rb'             # uncommon
+require_relative 'array/recurse.rb'
+require_relative 'array/recursively.rb'
+require_relative 'array/rotate.rb'
+require_relative 'array/select.rb'
+require_relative 'array/splice.rb'
+require_relative 'array/split.rb'
+require_relative 'array/store.rb'
+require_relative 'array/thru.rb'
+require_relative 'array/traverse.rb'
+require_relative 'array/uniq_by.rb'
 
 
-# OLD WAY
-#dir, base = *File.split(__FILE__)
-#base = base.chomp('.rb')
-#Dir[File.join(dir, base, '*.rb')].each do |lib|
-#  require "facets/#{base}/#{File.basename(lib)}"
+
+
+#folder = __FILE__.chomp('.rb')
+
+#target = File.basename(folder)
+
+#loader = \
+#  if RUBY_VERSION < '1.9'
+#    lambda{ |file| require File.join(folder, file) }
+#  else
+#    lambda{ |file| require_relative File.join(target, file) }
+#  end
+
+#files.each do |file|
+#  next unless file.end_with?('.rb')
+#  loader.call(file)
 #end