utilrb 1.1 → 1.2

data/{Changes.txt → History.txt}

@@ -1,3 +1,14 @@
+=== Version 1.2
+
+* compatibility with ruby 1.9. Some feature are specific 1.8:
+  IO#clearerr, Proc#line, Proc#file and Proc#same_body?.
+* misc fixes to Time#to_hms and Time.from_hms
+* migrate to facets >= 2.4.0
+* fix Object#address on 64bit architectures
+* new functionality:
+  - socket-related tools (see Socket)
+  - Dir#empty?
+
 === Version 1.1
 
 * changes and fixes:

data/License.txt

@@ -1,5 +1,5 @@
-Copyright (c) 2006-2007 LAAS/CNRS <openrobots@laas.fr>
-	      2006-2007 Sylvain Joyeux <sylvain.joyeux@laas.fr>
+Copyright (c) 2006-2008 LAAS/CNRS <openrobots@laas.fr>
+	      2006-2008 Sylvain Joyeux <sylvain.joyeux@laas.fr>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Manifest.txt

@@ -1,4 +1,4 @@
-Changes.txt
+History.txt
 License.txt
 Manifest.txt
 README.txt
@@ -6,8 +6,9 @@ Rakefile
 bm/allocation.rb
 bm/speed.rb
 ext/extconf.rb
-ext/faster.cc
-ext/ruby_internals.h
+ext/utilrb_ext.cc
+ext/ruby_internals-1.8.h
+ext/ruby_internals-1.9.h
 ext/swap.cc
 ext/value_set.cc
 lib/utilrb.rb
@@ -15,6 +16,8 @@ lib/utilrb/array.rb
 lib/utilrb/array/to_s.rb
 lib/utilrb/column_formatter.rb
 lib/utilrb/common.rb
+lib/utilrb/dir.rb
+lib/utilrb/dir/empty.rb
 lib/utilrb/enumerable.rb
 lib/utilrb/enumerable/null.rb
 lib/utilrb/enumerable/random_element.rb
@@ -44,6 +47,7 @@ lib/utilrb/module/attr_enumerable.rb
 lib/utilrb/module/attr_predicate.rb
 lib/utilrb/module/cached_enum.rb
 lib/utilrb/module/define_method.rb
+lib/utilrb/module/define_or_reuse.rb
 lib/utilrb/module/include.rb
 lib/utilrb/module/inherited_enumerable.rb
 lib/utilrb/object.rb
@@ -54,6 +58,8 @@ lib/utilrb/objectstats.rb
 lib/utilrb/pkgconfig.rb
 lib/utilrb/set.rb
 lib/utilrb/set/to_s.rb
+lib/utilrb/socket/tcp_server.rb
+lib/utilrb/socket/tcp_socket.rb
 lib/utilrb/time.rb
 lib/utilrb/time/to_hms.rb
 lib/utilrb/unbound_method.rb
@@ -62,6 +68,7 @@ lib/utilrb/value_set.rb
 test/data/test_pkgconfig.pc
 test/test_array.rb
 test/test_config.rb
+test/test_dir.rb
 test/test_enumerable.rb
 test/test_exception.rb
 test/test_gc.rb

data/README.txt

@@ -1,9 +1,9 @@
 Utilrb
     http://utilrb.rubyforge.org
-    http://www.laas.fr/~sjoyeux/darcs/utilrb (dev repository)
-    http://www.laas.fr/~sjoyeux/research.php
+    http://www.rubyforge.org/projects/utilrb
+    http://github.com/doudou/util-rb (git repository)
 
-Copyright (c) 2006 
+Copyright (c) 2006-2008
     Sylvain Joyeux <sylvain.joyeux@m4x.org>
     LAAS/CNRS <openrobots@laas.fr>
 
@@ -13,6 +13,12 @@ This work is licensed under the BSD license. See License.txt for details
 Utilrb is yet another Ruby toolkit, in the spirit of facets. It includes all
 the standard class extensions I use in my own projects like Genom.rb.
 
+== Installation
+The only dependency Utilrb has is flexmock if you want to run tests. It is
+available as a gem, so you can run
+
+  gem install flexmock
+
 == Utilrb's C extension
 Utilrb includes a C extension in ext/. It is optional, but some of the
 functionalities will be disabled if it is not present. Trying to require
