sys-filesystem 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7c3f0edc5663aaad12f5efe558ade7e4b60d501a76da48d1620141f08196800
-  data.tar.gz: 6f5ba4a40c49bbbbf0a93607713a314f9f4c5cc88d8d9748f0b0d40c50ce97f7
+  metadata.gz: f47e78baa2a2d0586d9dccbe36fc98a2683f0f0cc9828d70317ba7d2dc2aaa40
+  data.tar.gz: 8a887956f1a3c621057e93960e67871c646ae00f7cfe157d21ee0fd0f7d21bc7
 SHA512:
-  metadata.gz: cd8722d5a57207ec407585cc6c92087cd8dcdb844e8e5c5acec6be7688fa2170fccb4036c6395552081378b6d00bd70cb4dae6b9fae30728e3118d972d425ef8
-  data.tar.gz: caff95ccc96dd102f379a1c48d15b00111e75d3c5069330cf0d02bc0096d84f3601efc667bb58a8ac43c9651e4548b3fdd51f58814b1b8e8c6c0148c71d73e1d
+  metadata.gz: 66a048e0249d7147868c2a3a21468f5f292be47e82d19316d00d7dc5deab8a4c961bd363c55c55ac7e83d8992a0ecc71a3579ec4ca6e7a874308bd7f5e727aa7
+  data.tar.gz: 76ba77a00a187654367b01cacf2c282959fdbcaa3b2646075687a4f842ade1926bab0b38c51e60ac7b582f0633ce9ff27e32c349720788988a0e48cc5915c27a

data/CHANGES

@@ -1,3 +1,7 @@
+== 1.3.0 - 3-Oct-2019
+* Added the mount and umount singleton methods.
+* Changed an internal class variable to a frozen constant.
+
 == 1.2.0 - 1-Jan-2019
 * Changed the license to Apache-2.0.
 * Added the case_sensitive? and case_insensitive? instance methods to the

data/README

@@ -59,10 +59,10 @@
   Nobuyoshi Miyokawa, for adding the original FreeBSD and OS X support.
    
 = License
-  Artistic 2.0
+  Apache-2.0
 
 = Copyright
-  (C) 2003-2018 Daniel J. Berger
+  (C) 2003-2019 Daniel J. Berger
   All Rights Reserved
 
 = Warranty

data/lib/sys/filesystem.rb

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

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

@@ -14,7 +14,7 @@ module Sys
     private
 
     # Readable versions of constant names
-    @@opt_names = {
+    OPT_NAMES = {
       MNT_RDONLY           => 'read-only',
       MNT_SYNCHRONOUS      => 'synchronous',
       MNT_NOEXEC           => 'noexec',
@@ -35,7 +35,7 @@ module Sys
       MNT_NOUSERXATTR      => 'nouserxattr',
       MNT_DEFWRITE         => 'defwrite',
       MNT_NOATIME          => 'noatime'
-    }
+    }.freeze
 
     # File used to read mount informtion from.
     if File.exist?('/etc/mtab')
@@ -268,7 +268,7 @@ module Sys
           string = ""
           flags = mnt[:f_flags] & MNT_VISFLAGMASK
 
-          @@opt_names.each{ |key,val|
+          OPT_NAMES.each{ |key,val|
             if flags & key > 0
               if string.empty?
                 string << val
@@ -379,5 +379,50 @@ module Sys
 
       val
     end
+
+    # Attach the filesystem specified by +source+ to the location (a directory
+    # or file) specified by the pathname in +target+.
+    #
+    # Note that the +source+ is often a pathname referring to a device, but
+    # can also be the pathname of a directory or file, or a dummy string.
+    #
+    # By default this method will assume 'ext2' as the filesystem type, but
+    # you should update this as needed.
+    #
+    # Typically requires admin privileges.
+    #
+    # Example:
+    #
+    #   Sys::Filesystem.mount('/dev/loop0', '/home/you/tmp', 'ext4', Sys::Filesystem::MNT_RDONLY)
+    #
+    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)
+      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.
+    #
+    # Typically requires admin privileges.
+    #
+    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)
+      end
+
+      self
+    end
   end
 end

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

@@ -36,6 +36,37 @@ module Sys
         MNT_NOUSERXATTR | MNT_DEFWRITE  | MNT_MULTILABEL |
         MNT_NOATIME | MNT_CPROTECT
       )
