facets 1.4.0 → 1.4.1

data/ProjectInfo

@@ -0,0 +1,94 @@
+---
+
+title    : Facets
+name     : facets
+version  : '1.4.1'
+created  : '2004-12-16'
+status   : Beta/Stable
+
+author   : Thomas Sawyer
+email    : &email transfire@gmail.com
+homepage : "http://facets.rubyforge.org"
+
+summary: Exceptional collection of extensions and additions.
+
+description:
+  Facets Core is a large collection of core extension methods
+  and module additions for the Ruby programming language.
+  The extensions are unique by virtue of thier atomicity.
+  Methods are stored in their own files, allowing
+  for highly granular control of requirements.
+  The modules include a variety of useful classes, mixins and
+  microframeworks, from the Functor to a full SI units system.
+
+rubyforge:
+  project: 'facets'
+  username: transami
+
+revision:
+  type: darcs
+  exclude:
+    - 'lib/facet'
+    - 'release'
+    - 'web/doc/api'
+    - 'web/images'
+    - 'setup.rb'
+
+# --- TASKS --- #
+
+package: !!package
+  distribute: [ gem, tar.bz2, deb ]
+  dir: release
+
+release: !!release
+  host       : rubyforge.org
+  username   : transami
+  project    : facets
+  groupid    : 804
+  package    : Facets
+  dir        : release
+
+extest: !!extest
+  files: 'lib/facets/**/*.rb'
+
+test: !!test
+
+rdoc-core: !!rdoc
+  dir: web/doc/api/core
+  template: jamis
+  options: ['--all', '--inline-source']
+  include:
+    - 'lib/facets/core/**/*'
+    - '[A-Z]*'
+
+rdoc-more: !!rdoc
+  dir: web/doc/api/more
+  template: jamis
+  options: ['--all', '--inline-source']
+  include:
+    - 'lib/facets/more/**/*'
+    - '[A-Z]*'
+
+publish: !!publish
+  host: rubyforge.org
+  type: web
+  username: transami
+  project: facets
+  dir: web
+
+announce: !!announce
+  to: transfire@gmail.com #ruby-talk@ruby-lang.org
+  from: transfire@gmail.com
+  domain: jupiterzeus.net
+  server: smtp.gmail.com
+  port: 25 #587
+  account: transfire@gmail.com
+  authtype: login  #cram_md5 #plain
+  sectype: tls # ~, tls, ssl
+  file: note/ANN
+  slogan: ALL YOUR BASE ARE BELONG TO RUBY!
+  links:
+    - http://facets.rubyforge.org
+
+count: !!count
+  include: 'lib/**/*'

data/Reapfile