@@ -31,14 +37,5 @@ loading. Set it to +no+ to disable the extension, to +yes+ to force it
 (an error is generated if the extension is not available). If the variable
 is not set, the extension is loaded if available.
 
-== TODO
-* put the +block+ argument in front in Module#define_method_with_block. This
-  would allow to do 
-
-    define_method_with_block(:bla) do |block, *args| 
-    end
-
-  [DONE 20061101125259-1e605-fef189550540b8e096f0bbe6c219d892bf3e13fc.gz]
-
 == CHANGES
-:include: Changes.txt
+:include: History.txt

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rake'
 require 'rake/rdoctask'
+
 # FIX: Hoe always calls rdoc with -d, and diagram generation fails here
 class Rake::RDocTask
     alias __option_list__ option_list
@@ -10,20 +11,24 @@ class Rake::RDocTask
     end
 end
 
-require 'hoe'
 require './lib/utilrb/common'
 
-Hoe.new('utilrb', Utilrb::VERSION) do |p|
-    p.author = "Sylvain Joyeux"
-    p.email = "sylvain.joyeux@m4x.org"
+begin
+    require 'hoe'
+    config = Hoe.new('utilrb', Utilrb::VERSION) do |p|
+        p.developer("Sylvain Joyeux", "sylvain.joyeux@m4x.org")
 
-    p.summary = 'Yet another Ruby toolkit'
-    p.description = p.paragraphs_of('README.txt', 3..6).join("\n\n")
-    p.url         = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
-    p.changes     = p.paragraphs_of('Changes.txt', 0..1).join("\n\n")
+        p.summary = 'Yet another Ruby toolkit'
+        p.description = p.paragraphs_of('README.txt', 3..6).join("\n\n")
+        p.url         = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+        p.changes     = p.paragraphs_of('History.txt', 0..1).join("\n\n")
 
-    p.extra_deps << 'facets'
-    p.rdoc_pattern = /(ext\/.*cc$|lib)|txt/
+        p.extra_deps << ['facets', '>= 2.4.0'] << 'rake'
+        p.rdoc_pattern = /(ext\/.*cc$|lib)|txt/
+    end
+    config.spec.extensions << 'ext/extconf.rb'
+rescue LoadError
+    puts "cannot load the Hoe gem, distribution is disabled"
 end
 
 desc "builds Utilrb's C extension"
@@ -33,13 +38,25 @@ task :setup do
 	    raise "cannot build the C extension"
 	end
     end
-    FileUtils.ln_sf "../../ext/faster.so", "lib/utilrb/faster.so"
+    FileUtils.ln_sf "../ext/utilrb_ext.so", "lib/utilrb_ext.so"
+end
+
+task :clean do
+    puts "Cleaning extension in ext/"
+    FileUtils.rm_f "lib/utilrb_ext.so"
+    if File.file?(File.join('ext', 'Makefile'))
+        Dir.chdir("ext") do
+            system("make clean")
+        end
+    end
+    FileUtils.rm_f "ext/Makefile"
+    FileUtils.rm_f "lib/utilrb_ext.so"
 end
 
 task :full_test do
-    ENV['UTILRB_FASTER_MODE'] = 'no'
+    ENV['UTILRB_EXT_MODE'] = 'no'
     system("testrb test/")
-    ENV['UTILRB_FASTER_MODE'] = 'yes'
+    ENV['UTILRB_EXT_MODE'] = 'yes'
     system("testrb test/")
 end
 

data/ext/extconf.rb

@@ -1,5 +1,10 @@
 require 'mkmf'
+
 CONFIG['CC'] = "g++"
+if RUBY_VERSION >= "1.9"
+    $CFLAGS += "-DRUBY_IS_19"
+end
+
 $LDFLAGS += "-module"
-create_makefile("faster")
+create_makefile("utilrb_ext")
 

data/ext/ruby_internals-1.9.h

