rio 0.3.1

data/lib/rio/if/test.rb

@@ -0,0 +1,219 @@
+#--
+# =============================================================================== 
+# Copyright (c) 2005, Christopher Kleckner
+# All rights reserved
+#
+# This file is part of the Rio library for ruby.
+#
+# Rio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# Rio 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.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rio; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# =============================================================================== 
+#++
+#
+# To create the documentation for Rio run the command
+#  rake rdoc
+# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+#
+# Suggested Reading
+# * RIO::Doc::SYNOPSIS
+# * RIO::Doc::INTRO
+# * RIO::Doc::HOWTO
+# * RIO::Rio
+#
+# <b>Rio is pre-alpha software. 
+# The documented interface and behavior is subject to change without notice.</b>
+
+
+module RIO
+  class Rio
+    # Calls FileTest#blockdev?
+    #  rio('afile').blockdev?     =>  true or false
+    # Returns +true+ if the named file is a block device.
+    def blockdev?() target.blockdev?() end
+    # Calls FileTest#chardev?
+    #  rio('afile').chardev?     =>  true or false
+    # Returns +true+ if the named file is a character device.
+    def chardev?() target.chardev? end
+    # Calls FileTest#directory?
+    #  rio('afile').directory?     =>  true or false
+    # Returns +true+ if the named file is a directory, +false+ otherwise.
+    def directory?() target.directory? end
+    def dir?() target.dir? end
+    # Calls FileTest#exist?
+    #  rio('afile').exist?()    =>  true or false
+    # Returns +true+ if the named file exists.
+    def exist?() target.exist? end
+    # Calls FileTest#file?
+    #  rio('afile').file?     => true or false
+    # Returns +true+ if the named file exists and is a regular file.
+    def file?() target.file? end
+    # Calls FileTest#socket?
+    #  rio('afile').socket?     =>  true or false
+    # Returns +true+ if the named file is a socket.
+    def socket?() target.socket? end 
+    # Calls FileTest#symlink?
+    #  rio('afile').symlink?     =>  true or false
+    # Returns +true+ if the named file is a symbolic link.
+    def symlink?() target.symlink? end
+
+    # Returns +true+ if a Rio is not closed?
+    def open?() target.open?() end 
+
+    # Calls IO#closed?
+    #  ario.closed?    => true or false
+    # Returns +true+ if _ario_ is completely closed (for duplex streams,
+    # both reader and writer), +false+ otherwise.
+    def closed?() target.closed?()  end
+
+    # Calls File#fnmatch?
+    #
+    # Returns true if path matches against pattern
+    def fnmatch?(*args) target.fnmatch?(*args) end
+
+    # Calls File#ftype
+    #
+    # Identifies the type of the named file; the return string is one of 'file�, 'directory�, 
+    # 'characterSpecial�, 'blockSpecial�, 'fifo�, 'link�, 'socket�, or 'unknown�.
+    def ftype(*args) target.ftype(*args) end
+
+    # Calls File#stat
+    def stat(*args) target.stat(*args) end
+    
+    # Calls File#lstat
+    def lstat(*args) target.lstat(*args) end
+
+    # Calls FileTest#pipe?
+    #  rio('afile').pipe?     =>  true or false
+    # Returns +true+ if the named file is a pipe.
+    def pipe?() target.pipe?() end
+
+
+    # Calls File#atime
+    #
+    # Returns the last access time (a Time object) for the file system object referenced
+    def atime(*args) target.atime(*args) end
+
+    # Calls File#ctime
+    #
+    # Returns the change time for Rios that reference file system object (that is, 
+    # the time directory information about the file was changed, not the file itself).    
+    def ctime(*args) target.ctime(*args) end
+
+    # Calls File#mtime
+    #
+    # Returns the modification time for Rio that reference file system objects
+    def mtime(*args) target.mtime(*args) end
+
+    # Calls File#executable?
+    #
+    # Returns true if the file is executable by the effective user id of this process.
+    def executable?(*args) target.executable?(*args) end 
+
+    # Calls File#executable_real?
+    #
+    # Returns true if the file is executable by the real user id of this process.
+    def executable_real?(*args) target.executable_real?(*args) end 
+
+    # Calls FileTest#readable?
+    #  rio('afile').readable?     => true or false
+    # Returns +true+ if the named file is readable by the effective user
+    #      id of this process.
+    def readable?(*args) target.readable?(*args) end 
+
+    # Calls FileTest#readable_real?
+    #  rio('afile').readable_real?     => true or false
+    # Returns +true+ if the named file is readable by the real user id of
+    # this process.
+    def readable_real?(*args) target.readable_real?(*args) end 
+
+    # Calls FileTest#writable?
+    #  rio('afile').writable?     => true or false
+    # Returns +true+ if the named file is writable by the effective user
+    # id of this process.
+    def writable?(*args) target.writable?(*args) end 
+
+    # Calls FileTest#writable_real?
+    #  rio('afile').writable_real?     => true or false
+    # Returns +true+ if the named file is writable by the real user id of
+    # this process.
+    def writable_real?(*args) target.writable_real?(*args) end
+
+    # Calls FileTest#sticky?
+    #  rio('afile').sticky?     =>  true or false
+    # Returns +true+ if the named file is a has the sticky bit set.
+    def sticky?(*args) target.sticky?(*args) end 
+
+    # Calls FileTest#owned?
+    #  rio('afile').owned?     => true or false
+    # Returns +true+ if the named file exists and the effective used id
+    # of the calling process is the owner of the file.
+    def owned?(*args) target.owned?(*args) end 
+
+    # Calls FileTest#grpowned?
+    #  rio('afile').grpowned?     => true or false
+    # Returns +true+ if the named file exists and the effective group id
+    # of the calling process is the owner of the file. Returns +false+ on
+    # Windows.
+    def grpowned?(*args) target.grpowned?(*args) end 
+
+    # Calls FileTest#setgid?
+    #  rio('afile').setgid?     =>  true or false
+    # Returns +true+ if the named file is a has the setgid bit set.
+    def setgid?(*args) target.setgid?(*args) end 
+    
+    # Calls FileTest#setuid?
+    #  rio('afile').setuid?     =>  true or false
+    # Returns +true+ if the named file is a has the setuid bit set.
+    def setuid?(*args) target.setuid?(*args) end
+    
+    # Calls FileTest#size
+    #  rio('afile').size     => integer
+    # Returns the size of _afile_.
+    # To get the length of the Rio's string representation use Rio#length
+    def size(*args) target.size(*args) end 
+    
+    # Calls FileTest#size?
+    #  rio('afile').size?     => integer  or  nil
+    # Returns +nil+ if _afile_ doesn't exist or has zero size, the
+    # size of the file otherwise.
+    def size?(*args) target.size?(*args) end 
+    
+    # Calls FileTest#zero?
+    #  rio('afile').zero?     => true or false
+    # Returns +true+ if the named file exists and has a zero size.
+    def zero?(*args) target.zero?(*args) end
+
+
+    # Returns true if the rio represents and absolute path or URI. Alias for Rio#absolute?
+    #
+    #  rio('/tmp').abs?                     # >> true
+    #  rio('.ssh').abs?                     # >> false
+    #  rio('file:///tmp').abs?              # >> true
+    #  rio('http://www.ruby-doc.org/').abs? # >> true
+    # 
+    def abs?() target.abs?()  end
+
+
+    # Returns true if the Rio represents and absolute path or URI. Calls URI#absolute?
+    #
+    #  rio('/tmp').absolute?                     # >> true
+    #  rio('.ssh').absolute?                     # >> false
+    #  rio('file:///tmp').absolute?              # >> true
+    #  rio('http://www.ruby-doc.org/').absolute? # >> true
+    # 
+    def absolute?() target.absolute?()  end
+
+
+  end
+end

