sys-filesystem 1.4.3 → 1.5.5

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

@@ -105,6 +105,24 @@ module Sys
       # The filesystem type, e.g. UFS.
       attr_accessor :base_type
 
+      # The filesystem type
+      attr_accessor :filesystem_type
+
+      # The user that mounted the filesystem
+      attr_accessor :owner
+
+      # Count of sync reads since mount
+      attr_accessor :sync_reads
+
+      # Count of sync writes since mount
+      attr_accessor :sync_writes
+
+      # Count of async reads since mount
+      attr_accessor :async_reads
+
+      # Count of async writes since mount
+      attr_accessor :async_writes
+
       alias inodes files
       alias inodes_free files_free
       alias inodes_available files_available
@@ -224,7 +242,7 @@ module Sys
       fs = Statvfs.new
 
       if statvfs(path, fs) < 0
-        raise Error, 'statvfs() function failed: ' + strerror(FFI.errno)
+        raise Error, "statvfs() function failed: #{strerror(FFI.errno)}"
       end
 
       obj = Sys::Filesystem::Stat.new
@@ -250,6 +268,16 @@ module Sys
         obj.base_type = fs[:f_basetype].to_s
       end
 
+      # DragonFlyBSD has additional struct members
+      if RbConfig::CONFIG['host_os'] =~ /dragonfly/i
+        obj.owner = fs[:f_owner]
+        obj.filesystem_type = fs[:f_type]
+        obj.sync_reads = fs[:f_syncreads]
+        obj.async_reads = fs[:f_asyncreads]
+        obj.sync_writes = fs[:f_syncwrites]
+        obj.async_writes = fs[:f_asyncwrites]
+      end
+
       obj.freeze
     end
 
@@ -275,7 +303,7 @@ module Sys
         num = getmntinfo(buf, 2)
 
         if num == 0
-          raise Error, 'getmntinfo() function failed: ' + strerror(FFI.errno)
+          raise Error, "getmntinfo() function failed: #{strerror(FFI.errno)}"
         end
 
         ptr = buf.get_pointer(0)
@@ -293,9 +321,9 @@ module Sys
           OPT_NAMES.each do |key, val|
             if flags & key > 0
               if string.empty?
-                string << val
+                string += val
               else
-                string << ", #{val}"
+                string += ", #{val}"
               end
             end
             flags &= ~key
@@ -325,41 +353,23 @@ module Sys
             raise SystemCallError.new(method_name, FFI.errno)
           end
 
-          if RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i
-            mt = Mnttab.new
-            while getmntent(fp, mt) == 0
-              obj = Sys::Filesystem::Mount.new
-              obj.name = mt[:mnt_special].to_s
-              obj.mount_point = mt[:mnt_mountp].to_s
-              obj.mount_type = mt[:mnt_fstype].to_s
-              obj.options = mt[:mnt_mntopts].to_s
-              obj.mount_time = Time.at(Integer(mt[:mnt_time]))
-
-              if block_given?
-                yield obj.freeze
-              else
-                array << obj.freeze
-              end
-            end
-          else
-            while ptr = getmntent(fp)
-              break if ptr.null?
-              mt = Mntent.new(ptr)
-
-              obj = Sys::Filesystem::Mount.new
-              obj.name = mt[:mnt_fsname]
-              obj.mount_point = mt[:mnt_dir]
-              obj.mount_type = mt[:mnt_type]
-              obj.options = mt[:mnt_opts]
-              obj.mount_time = nil
-              obj.dump_frequency = mt[:mnt_freq]
-              obj.pass_number = mt[:mnt_passno]
-
-              if block_given?
-                yield obj.freeze
-              else
-                array << obj.freeze
-              end
+          while ptr = getmntent(fp)
+            break if ptr.null?
+            mt = Mntent.new(ptr)
+
+            obj = Sys::Filesystem::Mount.new
+            obj.name = mt[:mnt_fsname]
+            obj.mount_point = mt[:mnt_dir]
+            obj.mount_type = mt[:mnt_type]
+            obj.options = mt[:mnt_opts]
+            obj.mount_time = nil
+            obj.dump_frequency = mt[:mnt_freq]
+            obj.pass_number = mt[:mnt_passno]
+
+            if block_given?
+              yield obj.freeze
+            else
+              array << obj.freeze
             end
           end
         ensure
@@ -419,29 +429,31 @@ module Sys
     #
     def self.mount(source, target, fstype = 'ext2', flags = 0, data = nil)
       if mount_c(source, target, fstype, flags, data) != 0
-        raise Error, 'mount() function failed: ' + strerror(FFI.errno)
+        raise Error, "mount() function failed: #{strerror(FFI.errno)}"
       end
 
       self
     end
 
     # Removes the attachment of the (topmost) filesystem mounted on target.
-    # Additional flags may be provided for operating systems that support
-    # the umount2 function. Otherwise this argument is ignored.
+    # You may also specify bitwise OR'd +flags+ to control the precise behavior.
+    # The possible flags on Linux are:
     #
