facets 2.2.1 → 2.3.0

data/lib/more/facets/rbconfig.rb

@@ -0,0 +1,55 @@
+# TITLE:
+#
+#   Ruby Configuration
+#
+# SUMMARY:
+#
+#   An extended rendition of the Ruby's standard Config module.
+#
+# COPYRIGHT:
+#
+#   Copyright (c) 2006 Thomas Sawyer
+#
+# LICENSE:
+#
+#   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.
+#
+# AUTHORS:
+#
+#   - Thomas Sawyer
+
+
+require 'rbconfig'
+
+
+# = Config
+#
+module Config
+
+  def self.inspect
+    CONFIG.inspect
+  end
+
+  # In case rubygems has already defined it.
+  unless self.respond_to?(:datadir)
+    # Return the path to the data directory associated with the
+    # given library/package name. Normally this is just
+    #
+    #   "#{Config::CONFIG['datadir']}/#{name}"
+    #
+    # but may be modified by tools like RubyGems to handle
+    # versioned data directories.
+
+    def self.datadir(package_name)
+      File.join(CONFIG['datadir'], package_name)
+    end
+  end
+
+end

data/lib/more/facets/set.rb

@@ -0,0 +1,27 @@
+require 'set'
+
+class Set
+  def power_set
+    if empty?
+      Set[ self ]
+    else
+      any_value = [to_a.first]
+      subsubs = (self - any_value).power_set
+      subsubs + subsubs.map{ |subset| subset + any_value }
+    end
+  end
+end
+
+class Array
+  def power_set
+    if empty?
+      [self]
+    else
+      subset  = dup
+      value   = [ subset.pop ]
+      subsubs = subset.power_set
+      subsubs.concat( subsubs.map{ |subset| subset + value } )
+    end
+  end
+end
+

data/lib/more/facets/snapshot.rb

@@ -181,33 +181,3 @@ class Struct
   end
 end
 
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-
-=begin testing
-
-require 'test/unit'
-
-class TestSnapshot < Test::Unit::TestCase
-
-  def setup
-    customer = Struct.new(:name, :address, :zip)
-    joe = customer.new( "Joe Pitare", "1115 Lila Ln.", 47634 )
-    @joe_snap = joe.take_snapshot
-  end
-
-  def test_storage
-    assert_equal( "Joe Pitare", @joe_snap[:name]  )
-    assert_equal( "1115 Lila Ln.", @joe_snap[:address] )
-    assert_equal( 47634, @joe_snap[:zip] )
-  end
-
-end
-
-=end

data/lib/more/facets/stylize.rb