@@ -0,0 +1,184 @@
+#!/usr/bin/env ruby
+
+require './lib/facets/core/file/self/read_list'
+
+#DATPATH = "data/facets"
+#ETCPATH = "conf/facets"
+#REQPATH = "facets/core"
+#GENPATH = "lib/facets/core"
+
+# REAP doesn't accept a default. Should it?
+#task :default => [ :tasks ]  # THIS IS WHAT IT DOES BY DEFAULT.
+
+#
+# Three stages to release.
+#
+
+desc %{First stage (redirect,extest,test)}
+task '1stage' => [ :redirect, :extest, :test ]
+
+desc %{Second stage (rdoc-core,rdoc-more,package)}
+task '2stage' => [ :'rdoc-core', :'rdoc-more', :package ]
+
+desc %{Final stage (publish,release)}
+task '3stage' => [ :publish, :release ]
+
+#
+# Generate facet/ redirection folder.
+#
+
+LIBDIR = 'lib'
+REDIR = 'facet'
+SRCDIR = 'facets'
+
+desc %{Build facet redirect directory}
+task :redirect do
+  #puts "Creating redirection folder #{REDIR}/ ..."
+  count = 0
+  dest = File.join( LIBDIR, REDIR )
+  FileUtils.rm_r(dest) if File.directory?(dest)
+  Dir.chdir( LIBDIR ) do
+    ['core','more'].each{ |d|
+      from = File.join( SRCDIR, d )
+      files = Dir.glob( File.join( from, '**/*.rb' ) )
+      files.each { |e|
+        re = Regexp.new( Regexp.escape( from + '/' ) )
+        link = e.sub( re, 'facet/')
+        FileUtils.mkdir_p( File.dirname( link ) )
+        File.open( link, "w+" ) { |w| w << "require '#{e}'" }
+        count += 1
+      }
+    }
+  end
+  puts "Created #{count} redirection files in #{REDIR}/ folder."
+end
+
+#
+# Read in the facets directory and sort-out per class
+#
+
+Methods = {}
+MTHPATH = "lib/facets/core"
+
+task :index_methods do
+  Dir.chdir(MTHPATH) do
+    dg = Dir.glob('*/**/*.rb')
+    dg.each { |f|
+      klass, *meth= f.split('/')
+      Methods[ klass ] ||= []
+      Methods[ klass ] << "#{meth.join('/').chomp('.rb')}"
+    }
+    Methods.keys.each { |k| Methods[k].sort! }
+  end
+end
+
+#
+# List Methods
+#
+
+desc %{Output a list of all methods}
+task :list => [ :index_methods ] do
+  puts method_list_outline
+end
+
+#
+# Make sure there are no remarked test comments.
+#
+
+#desc "Check for open comment tests"
+#task :testchk do
+#  system %q{grep -r ^#=begin\ test ./lib}
+#end
+
+# # Save method index to file in yaml format
+#
+# desc %{Generate method index file}
+# task :index => [ :methods ] do
+#   print "Creating method index... "
+#   loc = File.join( DATPATH, 'index.yml' )
+#   File.open( loc, 'w' ) { |f|
+#     f << Methods.to_yaml
+#   }
+#   puts "[done]"
+# end
+
+# # Create per class feature files
+#
+# desc %Q{Generate per-class feature files}
+# task :class => [:methods ] do
+#   print "Creating per class files... "
+#
+#   index  = Methods
+#   noauto = File.read_list( File.join( ETCPATH, 'noauto' ) )
+#   allfiles = index.collect{ |k,ms| ms.collect{ |m| "#{k}/#{m}" } }.flatten
+#   full = calc_full(allfiles, noauto)
+#
+#   index.each { |classname, method_files|
+#     File.open( "#{GENPATH}/#{classname.downcase}.rb", 'w' ) { |f|
+#       method_files.each { |rf|
+#         mfn = "#{classname.downcase}/#{rf}"
+#         if full.include?(mfn)
+#           f << %Q{require '#{REQPATH}/#{mfn}'\n}
+#         end
+#       }
+#     }
+#   }
+#   puts "[done]"
+# end
+
+# # HTML List MethodsFile.new(
+#
+# HEAD = <<-HERE
+# <html>
+# <head>
+#   <style>
+#     pre#methods {
+#       font-size: .8em;
+#       line-height: 1em;
+#     }
+#   </style>
+# </head>
+# <body>
+# <pre id="methods">
+# HERE
+#
+# FOOT=<<-HERE
+# </pre>
+# </body>
+# </html>
+# HERE
+#
+# desc %{generate method list html file}
+# task 'listHtml' => [ :scrape_methods ] do
+#   s = HEAD + method_list_outline + FOOT
+#   File.open('pub/www/methods.html', 'w') { |f| f << s }
+# end
+
+private  # Support Methods
+
+  # Create a nice text outline of the core methods.
+
+  def method_list_outline
+    s = ''
+    Methods.keys.sort.each { |k|
+      ms = Methods[k].collect{|m| m.gsub(%r{^self\/},'::')}.sort
+      s << "#{k}:\n"
+      ms.each { |m| s << "  #{m}\n" }
+    }
+    s
+  end
+
+#   # Full set of require files (all files minus noauto and unsafe)
+#
+#   def calc_full( allfiles, noauto )
+#     sf = allfiles.dup
+#     noauto.each do |f|
+#       if f.include?('*')
+#         re = %r"#{f.gsub('*','.*')}"
+#         sf.reject!{ |x| x =~ re }
+#       elsif sf.include?(f)
+#         sf.delete f
+#       end
+#     end
+#     sf.sort
+#   end