+
+      MS_RDONLY = 1
+      MS_NOSUID = 2
+      MS_NODEV = 4
+      MS_NOEXEC = 8
+      MS_SYNCHRONOUS = 16
+      MS_REMOUNT = 32
+      MS_MANDLOCK = 64
+      MS_DIRSYNC = 128
+      MS_NOATIME = 1024
+      MS_NODIRATIME = 2048
+      MS_BIND = 4096
+      MS_MOVE = 8192
+      MS_REC = 16384
+      MS_SILENT = 32768
+      MS_POSIXACL = 1 << 16
+      MS_UNBINDABLE = 1 << 17
+      MS_PRIVATE = 1 << 18
+      MS_SLAVE = 1 << 19
+      MS_SHARED = 1 << 20
+      MS_RELATIME = 1 << 21
+      MS_KERNMOUNT = 1 << 22
+      MS_I_VERSION =  1 << 23
+      MS_STRICTATIME = 1 << 24
+      MS_ACTIVE = 1 << 30
+      MS_NOUSER = 1 << 31
+
+      MNT_FORCE = 1
+      MNT_DETACH = 2
+      MNT_EXPIRE = 4
+      UMOUNT_NOFOLLOW = 8
     end
   end
 end

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

@@ -14,8 +14,17 @@ module Sys
       end
 
       attach_function(:strerror, [:int], :string)
+      attach_function(:mount_c, :mount, [:string, :string, :string, :ulong, :string], :int)
 
-      private_class_method :statvfs, :strerror
+      begin
+        attach_function(:umount_c, :umount, [:string], :int)
+      rescue FFI::NotFoundError
+        if RbConfig::CONFIG['host_os'] =~ /darwin|osx|mach/i
+          attach_function(:umount_c, :unmount, [:string], :int)
+        end
+      end
+
+      private_class_method :statvfs, :strerror, :mount_c, :umount_c
 
       begin
         if RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i
@@ -27,7 +36,8 @@ module Sys
           attach_function(:getmntent, [:pointer], :pointer)
           attach_function(:setmntent, [:string, :string], :pointer)
           attach_function(:endmntent, [:pointer], :int)
-          private_class_method :getmntent, :setmntent, :endmntent
+          attach_function(:umount2, [:string, :int], :int)
+          private_class_method :getmntent, :setmntent, :endmntent, :umount2
         end
       rescue FFI::NotFoundError
         if RbConfig::CONFIG['host_os'] =~ /darwin|osx|mach/i

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

@@ -353,6 +353,35 @@ module Sys
       stat_obj.freeze # Read-only object
     end
 
+    # Associate a volume with a drive letter or a directory on another volume.
+    #
+    def self.mount(target, source)
+      targetw = target.to_s.wincode
+      sourcew = source.to_s.wincode
+
+      volume_namew = (0.chr * 256).wincode
+
+      unless GetVolumeNameForVolumeMountPointW(sourcew, volume_namew, volume_namew.size)
+        raise SystemCallError.new('GetVolumeNameForVolumeMountPoint', FFI.errno)
+      end
+
+      unless SetVolumeMountPointW(targetw, volume_namew)
+        raise SystemCallError.new('SetVolumeMountPoint', FFI.errno)
+      end
+
+      self
+    end
+
+    # Deletes a drive letter or mounted folder.
+    #
+    def self.umount(mount_point)
+      unless DeleteVolumeMountPoint(mount_point)
+        raise SystemCallError.new('DeleteVolumeMountPoint', FFI.errno)
+      end
+
+      self
+    end
+
     private
 
     # This method is used to get the boot time of the system, which is used

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

@@ -14,6 +14,7 @@ module Sys
         end
       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