@@ -211,150 +211,3 @@ class Integer
   include Style
 end
 
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestInflect < Test::Unit::TestCase
-
-    def test_basename_01
-      assert_equal( "Unit", "Test::Unit".basename )
-    end
-
-    def test_basename_02
-      a =  "Down::Bottom"
-      assert_raises( ArgumentError ) { a.basename(1) }
-    end
-
-    def test_basename_03
-      a =  "Down::Bottom"
-      assert_equal( "Bottom", a.basename )
-    end
-
-    def test_basename_04
-      b =  "Further::Down::Bottom"
-      assert_equal( "Bottom", b.basename )
-    end
-
-    def test_camelize
-      assert_equal( 'ThisIsIt', 'this_is_it'.camelize )
-    end
-
-    def test_camelcase
-      assert_equal( "abcXyz", "abc_xyz".camelcase )
-      assert_equal( "abcXyz", "abc xyz".camelcase )
-      assert_equal( "abcXyz", "abc  xyz".camelcase )
-      assert_equal( "abcXyz", "abc\txyz".camelcase )
-      assert_equal( "abcXyz", "abc\nxyz".camelcase )
-      assert_equal( "abcXyz", "abc____xyz".camelcase )
-    end
-
-    def test_camelcase_true
-      assert_equal( "AbcXyz", "abc_xyz".camelcase(true) )
-      assert_equal( "AbcXyz", "abc xyz".camelcase(true) )
-      assert_equal( "AbcXyz", "abc  xyz".camelcase(true) )
-      assert_equal( "AbcXyz", "abc\txyz".camelcase(true) )
-      assert_equal( "AbcXyz", "abc\nxyz".camelcase(true) )
-    end
-
-    def test_humanize
-      assert_equal( 'This is it', 'this_is_it'.humanize )
-    end
-
-    def test_title
-      r = "try this out".title
-      x = "Try This Out"
-      assert_equal(x,r)
-    end
-
-    def test_demodulize_01
-      a =  "Down::Bottom"
-      assert_raises( ArgumentError ) { a.demodulize(1) }
-    end
-
-    def test_demodulize_02
-      a =  "Down::Bottom"
-      assert_equal( "Bottom", a.demodulize )
-    end
-
-    def test_demodulize_03
-      b =  "Further::Down::Bottom"
-      assert_equal( "Bottom", b.demodulize )
-    end
-
-    def test_demodulize_01
-      a =  "Down::Bottom"
-      assert_raises( ArgumentError ) { a.demodulize(1) }
-    end
-
-    def test_demodulize_02
-      a =  "Down::Bottom"
-      assert_equal( "Bottom", a.demodulize )
-    end
-
-    def test_demodulize_03
-      b =  "Further::Down::Bottom"
-      assert_equal( "Bottom", b.demodulize )
-    end
-
-    def test_methodize
-      assert_equal( 'hello_world', 'HelloWorld'.methodize )
-      assert_equal( '__unix_path', '/unix_path'.methodize )
-    end
-
-    def test_modulize
-      assert_equal( 'MyModule::MyClass',   'my_module__my_class'.modulize   )
-      assert_equal( '::MyModule::MyClass', '__my_module__my_class'.modulize )
-      assert_equal( 'MyModule::MyClass',   'my_module/my_class'.modulize    )
-      assert_equal( '::MyModule::MyClass', '/my_module/my_class'.modulize   )
-    end
-
-    def test_pathize
-      assert_equal( 'my_module/my_class',   'MyModule::MyClass'.pathize )
-      assert_equal( 'u_r_i',                'URI'.pathize )
-      assert_equal( '/my_class',            '::MyClass'.pathize )
-      assert_equal( '/my_module/my_class/', '/my_module/my_class/'.pathize )
-    end
-
-  end
-
-
-  class TestClassInflect < Test::Unit::TestCase
-
-    def test_method_name
-      assert_equal( Test::Unit::TestCase.methodize, 'test__unit__test_case' )
-    end
-
-    def test_method_name
-      assert_equal( Test::Unit::TestCase.pathize, '/test/unit/test_case' )
-    end
-
-  end
-
-  class TestIntegerInflect < Test::Unit::TestCase
-
-    def test_ordinalize
-      assert_equal( '1st', '1'.ordinalize )
-      assert_equal( '2nd', '2'.ordinalize )
-      assert_equal( '3rd', '3'.ordinalize )
-      assert_equal( '4th', '4'.ordinalize )
-    end
-
-    def test_ordinal
-      assert_equal( '1st', 1.ordinal )
-      assert_equal( '2nd', 2.ordinal )
-      assert_equal( '3rd', 3.ordinal )
-      assert_equal( '4th', 4.ordinal )
-    end
-
-  end
-
-=end

data/lib/more/facets/times.rb

@@ -344,101 +344,3 @@ class Time
   end
 end
 
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-
-=begin testing
-
-  require 'test/unit'
-  #require 'mega/multiplier'
-
-  class NumericTest < Test::Unit::TestCase
-
-    #def test_micro_seconds
-    #  assert_equal( 0.000001, 1.microsecond )
-    #end
-
-    #def test_milli_seconds
-    #  assert_equal( 0.001, 1.millisecond )
-    #end
-
-    def test_seconds
-      assert_equal( 60**0, 1.seconds )
-    end
-
-    def test_minutes
-      assert_equal( 60**1, 1.minutes )
-    end
-
-    def test_hours
-      assert_equal( 60**2, 1.hours )
-    end
-
-    def test_days
-      assert_equal( 24*(60**2), 1.days )
-    end
-
-    def test_weeks
-      assert_equal( 7*24*(60**2), 1.weeks )
-    end
-
-    def test_fortnights
-      assert_equal( 14*24*(60**2), 1.fortnights )
-    end
-
-    def test_months
-      assert_equal( 30*24*(60**2), 1.months )
-    end
-
-    def test_years
-      assert_equal( 365*24*(60**2), 1.years )
-    end
-
-    def test_before
-      t = Time.now
-      assert_equal( t - 1.day, 1.day.before(t) )
-    end
-
-    def test_after
-      t = Time.now
-      assert_equal( t + 1.day, 1.day.after(t) )
-    end
-
-  end
-
-  class WeekdaysTest < Test::Unit::TestCase
-
-    MONDAY = Time.at(1165250000)
-    THURSDAY = Time.at(1165500000)
-    FRIDAY = Time.at(1165606025)
-
-    def test_weekday_after_monday
-      assert_equal 2, 1.weekday.since(MONDAY).wday
-    end
-
-    def test_weekday_after_friday
-      assert_equal 1, 1.weekday.after(FRIDAY).wday
-    end
-
-    def test_weekdays_before_friday
-      assert_equal 2, 3.weekdays.before(FRIDAY).wday
-    end
-
-    #def test_weekday_before_today
-    #  Time.expects(:now).returns(THURSDAY)
-    #  assert_equal 3, 1.weekday.ago.wday
-    #end
-
-    #def test_weekdays_after_today
-    #  Time.expects(:now).returns(MONDAY)
-    #  assert_equal 3, 2.weekday.from_now.wday
-    #end
-
-  end
-
-=end

data/lib/more/facets/tracepoint.rb

