sys-filesystem 1.3.3 → 1.4.2

data/Rakefile

@@ -1,34 +1,16 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx')
-
-desc "Run the test suite"
-Rake::TestTask.new("test") do |t|
-  if File::ALT_SEPARATOR
-    t.libs << 'lib/windows'
-  else
-    t.libs << 'lib/unix'
-  end
-
-  t.warning = true
-  t.verbose = true
-  t.test_files = FileList['test/test_sys_filesystem.rb']
-end
-
-desc "Run the example program"
-task :example do |t|
-  sh "ruby -Ilib -Ilib/unix -Ilib/windows examples/example_stat.rb"
-end
+CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx', '**/*.lock')
 
 namespace :gem do
   desc "Build the sys-filesystem gem"
-  task :create => [:clean] do |t|
+  task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('sys-filesystem.gemspec'))
+    spec = Gem::Specification.load('sys-filesystem.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc "Install the sys-filesystem gem"
@@ -38,4 +20,12 @@ namespace :gem do
   end
 end
 
-task :default => :test
+desc "Run the example program"
+task :example do
+  sh "ruby -Ilib -Ilib/unix -Ilib/windows examples/example_stat.rb"
+end
+
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/example_mount.rb

@@ -7,11 +7,12 @@
 require 'optparse'
 
 options = {:mount_options => []}
+
 OptionParser.new do |opts|
   opts.banner = "Usage: #$0 [-o options] [-t external_type] special node"
 
-  opts.on("-o=OPTIONS",       "Set one or many mount options (comma delimited)") do |opts|
-    options[:mount_options] += opts.split(',')
+  opts.on("-o=OPTIONS",       "Set one or many mount options (comma delimited)") do |cli_opts|
+    options[:mount_options] += cli_opts.split(',')
   end
 
   opts.on("-r",               "Set readonly flag") do

data/lib/sys/filesystem.rb

@@ -1,7 +1,7 @@
 module Sys
   class Filesystem
     # The version of the sys-filesystem library
-    VERSION = '1.3.3'.freeze
+    VERSION = '1.4.2'.freeze
   end
 end
 

data/lib/sys/unix/sys/filesystem.rb

@@ -11,44 +11,44 @@ module Sys
     include Sys::Filesystem::Structs
     extend Sys::Filesystem::Functions
 
-    private
-
     # Readable versions of constant names
     OPT_NAMES = {
-      MNT_RDONLY           => 'read-only',
-      MNT_SYNCHRONOUS      => 'synchronous',
-      MNT_NOEXEC           => 'noexec',
-      MNT_NOSUID           => 'nosuid',
-      MNT_NODEV            => 'nodev',
-      MNT_UNION            => 'union',
-      MNT_ASYNC            => 'asynchronous',
-      MNT_CPROTECT         => 'content-protection',
-      MNT_EXPORTED         => 'exported',
-      MNT_QUARANTINE       => 'quarantined',
-      MNT_LOCAL            => 'local',
-      MNT_QUOTA            => 'quotas',
-      MNT_ROOTFS           => 'rootfs',
-      MNT_DONTBROWSE       => 'nobrowse',
+      MNT_RDONLY => 'read-only',
+      MNT_SYNCHRONOUS => 'synchronous',
+      MNT_NOEXEC => 'noexec',
+      MNT_NOSUID => 'nosuid',
+      MNT_NODEV => 'nodev',
+      MNT_UNION => 'union',
+      MNT_ASYNC => 'asynchronous',
+      MNT_CPROTECT => 'content-protection',
+      MNT_EXPORTED => 'exported',
+      MNT_QUARANTINE => 'quarantined',
+      MNT_LOCAL => 'local',
+      MNT_QUOTA => 'quotas',
+      MNT_ROOTFS => 'rootfs',
+      MNT_DONTBROWSE => 'nobrowse',
       MNT_IGNORE_OWNERSHIP => 'noowners',
-      MNT_AUTOMOUNTED      => 'automounted',
-      MNT_JOURNALED        => 'journaled',
-      MNT_NOUSERXATTR      => 'nouserxattr',
-      MNT_DEFWRITE         => 'defwrite',
-      MNT_NOATIME          => 'noatime'
+      MNT_AUTOMOUNTED => 'automounted',
+      MNT_JOURNALED => 'journaled',
+      MNT_NOUSERXATTR => 'nouserxattr',
+      MNT_DEFWRITE => 'defwrite',
+      MNT_NOATIME => 'noatime'
     }.freeze
 
+    private_constant :OPT_NAMES
+
     # File used to read mount informtion from.
     if File.exist?('/etc/mtab')
-      MOUNT_FILE = '/etc/mtab'
+      MOUNT_FILE = '/etc/mtab'.freeze
     elsif File.exist?('/etc/mnttab')
-      MOUNT_FILE = '/etc/mnttab'
+      MOUNT_FILE = '/etc/mnttab'.freeze
     elsif File.exist?('/proc/mounts')
-      MOUNT_FILE = '/proc/mounts'
+      MOUNT_FILE = '/proc/mounts'.freeze
     else
-      MOUNT_FILE = 'getmntinfo'
+      MOUNT_FILE = 'getmntinfo'.freeze
     end
 
-    public
+    private_constant :MOUNT_FILE
 
     # The error raised if any of the Filesystem methods fail.
     class Error < StandardError; end
@@ -198,7 +198,27 @@ module Sys
     # Returns a Sys::Filesystem::Stat object containing information about the
     # +path+ on the filesystem.
     #
+    # Examples:
+    #
+    #    # path
+    #    Sys::Filesystem.stat("path")
+    #
+    #    # Pathname
+    #    pathname = Pathname.new("path")
+    #    Sys::Filesystem.stat(pathname)
+    #
+    #    # File
+    #    file = File.open("file", "r")
+    #    Sys::Filesystem.stat(file)
+    #
+    #    # Dir
+    #    dir = Dir.open("/")
+    #    Sys::Filesystem.stat(dir)
+    #
     def self.stat(path)
+      path = path.path if path.respond_to?(:path) # File, Dir
+      path = path.to_s if path.respond_to?(:to_s) # Pathname
+
       fs = Statvfs.new
 
       if statvfs(path, fs) < 0
@@ -258,17 +278,17 @@ module Sys
 
         ptr = buf.get_pointer(0)
 
-        num.times{ |i|
+        num.times do
           mnt = Statfs.new(ptr)
           obj = Sys::Filesystem::Mount.new
           obj.name = mnt[:f_mntfromname].to_s
           obj.mount_point = mnt[:f_mntonname].to_s
           obj.mount_type = mnt[:f_fstypename].to_s
 
-          string = ""
+          string = ''
           flags = mnt[:f_flags] & MNT_VISFLAGMASK
 
-          OPT_NAMES.each{ |key,val|
+          OPT_NAMES.each do |key, val|
             if flags & key > 0
               if string.empty?
                 string << val
@@ -277,7 +297,7 @@ module Sys
               end
             end
             flags &= ~key
-          }
+          end
 
           obj.options = string
 
@@ -288,7 +308,7 @@ module Sys
           end
 
           ptr += Statfs.size
-        }
+        end
       else
         begin
           if respond_to?(:setmntent, true)
@@ -365,7 +385,7 @@ module Sys
       dev = File.stat(file).dev
       val = file
 
-      self.mounts.each{ |mnt|
+      mounts.each do |mnt|
         mp = mnt.mount_point
         begin
           if File.stat(mp).dev == dev
@@ -375,7 +395,7 @@ module Sys
         rescue Errno::EACCES
           next
         end
-      }
+      end
 
       val
     end

data/lib/sys/unix/sys/filesystem/constants.rb

@@ -1,8 +1,6 @@
 module Sys
   class Filesystem
     module Constants
-      private
-
       MNT_RDONLY      = 0x00000001 # read only filesystem
       MNT_SYNCHRONOUS = 0x00000002 # file system written synchronously
       MNT_NOEXEC      = 0x00000004 # can't exec from filesystem
@@ -33,7 +31,7 @@ module Sys
         MNT_LOCAL  | MNT_QUOTA |
         MNT_ROOTFS | MNT_DOVOLFS | MNT_DONTBROWSE |
         MNT_IGNORE_OWNERSHIP | MNT_AUTOMOUNTED | MNT_JOURNALED |
-        MNT_NOUSERXATTR | MNT_DEFWRITE  | MNT_MULTILABEL |
+        MNT_NOUSERXATTR | MNT_DEFWRITE | MNT_MULTILABEL |
         MNT_NOATIME | MNT_CPROTECT
       )
 
@@ -58,7 +56,7 @@ module Sys
       MS_SHARED = 1 << 20
       MS_RELATIME = 1 << 21
       MS_KERNMOUNT = 1 << 22
-      MS_I_VERSION =  1 << 23
+      MS_I_VERSION = 1 << 23
       MS_STRICTATIME = 1 << 24
       MS_ACTIVE = 1 << 30
       MS_NOUSER = 1 << 31

data/lib/sys/unix/sys/filesystem/functions.rb

@@ -7,14 +7,16 @@ module Sys
 
       ffi_lib FFI::Library::LIBC
 
-      if RbConfig::CONFIG['host_os'] =~ /sunos|solaris|linux/i
-        attach_function(:statvfs, :statvfs64, [:string, :pointer], :int)
+      if RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i
+        attach_function(:statvfs, :statvfs64, %i[string pointer], :int)
+      elsif RbConfig::CONFIG['host_os'] =~ /linux/i && RbConfig::CONFIG['arch'] =~ /64/
+        attach_function(:statvfs, :statvfs64, %i[string pointer], :int)
       else
-        attach_function(:statvfs, [:string, :pointer], :int)
+        attach_function(:statvfs, %i[string pointer], :int)
       end
 
       attach_function(:strerror, [:int], :string)
-      attach_function(:mount_c, :mount, [:string, :string, :string, :ulong, :string], :int)
+      attach_function(:mount_c, :mount, %i[string string string ulong string], :int)
 
       begin
         attach_function(:umount_c, :umount, [:string], :int)
@@ -28,22 +30,26 @@ module Sys
 
       begin
         if RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i
-          attach_function(:fopen, [:string, :string], :pointer)
+          attach_function(:fopen, %i[string string], :pointer)
           attach_function(:fclose, [:pointer], :int)
-          attach_function(:getmntent, [:pointer, :pointer], :int)
+          attach_function(:getmntent, %i[pointer pointer], :int)
           private_class_method :fopen, :fclose, :getmntent
         else
           attach_function(:getmntent, [:pointer], :pointer)
-          attach_function(:setmntent, [:string, :string], :pointer)
+          attach_function(:setmntent, %i[string string], :pointer)
           attach_function(:endmntent, [:pointer], :int)
-          attach_function(:umount2, [:string, :int], :int)
+          attach_function(:umount2, %i[string int], :int)
           private_class_method :getmntent, :setmntent, :endmntent, :umount2
         end
       rescue FFI::NotFoundError
         if RbConfig::CONFIG['host_os'] =~ /darwin|osx|mach/i
-          attach_function(:getmntinfo, :getmntinfo64, [:pointer, :int], :int)
+          begin
+            attach_function(:getmntinfo, :getmntinfo64, %i[pointer int], :int)
+          rescue FFI::NotFoundError
+            attach_function(:getmntinfo, %i[pointer int], :int) # Big Sur and later
+          end
         else
-          attach_function(:getmntinfo, [:pointer, :int], :int)
+          attach_function(:getmntinfo, %i[pointer int], :int)
         end
         private_class_method :getmntinfo
       end

data/lib/sys/unix/sys/filesystem/structs.rb

@@ -40,20 +40,37 @@ module Sys
             :f_mntonname, [:char, MNAMELEN]
           )
         elsif RbConfig::CONFIG['host_os'] =~ /linux/i
-          layout(
-            :f_type, :ulong,
-            :f_bsize, :ulong,
-            :f_blocks, :uint64,
-            :f_bfree, :uint64,
-            :f_bavail, :uint64,
-            :f_files, :uint64,
-            :f_ffree, :uint64,
-            :f_fsid, [:int, 2],
-            :f_namelen, :ulong,
-            :f_frsize, :ulong,
-            :f_flags, :ulong,
-            :f_spare, [:ulong, 4]
-          )
+          if RbConfig::CONFIG['arch'] =~ /64/
+            layout(
+              :f_type, :ulong,
+              :f_bsize, :ulong,
+              :f_blocks, :uint64,
+              :f_bfree, :uint64,
+              :f_bavail, :uint64,
+              :f_files, :uint64,
+              :f_ffree, :uint64,
+              :f_fsid, [:int, 2],
+              :f_namelen, :ulong,
+              :f_frsize, :ulong,
+              :f_flags, :ulong,
+              :f_spare, [:ulong, 4]
+            )
+          else
+            layout(
+              :f_type, :ulong,
+              :f_bsize, :ulong,
+              :f_blocks, :uint32,
+              :f_bfree, :uint32,
+              :f_bavail, :uint32,
+              :f_files, :uint32,
+              :f_ffree, :uint32,
+              :f_fsid, [:int, 2],
+              :f_namelen, :ulong,
+              :f_frsize, :ulong,
+              :f_flags, :ulong,
+              :f_spare, [:ulong, 4]
+            )
+          end
         else
           layout(
             :f_bsize, :uint32,
@@ -123,6 +140,22 @@ module Sys
             :f_fstr, [:char, 32],
             :f_filler, [:ulong, 16]
           )
+        elsif RbConfig::CONFIG['host'] =~ /i686/i
+          layout(
+            :f_bsize, :ulong,
+            :f_frsize, :ulong,
+            :f_blocks, :uint,
+            :f_bfree, :uint,
+            :f_bavail, :uint,
+            :f_files, :uint,
+            :f_ffree, :uint,
+            :f_favail, :uint,
+            :f_fsid, :ulong,
+            :f_unused, :int,
+            :f_flag, :ulong,
+            :f_namemax, :ulong,
+            :f_spare, [:int, 6]
+          )
         else
           layout(
             :f_bsize, :ulong,

data/lib/sys/windows/sys/filesystem.rb

@@ -181,7 +181,7 @@ module Sys
 
       boot_time = get_boot_time
 
-      drives.each{ |drive|
+      drives.each do |drive|
         mount  = Mount.new
         volume = FFI::MemoryPointer.new(:char, MAXPATH)
         fsname = FFI::MemoryPointer.new(:char, MAXPATH)
@@ -206,7 +206,7 @@ module Sys
 
         # Skip unmounted floppies or cd-roms, or inaccessible drives
         unless bool
-          if [5,21].include?(FFI.errno) # ERROR_NOT_READY or ERROR_ACCESS_DENIED
+          if [5, 21].include?(FFI.errno) # ERROR_NOT_READY or ERROR_ACCESS_DENIED
             next
           else
             raise SystemCallError.new('GetVolumeInformation', FFI.errno)
@@ -218,7 +218,7 @@ module Sys
 
         name = 0.chr * MAXPATH
 
-        if QueryDosDeviceA(drive[0,2], name, name.size) == 0
+        if QueryDosDeviceA(drive[0, 2], name, name.size) == 0
           raise SystemCallError.new('QueryDosDevice', FFI.errno)
         end
 
@@ -231,7 +231,7 @@ module Sys
         else
           mounts << mount
         end
-      }
+      end
 
       mounts # Nil if the block form was used.
     end
@@ -259,10 +259,25 @@ module Sys
     #
     # Examples:
     #
+    #    # Regular directory
     #    Sys::Filesystem.stat("C:\\")
     #    Sys::Filesystem.stat("C:\\Documents and Settings\\some_user")
     #
+    #    # Pathname
+    #    pathname = Pathname.new("C:\\")
+    #    Sys::Filesystem.stat(pathname)
+    #
+    #    # Dir
+    #    dir = Dir.open("C:\\")
+    #    Sys::Filesystem.stat(dir)
+    #
+    # Note that on Windows you cannot stat a regular file because
+    # Windows won't like it. It must be a directory in some form.
+    #
     def self.stat(path)
+      path = path.path if path.respond_to?(:path) # Dir
+      path = path.to_s if path.respond_to?(:to_s) # Pathname
+
       bytes_avail = FFI::MemoryPointer.new(:ulong_long)
       bytes_free  = FFI::MemoryPointer.new(:ulong_long)
       total_bytes = FFI::MemoryPointer.new(:ulong_long)
@@ -270,7 +285,7 @@ module Sys
       mpoint = mount_point(path).to_s
       mpoint << '/' unless mpoint.end_with?('/')
 
-      wpath  = path.to_s.wincode
+      wpath = path.to_s.wincode
 
       # We need this call for the 64 bit support
       unless GetDiskFreeSpaceExW(wpath, bytes_avail, total_bytes, bytes_free)
@@ -382,8 +397,6 @@ module Sys
       self
     end
 
-    private
-
     # This method is used to get the boot time of the system, which is used
     # for the mount_time attribute within the File.mounts method.
     #
@@ -396,36 +409,37 @@ module Sys
         raise Error, e
       else
         query = 'select LastBootupTime from Win32_OperatingSystem'
-        results = wmi.ExecQuery(query)
-        results.each{ |ole|
-          time_array = Time.parse(ole.LastBootupTime.split('.').first)
-          return Time.mktime(*time_array)
-        }
+        ole = wmi.ExecQuery(query).ItemIndex(0)
+        time_array = Time.parse(ole.LastBootupTime.split('.').first)
+        Time.mktime(*time_array)
       end
     end
 
+    private_class_method :get_boot_time
+
     # Private method that converts filesystem flags into a comma separated
     # list of strings. The presentation is meant as a rough analogue to the
     # way options are presented for Unix filesystems.
     #
     def self.get_options(flags)
-       str = ""
-       str << " casepres" if CASE_PRESERVED_NAMES & flags > 0
-       str << " casesens" if CASE_SENSITIVE_SEARCH & flags > 0
-       str << " compression" if FILE_COMPRESSION & flags > 0
-       str << " namedstreams" if NAMED_STREAMS & flags > 0
-       str << " pacls" if PERSISTENT_ACLS & flags > 0
-       str << " ro" if READ_ONLY_VOLUME & flags > 0
-       str << " encryption" if SUPPORTS_ENCRYPTION & flags > 0
-       str << " objids" if SUPPORTS_OBJECT_IDS & flags > 0
-       str << " rpoints" if SUPPORTS_REPARSE_POINTS & flags > 0
-       str << " sparse" if SUPPORTS_SPARSE_FILES & flags > 0
-       str << " unicode" if UNICODE_ON_DISK & flags > 0
-       str << " compressed" if VOLUME_IS_COMPRESSED & flags > 0
-
-       str.tr!(' ', ',')
-       str = str[1..-1] # Ignore the first comma
-       str
+      str = ''
+      str << ' casepres' if CASE_PRESERVED_NAMES & flags > 0
+      str << ' casesens' if CASE_SENSITIVE_SEARCH & flags > 0
+      str << ' compression' if FILE_COMPRESSION & flags > 0
+      str << ' namedstreams' if NAMED_STREAMS & flags > 0
+      str << ' pacls' if PERSISTENT_ACLS & flags > 0
+      str << ' ro' if READ_ONLY_VOLUME & flags > 0
+      str << ' encryption' if SUPPORTS_ENCRYPTION & flags > 0
+      str << ' objids' if SUPPORTS_OBJECT_IDS & flags > 0
+      str << ' rpoints' if SUPPORTS_REPARSE_POINTS & flags > 0
+      str << ' sparse' if SUPPORTS_SPARSE_FILES & flags > 0
+      str << ' unicode' if UNICODE_ON_DISK & flags > 0
+      str << ' compressed' if VOLUME_IS_COMPRESSED & flags > 0
+
+      str.tr!(' ', ',')
+      str[1..-1] # Ignore the first comma
     end
+
+    private_class_method :get_options
   end
 end