supplement 1.7 → 2.2.1

data/LICENSE

@@ -5,7 +5,7 @@
 |___/\__,_| .__/| .__/|_|\___|_| |_| |_|\___|_| |_|\__|
           |_|   |_|                                    
 
-Copyright (c) 2009-2013, Bertram Scharpf <software@bertram-scharpf.de>.
+Copyright (C) 2009-2014, Bertram Scharpf <software@bertram-scharpf.de>.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README

@@ -1,4 +1,4 @@
-= supplement 1.7  --  Useful Ruby enhancements
+= supplement 2.2.1  --  Useful Ruby enhancements
 
 Some simple Ruby extensions.
 
@@ -39,7 +39,8 @@ Now here it is where I can just point to.
 * Array#notempty?
 * Hash#notempty?
 * Struct.[]
+* Process.renice
 * Interval timer
 * File system stats
-* File#flockb using a block
+* LockedFile
 

data/lib/Rakefile

@@ -12,7 +12,8 @@ rule ".o" => ".c" do |t|
 end
 
 DLs = {
-  "supplement.so"          => %w(supplement.o sync.o),
+  "supplement.so"          => %w(supplement.o process.o),
+  "supplement/locked.so"   => %w(supplement/locked.o),
   "supplement/filesys.so"  => %w(supplement/filesys.o),
   "supplement/itimer.so"   => %w(supplement/itimer.o),
   "supplement/terminal.so" => %w(supplement/terminal.o),

data/lib/mkrf_conf

@@ -21,7 +21,6 @@ Autorake.configure {
         enable :string_start_with
         enable :thread_exclusive
       end
-      have_header "rubysig.h"
     end
   end
 
@@ -30,12 +29,17 @@ Autorake.configure {
     have_header "st.h"
     have_header "rubyio.h"
     have_header "re.h"
+    have_header "rubysig.h"
   else
     have_header "ruby/ruby.h"
     have_header "ruby/st.h"
     have_header "ruby/io.h"
     have_header "ruby/re.h"
+
+    have_function "rb_thread_wait_for"
   end
 
+  have_function "cbrt"
+
 }
 

data/lib/process.c

@@ -0,0 +1,71 @@
+/*
+ *  process.c  --  Renice; sync all
+ */
+
+
+#include "process.h"
+
+#if   HAVE_HEADER_RUBY_H
+    #include <ruby.h>
+#elif HAVE_HEADER_RUBY_RUBY_H
+    #include <ruby/ruby.h>
+#endif
+
+#include <sys/time.h>
+#include <sys/resource.h>
+
+#include <unistd.h>
+
+
+static VALUE rb_process_renice( int argc, VALUE *argv, VALUE obj);
+static VALUE rb_process_sync( VALUE obj);
+
+
+/*
+ *  call-seq:
+ *     Process.renice( pid = nil, priority) -> nil
+ *
+ * Set a new nice value. If pid is +nil+, renice the current process.
+ */
+
+VALUE
+rb_process_renice( int argc, VALUE *argv, VALUE obj)
+{
+    VALUE p1, p2;
+    pid_t pid;
+    int prio;
+
+    if (rb_scan_args( argc, argv, "11", &p1, &p2) == 1)
+        pid = getpid(),     prio = NUM2INT( p1);
+    else
+        pid = NUM2INT( p1), prio = NUM2INT( p2);
+
+    rb_secure(2);
+    if (setpriority( PRIO_PROCESS, pid, prio) < 0)
+        rb_sys_fail(0);
+
+    return Qnil;
+}
+
+
+/*
+ *  call-seq:
+ *     Process.sync -> nil
+ *
+ * Force completion of pending disk writes (flush cache). See sync(8).
+ */
+
+VALUE
+rb_process_sync( VALUE obj)
+{
+    sync();
+    return Qnil;
+}
+
+
+void Init_supplement_process( void)
+{
+    rb_define_singleton_method( rb_mProcess, "renice", rb_process_renice, -1);
+    rb_define_singleton_method( rb_mProcess, "sync", rb_process_sync, 0);
+}
+

data/lib/process.h

@@ -0,0 +1,13 @@
+/*
+ *  process.h  --  Renice; sync all
+ */
+
+
+#ifndef __PROCESS_H__
+#define __PROCESS_H__
+
+
+extern void Init_supplement_process( void);
+
+#endif
+

data/lib/supplement.c

@@ -4,7 +4,7 @@
 
 #include "supplement.h"
 
-#include "sync.h"
+#include "process.h"
 
 #if   HAVE_HEADER_ST_H
     #include <st.h>
@@ -29,12 +29,6 @@
 #endif
 
 
-#include <sys/stat.h>
-#include <sys/file.h>
-#include <math.h>
-
-
-
 #ifdef HAVE_HEADER_RUBY_H
     /* Oh what a bug! */
     #define R_MATCH( obj) RMATCH( obj)
@@ -42,16 +36,6 @@
 #endif
 
 
-struct supplement_flock {
-    struct supplement_flock *prev;
-    VALUE                    file;
-    int                      op;
-    int                      last_op;
-};
-
-static struct supplement_flock *flocks_root = NULL;
-
-
 static VALUE supplement_index_blk( VALUE);
 static VALUE supplement_index_ref( VALUE, VALUE);
 static VALUE supplement_rindex_blk( VALUE);
@@ -64,11 +48,7 @@ static VALUE supplement_rindex_val( VALUE, VALUE);
 static VALUE supplement_reject( VALUE);
 static VALUE supplement_invert_yield( VALUE);
 #endif
-static VALUE supplement_each_line( VALUE);
-static void  supplement_init_flock( struct supplement_flock *, VALUE, VALUE);
-static VALUE supplement_do_unflock( VALUE);
 static VALUE supplement_do_unumask( VALUE);
-static VALUE supplement_chdir( VALUE);
 #ifdef FEATURE_THREAD_EXCLUSIVE
 static VALUE bsruby_set_thread_critical( VALUE);
 #endif
@@ -81,8 +61,6 @@ static ID id_eqq;
 #ifdef FEATURE_ARRAY_SELECT_BANG
 static ID id_reject_bang;
 #endif
-static ID id_chdir;
-static ID id_path;
 static ID id_mkdir;
 static ID id_index;
 
@@ -828,6 +806,9 @@ rb_num_sqrt( VALUE num)
 VALUE
 rb_num_cbrt( VALUE num)
 {
+#if HAVE_FUNC_CBRT
+    return rb_float_new( cbrt( RFLOAT_VALUE( rb_Float( num))));
+#else
     double n;
     int neg;
     int i;
@@ -848,6 +829,7 @@ rb_num_cbrt( VALUE num)
       n = w;
     }
     return rb_float_new( neg ? -n : n);
+#endif
 }
 
 
@@ -1205,120 +1187,6 @@ rb_file_size( VALUE obj)
 }
 
 
