facets 2.8.4 → 2.9.0.pre.1

data/lib/more/facets/equitable.rb

@@ -1,120 +0,0 @@
-# = Equitable
-#
-# This mixin provides methods of equality based
-# on a single #identity method which must return
-# a list of accessors used as the identity keys.
-#
-# It also provides a "shortcut" for creating the
-# #identity method based on given accessors and returns
-# the Equitable module for inclusion.
-#
-#   include Equitable(:a, :b)
-#
-# is equivalent to including a module containing:
-#
-#   def ==(other)
-#     self.a == other.a && self.b == other.b
-#   end
-#
-#   def eql?(other)
-#     self.a.eql?(other.a) && self.b.eql?(other.b)
-#   end
-#
-#   def hash()
-#     self.a.hash ^ self.b.hash
-#   end
-#
-# == Authors
-#
-# * Thomas Sawyer
-#
-# == Copying
-#
-# Copyright (c) 2004 Thomas Sawyer
-#
-# Ruby License
-#
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.
-
-
-# = Equitable
-#
-# This mixin provides methods of equality based
-# on a single #identity method which must return
-# a list of accessors used as the identity keys.
-#
-# It also provides a "shortcut" for creating the
-# #identity method based on given accessors and returns
-# the Equitable module for inclusion.
-#
-#   include Equitable(:a, :b)
-#
-# is equivalent to including a module containing:
-#
-#   def ==(other)
-#     self.a == other.a && self.b == other.b
-#   end
-#
-#   def eql?(other)
-#     self.a.eql?(other.a) && self.b.eql?(other.b)
-#   end
-#
-#   def hash()
-#     self.a.hash ^ self.b.hash
-#   end
-#
-module Equitable
-
-  def self.identify(base, *accessors)
-    base.send(:define_method, :identity){ accessors }
-    self
-  end
-
-  def ==(o)
-    identity.all?{ |a| send(a) == o.send(a) }
-  end
-
-  def eql?(o)
-    identity.all?{ |a| send(a).eql?(o.send(a)) }
-  end
-
-  def hash
-    identity.inject(0){ |memo, a| memo ^ send(a).hash }
-  end
-
-end
-
-class Module
-
-  # This function provided a "shortcut" for creating the
-  # #identity method based on given accessors and returns
-  # the Equitable module for inclusion.
-  #
-  #  include Equitable(:a, :b)
-  #
-  # is equivalent to including a module containing:
-  #
-  #   def ==(other)
-  #     self.a == other.a && self.b == other.b
-  #   end
-  #
-  #   def eql?(other)
-  #     self.a.eql?(other.a) && self.b.eql?(other.b)
-  #   end
-  #
-  #   def hash()
-  #     self.a.hash ^ self.b.hash
-  #   end
-  #
-
-  def Equitable(*accessors)
-    Equitable.identify(self, *accessors)
-  end
-
-end
-

data/lib/more/facets/expirable.rb

@@ -1,54 +0,0 @@
-# Expirable
-#
-# Copyright (c) 2004 George Moschovitis
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-
-# Generic expirability mixin.
-#
-module Expirable
-
-  attr_accessor :expires
-
-  # Set the expires timeout for this entry.
-
-  def expires_after(timeout = (60*60*24))
-    @expires = Time.now + timeout
-  end
-
-  # Set the expire timeout for this entry. The timeout happens
-  # after (base + rand(spread)) seconds.
-
-  def expires_spread(base, spread)
-    @expires = Time.now + base + rand(spread)
-  end
-
-  # Is this entry expired?
-
-  def expired?
-    if @expires.nil? or (Time.now > @expires)
-      return true
-    else
-      return false
-    end
-  end
-
-  # Update the expiration period. Override in your application.
-
-  def touch!
-  end
-
-end
-

data/lib/more/facets/filelist.rb

