utilrb 1.5.0 → 1.6.0

data/lib/utilrb/common.rb

@@ -1,6 +1,6 @@
 module Utilrb
     unless defined? Utilrb::VERSION
-	VERSION = "1.5.0"
+	VERSION = "1.6.0"
         RUBY_IS_19  = (RUBY_VERSION >= "1.9.2")
         RUBY_IS_191 = (RUBY_VERSION >= "1.9") && (RUBY_VERSION < "1.9.2")
     end

data/lib/utilrb/kernel/load_dsl_file.rb

@@ -91,12 +91,20 @@ module Kernel
         end
     end
 
-    def eval_dsl_file_content(file, file_content, proxied_object, context, full_backtrace, *exceptions, &block)
+    def eval_dsl(text, proxied_object, context, full_backtrace, *exceptions)
+        eval_dsl_file_content(nil, text, proxied_object, context, full_backtrace, *exceptions)
+    end
+
+    def eval_dsl_file_content(file, file_content, proxied_object, context, full_backtrace, *exceptions)
         code = with_module(*context) do
             code =  <<-EOD
             Proc.new { #{file_content} }
             EOD
-            eval code, binding, file, 1
+            if file
+                eval code, binding, file, 1
+            else
+                eval code, binding
+            end
         end
 
         dsl_exec_common(file, proxied_object, context, full_backtrace, *exceptions, &code)
@@ -125,8 +133,13 @@ module Kernel
             return false
         end
 
-        eval_dsl_file(file, *args, &block)
         $LOADED_FEATURES << file
+        begin
+            eval_dsl_file(file, *args, &block)
+        rescue Exception
+            $LOADED_FEATURES.delete(file)
+            raise
+        end
         true
     end
 

data/lib/utilrb/kernel/options.rb

@@ -16,7 +16,20 @@ module Kernel
     #   filter_options(option, array)	   -> known, unknown
     #   filter_options(nil, known_options) -> default_options, {}
     #
-    def filter_options(options, option_spec)
+    def filter_options(options, *user_option_spec)
+        option_spec = Hash.new
+        user_option_spec.each do |opt|
+            if opt.respond_to?(:to_hash)
+                option_spec.merge!(opt)
+            elsif opt.respond_to?(:to_ary)
+                opt.each do |key|
+                    option_spec[key] = nil
+                end
+            else
+                option_spec[opt] = nil
+            end
+        end
+
         unknown_options = Hash.new
         options = options.dup
         options.delete_if do |key, value|
@@ -52,9 +65,9 @@ module Kernel
     # keys. +option_hash+ keys shall be in +known_array+. +nil+ is treated 
     # as an empty option hash, all keys are converted into symbols.
     #
-    def validate_options(options, known_options)
+    def validate_options(options, *known_options)
 	options ||= Hash.new
-	opt, unknown = Kernel.filter_options(options.to_hash, known_options)
+	opt, unknown = Kernel.filter_options(options.to_hash, *known_options)
 	unless unknown.empty?
 	    not_valid = unknown.keys.map { |m| "'#{m}'" }.join(" ")
 	    raise ArgumentError, "unknown options #{not_valid}", caller(1)

data/lib/utilrb/logger/hierarchy.rb

@@ -9,29 +9,36 @@ class Logger
     # It defines the #logger accessor which either returns the logger
     # attribute of the module, if one is defined, or its parent logger
     # attribute.
+    #
+    # This module is usually used in conjunction with the Logger::Root method:
     # 
-    # module First
-    #   include Hierarchy
-    #   self.logger = Logger.new
+    #   module First
+    #     extend Logger.Root("First", :INFO)
     #
-    #   module Second
-    #     include Hierarchy
+    #     module Second
+    #       extend Hierarchy
+    #     end
     #   end
-    # end
     #
-    # Second.logger will return First.logger. If we do
-    # Second.logger = Logger.new, then this one would
-    # be returned.
+    # Second.logger will return First.logger. If we do Second.make_own_logger,
+    # then a different object will be returned.
+    #
+    # "extend Hierarchy" will also add the Forward support if the parent module
+    # has it.
     module Hierarchy
+        # Allows to change the logger object at this level of the hierarchy
+        #
+        # This is usually not used directly: a new logger can be created with
+        # Hierarchy#make_own_logger and removed with Hierarchy#reset_own_logger
         attr_writer :logger
 
-        def self.included(obj)
+        def self.included(obj) # :nodoc:
             if obj.singleton_class.ancestors.include?(Logger::Forward)
                 obj.send(:include, Logger::Forward)
             end
         end
 
-        def self.extended(obj)
+        def self.extended(obj) # :nodoc:
             if obj.kind_of?(Module)
                 parent_module = constant(obj.spacename)
                 if (parent_module.singleton_class.ancestors.include?(Logger::Forward))
@@ -40,10 +47,15 @@ class Logger
             end
         end
 
+        # Returns true if the local module has its own logger, and false if it
+        # returns the logger of the parent
         def has_own_logger?
             defined?(@logger) && @logger
         end
 
+        # Makes it so that this level of the module hierarchy has its own
+        # logger. If +new_progname+ and/or +new_level+ are nil, the associated
+        # value are taken from the parent's logger.
         def make_own_logger(new_progname = nil, new_level = nil)
             if !has_own_logger?
                 @logger = self.logger.dup
@@ -57,10 +69,14 @@ class Logger
             @logger
         end
 
+        # Removes a logger defined at this level of the module hierarchy. The
+        # logging methods will now access the parent's module logger.
         def reset_own_logger
             @logger = nil
         end
 
+        # Returns the logger object that should be used to log at this level of
+        # the module hierarchy
         def logger
             if defined?(@logger) && @logger
                 return @logger 

data/lib/utilrb/module/const_defined_here_p.rb

@@ -1,3 +1,4 @@
+require 'utilrb/common'
 class Module
     if Utilrb::RUBY_IS_191 || Utilrb::RUBY_IS_19
     def const_defined_here?(name)

data/lib/utilrb/module/include.rb

@@ -13,7 +13,13 @@ class Module
     #   ClassExtension in the target, it is created)
     # * if it is included in a Class, the ClassExtension module
     #   extends the class.
-    def include(mod)
+    def include(*mods)
+        mods.each do |mod|
+            __include_single_module(mod)
+        end
+    end
+
+    def __include_single_module(mod)
 	if mod.const_defined?(:ModuleExtension)
 	    if is_a?(Module)
 		unless const_defined?(:ModuleExtension)

data/test/test_hash.rb

@@ -27,6 +27,14 @@ class TC_Hash < Test::Unit::TestCase
 	assert_equal(["1 => 2", "2 => 3", "3 => ..."].to_set, values.to_set)
     end
 
+    def test_map_key
+        base = { 1 => 'a', 2 => 'b' }
+        result = base.map_key { |k, v| k += 1 }
+
+        assert_equal({ 1 => 'a', 2 => 'b' }, base)
+        assert_equal({ 2 => 'a', 3 => 'b' }, result)
+    end
+
     def test_map_value
         base = { 'a' => 1, 'b' => 2 }
         result = base.map_value { |k, v| v += 1 }

data/test/test_kernel.rb

@@ -203,6 +203,47 @@ class TC_Kernel < Test::Unit::TestCase
         assert(methods.include?('my_method'), "the 'class K' statement did not refer to the already defined class")
     end
 
+    def test_load_dsl_file_loaded_features_behaviour
+        eval_context = Class.new do
+            attr_reader :real_method_call_count
+            def initialize
+                @real_method_call_count = 0
+            end
+            def real_method
+                @real_method_call_count += 1
+            end
+        end
+
+        Tempfile.open('test_eval_dsl_file') do |io|
+            io.puts <<-EOD
+            real_method
+            EOD
+            io.flush
+
+            obj = eval_context.new
+            assert(Kernel.load_dsl_file(io.path, obj, [], false))
+            assert_equal(1, obj.real_method_call_count)
+            assert($LOADED_FEATURES.include?(io.path))
+            assert(!Kernel.load_dsl_file(io.path, obj, [], false))
+            assert_equal(1, obj.real_method_call_count)
+
+            $LOADED_FEATURES.delete(io.path)
+        end
+
+        Tempfile.open('test_eval_dsl_file') do |io|
+            io.puts <<-EOD
+            raise
+            EOD
+            io.flush
+
+            obj = eval_context.new
+            assert(!$LOADED_FEATURES.include?(io.path))
+            assert_raises(RuntimeError) { Kernel.load_dsl_file(io.path, obj, [], false) }
+            assert(!$LOADED_FEATURES.include?(io.path))
+            assert_equal(0, obj.real_method_call_count)
+        end
+    end
+
     Utilrb.require_ext('is_singleton?') do
 	def test_is_singleton
 	    klass = Class.new

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: utilrb
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 15
   prerelease: 
   segments: 
   - 1
-  - 5
+  - 6
   - 0
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors: 
 - Sylvain Joyeux
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-03 00:00:00 Z
+date: 2012-03-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: facets
@@ -229,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: utilrb
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Yet another Ruby toolkit