data/forge/README

@@ -0,0 +1,13 @@
+
+This directory contains alpha code and is generally considered
+expiremental. It is provided as a means for conmmon development
+and potential inspiration.
+
+Some of these, or variations there-of, will eventually become
+part of the main lib, many will not.
+
+Notice this development directory reflects the main lib directory
+in structure with the exception of an extra folder called 'reference'.
+This folder holds material gathered from outside sources that have
+not sifted through yet, but could yield some useful code in the future.
+

data/forge/TODO

@@ -0,0 +1,73 @@
+
+= Facets' To Do List
+
+IT IS ALWAYS A GOOD IDEA TO WRITE A TEST!
+AND ITS ALWAYS A FINE THING TO IMPROVE DOCUMENTATION!
+
+* Move methods to facets/method and link back to facet/ but prefer library alias
+  instead. (Rolls)
+
+* hash/invert: What about letting Hash#invert take a block that specifies
+  what to do when a collision occurs?
+
+* hash/at_rand: allow for a _number_ of values, keys and pairs to be returned.
+
+* > Yep. Gone. But I may replace with a version that deletes only the first 
+  > matching element. Thoughts?
+  If you don't want to do that I would rather add an option hash to .delete and
+  use :once => true or something similar. (More expressive)
+
+* numeric/bound_by: Numeric includes Comparable. Maybe drop this, but 
+  might it be reasonable for Numeric but no other comparables?
+
+* nil/[]: Why should nil respond to [], but not to .each? I don't think 
+  nil should be treated as a container.
+  nil/length: See above.
+
+* nil/method_missing: I'm not so sure about this. There is a lot of 
+  libraries depending on nil raising exceptions on failed method access. I 
+  also think that this could make programming errors very hard to find.
+
+* fileutils/head&tail: Hm, I think the block forms ought to be equivalent to 
+  tail -f and so on. Then the block forms should also return all lines by default
+  instead of only the first 10.
+
+* fileutils/which: Should probably be based on fileutils/where_is as they have 
+  lots of common code. The two methods should probably also use RUBY_PLATFORM instead
+  of checking for ALT_SEPARATOR.
+
+* module/memoize: Should the main memoize method be defined as it is? 
+  (see bottom of file).
+
+* kernel/demo: It can be implemented as demo "1+1"  using Binding.of_caller. 
+  Using only the block is possibly with SCRIPT_LINES__ or File access and is quite ugly.
+
+* hash/weave: Document how does it compare to Hash#merge?
+
+* Perhaps work on alernative require mechinism. Currently there is none.
+  Here some pseudo docs for it:
+
+    and an alternative interface to requiring the extension methods.
+    With the Facets module you can require a facet method like so:
+
+      Facets.require Time, :stamp
+
+    One of the advantages of this approach is that Facets' can search the class hierarchy
+    for a method. For example if you wanted to use #each_permutation on an Array.
+
+      Facets.require 'array/each_permutation'
+
+    Even though #each_permutation is a method of Enumerable this will still work
+    because Enumerable is a superclass of Array.
+
+    Also it allows for the use operators without special recourse.
+    For instance, the Proc compostion operator can be require simply.
+
+      Facets.require 'proc/*'
+
+    If you're wondering why you have to specify the Facets module in #use,
+    it is becuase #use is a generalized method. Anyone can easily take advantage
+    of this functionality by utilizing Facets' Module-Package system (package.rb).
+    See the API Documentation for further details of putting this to use in your
+    programs.
+

data/forge/autorequire.rb

