sys-filesystem 1.3.4 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac54aad155b1415a88d7477893ebe33cc3237fdd33c817b603c34aac98fea516
-  data.tar.gz: 946f4562eb6346e1f7b4555ce95a8c5ff364ac8ca81e6d9b710815ee412845b0
+  metadata.gz: 3b00e624e22bd699630d63b34f90be7758f82630a069f7db2a61e2139cb55888
+  data.tar.gz: 59add440f0203bade0430b2acd410e785b4ab0de416f272755a72db9276aa767
 SHA512:
-  metadata.gz: b70b2160214b9ec52f90428caf4670d5d8012faf3250c57272ecce4371359e4a3a950853798c96d07839baf15dd2314f46cb152d4b82c6f75460d5d52e50be7a
-  data.tar.gz: acaa95a66403e4b800177022e78ad114aafdd32319eeed1b99083d0daa9f935a37f519dcc68fd38921fd01930532604e52cf65040a19370c20f2194b93a53e07
+  metadata.gz: eb24f3c965a15d090fd7fff5800cc4c1829a7ddc7f2cbc4e943bb7e57ae92749a6abfccfecd94e8522287e9700916fc22f57af164afa413459321fa9460ba9a3
+  data.tar.gz: d5d30e84e01f370ac62b77251f2c80c07964a99bebfa0cc30252237bc33830198d3a065c28a546c230327b1b951d45d95bc309f75276d17d7e1e8968ade216f2

data/{CHANGES.rdoc → CHANGES.md}

@@ -1,26 +1,51 @@
-== 1.3.4 - 17-Mar-2020
+## 1.4.3 - 20-Oct-2021
+* Another fix for 32-bit vs 64-bit Linux since it was realized we cannot always
+  rely on the host architecture information. Handling for JRuby was improved
+  as well. Thanks go to Scott Bradnick for the spot. 
+* The constructor is now explicitly private. This class was never meant to
+  actually be instantiated.
+* Updated the MANIFEST.md file.
+
+## 1.4.2 - 22-Jul-2021
+* Fixed support for 32-bit Linux. Thanks go to ciprianbadescu for the spot.
+
+## 1.4.1 - 30-Dec-2020
+* Fix an FFI function declaration bug for Big Sur and later on Mac. Thanks go
+  to Roman Gaufman for the spot and Martins Polakovs for testing.
+* Fixed the changelog metadata URI.
+* Added a .gitignore file.
+
+## 1.4.0 - 6-Sep-2020
+* The Sys::Filesystem.stat method now accepts a Pathname and Dir object as
+  an argument. On most platforms it will also accept a File object. Thanks
+  go to hirura for the patch.
+* Fixed the statvfs struct layout on i686 platforms. Thanks go to
+  Filipovici-Andrei for the patch.
+* Switched from test-unit to rspec, and updated the tests.
+
+## 1.3.4 - 17-Mar-2020
 * Properly include a LICENSE file as per the Apache-2.0 license.
 
-== 1.3.3 - 18-Feb-2020
+## 1.3.3 - 18-Feb-2020
 * Linux now uses statvfs64 under the hood. This fixes a potential issue with
   32 bit systems. Thanks go to Tom Smyth for the spot.
 
-== 1.3.2 - 8-Dec-2019
+## 1.3.2 - 8-Dec-2019
 * Renamed various text files to include .rdoc extension so that github renders
   them nicely.
 
-== 1.3.1 - 15-Oct-2019
+## 1.3.1 - 15-Oct-2019
 * Fixed a bug where the Statvfs and Statfs structs were not allocated properly
   on Linux, which could cause issues. Thanks go to Daniele Orlandi for the spot.
 * Added specs to ensure that the FFI struct size matches the C struct size.
   This required adding mkmf-lite as a development dependency.
 * Added a slightly more pessimistic version requirement for test-unit.
 
-== 1.3.0 - 3-Oct-2019
+## 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
+## 1.2.0 - 1-Jan-2019
 * Changed the license to Apache-2.0.
 * Added the case_sensitive? and case_insensitive? instance methods to the
   Filesystem::Stat class.
@@ -28,7 +53,7 @@
 * Fixed the deprecation warnings when running the tests on Windows.
 * Added metadata to the gemspec.
 
-== 1.1.9 - 26-Jan-2018
+## 1.1.9 - 26-Jan-2018
 * The bytes_free and bytes_total methods were updated to use the fragment size
   instead of the block size. This fixes Macs using APFS, as well as Solaris 10.
   Thanks go to Mikhail Vasin for the spot.
@@ -36,39 +61,39 @@
   to address the issue now resolved by the above change.
 * Updated the cert again.
 
-== 1.1.8 - 2-Sep-2017
+## 1.1.8 - 2-Sep-2017
 * The stat and mount_point methods now call to_s on the string argument
   explicitly so that Pathname objects will now work with String#wincode.
 * Updated some tests to avoid Fixnum warnings for Ruby 2.4.
 * Updated the cert.
 
