RubyGems - facets - Versions diffs - 1.4.0 → 1.4.1 - Mend

facets 1.4.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1260) hide show

data/note/IMPORTANT ADDED Viewed

@@ -0,0 +1,8 @@
+Facets is a GENERAL PURPOSE library. It is vital that is stay that way!
+Under no circumstances should something be added to Facets specific to
+a particular use case or application. While a lib might serve the needs
+of such, the lib itself must have general applicability. Although not a
+sure test in either "direction", a good rule of thumb for such a
+condition is whether a lib has an external dependency --it should not.

data/note/Rakefile.old ADDED Viewed

@@ -0,0 +1,181 @@
+#!/usr/bin/env ruby
+#require 'uri'
+require 'yaml'
+require 'fileutils'
+require './lib/facets/core/file/self/read_list'
+require 'reap/rake'
+DATPATH = "data/facets"
+ETCPATH = "conf/facets"
+REQPATH = "facets/core"
+MTHPATH = "lib/facets/core"
+GENPATH = "lib/facets/core"
+task :default => [ :tasks ]
+task :tasks do
+  Rake.application.options.show_task_pattern = //
+  Rake.application.display_tasks_and_comments
+end
+#-----------------------------------------------------
+# Generate facet/
+#-----------------------------------------------------
+desc %{Build facet redirect directory}
+task :redirect do
+  sh %{rm -R 'lib/facet'} if File.directory?('lib/facet')
+  print "Creating redirection facet/ files..."
+  ['core','more'].each{ |d|
+    from = "lib/facets"
+    rbs = Dir.glob( File.join( from, d, '**/*.rb' ) )
+    rbs.each { |e|
+      nolib = e.gsub( /^lib\//, '' )
+      re = Regexp.new( Regexp.escape( File.join( from, d ) + '/' ) )
+      link = e.gsub( re, 'lib/facet/')
+      FileUtils.mkdir_p( File.dirname( link ) )
+      File.open( link, "w+" ) { |w|
+         w << "require '#{nolib}'"
+      }
+    }
+  }
+  puts "[done]"
+end
+#-----------------------------------------------------
+# Read in the facets directory and sort-out per class
+#-----------------------------------------------------
+Methods = {}
+task :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
+#-----------------------------------------------------
+# 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
+#-----------------------------------------------------
+# Do all prep tasks (do this to generate data index
+# file and method group files)
+#-----------------------------------------------------
+desc %{Do all preperation (index, class)}
+task :prep => [ :index, :class, :redirect ] do
+end
+#-----------------------------------------------------
+# List Methods
+#-----------------------------------------------------
+desc %{Output a list of all methods}
+task 'list' => [ :methods ] do
+  puts method_list_outline
+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
+#desc "Check for open comment tests"
+#task :testchk do
+#  system %q{grep -r ^#=begin\ test ./lib}
+#end
+#-----------------------------------------------------
+# Supporting Methods
+#-----------------------------------------------------
+private
+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 (allfiles 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/note/history/ANN-0.6.0 ADDED Viewed

@@ -0,0 +1,40 @@
+Happy Winter Solstice,
+I am pleased to finally announce the first public release of Ruby
+Facets. Ruby Facets was born, as I imagine many such projects
+are, over a period of years, as a growing collection of routines
+for which I commonly found need. Recently the library had
+grown large enough that I thought it might stand on its own.
+So a few weeks ago, I decided I'd go ahead and prepare a
+release. There was a good bit of work to do --organizing,
+documenting, testing; and I had the "bright" idea of scouring
+the web for other tidbits that I might add. That turned into a
+whole project in itself! But I persevered and now Facets is
+finally polished enough for an initial offering.
+Of course, there are still plenty of things left to do: write better
+documentation, improve the tests and write a few yet missing,
+improve the methods themselves, perhaps even a few improvements
+in method and file names, plus error catching code --I'm sure there
+are a number of places for that improvement, and of course there's
+plenty of room for adding new goodies, too. In fact I hope the
+Ruby community at large will take this opportunity to contribute any
+extension methods used personally but deemed generally useful.
+As the project manager I am quite open to the many possibilities.
+Please contribute!
+Being the very first release, I expect there may arise some
+unforeseen bugs. If you come across any please let me know,
+as soon as possible, so I can fix. You can contact me either
+privately or via ruby-talk, or through the new calibre-cuts
+mailing-list:
+  http://rubyforge.org/mailman/listinfo/calibre-cuts
+My hope for Ruby Facets, and the other children of its parent
+project, Ruby Calibre, is that Ruby will gain a vast and widely
+used set of useful classes and routines in a nice all-in-one package
+--Ruby's Tertiary library after Core and Standard, if you will.
+Thanks and Happy Holidays,
+T.

data/note/history/ANN-0.6.1 ADDED Viewed

@@ -0,0 +1,36 @@
+Happy New Year,
+A new version of Ruby Facets is out: 0.6.1. This version updates the common
+"mix" files to be insync with the previous 0.6 updates (they were lagging
+behind at version 0.5). Not to be confused with a _mixin_, a mix simply
+bundles a group of atomic requires into single file. The most common are
+for the class and modules themselves. For example:
+  require 'facet/string'
+This mix requires all String facets considerd most commonly useful.
+Also added are a few new extra mixes: 'facet/rand' and 'facet/nil-as-emptiness'.
+'rand' requires an assortment of random related methods. 'nil-as-emptiness'
+makes NilClass return nil to a number of common methods, like #empty?
+and #[].
+If you are interested in contributing to a project but have little time
+to spare, helping with Facets may be a perfect project. There are still
+plenty of light-weight tasks to do: improve documentation, improve the
+tests and write a few yet missing, improve the rohbustness of methods
+themselves, including exceptional error catching, and of course there's
+plenty of room for adding new goodies, too. If you have any extension
+methods that you use and think may be of benefit to others, please let
+us know. We are quite open to the many possibilities.
+And, of course, please let us know if you come across any bugs.
+You can contact us either privately or via ruby-talk, or through the
+new calibre-cuts mailing-list:
+  http://rubyforge.org/mailman/listinfo/calibre-cuts
+Thanks,
+T.

data/note/history/ANN-0.6.3 ADDED Viewed

@@ -0,0 +1,43 @@
+Hi--
+Ruby Facets 0.6.3 is now out. This version adds some new methods (as
+usual). But the biggest news is that Facets is now avaialble via
+RubyGems. To install simply run 'gem install facets'.
+Here's a rundown of the ChangeLog for 0.6.3:
+* Added kernel/require_all which allows one to require a pattern of files,
+making it easy to require every file in a directory.
+* Added hash/traverse and hash/traverse!, which takes a block and iterates over
+each key-value pair descending into subhash values and applying the block.
+Thanks goes to Ara T. Howard and robert for their help.
+* Changed enumerable/build_hash to enumerable/graph. The method #build_hash
+has been aliased to #graph for the time being for backward compatability.
+* Added hash/collect. This uses enumerable/graph so that
+hash/collect will return a hash rather then an array.
+* Added numeric/before and numeric/after in place of #ago and #since
+and aliased #ago and #since to them, per the suggestions of
+Francis Hwang.
+* Added "poor man's profiler", time/elapse. Credit goes to Hal Fulton.
+* Added array/last_index. Thanks goes to Jabari.
+If you have any extension methods that you use and think may be of benefit
+to others, please submit them. And, of course, please let me know if you
+come across any bugs.
+You can contact me either privately or via ruby-talk,
+or via the Ruby Muse mailing list, suby-ruby at berlios.de
+(membership required).
+  http://rubyforge.org/mailman/listinfo/calibre-cuts
+Thanks,
+T.

data/note/history/ANN-0.7.0 ADDED Viewed

@@ -0,0 +1,59 @@
+Hi--
+Exciting news! Ruby Facets 0.7 series is officially out. And this version goes ballistic.
+Why? Well, what used to be the Carats library has now been merged into Facets! So not only
+does Facets have the atomic methods, it now has a plethora of classes, modules and mixins
+to draw upon.
+Here's a list of the general changes for the current version 0.7.2:
+* The Carats library has been ported into the Facet lib. These files sit in the
+  main lib directory 'facet/' above the "atomic" methods which are all in
+  subdirectories 'facet/{module|class}/'. This layout works well, and allows for
+  everything to be provided from the same location.
+* All methods with names containing non-alphanumeric characters are now CGI-escaped.
+  This removes some incompatibilites with some file systems. For instance Object#in?
+  is now stored in object/in%3F.rb.
+* So one doesn't have to fuss with these escape chars, a new method has been added,
+  kernel/require_facet, which automatically does the substitutions.
+* An expiremental file, facet.rb, had been added that allows automatic requiring of
+  atomic methods. It uses object/method_missing to require the methods on demand.
+* A number of "molecular" files have been added. These require multiple
+  related "atoms" at once for greater convenience.
+* A few methods that were grouped together in the same file have been separated
+  into their own files. (This is more feasible thanks to the additional
+  "require collections.")
+* The method array/put has been changed to array/top (it is an alias for #unshift).
+* Methods #matchdata/post_match_from and #matchdata/pre_match_from have been
+  deprecated in favor of some more generalized methods that serves the same
+  purposes, matchdata/matchtree and matchdata/matchset.
+* Added module/include_as which allows one to include a module but within a specified
+  namespace.
+* Added array/each_permutation, which applys a block to each permutation (in contrast
+  to each_combination).
+As for the rest. Well, this thing is HUGE! There's no way I can go into it all of it here.
+So dig in and check it out. Documentation is a bit improved, too btw, albeit there's still
+plenty of work to be done in this regard.
+If you have any extension methods that you use and think may be of benefit
+to others, please submit them. And, of course, please let me know if you
+come across any bugs.
+You can contact me either privately or via ruby-talk,
+or via the Ruby Muse mailing list, suby-ruby at berlios.de
+(membership required).
+  http://rubyforge.org/mailman/listinfo/calibre-cuts
+Thanks,
+T.

data/note/history/ANN-0.8.1 ADDED Viewed

@@ -0,0 +1,127 @@
+DRUM ROLL PLEASE. I'm happy to announce two new sister projects:
+Nano Methods and Mega Modules. They are born from the heritage of the
+old Ruby Facets project (now deprecated). In the course of the last
+several months a slew of major improvements have been made. We have some
+spiffy new websites and, most importantly, this release marks the
+beginning of a clear window toward 1.0 status.
+GREAT NEWS! Nano Methods and Mega Modules are now the official
+support libraries for Nitro and Og (http://www.nitrohq.com).
+Nitro is a sophisticated Web Application Engine and Og is an
+intuitive yet powerful Object Relational Mapping Library.
+WHY MEGA? You may have noticed that I back peddled on the major change to
+Facets 0.7.0. In that release I had merged the class and module additions
+library, Ruby Carats, into Facets. But I had to separate them out again. It
+simply proved too cumbersome to have such a variety of content all in one
+location. I am very excited the re-separation though. It has already lent
+itself to major improvements to the library, with a number of exciting
+additions on the way.
+NANO SYSTEM. Another new feature is the introduction of the NanoSystem
+module. This module provides access to meta-info about Nano's extensions.
+Primarily it is an index of all the methods. With this information at its
+disposal another unique way to require method becomes possible:
+  require 'nanosys'
+  String.use :capitalized?, :underscore
+I am not recommending this approach at the moment. But in the long run,
+as the NanoSystem module matures, it may well prove to be a much more
+elegant means of extension loading.
+FOR FACETS USERS. To upgrade, the project name change will require
+you to change the #require path-space from 'facet/' to 'nano/', or
+occasionally 'mega/'. The division is pretty clear, Nano stores methods
+and Mega stores classes and modules. Sorry for the inconvenience, but
+after a long debate I decided it was worth it --and better to do so now
+rather then later. Hope you like the new names.
+CORNUCOPIA. Finally, there are also _a lot_ of minor changes in this release.
+Some of them are simply improvements in the naming of methods or more appropriate
+class/module placement. I've gone over all the methods enough now to be
+confident that the present methods are pretty well set. You can expect many fewer
+name/location changes from here on out. Also, a good number of new methods have
+been added. Most of these I have managed to make mention of in the following
+ChangeLog summary.
+* Class methods are not prefixed with '::' to separate them from instance methods.
+* Added logger #format and #format_message (whomever wrote these please let me know,
+I got them thru a second-hand source and the original author is lost to me. I try
+very hard to credit where credit is due.)
+* Renamed object/supers to object/superup. Better!
+* Got rid of symbol/gen. Use object/generate_method_name or
+module#generate_instance_method_name instead. [ed- Is that the longest
+non-foo method name ever?]
+* The file 1st.rb file has moved to object/method!. This provides a version
+of #method that persists the returned Method object.
+* Added module/clone_using, module/clone_renaming and module/clone_removing.
+* Added module/integrate (I love this one, but note that its syntax is not yet
+set in stone.)
+* Added many new enumerable methods: #filter_map, #compact_map, #commonality,
+#frequency, #probability and #find_collisions.
+* Moved some methods from array to enumerable: #each_permutation,
+#each_combination, #each_unique_pair and the class method ::combinations.
+* Added string/bytes per ruby-dev summary 26385-26467.
+* Moved #cattr_reader, #cattr_writer and #cattr_accessor from Class to Module.
+These are the class variable attributes as defined by Rails DHH.
+* Added class instance attribute methods: iattr_reader, iatter_writer, &c.
+The name of these are not set in stone. It's a bad misnomer. Looking
+for suggestions.
+* Added methods to comparable: #cap, #clip. #clip replaces #bound_by, since
+'by' generally indicates the method takes a block parameter. I have retained
+#at_least and #at_most, although #cap and #clip handle the same functionality.
+* Added class/descendants (alias subclasses) and class/remove_descendants.
+* Removed string/table_name and string/class_name (were too Rails specific).
+Note: A new module has been added to Mega Modules, called orm_inflect.rb.
+It contains numerous methods for doing this sort of thing.
+* Added numeric/ceil_multiple.
+* Added string/soundex for calculating the soundex code of a word/name.
+* numeric/octet_units has bee moved to mega/binary_multipliers, which
+is a rewrite of Richard Kilmer's bytes.rb. Actually #octet_units is
+now just an alias or #strfbytes, accompanied by #strfbits.
+* Placed Florian's binding-of-caller.rb in binding/of_caller. Makes more
+sense there.
+* Fixed Continuation::create; it wasn't defined as a class method
+and should have been.
+* Fixed bug with string/capitalized? which wasn't always giving the correct
+result.
+There are a number of others, but this particular session of development was
+so rapid and choked full, I wasn't able to log them all.
+Please see the API RDocs for a complete listing.
+CONTRIBUTE. As always, if you have any extension methods that you use and think
+may be of benefit to others, please submit them. There's a good chance they'll be
+incorporated. Also, if you happen to notice any code that is mis-credited or is
+not credited at all and should be, please correct me. Giving credit where credit
+is due is _vry_ important to me, unfortuantely in the juggle of things it doesn't
+always get doen as wellas it should. And, of course, please let me know if you
+come across any bugs.
+You can contact me either privately or via ruby-talk.
+Thanks and Enjoy,
+trans|onoma