@@ -0,0 +1,83 @@
+
+def autorequire
+  # built-in
+  autoload( 'CGI', 'cgi' )
+  autoload( 'FCGI', 'fcgi' )
+  autoload( 'OpenStruct', 'ostruct' )
+  # facets
+  autoload( 'ANSICode', 'calibre/class/ansicode' )
+  autoload( 'BBCode', 'calibre/class/bbcode' )
+  autoload( 'BinaryReader', 'calibre/class/binaryreader' )
+  autoload( 'BlankSlate', 'calibre/class/blankslate' )
+  autoload( 'ByteOrder', 'calibre/class/byteorder' )
+  autoload( 'ClassMethods', 'calibre/class/classmethods' )
+  autoload( 'Coroutine', 'calibre/class/coroutine' )
+  autoload( 'CrossCase', 'calibre/class/crosscase' )
+  autoload( 'FileList', 'calibre/class/expirable' )
+  autoload( 'FloatString', 'calibre/class/floatstring' )
+  autoload( 'Functor', 'calibre/class/functor' )  
+  autoload( 'HArray', 'calibre/class/floatstring' )
+  autoload( 'Heap', 'calibre/class/floatstring' )
+  autoload( 'Infinity', 'calibre/class/infinity' )
+  autoload( 'Interval', 'calibre/class/interval' )
+  autoload( 'IOReactor', 'calibre/class/ioreactor' )
+  autoload( 'IORedirect', 'calibre/class/ioredirect' )
+  autoload( 'LRUCache', 'calibre/class/lrucache' )
+  autoload( 'MethodProbe', 'calibre/class/methodprobe' )
+  autoload( 'Multiton', 'calibre/class/multiton' )
+  autoload( 'Nack', 'calibre/class/nack' )
+  autoload( 'NilComparable', 'calibre/class/nilcomparable' )
+  autoload( 'NotCopyable', 'calibre/class/notcopyable' )
+  autoload( 'OpenStructable', 'calibre/class/ostructable' )
+  autoload( 'OrderedHash', 'calibre/class/ohash' )
+  autoload( 'ParamEnumerable', 'calibre/class/penumerable' )
+  autoload( 'Parser', 'calibre/class/parser' )
+  autoload( 'PhysicalConst', 'calibre/class/physical-const' )
+  autoload( 'Pool', 'calibre/class/pool' )
+  autoload( 'PromoteSelf', 'calibre/class/promoteself' )
+  autoload( 'Reference', 'calibre/class/reference' )
+  autoload( 'Semaphore', 'calibre/class/semaphore' )
+  autoload( 'StaticHash', 'calibre/class/statichash' )
+  autoload( 'SuperStruct', 'calibre/class/sstruct' )
+  autoload( 'SyncHash', 'calibre/class/synchash' )
+  autoload( 'SyncArray', 'calibre/class/syncarray' )
+  autoload( 'SyncHash', 'calibre/class/synchash' )
+  autoload( 'TagIterator', 'calibre/class/tagiter' )
+  autoload( 'Timer', 'calibre/class/timer' )
+  autoload( 'TracePoint', 'calibre/class/tracepoint' )
+  autoload( 'Tuple', 'calibre/class/tuple' )
+  autoload( 'Tuple', 'calibre/class/tuple' )
+  autoload( 'Uninheritable', 'calibre/class/uninheritable' )
+  autoload( 'Version', 'calibre/class/version' )
+end
+
+alias  :autoload_classes :autorequire
+alias  :autoload_modules :autorequire
+
+
+
+# testing
+
+if $0 == __FILE__
+
+  require 'test/unit'
+
+  autoload_classes
+
+  class TC < Test::Unit::TestCase
+
+    def test01
+      assert_nothing_raised do
+        Interval.new(0,9)
+      end
+    end
+
+    def test02
+      assert_raise(NameError) do
+        GGAARRBBAAGGEE.new
+      end
+    end
+
+  end #class TC
+
+end