@@ -0,0 +1,48 @@
+#ifndef __RUBY_INTERNALS_HH__
+#define __RUBY_INTERNALS_HH__
+
+/* WARNING: this file contains copies of internal Ruby structures. They are not supposed to be copied (I think ;-)), but I had to nonetheless.
+ * The following methods depend on these:
+ *
+ *   Kernel.swap!
+ *   Proc#same_body?
+ *   Proc#file
+ *   Proc#line
+ */
+
+#include <ruby.h>
+#include <ruby/intern.h>
+#include <ruby/node.h>
+#include <ruby/re.h>
+
+typedef struct RVALUE {
+    union {
+	struct {
+	    VALUE flags;		/* always 0 for freed obj */
+	    struct RVALUE *next;
+	} free;
+	struct RBasic  basic;
+	struct RObject object;
+	struct RClass  klass;
+	struct RFloat  flonum;
+	struct RString string;
+	struct RArray  array;
+	struct RRegexp regexp;
+	struct RHash   hash;
+	struct RData   data;
+	struct RStruct rstruct;
+	struct RBignum bignum;
+	struct RFile   file;
+	struct RNode   node;
+	struct RMatch  match;
+    } as;
+#ifdef GC_DEBUG
+    char *file;
+    int   line;
+#endif
+} RVALUE;
+
+static const size_t SLOT_SIZE = sizeof(RVALUE);
+
+#endif
+

data/ext/swap.cc