-/*
- *  call-seq:
- *     flockb( excl = nil, nb = nil) { || ... }  -> nil
- *
- *  Lock file using the <code>flock()</code> system call.
- *  When the <code>nb</code> flag is <code>true</code>, the method
- *  won't block but rather raise an exception. Catch
- *  <code>SystemCallError</code>. The calls may be nested in any order.
- *
- *    File.open "/var/mail/joe", "a" do  |f|
- *      f.flockb true do
- *        f.write another_message
- *      end
- *    end
- */
-
-VALUE
-rb_file_flockb( int argc, VALUE *argv, VALUE file)
-{
-    VALUE excl, nb;
-    struct supplement_flock cur_flock;
-#ifdef HAVE_HEADER_RUBY_H
-    OpenFile *fptr;
-#else
-    rb_io_t *fptr;
-#endif
-    int op;
-
-    rb_scan_args( argc, argv, "02", &excl, &nb);
-    supplement_init_flock( &cur_flock, file, excl);
-
-    op = cur_flock.op | LOCK_NB;
-    GetOpenFile( file, fptr);
-#ifdef HAVE_HEADER_RUBY_H
-    while (flock( fileno( fptr->f), op) < 0) {
-#else
-    while (flock( fptr->fd, op) < 0) {
-#endif
-        switch (errno) {
-          case EAGAIN:
-          case EACCES:
-#if defined( EWOULDBLOCK) && EWOULDBLOCK != EAGAIN
-          case EWOULDBLOCK:
-#endif
-            if (!RTEST( nb)) {
-                rb_thread_polling();        /* busy wait */
-                rb_io_check_closed( fptr);
-                continue;
-            }
-            /* fall through */
-          default:
-#ifdef HAVE_HEADER_RUBY_H
-            rb_sys_fail( fptr->path);
-#else
-            rb_sys_fail_str( fptr->pathv);
-#endif
-        }
-    }
-    cur_flock.prev = flocks_root;
-    flocks_root = &cur_flock;
-    return rb_ensure( rb_yield, Qnil, supplement_do_unflock, Qnil);
-}
-
-void
-supplement_init_flock( struct supplement_flock *s, VALUE file, VALUE excl)
-{
-    struct supplement_flock *i;
-
-    s->file = file;
-
-    s->last_op = LOCK_UN;
-    for (i = flocks_root; i != NULL; i = i->prev) {
-        if (i->file == file) {
-            s->last_op = i->op;
-            break;
-        }
-    }
-
-    switch (s->last_op) {
-        case LOCK_UN:
-        case LOCK_SH:
-            s->op = RTEST( excl) ? LOCK_EX : LOCK_SH;
-            break;
-        case LOCK_EX:
-            s->op = LOCK_EX;
-            break;
-        default:
-            s->op = LOCK_UN;  /* should never be reached. */
-            break;
-    }
-}
-
-VALUE
-supplement_do_unflock( VALUE v)
-{
-#ifdef HAVE_HEADER_RUBY_H
-    OpenFile *fptr;
-#else
-    rb_io_t *fptr;
-#endif
-    int fd;
-
-    GetOpenFile( flocks_root->file, fptr);
-#ifdef HAVE_HEADER_RUBY_H
-    flock( fileno( fptr->f), flocks_root->last_op);
-#else
-    flock( fptr->fd, flocks_root->last_op);
-#endif
-    flocks_root = flocks_root->prev;
-
-    return Qnil;
-}
-
-
 /*
  *  call-seq:
  *     umask()             -> int
@@ -1447,40 +1315,6 @@ rb_dir_entries_bang( VALUE self)
 }
 
 
-/*
- *  call-seq:
- *     chdir()                 -> nil
- *     chdir() { |path| ... }  -> obj
- *
- *  As you probably expect, change the working directory like in
- *  <code>Dir.chdir</code>.
- *
- */
-
-VALUE
-rb_dir_chdir( VALUE dir)
-{
-    VALUE path;
-
-    if (!id_chdir) {
-        id_chdir = rb_intern( "chdir");
-        id_path  = rb_intern( "path");
-    }
-    path = rb_funcall( dir, id_path, 0);
-    if (rb_block_given_p())
-        return rb_iterate( &supplement_chdir, path, &rb_yield, Qnil);
-    else {
-        supplement_chdir( path);
-        return Qnil;
-    }
-}
-
-VALUE
-supplement_chdir( VALUE path)
-{
-    return rb_funcall( rb_cDir, id_chdir, 1, path);
-}
-
 
 /*
  *  Document-class: Match
@@ -1669,13 +1503,11 @@ void Init_supplement( void)
     rb_define_method( rb_cHash, "notempty?", rb_hash_notempty_p, 0);
 
     rb_define_method( rb_cFile, "size", rb_file_size, 0);
-    rb_define_method( rb_cFile, "flockb", rb_file_flockb, -1);
     rb_define_singleton_method( rb_cFile, "umask", rb_file_s_umask, -1);
 
     rb_define_singleton_method( rb_cDir, "current", rb_dir_s_current, 0);
     rb_define_singleton_method( rb_cDir, "mkdir!", rb_dir_s_mkdir_bang, -1);
     rb_define_method( rb_cDir, "entries!", rb_dir_entries_bang, 0);
-    rb_define_method( rb_cDir, "chdir", rb_dir_chdir, 0);
 
     rb_define_method( rb_cMatch, "begin", rb_match_begin, -1);
     rb_define_method( rb_cMatch, "end", rb_match_end, -1);
@@ -1693,11 +1525,9 @@ void Init_supplement( void)
 #ifdef FEATURE_ARRAY_SELECT_BANG
     id_reject_bang = 0;
 #endif
-    id_chdir       = 0;
-    id_path        = 0;
     id_mkdir       = 0;
     id_index       = 0;
 
-    Init_supplement_sync();
+    Init_supplement_process();
 }
 

data/lib/supplement.h

@@ -63,12 +63,10 @@ extern VALUE rb_num_cbrt( VALUE);
 extern VALUE rb_hash_notempty_p( VALUE);
 
 extern VALUE rb_file_size( VALUE);
-extern VALUE rb_file_flockb( int, VALUE *, VALUE);
 extern VALUE rb_file_s_umask( int, VALUE *);
 extern VALUE rb_dir_s_current( VALUE);
 extern VALUE rb_dir_s_mkdir_bang( int, VALUE *);
 extern VALUE rb_dir_entries_bang( VALUE);
-extern VALUE rb_dir_chdir( VALUE);
 
 extern VALUE rb_match_begin( int, VALUE *, VALUE);
 extern VALUE rb_match_end( int, VALUE *, VALUE);

data/lib/supplement/dir.rb

@@ -0,0 +1,49 @@
+#
+#  supplement/dir.rb  --  More Dir methods
+#
+
+class Dir
+
+  class <<self
+
+    # :call-seq:
+    #    Dir.nuke!( name)     -> nil
+    #
+    # Delete a directory, all its contents and all subdirectories.
+    # WARNING! This can cause serious damage.
+    #
+    def nuke! n
+      (new n).entries!.each { |e|
+        p = File.join n, e
+        if File.directory? p then
+          nuke! p
+        else
+          File.unlink p
+        end
+      }
+      rmdir n
+      nil
+    end
+
+    # :call-seq:
+    #    Dir.rmpath( name)     -> nil
+    #
+    # Delete as many empty directories as possible.
+    #
+    def rmpath n
+      case n
+        when "/", "." then
+        else
+          if (new n).entries!.empty? then
+            rmdir n
+            d = File.dirname n
+            rmpath d
+          end
+      end
+      nil
+    end
+
+  end
+
+end
+

data/lib/supplement/filesys.h

@@ -5,7 +5,11 @@
 #ifndef __SUPPLEMENT_FILESYS_H__
 #define __SUPPLEMENT_FILESYS_H__
 
-#include <ruby.h>
+#if   HAVE_HEADER_RUBY_H
+    #include <ruby.h>
+#elif HAVE_HEADER_RUBY_RUBY_H
+    #include <ruby/ruby.h>
+#endif
 
 
 extern VALUE rb_fsstat_s_alloc( VALUE);

data/lib/supplement/itimer.c

@@ -5,7 +5,7 @@
 
 #include "itimer.h"
 
-#include <math.h>
+#include <sys/time.h>
 
 static void  suppelement_sec_timeval( VALUE, struct timeval *t);
 static VALUE suppelement_timeval_sec( struct timeval *);
@@ -61,7 +61,7 @@ suppelement_sec_timeval( VALUE secs, struct timeval *t)
             d = modf( RFLOAT_VALUE(secs), &f);
             t->tv_sec = (time_t) f, t->tv_usec = (time_t) (d*1e6+0.5);
             if (f != t->tv_sec)
-                rb_raise( rb_eRangeError, "time interval out of Time range",
+                rb_raise( rb_eRangeError, "time interval %f out of Time range",
                     RFLOAT_VALUE(secs));
         }
         break;

data/lib/supplement/itimer.h

@@ -5,7 +5,11 @@
 #ifndef __SUPPLEMENT_ITIMER_H__
 #define __SUPPLEMENT_ITIMER_H__
 
-#include <ruby.h>
+#if   HAVE_HEADER_RUBY_H
+    #include <ruby.h>
+#elif HAVE_HEADER_RUBY_RUBY_H
+    #include <ruby/ruby.h>
+#endif
 
 
 extern VALUE rb_process_setitimer( int, VALUE *, VALUE);

data/lib/supplement/locked.c

@@ -0,0 +1,127 @@
+/*
+ *  supplement/locked.c  --  Locked File
+ */
+
+#include "locked.h"
+
+#if   HAVE_HEADER_RUBYIO_H
+    #include <rubyio.h>
+#elif HAVE_HEADER_RUBY_IO_H
+    #include <ruby/io.h>
+#endif
+
+#include <sys/file.h>
+
+
+/*
+ *  Document-class: LockedFile
+ *
+ *  Open a File and lock it.
+ */
+
+/*
+ *  call-seq:
+ *     LockedFile.open( *args)                 -> file
+ *     LockedFile.open( *args) { |file| ... }  -> ob.j
+ *
+ *  Same as File.open but do an +flock+. If the lock fails, the method
+ *  +lock_failed+ will be called. If that doesn't exist, another lock
+ *  will be tried.
+ */
+
+VALUE
+rb_locked_init( int argc, VALUE *argv, VALUE self)
+{
+#ifdef HAVE_HEADER_RUBY_H
+    OpenFile *fptr;
+#else
+    rb_io_t *fptr;
+#endif
+#ifdef HAVE_FUNC_RB_THREAD_WAIT_FOR
+    struct timeval time;
+#endif
+    int op;
+
+    rb_call_super( argc, argv);
+    GetOpenFile( self, fptr);
+
+    op = fptr->mode & FMODE_WRITABLE ? LOCK_EX : LOCK_SH;
+    op |= LOCK_NB;
+#ifdef HAVE_HEADER_RUBY_H
+    while (flock( fileno( fptr->f), op) < 0) {
+#else
+    while (flock( fptr->fd, op) < 0) {
+#endif
+        static ID id_lock_failed = 0;
+
+        switch (errno) {
+	case EINTR:
+	    break;
+        case EAGAIN:
+        case EACCES:
+#if defined( EWOULDBLOCK) && EWOULDBLOCK != EAGAIN
+        case EWOULDBLOCK:
+#endif
+            if (id_lock_failed == 0)
+                id_lock_failed = rb_intern( "lock_failed");
+            if (rb_respond_to( self, id_lock_failed))
+                rb_funcall( self, id_lock_failed, 0);
+            else {
+#ifdef HAVE_FUNC_RB_THREAD_WAIT_FOR
+                time.tv_sec = 0;
+                time.tv_usec = 100 * 1000;
+                rb_thread_wait_for(time);
+#else
+                rb_thread_polling();
+#endif
+            }
+            break;
+        default:
+#ifdef HAVE_HEADER_RUBY_H
+            rb_sys_fail( fptr->path);
+#else
+            rb_sys_fail_str( fptr->pathv);
+#endif
+            break;
+        }
+    }
+    return self;
+}
+
+
+/*
+ *  call-seq:
+ *     close()                 -> nil
+ *
+ *  Unlock using flock and close.
+ */
+
+VALUE
+rb_locked_close( VALUE self)
+{
+#ifdef HAVE_HEADER_RUBY_H
+    OpenFile *fptr;
+#else
+    rb_io_t *fptr;
+#endif
+
+    GetOpenFile( self, fptr);
+#ifdef HAVE_HEADER_RUBY_H
+    flock( fileno( fptr->f), LOCK_UN);
+#else
+    flock( fptr->fd, LOCK_UN);
+#endif
+    rb_call_super( 0, NULL);
+    return Qnil;
+}
+
+void Init_locked( void)
+{
+    VALUE rb_cLockedFile;
+
+    rb_cLockedFile = rb_define_class( "LockedFile", rb_cFile);
+
+    rb_define_method( rb_cLockedFile, "initialize", &rb_locked_init, -1);
+    rb_define_method( rb_cLockedFile, "close",      &rb_locked_close, 0);
+}
+

data/lib/supplement/locked.h

@@ -0,0 +1,20 @@
+/*
+ *  supplement/filesys.h  --  File system tools
+ */
+
+#ifndef __SUPPLEMENT_FILESYS_H__
+#define __SUPPLEMENT_FILESYS_H__
+
+#if   HAVE_HEADER_RUBY_H
+    #include <ruby.h>
+#elif HAVE_HEADER_RUBY_RUBY_H
+    #include <ruby/ruby.h>
+#endif
+
+VALUE rb_locked_init( int argc, VALUE *argv, VALUE self);
+VALUE rb_locked_close( VALUE self);
+
+extern void Init_locked( void);
+
+#endif
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: supplement
 version: !ruby/object:Gem::Version
-  version: '1.7'
+  version: 2.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: autorake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
@@ -24,13 +24,12 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-description: ! 'Simple methods that didn''t manage to become part of standard Ruby.
-
-'
-email: <software@bertram-scharpf.de>
+description: |
+  Simple methods that didn't manage to become part of standard Ruby.
+email: "<software@bertram-scharpf.de>"
 executables: []
 extensions:
 - lib/mkrf_conf
@@ -42,8 +41,11 @@ files:
 - lib/Rakefile
 - lib/supplement.c
 - lib/supplement.h
-- lib/sync.c
-- lib/sync.h
+- lib/process.c
+- lib/process.h
+- lib/supplement/locked.c
+- lib/supplement/locked.h
+- lib/supplement/dir.rb
 - lib/supplement/filesys.c
 - lib/supplement/filesys.h
 - lib/supplement/itimer.c
@@ -58,28 +60,28 @@ homepage: http://www.bertram-scharpf.de/software/supplement
 licenses: []
 post_install_message: 
 rdoc_options:
-- --charset
+- "--charset"
 - utf-8
-- --main
+- "--main"
 - README
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
 - Ruby and the autorake gem
 rubyforge_project: NONE
-rubygems_version: 1.8.25
+rubygems_version: 1.8.29
 signing_key: 
 specification_version: 3
 summary: Simple Ruby extensions

data/lib/sync.c

@@ -1,34 +0,0 @@
-/*
- *  sync.c  --  Sync all
- */
-
-
-#include "sync.h"
-
-#include <ruby.h>
-#include <unistd.h>
-
-
-static VALUE rb_process_sync( VALUE obj);
-
-
-/*
- *  call-seq:
- *     Process.sync -> nil
- *
- * Force completion of pending disk writes (flush cache). See sync(8).
- */
-
-VALUE
-rb_process_sync( VALUE obj)
-{
-    sync();
-    return Qnil;
-}
-
-
-void Init_supplement_sync( void)
-{
-    rb_define_singleton_method( rb_mProcess, "sync", rb_process_sync, 0);
-}
-

data/lib/sync.h

@@ -1,13 +0,0 @@
-/*
- *  sync.h  --  Sync all
- */
-
-
-#ifndef __SYNC_H__
-#define __SYNC_H__
-
-
-extern void Init_supplement_sync( void);
-
-#endif
-