@@ -26,7 +27,9 @@ module Sys
         [: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
 
       ffi_lib :shlwapi
 

data/sys-filesystem.gemspec

@@ -2,12 +2,12 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-filesystem'
-  spec.version    = '1.2.0'
+  spec.version    = '1.3.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'https://github.com/djberg96/sys-filesystem'
   spec.summary    = 'A Ruby interface for getting file system information.'
-  spec.test_file  = 'test/test_sys_filesystem.rb'
+  spec.test_files = Dir['test/*.rb']
   spec.license    = 'Apache-2.0'
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = Dir['certs/*']
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'homepage_uri'      => 'https://github.com/djberg96/sys-filesystem',
     'bug_tracker_uri'   => 'https://github.com/djberg96/sys-filesystem/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/sys-filesystem/blob/master/CHANGES',
+    'changelog_uri'     => 'https://github.com/djberg96/sys-filesystem/blob/ffi/CHANGES',
     'documentation_uri' => 'https://github.com/djberg96/sys-filesystem/wiki',
     'source_code_uri'   => 'https://github.com/djberg96/sys-filesystem',
     'wiki_uri'          => 'https://github.com/djberg96/sys-filesystem/wiki'

data/test/test_sys_filesystem_unix.rb

@@ -25,7 +25,8 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
   end
 
   def test_version
-    assert_equal('1.2.0', Filesystem::VERSION)
+    assert_equal('1.3.0', Filesystem::VERSION)
+    assert_true(Filesystem::VERSION.frozen?)
   end
 
   def test_stat_path
@@ -282,6 +283,14 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
     assert_false(Filesystem.methods.include?('strerror'))
   end
 
+  def test_mount_singleton_method
+    assert_respond_to(Sys::Filesystem, :mount)
+  end
+
+  def test_umount_singleton_method
+    assert_respond_to(Sys::Filesystem, :umount)
+  end
+
   def teardown
     @dir   = nil
     @stat  = nil

data/test/test_sys_filesystem_windows.rb

@@ -20,7 +20,8 @@ class TC_Sys_Filesystem_Windows < Test::Unit::TestCase
   end
 
   test "version number is set to the expected value" do
-    assert_equal('1.2.0', Filesystem::VERSION)
+    assert_equal('1.3.0', Filesystem::VERSION)
+    assert_true(Filesystem::VERSION.frozen?)
   end
 
   test "stat path works as expected" do
@@ -275,6 +276,16 @@ class TC_Sys_Filesystem_Windows < Test::Unit::TestCase
     assert_equal(0, @size.to_gb)
   end
 
+  # Mount and Unmount
+
+  test "mount singleton method exists" do
+    assert_respond_to(Sys::Filesystem, :mount)
+  end
+
+  test "umount singleton method exists" do
+    assert_respond_to(Sys::Filesystem, :umount)
+  end
+
   # FFI
 
   test "internal ffi functions are not public" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-filesystem
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2019-01-01 00:00:00.000000000 Z
+date: 2019-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -91,20 +91,12 @@ extra_rdoc_files:
 - MANIFEST
 files:
 - test
-- test/test_sys_filesystem_windows.rb
-- test/test_sys_filesystem_unix.rb
 - test/test_sys_filesystem.rb
-- CHANGES
-- MANIFEST
-- README
-- Rakefile
-- sys-filesystem.gemspec
-- certs
-- certs/djberg96_pub.pem
+- test/test_sys_filesystem_unix.rb
+- test/test_sys_filesystem_windows.rb
 - examples
 - examples/example_stat.rb
 - lib
-- lib/sys-filesystem.rb
 - lib/sys
 - lib/sys/unix
 - lib/sys/unix/sys
@@ -113,21 +105,29 @@ files:
 - lib/sys/unix/sys/filesystem/constants.rb
 - lib/sys/unix/sys/filesystem/functions.rb
 - lib/sys/unix/sys/filesystem.rb
-- lib/sys/filesystem.rb
 - lib/sys/windows
 - lib/sys/windows/sys
 - lib/sys/windows/sys/filesystem
-- lib/sys/windows/sys/filesystem/helper.rb
 - lib/sys/windows/sys/filesystem/constants.rb
+- lib/sys/windows/sys/filesystem/helper.rb
 - lib/sys/windows/sys/filesystem/functions.rb
 - lib/sys/windows/sys/filesystem.rb
+- lib/sys/filesystem.rb
+- lib/sys-filesystem.rb
+- MANIFEST
+- README
+- Rakefile
+- certs
+- certs/djberg96_pub.pem
+- CHANGES
+- sys-filesystem.gemspec
 homepage: https://github.com/djberg96/sys-filesystem
 licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/djberg96/sys-filesystem
   bug_tracker_uri: https://github.com/djberg96/sys-filesystem/issues
-  changelog_uri: https://github.com/djberg96/sys-filesystem/blob/master/CHANGES
+  changelog_uri: https://github.com/djberg96/sys-filesystem/blob/ffi/CHANGES
   documentation_uri: https://github.com/djberg96/sys-filesystem/wiki
   source_code_uri: https://github.com/djberg96/sys-filesystem
   wiki_uri: https://github.com/djberg96/sys-filesystem/wiki
@@ -147,9 +147,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: A Ruby interface for getting file system information.
 test_files:
 - test/test_sys_filesystem.rb
+- test/test_sys_filesystem_unix.rb
+- test/test_sys_filesystem_windows.rb