sys-filesystem 1.3.4 → 1.4.3

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

@@ -11,44 +11,46 @@ module Sys
     include Sys::Filesystem::Structs
     extend Sys::Filesystem::Functions
 
-    private
+    private_class_method :new
 
     # 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 +200,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 +280,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 +299,7 @@ module Sys
               end
             end
             flags &= ~key
-          }
+          end
 
           obj.options = string
 
@@ -288,7 +310,7 @@ module Sys
           end
 
           ptr += Statfs.size
-        }
+        end
       else
         begin
           if respond_to?(:setmntent, true)
@@ -365,7 +387,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 +397,7 @@ module Sys
         rescue Errno::EACCES
           next
         end
-      }
+      end
 
       val
     end

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

@@ -15,21 +15,21 @@ module Sys
       end
 
       attach_pfunc :DeleteVolumeMountPointA, [:string], :bool
-      attach_pfunc :GetDiskFreeSpaceW, [:buffer_in, :pointer, :pointer, :pointer, :pointer], :bool
-      attach_pfunc :GetDiskFreeSpaceExW, [:buffer_in, :pointer, :pointer, :pointer], :bool
-      attach_pfunc :GetLogicalDriveStringsA, [:ulong, :pointer], :ulong
+      attach_pfunc :GetDiskFreeSpaceW, %i[buffer_in pointer pointer pointer pointer], :bool
+      attach_pfunc :GetDiskFreeSpaceExW, %i[buffer_in pointer pointer pointer], :bool
+      attach_pfunc :GetLogicalDriveStringsA, %i[ulong pointer], :ulong
 
       attach_pfunc :GetVolumeInformationA,
-        [:buffer_in, :pointer, :ulong, :pointer, :pointer, :pointer, :pointer, :ulong],
-        :bool
+                   %i[buffer_in pointer ulong pointer pointer pointer pointer ulong],
+                   :bool
 
       attach_pfunc :GetVolumeInformationW,
-        [:buffer_in, :pointer, :ulong, :pointer, :pointer, :pointer, :pointer, :ulong],
-        :bool
+                   %i[buffer_in pointer ulong pointer pointer pointer pointer ulong],
+                   :bool
 
-      attach_pfunc :GetVolumeNameForVolumeMountPointW, [:buffer_in, :buffer_in, :ulong], :bool
-      attach_pfunc :QueryDosDeviceA, [:buffer_in, :buffer_out, :ulong], :ulong
-      attach_pfunc :SetVolumeMountPointW, [:buffer_in, :buffer_in], :bool
+      attach_pfunc :GetVolumeNameForVolumeMountPointW, %i[buffer_in buffer_in ulong], :bool
+      attach_pfunc :QueryDosDeviceA, %i[buffer_in buffer_out ulong], :ulong
+      attach_pfunc :SetVolumeMountPointW, %i[buffer_in buffer_in], :bool
 
       ffi_lib :shlwapi
 

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

@@ -2,6 +2,6 @@ class String
   # Convenience method for converting strings to UTF-16LE for wide character
   # functions that require it.
   def wincode
-    (self.tr(File::SEPARATOR, File::ALT_SEPARATOR) + 0.chr).encode('UTF-16LE')
+    (tr(File::SEPARATOR, File::ALT_SEPARATOR) + 0.chr).encode('UTF-16LE')
   end
 end

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

@@ -18,6 +18,8 @@ module Sys
     # Error typically raised if any of the Sys::Filesystem methods fail.
     class Error < StandardError; end
 
+    private_class_method :new
+
     class Mount
       # The name of the volume. This is the device mapping.
       attr_reader :name
@@ -181,7 +183,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 +208,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 +220,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 +233,7 @@ module Sys
         else
           mounts << mount
         end
-      }
+      end
 
       mounts # Nil if the block form was used.
     end
@@ -259,10 +261,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 +287,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 +399,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 +411,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

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+
+RSpec.configure do |config|
+  config.filter_run_excluding(:windows) unless Gem.win_platform?
+  config.filter_run_excluding(:unix) if Gem.win_platform?
+end