data/lib/rio/impl/path.rb

@@ -0,0 +1,82 @@
+#--
+# =============================================================================== 
+# Copyright (c) 2005, Christopher Kleckner
+# All rights reserved
+#
+# This file is part of the Rio library for ruby.
+#
+# Rio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# Rio 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.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rio; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# =============================================================================== 
+#++
+#
+# To create the documentation for Rio run the command
+#  rake rdoc
+# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+#
+# Suggested Reading
+# * RIO::Doc::SYNOPSIS
+# * RIO::Doc::INTRO
+# * RIO::Doc::HOWTO
+# * RIO::Rio
+#
+# <b>Rio is pre-alpha software. 
+# The documented interface and behavior is subject to change without notice.</b>
+
+
+module RIO
+  module Impl #:nodoc: all
+    module U
+      def self.fnmatch?(s,globstr,*flags) ::File.fnmatch?(globstr,s,*flags) end
+      def self.expand_path(s,*args) ::File.expand_path(s,*args) end
+      def self.extname(s,*args) ::File.extname(s,*args) end
+
+      def self.basename(s,*args) ::File.basename(s,*args) end
+      def self.dirname(s,*args) ::File.dirname(s,*args) end
+
+      def self.ftype(s,*args) ::File.ftype(s,*args) end
+      def self.symlink(s,d) ::File.symlink(s.to_s,d.to_s) end
+
+      def self.stat(s,*args) ::File.stat(s,*args) end
+
+      def self.atime(s,*args) ::File.atime(s,*args) end
+      def self.ctime(s,*args) ::File.ctime(s,*args) end
+      def self.mtime(s,*args) ::File.mtime(s,*args) end
+
+      def self.blockdev?(s,*args) ::FileTest.blockdev?(s,*args) end
+      def self.chardev?(s,*args) ::FileTest.chardev?(s,*args) end
+      def self.directory?(s,*args) ::FileTest.directory?(s,*args) end
+      def self.dir?(s,*args) ::FileTest.directory?(s,*args) end
+      def self.executable?(s,*args) ::FileTest.executable?(s,*args) end
+      def self.executable_real?(s,*args) ::FileTest.executable_real?(s,*args) end
+      def self.exist?(s,*args) ::FileTest.exist?(s,*args) end
+      def self.file?(s,*args) ::FileTest.file?(s,*args) end
+      def self.grpowned?(s,*args) ::FileTest.grpowned?(s,*args) end
+      def self.owned?(s,*args) ::FileTest.owned?(s,*args) end
+      def self.pipe?(s,*args) ::FileTest.pipe?(s,*args) end
+      def self.readable?(s,*args) ::FileTest.readable?(s,*args) end
+      def self.readable_real?(s,*args) ::FileTest.readable_real?(s,*args) end
+      def self.setgid?(s,*args) ::FileTest.setgid?(s,*args) end
+      def self.setuid?(s,*args) ::FileTest.setuid?(s,*args) end
+      def self.size(s,*args) ::FileTest.size(s,*args) end
+      def self.size?(s,*args) ::FileTest.size?(s,*args) end
+      def self.socket?(s,*args) ::FileTest.socket?(s,*args) end
+      def self.sticky?(s,*args) ::FileTest.sticky?(s,*args) end
+      def self.symlink?(s,*args) ::FileTest.symlink?(s,*args) end
+      def self.writable?(s,*args) ::FileTest.writable?(s,*args) end
+      def self.writable_real?(s,*args) ::FileTest.writable_real?(s,*args) end
+      def self.zero?(s,*args) ::FileTest.zero?(s,*args) end
+    end
+  end
+end

