core_ex 0.2.0 → 0.3.1

data/NEWS

@@ -1,4 +1,42 @@
-= New in 0.2, ...:
+= New in 0.3, 2005-09-15:
+
+  * Architecture:
+      - Need activesupport ~> 1.1.1.
+      - No more custom require/load/autoload.
+      - Many changes to be closer of the activesupport dependency system.
+      - No more use the auto_require feature of rubygems.
+      - Add an automated vendor directory support.
+      - No more use `ask' but HighLine in Rakefiles.
+
+  * Module:
+      - mix_in_with_args.rb: Provides `mixin' which is like `include' but
+          can receive arguments. A module can aslo be setup by two blocks
+          `setup' and `teardown'. Which are run  in  the   class context,
+          before and after the real inclusion.
+      - import.rb: Allow to write MyFavoriteModule.import! to load or require
+          a module managed by Dependencies of activesupport.
+
+  * Object:
+      - instance_eval_with_args.rb:
+          Makes the instance_eval method of Object support arguments.
+      - the_first_time.rb: This method takes a block. It ensures that the
+          code will be run only once. You can use this method only once
+          per file.
+      - singleton_class.rb: Provides an access to the singleton class of
+          an object. Also provides singleton_class_eval,
+          undef_singleton_method, define_singleton_method.
+
+  * Yaml:
+      - Better option handling in yaml extensions.
+      - Inlines little hashs and arrays (with the Inline option set to true).
+
+  * PathList:
+      - Improves PathList#each, and support aliases in Yaml.
+      - Many other improvements.
+
+  * TempPath: Add TempPath.fork_init that initialize a child of a fork.
+
+= New in 0.2, 2005-06-24:
 
   * Yaml:
       Great  improvement  of  the  Yaml  extension,  new  Yaml  types  are  now

data/SPEC.dyn.yml

@@ -1,10 +1,10 @@
 --- !ruby/object:OpenStruct 
 table: 
-  :date: "Thu, 23 Jun 2005"
-  :version: !ruby/object:Version 
-    build: 0
-    major: 0
-    minor: 2
-    revision: 307
   :url: svn://svn.feydakins.org/ruby_ex/trunk/core_ex
   :version_id: ''
+  :version: !ruby/object:Version 
+    build: 1
+    major: 0
+    minor: 3
+    revision: 356
+  :date: "Fri, 16 Sep 2005"