@@ -1,4 +1,8 @@
-#include "ruby_internals.h"
+#ifdef RUBY_IS_19
+#include "ruby_internals-1.9.h"
+#else
+#include "ruby_internals-1.8.h"
+#endif
 
 /*
  * Kernel.swap!(obj1, obj2, *args)

data/ext/{faster.cc → utilrb_ext.cc}

@@ -1,6 +1,12 @@
 #include <ruby.h>
 #include <set>
-#include "ruby_internals.h"
+
+#ifdef RUBY_IS_19
+#include "ruby_internals-1.9.h"
+#else
+#include <rubyio.h>
+#include "ruby_internals-1.8.h"
+#endif
 
 using namespace std;
 
@@ -26,6 +32,21 @@ static VALUE enumerable_each_uniq(VALUE self)
     return self;
 }
 
+#ifndef RUBY_IS_19
+/* call-seq:
+ *  io.clearerr => nil 
+ *
+ * Clear all error flags on the IO
+ */
+static VALUE io_clearerr(VALUE self)
+{
+    OpenFile* file;
+    file = RFILE(self)->fptr;
+    clearerr(file->f);
+    return Qnil;
+}
+#endif
+
 /* call-seq:
  *  Kernel.is_singleton?(object)
  *
@@ -39,6 +60,7 @@ static VALUE kernel_is_singleton_p(VALUE self)
 	return Qfalse;
 }
 
+#ifndef RUBY_IS_19
 
 /* call-seq:
  *  proc.same_body?(other) => true or false
@@ -92,16 +114,21 @@ static VALUE proc_line(VALUE self)
 	return Qnil;
 }
 
+#endif
+
 extern "C" void Init_value_set();
 extern "C" void Init_swap();
 
-extern "C" void Init_faster()
+extern "C" void Init_utilrb_ext()
 {
     rb_define_method(rb_mEnumerable, "each_uniq", RUBY_METHOD_FUNC(enumerable_each_uniq), 0);
     rb_define_method(rb_mKernel, "is_singleton?", RUBY_METHOD_FUNC(kernel_is_singleton_p), 0);
+#ifndef RUBY_IS_19
     rb_define_method(rb_cProc, "same_body?", RUBY_METHOD_FUNC(proc_same_body_p), 1);
     rb_define_method(rb_cProc, "file", RUBY_METHOD_FUNC(proc_file), 0);
     rb_define_method(rb_cProc, "line", RUBY_METHOD_FUNC(proc_line), 0);
+    rb_define_method(rb_cIO, "clearerr", RUBY_METHOD_FUNC(io_clearerr), 0);
+#endif
 
     Init_value_set();
     Init_swap();

data/lib/utilrb/column_formatter.rb

@@ -54,7 +54,7 @@ class ColumnFormatter
 	    
 	    while !names.empty? && (line_w < screen_width)
 		col_n = names.shift
-		col_w = width[col_n]
+		col_w = width[col_n] || 0
 		line_n << col_n
 		line_w += col_w
 		format << "% #{col_w}s"

data/lib/utilrb/common.rb

@@ -1,46 +1,49 @@
 module Utilrb
-    VERSION = "1.1" unless defined? Utilrb::VERSION
+    unless defined? Utilrb::VERSION
+	VERSION = "1.2"
+	RUBY_IS_19 = (RUBY_VERSION >= "1.9")
+    end
 
-    unless defined? UTILRB_FASTER_MODE
-	if ENV['UTILRB_FASTER_MODE'] == 'no'
-	    UTILRB_FASTER_MODE = nil
+    unless defined? UTILRB_EXT_MODE
+	if ENV['UTILRB_EXT_MODE'] == 'no'
+	    UTILRB_EXT_MODE = nil
 	    STDERR.puts "Utilrb: not loading the C extension"
 	else
 	    begin
-		require 'utilrb/faster'
-		UTILRB_FASTER_MODE = true
-		STDERR.puts "Utilrb: loaded C extension" if ENV['UTILRB_FASTER_MODE']
+		require 'utilrb_ext'
+		UTILRB_EXT_MODE = true
+		STDERR.puts "Utilrb: loaded C extension" if ENV['UTILRB_EXT_MODE']
 	    rescue LoadError => e
 		raise unless e.message =~ /no such file to load/
-		if ENV['UTILRB_FASTER_MODE'] == 'yes'
+		if ENV['UTILRB_EXT_MODE'] == 'yes'
 		    raise LoadError, "unable to load Util.rb C extension: #{e.message}"
 		else
-		    UTILRB_FASTER_MODE = nil
+		    UTILRB_EXT_MODE = nil
 		end
 	    end
 	end
     end
 
-    # Yields if the faster extension is not present
+    # Yields if the extension is not present
     # This is used by Utilrb libraries to provide a 
     # Ruby version if the C extension is not loaded
-    def self.unless_faster # :yield:
-	unless UTILRB_FASTER_MODE
+    def self.unless_ext # :yield:
+	unless UTILRB_EXT_MODE
 	    return yield if block_given?
 	end
     end
 
-    # Yields if the faster extension is present. This is used for Ruby code
+    # Yields if the extension is present. This is used for Ruby code
     # which depends on methods in the C extension
-    def self.if_faster(&block)
-	require_faster(nil, &block)
+    def self.if_ext(&block)
+	require_ext(nil, &block)
     end
 
-    # Yields if the faster extension is present, and 
+    # Yields if the extension is present, and 
     # issue a warning otherwise. This is used for Ruby
     # code which depends on methods in the C extension
-    def self.require_faster(name)
-	if UTILRB_FASTER_MODE
+    def self.require_ext(name)
+	if UTILRB_EXT_MODE
 	    yield if block_given?
 	elsif name
 	    STDERR.puts "Utilrb: not loading #{name} since the C extension is not available"

data/lib/utilrb/dir.rb

@@ -0,0 +1,2 @@
+require 'utilrb/kernel/require'
+require_dir(__FILE__)

data/lib/utilrb/dir/empty.rb

@@ -0,0 +1,3 @@
+class Dir
+    def empty?; entries.size == 2 end
+end

data/lib/utilrb/enumerable/uniq.rb

@@ -48,7 +48,7 @@ class Object
     end
 end
 
-Utilrb.unless_faster do
+Utilrb.unless_ext do
     module Enumerable
 	# call-seq:
 	#  each_uniq { |obj| ... }

data/lib/utilrb/kernel/options.rb

@@ -17,7 +17,7 @@ module Kernel
     #   filter_options(nil, known_options) -> default_options, {}
     #
     def filter_options(options, option_spec)
-        options     = (options || Hash.new).to_sym_keys
+        options     = (options.to_hash || Hash.new).to_sym_keys
 	# cannot use #to_sym_keys as option_spec can be an array
 	option_spec = option_spec.inject({}) { |h, (k, v)| h[k.to_sym] = v; h }
 
@@ -44,7 +44,8 @@ module Kernel
     # as an empty option hash, all keys are converted into symbols.
     #
     def validate_options(options, known_options)
-	opt, unknown = Kernel.filter_options(options, known_options)
+	options ||= Hash.new
+	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)