data/lib/rio/ioh.rb

@@ -0,0 +1,137 @@
+#--
+# =============================================================================== 
+# Copyright (c) 2005, Christopher Kleckner
+# All rights reserved
+#
+# This file is part of the Rio library for ruby.
+#
+# Rio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# Rio 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.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rio; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# =============================================================================== 
+#++
+#
+# To create the documentation for Rio run the command
+#  rake rdoc
+# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+#
+# Suggested Reading
+# * RIO::Doc::SYNOPSIS
+# * RIO::Doc::INTRO
+# * RIO::Doc::HOWTO
+# * RIO::Rio
+#
+# <b>Rio is pre-alpha software. 
+# The documented interface and behavior is subject to change without notice.</b>
+
+
+#require 'fileutils'
+
+module RIO
+  module IOH #:nodoc: all
+    class Base
+      attr :ios
+      def initialize(ios,*args)
+        @ios = ios
+      end
+      def initialize_copy(*args)
+        #p callstr('ioh:initialize_copy',*args)
+        super
+        @ios = @ios.clone unless @ios.nil?
+      end
+      def callstr(func,*args)
+        self.class.to_s+'['+self.to_s+']'+'.'+func.to_s+'('+args.join(',')+')'
+      end
+      def handle() @ios end
+      def open?() not closed? end
+    end
+    class Stream < Base
+      attr_reader :iostack
+      def initialize(iosp,*args)
+        super
+        @iostack = [@ios]
+      end
+      def initialize_copy(*args)
+        #p callstr('ioh_stream:initialize_copy',*args)
+        super
+        @iostack = @iostack.map { |io| io.nil? || io.equal?(@ios) ? io : io.clone }
+      end
+      def copy_blksize() 
+        if @ios.respond_to? :stat
+          sz = @ios.stat.blksize
+          sz = nil if sz.nil? || sz == 0
+        end
+        sz || 512 
+      end
+
+      def handle() @iostack[-1] end
+      def close()  handle.close unless self.closed? end
+      def closed?() handle.nil? or handle.closed? end
+      def eof?() closed? or handle.eof? end
+      def copy_stream(dst)
+        #p callstr('copy_stream',dst)
+        blksize = _stream_blksize(handle,dst)
+        until handle.eof?
+          dst.print(handle.read(blksize))
+        end
+        self
+      end
+
+      extend Forwardable
+      def_instance_delegators(:handle,:binmode,:stat,:rewind,
+                              :each,:each_byte,:each_line,:gets,:getc,
+                              :read,:readlines,:readline,:sysread,
+                              :<<,:print,:printf,:puts,:putc,:write,:syswrite,
+                              :pos,:pos=,:lineno,
+                              :fileno,
+                              :close_read,:close_write,
+                              :fsync,:sync,:sync=,:fcntl,:ioctl)
+      def method_missing(sym,*args,&block)
+        #p callstr('method_missing',sym,*args)
+        handle.__send__(sym,*args,&block)
+      end
+      DEFAULT_BLKSIZE = 1024
+      def _stream_blksize(*streams)
+        sizes = []
+        streams.each do |s|
+          next unless s.kind_of?(::IO)
+          next unless s.respond_to?(:stat)
+          size = _stat_blksize(s.stat)
+          sizes << size if size
+        end
+        sizes.min || DEFAULT_BLKSIZE
+      end
+      def _stat_blksize(st)
+        s = st.blksize
+        return nil unless s
+        return nil if s == 0
+        s
+      end
+    end
+    class Dir < Base
+      def close
+        #p "#{callstr('close')} ios=#{@ios}"
+        unless @ios.nil?
+          @ios.close
+          @ios = nil
+        end
+      end
+      def closed?() @ios.nil? end
+      extend Forwardable
+      def_instance_delegators(:handle,
+                              :each,:read,
+                              :pos,:pos=,:tell,:seek,:rewind)
+    end
+  end
+end
+__END__