data/SPEC.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = %q{core_ex}
+  s.version = "0.3.1"
+  s.date = %q{2005-09-16}
+  s.summary = %q{CoreEx is a proposal for a standard library extension.}
+  s.email = ["nicolas.despres@gmail.com", "ertai@feydakins.org"]
+  s.homepage = %q{http://api.feydakins.org/core_ex}
+  s.rubyforge_project = %q{core_ex}
+  s.description = %q{CoreEx  is  designed  to provides a simple but quite useful extension of the standard  library  of  Ruby. So some classes and modules like Pathname, Time, Enumerable,  Exception,  FileUtils,  String,  and YAML are extended. There is also   some   new   features   like   attr_once,  DTime,  TempPath,  Version, embedded_tests,  filelist  (almost  from  rake),  a  common  Rakefile, and an extension of the require system.}
+  s.authors = ["Nicolas Despr\350s", "Nicolas Pouillard"]
+  s.files = ["lib/core_ex.rb", "lib/d_time.rb", "lib/dumpable_proc.rb", "lib/path_list.rb", "lib/temp_path.rb", "lib/version.rb", "lib/yaml_extension.rb", "lib/core_ex/embedded_tests.rb", "lib/core_ex/enumerable.rb", "lib/core_ex/exception.rb", "lib/core_ex/file_utils.rb", "lib/core_ex/pathname.rb", "lib/core_ex/proc.rb", "lib/core_ex/rakefile_base.rf", "lib/core_ex/require.rb", "lib/core_ex/string.rb", "lib/core_ex/time.rb", "lib/core_ex/try_dup.rb", "lib/core_ex/yaml.rb", "lib/core_ex/dependencies_ext/constant_load_path.rb", "lib/core_ex/module/attr_once.rb", "lib/core_ex/module/import.rb", "lib/core_ex/module/mix_in_with_args.rb", "lib/core_ex/object/instance_eval_with_args.rb", "lib/core_ex/object/singleton_class.rb", "lib/core_ex/object/the_first_time.rb", "lib/test/unit/u_i/yaml/test_runner.rb", "test/check-core_ex.yml", "test/check-pkg-core_ex.yml", "test/resources", "test/sanity", "test/sanity-suite.yml", "test/test-unit-setup.rb", "test/unit-suite.yml", "test/resources/require", "test/resources/use-from-gems.rb", "test/resources/yaml_testrunner", "test/resources/require/test_require", "test/resources/require/test_require_rb.rb", "test/resources/require/test_require_so.so", "test/resources/yaml_testrunner/unit_test.rb", "test/sanity/multiple-requires.yml", "test/sanity/single-requires.yml", "AUTHORS", "NEWS", "Rakefile", "README", "SPEC.dyn.yml", "SPEC.gemspec", "SPEC.yml"]
+  s.add_dependency(%q<activesupport>, ["~> 1.1.1"])
+end

data/SPEC.yml

@@ -29,14 +29,14 @@ rdoc_files: !filelist
   - README
   - AUTHORS
   - NEWS
-  - lib/core_ex.rb
-  - lib/core_ex/**/*.rb
+  - lib/**/*.rb
 
 pkg_files: !filelist
   - lib/**/*.r[bf]
   - test/**/*
   - '[A-Z]*'
 
-autorequire: core_ex
+dependencies:
+  activesupport: [~> 1.1.1, 5161/activesupport-1.1.1.tgz]
 
 ttk_version: ~> 0.3.0

data/lib/core_ex/dependencies_ext/constant_load_path.rb

@@ -0,0 +1,23 @@
+# Copyright:: Copyright (c) 2005  Nicolas Pouillard. All rights reserved.
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# License::   Gnu General Public License.
+# Revision::  $Id: constant_load_path.rb 336 2005-09-06 20:32:49Z ertai $
+
+module CoreEx
+
+  module DependenciesExt
+
+    module ConstantLoadPath
+      attr_reader :root
+      def to_path
+        root.to_path
+      end
+    end # module ConstantLoadPath
+
+  end # module DependenciesExt
+
+end # module CoreEx
+
+test_section __FILE__ do
+
+end

data/lib/core_ex/embedded_tests.rb

@@ -1,37 +1,43 @@
 # Copyright:: Copyright (c) 2005  Nicolas Pouillard. All rights reserved.
 # Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
 # License::   Gnu General Public License.
-# Revision::  $Id: embedded_tests.rb 298 2005-06-18 21:56:51Z ertai $
+# Revision::  $Id: embedded_tests.rb 345 2005-09-09 01:40:37Z ertai $
 
-require 'set'
 
-module Kernel
+module CoreEx
 
-  @@test_mode = nil
-  @@files = Set.new
+  module EmbeddedTests
 
-  def test_mode ( aRegexp )
-    raise 'No block needed' if block_given?
-    require 'test/unit'
-    @@test_mode = aRegexp
-  end
+    @@embedded_test_mode = nil
+    @@embedded_test_files = Set.new
+    @@embedded_test_blocks = []
 
-  def test_mode?
-    !! @@test_mode
-  end
+    def embedded_test_mode ( aRegexp )
+      raise 'No block needed' if block_given?
+      require 'test/unit'
+      @@embedded_test_mode = aRegexp
+    end
+
+    def embedded_test_mode?
+      !! @@embedded_test_mode
+    end
+
+    def test_section ( __file__, &block )
+      __file__ = ::Pathname.new(__file__).expand_path
+      if block_given? and __file__.to_s =~ @@embedded_test_mode
+        unless @@embedded_test_files.include?(__file__)
+          @@embedded_test_blocks << block
+          @@embedded_test_files << __file__
+        end
+      end
+    end
 
-  def test_section ( __file__, &block )
-    __file__ = Pathname.new(__file__).expand_path
-    if block_given? and __file__.to_s =~ @@test_mode
-      unless @@files.include?(__file__)
+    def run_embedded_test_sections
+      @@embedded_test_blocks.each do |block|
         Kernel.instance_eval(&block)
-        @@files << __file__
       end
     end
-  end
 
-end # module Kernel
+  end # module EmbeddedTests  
 
-if defined? EMBEDDED_TEST_MODE
-  test_mode EMBEDDED_TEST_MODE
-end
+end # module CoreEx

data/lib/core_ex/enumerable.rb

@@ -1,9 +1,15 @@
 # Copyright:: Copyright (c) 2005  Nicolas Pouillard. All rights reserved.
 # Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
 # License::   Gnu General Public License.
-# Revision::  $Id: enumerable.rb 252 2005-05-31 23:41:42Z ertai $
+# Revision::  $Id: enumerable.rb 334 2005-09-04 14:29:40Z ertai $
+
+
+module CoreEx
+  # This empty module is just here to represent the feature of this file
+  module Enumerable
+  end # module Enumerable
+end # module CoreEx
 
-require 'core_ex'
 
 module Enumerable
 
@@ -24,12 +30,12 @@ module Enumerable
 
   def sum
     fold(0) { |accu, x| accu + x }
-  end 
+  end
 
 
   def prod
     fold(1) { |accu, x| accu * x }
-  end 
+  end
 
 
   # Basically, do the same as each_with_index but yield the arguments in
@@ -59,23 +65,9 @@ end # class Object
 
 
 
-class String
-
-  def rec_fold ( init, &block )
-    if include? "\n"
-      super
-    else
-      block[init, self]
-    end
-  end
-
-end # class String
-
-
 
 test_section __FILE__ do
 
-  require 'set'
   require 'generator'
 
   class EnumerableTest < Test::Unit::TestCase

data/lib/core_ex/exception.rb

@@ -1,32 +1,35 @@
 # Copyright:: Copyright (c) 2004  Nicolas Despres. All rights reserved.
 # Author::    Nicolas Despres  <polrop@lrde.epita.fr>.
 # License::   Gnu General Public License.
-# Revision::  $Id: exception.rb 249 2005-05-31 13:23:42Z ertai $
+# Revision::  $Id: exception.rb 334 2005-09-04 14:29:40Z ertai $
 
+module CoreEx
 
-class Exception
+  module Exception
 
-  #FIXME: write a ruby_pp which print exception backtrace exactly as ruby does
-  #       by cuting long and repetitive backtrace.
+    #FIXME: write a ruby_pp which print exception backtrace exactly as ruby does
+    #       by cuting long and repetitive backtrace.
 
-  def long_pp
-    str = short_pp + "\n"
-    backtrace[1..-1].each { |x| str += "  from #{x}\n" } if backtrace
-    str.chomp!
-    str
-  end
+    def long_pp
+      str = short_pp + "\n"
+      backtrace[1..-1].each { |x| str += "  from #{x}\n" } if backtrace
+      str.chomp!
+      str
+    end
+
+    def short_pp
+      if backtrace.nil?
+        tiny_pp
+      else
+        "#{backtrace[0]}: #{tiny_pp}"
+      end
+    end
 
-  def short_pp
-    if backtrace.nil?
-      tiny_pp
-    else
-      "#{backtrace[0]}: #{tiny_pp}"
+    def tiny_pp
+      exc_name = inspect.sub(/^#<(\w+):.+$/, '\1')
+      "#{self} (#{exc_name})"
     end
-  end
 
-  def tiny_pp
-    exc_name = inspect.sub(/^#<(\w+):.+$/, '\1')
-    "#{self} (#{exc_name})"
-  end
+  end # module Exception
 
-end # class Exception
+end # module CoreEx

data/lib/core_ex/file_utils.rb

@@ -0,0 +1,51 @@
+# Copyright:: Copyright (c) 2005  Nicolas Pouillard. All rights reserved.
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# License::   Gnu General Public License.
+# Revision::  $Id: file_utils.rb 334 2005-09-04 14:29:40Z ertai $
+
+
+module CoreEx
+
+  module FileUtils
+
+    module RemoveDir
+
+      def setup
+        alias_method :remove_dir_without_chmod, :remove_dir
+      end
+
+      def remove_dir (dir, force = false) #:nodoc:
+        dir = dir.sub(%r</\z>, '')
+        first_time_p = true
+        begin
+          Dir.foreach(dir) do |file|
+            next if /\A\.\.?\z/ =~ file
+            path = "#{dir}/#{file.untaint}"
+            if File.symlink?(path)
+              remove_file path, force
+            elsif File.directory?(path)
+              remove_dir path, force
+            else
+              remove_file path, force
+            end
+          end
+          begin
+            Dir.rmdir dir
+          rescue Errno::ENOENT
+            raise unless force
+          end
+        rescue
+          if first_time_p
+            first_time_p = false
+            File.chmod 0777, dir
+            retry
+          end
+          raise
+        end
+      end
+
+    end # module RemoveDir
+
+  end # module FileUtils
+
+end # module CoreEx

data/lib/core_ex/module/attr_once.rb

@@ -0,0 +1,41 @@
+# Copyright:: Copyright (c) 2004  Nicolas Despres. All rights reserved.
+# Author::    Nicolas Despres  <polrop@lrde.epita.fr>.
+# License::   Gnu General Public License.
+# Revision::  $Id: attr_once.rb 333 2005-09-04 14:17:17Z ertai $
+
+
+module CoreEx
+
+  module Module
+
+    module AttrOnce
+      # You can use this method as you use attr_reader. Must be used only with
+      # immutable object.
+      #
+      # This method is imported from the Date implementation. It provides a way
+      # to compute only once the value of getter. Basically, the first time, the
+      # getter is used, its result is computed and stored in an attribute with the
+      # same name. The second times only the attribute is returned.
+      def attr_once(*ids)
+        for id in ids
+          module_eval <<-"end;", __FILE__, __LINE__
+            alias_method :__#{id.to_i}__, :#{id.to_s}
+            private :__#{id.to_i}__
+            def #{id.to_s}(*args, &block)
+            if defined? @__#{id.to_i}__
+                @__#{id.to_i}__
+              elsif ! self.frozen?
+                @__#{id.to_i}__ ||= __#{id.to_i}__(*args, &block)
+              else
+                __#{id.to_i}__(*args, &block)
+              end
+            end
+          end;
+        end
+      end
+
+    end # module AttrOnce
+
+  end # module Module
+
+end # module CoreEx

data/lib/core_ex/module/import.rb

@@ -0,0 +1,28 @@
+# Copyright:: Copyright (c) 2005  Nicolas Pouillard. All rights reserved.
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# License::   Gnu General Public License.
+# Revision::  $Id: import.rb 336 2005-09-06 20:32:49Z ertai $
+
+
+module CoreEx
+
+  module Module
+
+    module Import
+
+      def require_or_load ( *args )
+        return true if args.empty?
+        Dependency.require_or_load(*args)
+      end
+
+      alias_method :import!, :require_or_load
+
+    end # module Import
+
+  end # module Module
+
+end # module CoreEx
+
+test_section __FILE__ do
+
+end

data/lib/core_ex/module/mix_in_with_args.rb

@@ -0,0 +1,267 @@
+# Copyright:: Copyright (c) 2005  Nicolas Pouillard. All rights reserved.
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# License::   Gnu General Public License.
+# Revision::  $Id: mix_in_with_args.rb 355 2005-09-15 23:18:43Z ertai $
+
+
+class Module
+
+  mattr_accessor :blocks
+  self.blocks ||= {}
+
+  mattr_accessor :mix_in_initialized
+  self.mix_in_initialized ||= Set.new
+
+  # Register the setup block
+  def setup ( &block )
+    blocks[[:setup, self]] = block unless block.nil?
+  end
+
+  # Register the teardown block
+  def teardown ( &block )
+    blocks[[:teardown, self]] = block unless block.nil?
+  end
+
+  def call_block ( kind, aModule, *args )
+    if block = blocks[[kind, aModule]]
+      if defined? CoreEx::Object::InstanceEvalWithArgs and
+          ::Object.include? CoreEx::Object::InstanceEvalWithArgs
+        instance_eval_with_args(*args, &block)
+      else
+        if args.empty?
+          module_eval(&block)
+        else
+          raise
+        end
+      end
+    end
+  end
+  private :call_block
+
+  alias_method :include_without_setup_call, :include
+
+  def include ( *someModules )
+    someModules.each do |aModule|
+      mixin aModule
+    end
+  end
+
+  def mixin ( aModule, *args )
+    pair = [self, aModule]
+    return if mix_in_initialized.include? pair
+    call_block(:setup, aModule, *args)
+    include_without_setup_call aModule
+    extend aModule::ClassMethods if aModule.const_defined? :ClassMethods
+    call_block(:teardown, aModule, *args)
+    mix_in_initialized << pair
+    self
+  end
+
+  alias_method :make, :mixin
+  alias_method :have, :mixin
+
+end # class Module
+
+
+
+module CoreEx
+
+  module Module
+
+    # have PrettyInspect
+    # mixin Taggable
+    # make Taggable, :anOption => aValue
+    #
+    # Nothing here because we can't bootstrap this feature
+    module MixInWithArgs
+
+      module Assertions
+
+        attr_accessor :klass
+
+        def assert_mixin ( aModule, args=[], comment='' )
+          assert_nothing_raised(comment+" mixin") do
+            @module.module_eval { mixin(aModule, *args) }
+          end
+          assert @module.include?(aModule)
+          assert_kind_of aModule, @module.new, comment if @module.is_a? Class
+        end
+
+      end # module Assertions
+
+    end # module MixInWithArgs
+
+
+    test_section __FILE__ do
+
+      begin
+      require 'ruby_ex'
+      require 'mocks'
+
+      class TestMixInWithArgs < ::Test::Unit::TestCase
+        include Mocks::Assertions
+        include MixInWithArgs::Assertions
+
+        MOCK_OBJECT = Mocks::Object.new
+
+        module Taggable
+          def tag ( *a, &b )
+            MOCK_OBJECT.tag(*a, &b)
+          end
+          setup do |*a|
+            MOCK_OBJECT.setup(*a)
+            MOCK_OBJECT.tag_defined(method_defined?(:tag))
+            remove_method :tag if method_defined? :tag
+            MOCK_OBJECT.tag_defined(method_defined?(:tag))
+            MOCK_OBJECT.self_is = self
+          end
+          teardown do |*a|
+            MOCK_OBJECT.teardown(*a)
+            MOCK_OBJECT.tag_defined(method_defined?(:tag))
+          end
+        end
+
+        module Cleanable
+          def clean ( *a, &b )
+            MOCK_OBJECT.clean(*a, &b)
+          end
+        end
+
+        module SetupWithoutArgs
+          setup do
+            MOCK_OBJECT.self_is = self
+          end
+        end # module SetupWithoutArgs
+
+        module SetupFixedArgs
+          setup do |x, y, z|
+            MOCK_OBJECT.setup(x, y, z)
+            MOCK_OBJECT.self_is = self
+          end
+        end # module SetupFixedArgs
+
+        module WithClassMethods
+          module ClassMethods
+            def m
+              MOCK_OBJECT.m self
+            end
+          end # module ClassMethods
+          def i
+            MOCK_OBJECT.i self
+          end
+          setup { MOCK_OBJECT.setup self }
+        end # module WithClassMethods
+
+        class WithTag
+          def tag ( *a )
+            MOCK_OBJECT.old_tag(*a)
+          end
+        end # class WithTag
+
+        def setup
+          @module = Class.new
+          @mock_object = MOCK_OBJECT
+        end
+
+        def teardown
+          @mock_object.mock_clear
+        end
+
+        def test_cleanable
+          assert_mixin Cleanable
+          assert_empty_mock
+          assert_nothing_raised { @module.new.clean(:foo, 42) }
+          assert_mock_calls [[:clean, [:foo, 42]]]
+        end
+
+        def test_taggable
+          assert_mixin Taggable, [:foo => :bar]
+          assert_nothing_raised { @module.new.tag(:foo, 42) }
+          assert_mock_calls [[:setup, {:foo => :bar}],
+                             [:tag_defined, false],
+                             [:tag_defined, false],
+                             [:self_is=, @module],
+                             [:teardown, {:foo => :bar}],
+                             [:tag_defined, true],
+                             [:tag, [:foo, 42]]]
+        end
+
+        def test_setup_without_args
+          assert_mixin SetupWithoutArgs
+          assert_nothing_raised { @module.new }
+          assert_mock_calls [[:self_is=, @module]]
+        end
+
+        def test_setup_fixed_args
+          assert_mixin SetupFixedArgs, [1, 2, 3]
+          assert_nothing_raised { @module.new }
+          assert_mock_calls [[:setup, [1, 2, 3]], [:self_is=, @module]]
+        end
+
+        def test_with_include
+          m = ::Module.new
+          m.module_eval "
+            class A
+              include Taggable
+            end
+            class B
+              include Cleanable
+            end
+            class C
+              mixin SetupFixedArgs, 1, 2, 3
+              include SetupWithoutArgs
+            end
+          "
+          assert_nothing_raised do
+            @a, @b, @c = m::A.new, m::B.new, m::C.new
+            @a.tag
+            @b.clean
+          end
+          assert_mock_calls [
+            [:setup],
+            [:tag_defined, false],
+            [:tag_defined, false],
+            [:self_is=, m::A],
+            [:teardown],
+            [:tag_defined, true],
+            [:setup, [1, 2, 3]],
+            [:self_is=, m::C],
+            [:self_is=, m::C],
+            [:tag], [:clean]
+          ]
+        end
+
+        def test_with_class_methods
+          assert_mixin WithClassMethods
+          assert_nothing_raised do
+            @object = @module.new
+            @object.i
+            @module.m
+          end
+          assert_mock_calls [[:setup, @module], [:i, @object], [:m, @module]]
+        end
+
+        def test_already_tagged
+          @module = WithTag
+          assert_nothing_raised { @module.new.tag }
+          assert_mixin Taggable
+          assert_nothing_raised { @module.new.tag }
+          assert_mock_calls [[:old_tag], [:setup],
+                             [:tag_defined, true],
+                             [:tag_defined, false],
+                             [:self_is=, @module],
+                             [:teardown],
+                             [:tag_defined, true],
+                             [:tag]]
+        end
+
+      end # class TestMixInWithArgs
+
+      rescue LoadError
+      end
+
+    end
+
+  end # module Module
+
+end # module CoreEx