-    # Typically requires admin privileges.
+    # * MNT_FORCE  - Abort pending requests, may cause data loss.
+    # * MNT_DETACH - Lazy umount, waits until the mount point is no longer busy.
+    # * MNT_EXPIRE - Mark mount point as expired, but don't actually remove it until
+    #                a second call MNT_EXPIRE call is made.
     #
-    def self.umount(target, flags = nil)
-      if flags && respond_to?(:umount2)
-        function = 'umount2'
-        rv = umount2_c(target, flags)
-      else
-        function = 'umount'
-        rv = umount_c(target)
-      end
-
-      if rv != 0
-        raise Error, "#{function} function failed: " + strerror(FFI.errno)
+    # * UMOUNT_NOFOLLOW - Don't dereference the target if it's a symbolic link.
+    #
+    # Note that BSD platforms may support different flags. Please see the man
+    # pages for details.
+    #
+    # Typically this method requires admin privileges.
+    #
+    def self.umount(target, flags = 0)
+      if umount_c(target, flags) != 0
+        raise Error, "umount function failed: #{strerror(FFI.errno)}"
       end
 
       self

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

@@ -2,6 +2,7 @@ require 'ffi'
 
 module Sys
   class Filesystem
+    # Wrapper module for Windows related FFI functions.
     module Functions
       extend FFI::Library
       ffi_lib :kernel32

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

@@ -1,6 +1,9 @@
+# Reopen core Ruby classes here and add some custom methods.
 class String
   # Convenience method for converting strings to UTF-16LE for wide character
   # functions that require it.
+  #--
+  # TODO: Use a refinement.
   def wincode
     (tr(File::SEPARATOR, File::ALT_SEPARATOR) + 0.chr).encode('UTF-16LE')
   end

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

@@ -9,7 +9,6 @@ require 'time'
 
 # The Sys module serves as a namespace only.
 module Sys
-
   # The Filesystem class encapsulates information about your filesystem.
   class Filesystem
     include Sys::Filesystem::Constants
@@ -20,6 +19,7 @@ module Sys
 
     private_class_method :new
 
+    # Mount objects are returned by the Sys::Filesystem.mounts method.
     class Mount
       # The name of the volume. This is the device mapping.
       attr_reader :name
@@ -50,6 +50,7 @@ module Sys
       alias freq frequency
     end
 
+    # Stat objects are returned by the Sys::Filesystem.stat method.
     class Stat
       # The path of the file system.
       attr_reader :path
@@ -160,6 +161,8 @@ module Sys
     #--
     # I couldn't really find a good reason to use the wide functions for this
     # method. If you have one, patches welcome.
+    #--
+    # rubocop:disable Metrics/BlockLength
     #
     def self.mounts
       # First call, get needed buffer size
@@ -196,14 +199,14 @@ module Sys
         filesystem_flags     = FFI::MemoryPointer.new(:ulong)
 
         bool = GetVolumeInformationA(
-           drive,
-           volume,
-           volume.size,
-           volume_serial_number,
-           max_component_length,
-           filesystem_flags,
-           fsname,
-           fsname.size
+          drive,
+          volume,
+          volume.size,
+          volume_serial_number,
+          max_component_length,
+          filesystem_flags,
+          fsname,
+          fsname.size
         )
 
         # Skip unmounted floppies or cd-roms, or inaccessible drives
@@ -237,6 +240,7 @@ module Sys
 
       mounts # Nil if the block form was used.
     end
+    # rubocop:enable Metrics/BlockLength
 
     # Returns the mount point for the given +file+. For MS Windows this
     # means the root of the path.
@@ -250,8 +254,6 @@ module Sys
 
       if PathStripToRootW(wfile)
         wfile.read_string(wfile.size).split("\000\000").first.tr(0.chr, '')
-      else
-        nil
       end
     end
 
@@ -425,18 +427,18 @@ module Sys
     #
     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 += ' 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

data/lib/sys-filesystem.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'sys/filesystem'

data/spec/spec_helper.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 require 'rspec'
+require 'sys_filesystem_shared'
 
 RSpec.configure do |config|
+  config.include_context(Sys::Filesystem)
   config.filter_run_excluding(:windows) unless Gem.win_platform?
   config.filter_run_excluding(:unix) if Gem.win_platform?
+  config.filter_run_excluding(:dragonfly) unless RbConfig::CONFIG['host_os'] =~ /dragonfly/i
 end

data/spec/sys_filesystem_shared.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'sys-filesystem'
+
+RSpec.shared_examples Sys::Filesystem do
+  example 'version number is set to the expected value' do
+    expect(Sys::Filesystem::VERSION).to eq('1.5.5')
+    expect(Sys::Filesystem::VERSION).to be_frozen
+  end
+
+  example 'you cannot instantiate an instance' do
+    expect{ described_class.new }.to raise_error(NoMethodError)
+  end
+end