data/lib/rio/iomode.rb

@@ -0,0 +1,96 @@
+#--
+# =============================================================================== 
+# Copyright (c) 2005, Christopher Kleckner
+# All rights reserved
+#
+# This file is part of the Rio library for ruby.
+#
+# Rio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# Rio 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.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rio; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# =============================================================================== 
+#++
+#
+# To create the documentation for Rio run the command
+#  rake rdoc
+# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+#
+# Suggested Reading
+# * RIO::Doc::SYNOPSIS
+# * RIO::Doc::INTRO
+# * RIO::Doc::HOWTO
+# * RIO::Rio
+#
+# <b>Rio is pre-alpha software. 
+# The documented interface and behavior is subject to change without notice.</b>
+
+
+
+require 'rio/abstract_method'
+
+module RIO
+  module Mode #:nodoc: all
+    class Base
+      attr_reader :mode
+      protected :mode
+      
+      def initialize(arg)
+        if arg.kind_of? self.class
+          copy(arg)
+        else
+          @mode = arg
+        end
+      end
+      
+      def copy(other)
+        @mode = other.mode
+      end
+      
+      def to_s() @mode.to_s end
+
+      abstract_method :primarily_read?, :primarily_write?, :allows_both?
+
+      def read_only?()
+        allows_read? and !allows_write?
+      end
+      def write_only?()
+        !allows_read? and allows_read?
+      end
+      def allows_read?()
+        primarily_read? or allows_both?
+      end
+      def allows_write?()
+        primarily_write? or allows_both?
+      end
+      extend Forwardable
+      def_instance_delegators(:@mode,:=~,:==,:===)
+    end
+  end
+  module Mode
+    module StrMethods
+      def primarily_read?() @mode[0,1] == 'r' end
+      def primarily_write?() @mode[0,1] == 'w' or primarily_append? end
+      def primarily_append?() @mode[0,1] == 'a' end
+      def allows_both?()
+        @mode[1,1] == '+'
+      end
+    end
+    class Str < Base
+      include StrMethods
+    end
+  end
+  module Mode
+    class Int < Base
+    end
+  end
+end