-== 1.1.7 - 1-Aug-2016
+## 1.1.7 - 1-Aug-2016
 * Fixed an issue in the stat method for MS Windows where the blocks_avail
   value was not correct. Thanks go to Maxime Lapointe for the spot.
 
-== 1.1.6 - 17-May-2016
+## 1.1.6 - 17-May-2016
 * On versions that use setmntent or fopen, explicitly raise an error if
   either of those calls return a null value.
 
-== 1.1.5 - 5-Dec-2015
+## 1.1.5 - 5-Dec-2015
 * This gem is now signed.
 * The gem related tasks in the Rakefile now assume Rubygems 2.x.
 * Updates to the gemspec, added cert_chain, removed rubyforge_project.
 * Internal reorganization, and use of relative_require as appropriate.
 * Added a sys-filesystem.rb file for convenience.
 
-== 1.1.4 - 15-Mar-2015
+## 1.1.4 - 15-Mar-2015
 * The File.mounts method no longer raises an error if a mount point
   is not accessible. Thanks go to Michael Pope for the patch.
 * Some internal code reorganization.
 
-== 1.1.3 - 1-Oct-2014
+## 1.1.3 - 1-Oct-2014
 * Now ignores EPERM errors when trying to find the mount point for a path.
   Thanks go to petersen for the patch.
 * The Filesystem.stat method now defaults to using the root path on Windows
   for volume information.
 
-== 1.1.2 - 9-May-2014
+## 1.1.2 - 9-May-2014
 * Added the percent_used, bytes_total, bytes_free and bytes_used methods
   to the Filesystem::Stat class. Thanks go to xanview for the suggestion.
 * Changed File.exists? to File.exist? to avoid warnings in Ruby 2.1.x.
@@ -77,30 +102,30 @@
 * Added the to_tb method for terabytes.
 * Minor updates to the gem:create and gem:install Rake tasks.
 
-== 1.1.1 - 3-Oct-2013
+## 1.1.1 - 3-Oct-2013
 * Solaris now always uses statvfs64 on Solaris for better 64-bit support.
   Thanks go to Jeff Shantz for the spot.
 
-== 1.1.0 - 19-Jan-2013
+## 1.1.0 - 19-Jan-2013
 * Converted the Windows source code to use FFI. Consequently, there is now
   a single gem rather than separate gems for Windows and Unix.
 * Revamped the Windows tests.
 
-== 1.0.0 - 11-Jan-2012
+## 1.0.0 - 11-Jan-2012
 * Converted everything from C to FFI for the Unix flavors. The Windows
   source code remains untouched.
 
-== 0.3.4 - 19-Nov-2010
+## 0.3.4 - 19-Nov-2010
 * Fixed a bug where negative block counts were happening on very large
   hard drives. Thanks go to Jonas Pfenniger for the spot.
 * Refactored the clean task in the Rakefile.
 * Some cosmetic source code changes.
 
-== 0.3.3 - 21-May-2010
+## 0.3.3 - 21-May-2010
 * Added a workaround for the Sys::Filesystem#block_size member to deal with
   a bug in OS X. Thanks go to Josh Pasqualetto for the spot.
 
-== 0.3.2 - 29-Dec-2009
+## 0.3.2 - 29-Dec-2009
 * Source has been moved to github.
 * Added the 'gem' task and removed build logic from the gemspec.
 * Updated the install task.
@@ -108,23 +133,23 @@
 * Removed some junk build files that were inadvertently included in
   the last gem.
 
-== 0.3.1 - 5-Aug-2009
+## 0.3.1 - 5-Aug-2009
 * Now compatible with Ruby 1.9.x.
 * Changed license to Artistic 2.0
 * Updated the gemspec, including the explicit addition of a license and
   test-unit as a development dependency, as well as an updated description. 
 
-== 0.3.0 - 26-Feb-2009
+## 0.3.0 - 26-Feb-2009
 * Added support for OS X and FreeBSD thanks to an awesome patch by Nobuyoshi
   Miyokawa.
 * Added the Filesystem.mount_point method that takes a file and returns
   the mount point it's sitting on.
 
-== 0.2.0 - 30-Dec-2008
+## 0.2.0 - 30-Dec-2008
 * Added the Filesystem.mounts method for iterating over mount or volume
   information.
 
-== 0.1.1 - 28-Mar-2007
+## 0.1.1 - 28-Mar-2007
 * Bug fix for BSD flavors.  Thanks go to Jeremy Kemper and Ole Christian
   Rynning for the spot.
 * Bug fix for OS X (along the same lines as the BSD fix). Thanks go to
@@ -133,5 +158,5 @@
 * Tweaks to the gemspec.
 * Added synopsis to the README.
 
-== 0.1.0 - 17-Nov-2006
+## 0.1.0 - 17-Nov-2006
 * Initial release.  Alpha. Code is stable, but API is not.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/{MANIFEST.rdoc → MANIFEST.md}

@@ -1,10 +1,12 @@
-* CHANGES.rdoc
+* CHANGES.md
+* Gemfile
 * LICENSE