@@ -0,0 +1,194 @@
+# TITLE:
+#
+#  TracePoint
+#
+# SUMMARY:
+#
+#   A TracePoint is a Binding with the addition event information.
+#   And it's a better way to use set_trace_func.
+#
+# COPYRIGHT:
+#
+#   Copyright (c) 2005 Thomas Sawyer
+#
+# LICENSE:
+#
+#   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.
+#
+# AUTHORS:
+#
+#   - Thomas Sawyer
+
+
+require 'facets/binding'
+
+
+# = CodePoint
+#
+# This is the same as a Binding. Not really needed, but I like consistency :)
+
+CodePoint = Binding
+
+# = TracePoint
+#
+# A TracePoint is a Binding with the addition of event information.
+# Among other things, it functions very well as the join-point for
+# Event-based AOP.
+#
+# == Usage
+#
+#   TracePoint.trace { |tp|
+#     puts "#{tp.self.class}\t#{tp.called}\t#{tp.event}\t#{tp.return?}\t#{tp.back == tp.bind}"
+#   }
+#
+#   1 + 1
+#
+# produces
+#
+#   Class   trace   return     true    false
+#   Object          line       false   false
+#   Fixnum  +       c-call     false   false
+#   Fixnum  +       c-return   false   false
+#
+# == Notes
+#
+# You can't subclass Binding, so we delegate (which is better anyway).
+
+class TracePoint  #< Codepoint
+
+  # -- class ---------------------
+  class << self
+
+    @@active = false
+
+    def active ; @@active ; end
+
+    def active=(x)
+      @@active = x ? true : false
+      unless @@active
+        set_trace_func nil
+      end
+    end
+
+    # Trace execution using a TracePoint.
+    def trace # :yield:
+      if active
+        bb_stack = []
+        set_trace_func proc{ |e, f, l, m, b, k|
+          #(p e, f, l, m, b, k, @@bb_stack; puts "---") if $DEBUG
+          if ['call','c-call','class'].include?(e)
+            bb_stack << b
+          elsif ['return','c-return','end'].include?(e)
+            bb = bb_stack.pop
+          end
+          b = bb if ! b    # this sucks!
+          tp = TracePoint.new(e,m,b,bb)
+          yield(tp)
+        }
+      end
+    end
+
+  end #class
+
+  # -- instance -------------------
+
+  attr_accessor :event, :binding, :back_binding
+
+  # Until Ruby has a built-in way to get the name of the calling method
+  # that information must be passed into the TracePoint.
+  def initialize( event, method, bind, back_binding=bind )
+    @event = event
+    @method = method
+    @binding = bind
+    @back_binding = back_binding
+  end
+
+  # shorthand for binding
+  def bind ; @binding ; end
+
+  # shorthand for back_binding
+  def back ; @back_binding ; end
+
+  # Delegates "self" to the binding which
+  # in turn delegates the binding object.
+  def self ; @binding.self ; end
+
+  # Returns the name of the event's method.
+  # This could delegate to the binding if Ruby had
+  # an internal way to retrieve the current method name.
+  def callee ; @method ; end
+  #def method ; @method ; end            # TODO Conflict with Kernel#method?
+  alias_method( :called, :callee )       # TODO deprecate
+  alias_method( :method_name, :called )  # TODO deprecate
+
+  # delegate to binding
+  #def method_missing(meth, *args, &blk)
+  #  @binding.send(meth, *args, &blk)
+  #end
+
+  ### methods for working with events
+
+  EVENT_MAP = {
+    :all     => ['call', 'c-call', 'return', 'c-return', 'line', 'class', 'end', 'raise'],
+    :before  => ['call', 'c-call'],
+    :after   => ['return', 'c-return'],
+    :call    => ['call'],
+    :return  => ['return'],
+    :ccall   => ['c-call'],
+    :creturn => ['c-return'],
+    :line    => ['line'],
+    :class   => ['class'],
+    :end     => ['end'],
+    :raise   => ['raise']
+  }
+  def event_map(e) ; EVENT_MAP[e] ; end
+
+  # Is the trace point defined or undefined?
+  def event? ; !! @event ; end
+  def eventless? ; ! @event ; end
+
+  # For use in case conditions
+  def ===(e)
+    EVENT_MAP[e].include?(@event)
+  end
+
+  # Creates an <event>? method for each of the above event mappings.
+  EVENT_MAP.each_pair { |m,v|
+    define_method( "#{m}?" ){ v.include?(@event) }
+  }
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+# TODO
+
+=begin #test
+
+  # Note: TracePoint will probably prove tricky to test, since
+  # manipulating set_trace_func tends to wreak havoc on errors,
+  # the call stack, and so on.
+
+  TracePoint.active = true
+
+  TracePoint.trace { |tp|
+    puts "#{tp.self.class}\t#{tp.called}\t#{tp.event}\t#{tp.return?}\t#{tp.back == tp.bind}"
+  }
+
+  1 + 1
+
+=end