@@ -1,497 +0,0 @@
-# = FileList
-#
-# A FileList is essentially an array with helper methods
-# to make file manipulation easier.
-#
-# FileLists are lazy.  When given a list of glob patterns for
-# possible files to be included in the file list, instead of
-# searching the file structures to find the files, a FileList holds
-# the pattern for latter use.
-#
-# This allows us to define a number of FileList to match any number of
-# files, but only search out the actual files when then FileList
-# itself is actually used.  The key is that the first time an
-# element of the FileList/Array is requested, the pending patterns
-# are resolved into a real list of file names.
-#
-#   fl = FileList.new
-#   fl.include('./**/*')
-#   fl.exclude('./*~')
-#
-# == History
-#
-#   FileList was ported from Jim Weirich's Rake.
-#
-# == Authors
-#
-# * Jim Weirich
-#
-# == Todo
-#
-# * Should the exclusions really be the default?
-#   Maybe have #exclude_typical instead.
-#
-# == Copying
-#
-# Copyright (C) 2002 Jim Weirich
-#
-# General Public License (GPL)
-#
-# 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.
-
-# = FileList
-#
-# A FileList is essentially an array with helper methods
-# to make file manipulation easier.
-#
-# FileLists are lazy.  When given a list of glob patterns for
-# possible files to be included in the file list, instead of
-# searching the file structures to find the files, a FileList holds
-# the pattern for latter use.
-#
-# This allows us to define a number of FileList to match any number of
-# files, but only search out the actual files when then FileList
-# itself is actually used.  The key is that the first time an
-# element of the FileList/Array is requested, the pending patterns
-# are resolved into a real list of file names.
-#
-#   fl = FileList.new
-#   fl.include('./**/*')
-#   fl.exclude('./*~')
-#
-class FileList
-
-  # TODO: Add glob options.
-  #attr :glob_options
-
-  #include Cloneable
-  def clone
-    sibling = self.class.new
-    instance_variables.each do |ivar|
-      value = self.instance_variable_get(ivar)
-      sibling.instance_variable_set(ivar, value.rake_dup)
-    end
-    sibling
-  end
-  alias_method :dup, :clone
-
-  # == Method Delegation
-  #
-  # The lazy evaluation magic of FileLists happens by implementing
-  # all the array specific methods to call +resolve+ before
-  # delegating the heavy lifting to an embedded array object
-  # (@items).
-  #
-  # In addition, there are two kinds of delegation calls.  The
-  # regular kind delegates to the @items array and returns the
-  # result directly.  Well, almost directly.  It checks if the
-  # returned value is the @items object itself, and if so will
-  # return the FileList object instead.
-  #
-  # The second kind of delegation call is used in methods that
-  # normally return a new Array object.  We want to capture the
-  # return value of these methods and wrap them in a new FileList
-  # object.  We enumerate these methods in the +SPECIAL_RETURN+ list
-  # below.
-
-  # List of array methods (that are not in +Object+) that need to be
-  # delegated.
-  ARRAY_METHODS = (Array.instance_methods - Object.instance_methods).map(&:to_s)
-
-  # List of additional methods that must be delegated.
-  MUST_DEFINE = %w[to_a inspect].map(&:to_s)
-
-  # List of methods that should not be delegated here (we define
-  # special versions of them explicitly below).
-  MUST_NOT_DEFINE = %w[to_a to_ary partition *].map(&:to_s)
-
-  # List of delegated methods that return new array values which
-  # need wrapping.
-  SPECIAL_RETURN = %w[
-    map collect sort sort_by select find_all reject grep
-    compact flatten uniq values_at
-    + - & |
-  ].map(&:to_s)
-
-  DELEGATING_METHODS = (ARRAY_METHODS + MUST_DEFINE - MUST_NOT_DEFINE).sort.uniq
-
-  # Now do the delegation.
-  DELEGATING_METHODS.each_with_index do |sym, i|
-    if SPECIAL_RETURN.include?(sym)
-      ln = __LINE__+1
-      class_eval %{
-        def #{sym}(*args, &block)
-          resolve if @pending
-          result = @items.send(:#{sym}, *args, &block)
-          FileList.new.import(result)
-        end
-      }, __FILE__, ln
-    else
-      ln = __LINE__+1
-      class_eval %{
-        def #{sym}(*args, &block)
-          resolve if @pending
-          result = @items.send(:#{sym}, *args, &block)
-          result.object_id == @items.object_id ? self : result
-        end
-      }, __FILE__, ln
-    end
-  end
-
-  # Create a file list from the globbable patterns given.  If you
-  # wish to perform multiple includes or excludes at object build
-  # time, use the "yield self" pattern.
-  #
-  # Example:
-  #   file_list = FileList.new['lib/**/*.rb', 'test/test*.rb']
-  #
-  #   pkg_files = FileList.new['lib/**/*'] do |fl|
-  #     fl.exclude(/\bCVS\b/)
-  #   end
-  #
-  def initialize(*patterns)
-    @pending_add = []
-    @pending = false
-    @exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup
-    @exclude_re = nil
-    @items = []
-    patterns.each { |pattern| include(pattern) }
-    yield self if block_given?
-  end
-
-  # Add file names defined by glob patterns to the file list.  If an
-  # array is given, add each element of the array.
-  #
-  # Example:
-  #   file_list.include("*.java", "*.cfg")
-  #   file_list.include %w( math.c lib.h *.o )
-  #
-  def include(*filenames)
-    # TODO: check for pending
-    filenames.each do |fn|
-      if fn.respond_to? :to_ary
-        include(*fn.to_ary)
-      else
-        @pending_add << fn
-      end
-    end
-    @pending = true
-    self
-  end
-  alias :add :include
-
-  # Register a list of file name patterns that should be excluded
-  # from the list.  Patterns may be regular expressions, glob
-  # patterns or regular strings.
-  #
-  # Note that glob patterns are expanded against the file system.
-  # If a file is explicitly added to a file list, but does not exist
-  # in the file system, then an glob pattern in the exclude list
-  # will not exclude the file.
-  #
-  # Examples:
-  #   FileList['a.c', 'b.c'].exclude("a.c") => ['b.c']
-  #   FileList['a.c', 'b.c'].exclude(/^a/)  => ['b.c']
-  #
-  # If "a.c" is a file, then ...
-  #   FileList['a.c', 'b.c'].exclude("a.*") => ['b.c']
-  #
-  # If "a.c" is not a file, then ...
-  #   FileList['a.c', 'b.c'].exclude("a.*") => ['a.c', 'b.c']
-  #
-  def exclude(*patterns)
-    patterns.each do |pat| @exclude_patterns << pat end
-    if ! @pending
-      calculate_exclude_regexp
-      reject! { |fn| fn =~ @exclude_re }
-    end
-    self
-  end
-
-  # Clear all the exclude patterns so that we exclude nothing.
-  def clear_exclude
-    @exclude_patterns = []
-    calculate_exclude_regexp if ! @pending
-  end
-
-  # Define equality.
-  def ==(array)
-    to_ary == array
-  end
-
-  # Return the internal array object.
-  def to_a
-    resolve
-    @items
-  end
-
-  # Return the internal array object.
-  def to_ary
-    resolve
-    @items
-  end
-
-  # Redefine * to return either a string or a new file list.
-  def *(other)
-    result = @items * other
-    case result
-    when Array
-      FileList.new.import(result)
-    else
-      result
-    end
-  end
-
-  # Resolve all the pending adds now.
-  def resolve
-    if @pending
-      @pending = false
-      @pending_add.each do |fn| resolve_add(fn) end
-      @pending_add = []
-      resolve_exclude
-    end
-    self
-  end
-
-  def calculate_exclude_regexp
-    ignores = []
-    @exclude_patterns.each do |pat|
-      case pat
-      when Regexp
-        ignores << pat
-      when /[*.]/
-        Dir[pat].each do |p| ignores << p end
-      else
-        ignores << Regexp.quote(pat)
-      end
-    end
-    if ignores.empty?
-      @exclude_re = /^$/
-    else
-      re_str = ignores.collect { |p| "(" + p.to_s + ")" }.join("|")
-      @exclude_re = Regexp.new(re_str)
-    end
-  end
-
-  def resolve_add(fn)
-    case fn
-    when Array
-      fn.each { |f| self.resolve_add(f) }
-    when %r{[*?]}
-      add_matching(fn)
-    else
-      self << fn
-    end
-  end
-
-  def resolve_exclude
-    @exclude_patterns.each do |pat|
-      case pat
-      when Regexp
-        reject! { |fn| fn =~ pat }
-      when /[*.]/
-        reject_list = Dir[pat]
-        reject! { |fn| reject_list.include?(fn) }
-      else
-        reject! { |fn| fn == pat }
-      end
-    end
-    self
-  end
-
-  # Return a new FileList with the results of running +sub+ against
-  # each element of the oringal list.
-  #
-  # Example:
-  #   FileList['a.c', 'b.c'].sub(/\.c$/, '.o')  => ['a.o', 'b.o']
-  #
-  def sub(pat, rep)
-    inject(FileList.new) { |res, fn| res << fn.sub(pat,rep) }
-  end
-
-  # Return a new FileList with the results of running +gsub+ against
-  # each element of the original list.
-  #
-  # Example:
-  #   FileList['lib/test/file', 'x/y'].gsub(/\//, "\\")
-  #      => ['lib\\test\\file', 'x\\y']
-  #
-  def gsub(pat, rep)
-    inject(FileList.new) { |res, fn| res << fn.gsub(pat,rep) }
-  end
-
-  # Same as +sub+ except that the oringal file list is modified.
-  def sub!(pat, rep)
-    each_with_index { |fn, i| self[i] = fn.sub(pat,rep) }
-    self
-  end
-
-  # Same as +gsub+ except that the original file list is modified.
-  def gsub!(pat, rep)
-    each_with_index { |fn, i| self[i] = fn.gsub(pat,rep) }
-    self
-  end
-
-  # Return a new array with <tt>String#ext</tt> method applied to
-  # each member of the array.
-  #
-  # This method is a shortcut for:
-  #
-  #    array.collect { |item| item.ext(newext) }
-  #
-  # +ext+ is a user added method for the Array class.
-  def ext(newext='')
-    collect { |fn| fn.ext(newext) }
-  end
-
-  # Grep each of the files in the filelist using the given pattern.
-  # If a block is given, call the block on each matching line,
-  # passing the file name, line number, and the matching line of
-  # text.  If no block is given, a standard emac style
-  # file:linenumber:line message will be printed to standard out.
-  def egrep(pattern)
-    each do |fn|
-      open(fn) do |inf|
-        count = 0
-
-        inf.each do |line|
-          count += 1
-          if pattern.match(line)
-            if block_given?
-              yield fn, count, line
-            else
-              puts "#{fn}:#{count}:#{line}"
-            end
-          end
-        end
-
-      end
-    end
-  end
-
-  # FileList version of partition.  Needed because the nested arrays
-  # should be FileLists in this version.
-  def partition(&block) # :nodoc:
-    resolve
-    result = @items.partition(&block)
-    [
-      FileList.new.import(result[0]),
-      FileList.new.import(result[1]),
-    ]
-  end
-
-  # Convert a FileList to a string by joining all elements with a space.
-  def to_s
-    resolve if @pending
-    self.join(' ')
-  end
-
-  # Add matching glob patterns.
-  def add_matching(pattern)
-    Dir[pattern].each do |fn|
-      self << fn unless exclude?(fn)
-    end
-  end
-  private :add_matching
-
-  # Should the given file name be excluded?
-  def exclude?(fn)
-    calculate_exclude_regexp unless @exclude_re
-    fn =~ @exclude_re
-  end
-
-  DEFAULT_IGNORE_PATTERNS = [
-    /(^|[\/\\])CVS([\/\\]|$)/,
-    /(^|[\/\\])\.svn([\/\\]|$)/,
-    /(^|[\/\\])_darcs([\/\\]|$)/,
-    /\.bak$/,
-    /~$/,
-    /(^|[\/\\])core$/
-  ]
-  @exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup
-
-  def import(array)
-    @items = array
-    self
-  end
-
-  class << self
-    # Create a new file list including the files listed. Similar to:
-    #
-    #   FileList.new(*args)
-    def [](*args)
-      new(*args)
-    end
-
-    # Set the ignore patterns back to the default value.  The
-    # default patterns will ignore files
-    # * containing "CVS" in the file path
-    # * containing ".svn" in the file path
-    # * containing "_darcs" in the file path
-    # * ending with ".bak"
-    # * ending with "~"
-    # * named "core"
-    #
-    # Note that file names beginning with "." are automatically
-    # ignored by Ruby's glob patterns and are not specifically
-    # listed in the ignore patterns.
-    def select_default_ignore_patterns
-      @exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup
-    end
-
-    # Clear the ignore patterns.
-    def clear_ignore_patterns
-      @exclude_patterns = [ /^$/ ]
-    end
-  end
-
-end # FileList
-
-
-
-# = TEST
-#
-# TODO This test needs a mock File class.
-
-# FileList can't be tested without a FIXTURE setup.
-# So don't bother running it directly from here, but
-# transfer it over to the test directory.
-# Need a  better solution, is there a way to fake the
-# filesystem?
-
-=begin #no test
-
-  require 'test/unit'
-
-  class TC_FileList < Test::Unit::TestCase
-
-    def test_filelist
-      Dir.chdir File.join( $TESTDIR, 'filelist' ) do
-        fl = FileList.new
-        fl.include('*')
-        assert_equal( ['testfile2.txt', 'testfile.txt'], fl.to_a )
-        fl.exclude('*2.txt')
-        assert_equal( ['testfile.txt'], fl.to_a )
-      end
-    end
-
-  end
-
-=end