-* MANIFEST.rdoc
+* MANIFEST.md
 * Rakefile
-* README.rdoc
+* README.md
 * sys-fileystem.gemspec
 * certs/djberg96_pub.pem
+* examples/example_mount.rb
 * examples/example_stat.rb
 * lib/sys-filesystem.rb
 * lib/sys/filesystem.rb
@@ -16,6 +18,6 @@
 * lib/sys/windows/sys/filesystem/constants.rb
 * lib/sys/windows/sys/filesystem/functions.rb
 * lib/sys/windows/sys/filesystem/helper.rb
-* test/test_sys_filesystem.rb
-* test/test_sys_filesystem_unix
-* test/test_sys_filesystem_windows
+* spec/spec_helper.rb
+* spec/sys_filesystem_unix_spec.rb
+* spec/sys_filesystem_windows_spec.rb

data/README.md

@@ -0,0 +1,92 @@
+[![Ruby](https://github.com/djberg96/sys-filesystem/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/sys-filesystem/actions/workflows/ruby.yml)
+
+## Description
+
+A cross platform Ruby interface for getting file system information.
+
+## Installation
+
+`gem install sys-filesystem`
+
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/sys-filesystem/main/certs/djberg96_pub.pem)`
+
+## Synopsis
+
+```ruby
+require 'sys/filesystem'
+include Sys
+   
+# Display information about a particular filesystem.
+p Filesystem.stat('/')
+
+# Sample output
+
+#<Sys::Filesystem::Stat:0x517440
+  @base_type = "ufs",
+  @flags = 4,
+  @files_available = 3817457,
+  @block_size = 8192,
+  @blocks_available = 19957633,
+  @blocks = 34349612,
+  @name_max = 255,
+  @path = "/",
+  @filesystem_id = 35651592,
+  @files = 4135040,
+  @fragment_size = 1024,
+  @files_free = 3817457,
+  @blocks_free = 20301129
+>
+   
+# Describe all mount points on the system
+Filesystem.mounts{ |mount| p mount }
+   
+# Find the mount point of any particular file
+puts Filesystem.mount_point('/home/djberge/some_file.txt') => '/home'
+```
+
+## Notes
+
+This is a pure Ruby implementation that uses FFI. This means it should work
+with JRuby, too.
+
+## Sample code
+
+Run 'rake example' if you want to see a basic sample run. The actual code
+is 'example_stat.rb' in the 'examples' directory. Modify it as you see fit.
+
+## Known Bugs
+
+None that I'm aware of. Please report bugs on the project page at:
+
+  https://github.com/djberg96/sys-filesystem
+
+## Future Plans
+
+* Add better 64-bit support for Linux and BSD.
+* Other suggestions welcome.
+
+## Acknowledgements
+
+* Mike Hall, for ideas and code that I borrowed from his 'filesystem' library.
+* Park Heesob, for implementation and API ideas for the MS Windows version.
+* Nobuyoshi Miyokawa, for adding the original FreeBSD and OS X support.
+   
+## License
+
+Apache-2.0
+
+## Copyright
+
+(C) 2003-2020 Daniel J. Berger
+All Rights Reserved
+
+## Warranty
+
+This library is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+
+## Author
+
+Daniel J. Berger

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.4'.freeze
+    VERSION = '1.4.3'.freeze
   end
 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,27 @@ module Sys
 
       ffi_lib FFI::Library::LIBC
 
-      if RbConfig::CONFIG['host_os'] =~ /sunos|solaris|linux/i
-        attach_function(:statvfs, :statvfs64, [:string, :pointer], :int)
+      def self.linux64?
+        if RUBY_PLATFORM == 'java'
+          ENV_JAVA['sun.arch.data.model'].to_i == 64
+        else
+          RbConfig::CONFIG['host_os'] =~ /linux/i &&
+            (RbConfig::CONFIG['arch'] =~ /64/ || RbConfig::CONFIG['DEFS'] =~ /64/)
+        end
+      end
+
+      private_class_method :linux64?
+
+      if RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i
+        attach_function(:statvfs, :statvfs64, %i[string pointer], :int)
+      elsif linux64?
+        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 +41,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

@@ -6,6 +6,17 @@ module Sys
     module Structs
       class Statfs < FFI::Struct
 
+        def self.linux64?
+          if RUBY_PLATFORM == 'java'
+            ENV_JAVA['sun.arch.data.model'].to_i == 64
+          else
+            RbConfig::CONFIG['host_os'] =~ /linux/i &&
+              (RbConfig::CONFIG['arch'] =~ /64/ || RbConfig::CONFIG['DEFS'] =~ /64/)
+          end
+        end
+
+        private_class_method :linux64?
+
         # FreeBSD 12.0 MNAMELEN from 88 => 1024.
         MNAMELEN =
           if RbConfig::CONFIG['host_os'] =~ /freebsd(.*)/i
@@ -40,20 +51,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 linux64?
+            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 +151,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,