sys-filesystem 1.3.3 → 1.4.2

data/sys-filesystem.gemspec

@@ -2,27 +2,25 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-filesystem'
-  spec.version    = '1.3.3'
+  spec.version    = '1.4.2'
   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.license    = 'Apache-2.0'
-  spec.test_files = Dir['test/*.rb']
+  spec.test_files = Dir['spec/*_spec.rb']
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = Dir['certs/*']
    
-  spec.extra_rdoc_files = Dir['*.rdoc']
-
-  spec.add_dependency('ffi')
+  spec.add_dependency('ffi', '~> 1.1')
+  spec.add_development_dependency('mkmf-lite', '~> 0.5') unless Gem.win_platform?
   spec.add_development_dependency('rake')
-  spec.add_development_dependency('test-unit', '~> 3.3')
-  spec.add_development_dependency('mkmf-lite', '~> 0.3')
+  spec.add_development_dependency('rspec', '~> 3.9')
 
   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/ffi/CHANGES',
+    'changelog_uri'     => 'https://github.com/djberg96/sys-filesystem/blob/main/CHANGES.md',
     '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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-filesystem
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.2
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,114 +35,102 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: mkmf-lite
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mkmf-lite
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '3.9'
 description: |2
       The sys-filesystem library provides a cross-platform interface for
       gathering filesystem information, such as disk space and mount point data.
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- MANIFEST.rdoc
-- README.rdoc
-- CHANGES.rdoc
+extra_rdoc_files: []
 files:
-- test
-- test/test_sys_filesystem.rb
-- test/test_sys_filesystem_windows.rb
-- test/test_sys_filesystem_unix.rb
-- examples
-- examples/example_stat.rb
+- CHANGES.md
+- Gemfile
+- LICENSE
+- MANIFEST.md
+- README.md
+- Rakefile
+- certs/djberg96_pub.pem
 - examples/example_mount.rb
-- lib
-- lib/sys
-- lib/sys/unix
-- lib/sys/unix/sys
+- examples/example_stat.rb
+- lib/sys-filesystem.rb
+- lib/sys/filesystem.rb
 - lib/sys/unix/sys/filesystem.rb
-- lib/sys/unix/sys/filesystem
 - lib/sys/unix/sys/filesystem/constants.rb
-- lib/sys/unix/sys/filesystem/structs.rb
 - lib/sys/unix/sys/filesystem/functions.rb
-- lib/sys/windows
-- lib/sys/windows/sys
+- lib/sys/unix/sys/filesystem/structs.rb
 - lib/sys/windows/sys/filesystem.rb
-- lib/sys/windows/sys/filesystem
 - lib/sys/windows/sys/filesystem/constants.rb
 - lib/sys/windows/sys/filesystem/functions.rb
 - lib/sys/windows/sys/filesystem/helper.rb
-- lib/sys/filesystem.rb
-- lib/sys-filesystem.rb
-- Rakefile
-- certs
-- certs/djberg96_pub.pem
-- MANIFEST.rdoc
-- README.rdoc
+- spec/spec_helper.rb
+- spec/sys_filesystem_unix_spec.rb
+- spec/sys_filesystem_windows_spec.rb
 - sys-filesystem.gemspec
-- CHANGES.rdoc
 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/ffi/CHANGES
+  changelog_uri: https://github.com/djberg96/sys-filesystem/blob/main/CHANGES.md
   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
@@ -161,11 +149,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3.1
 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_windows.rb
-- test/test_sys_filesystem_unix.rb
+- spec/sys_filesystem_unix_spec.rb
+- spec/sys_filesystem_windows_spec.rb

data/README.rdoc

@@ -1,77 +0,0 @@
-== Description
-A cross platform Ruby interface for getting file system information.
-
-== Installation
-  gem install sys-filesystem
-
-== Synopsis
-  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-2019 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/test/test_sys_filesystem.rb

@@ -1,7 +0,0 @@
-$LOAD_PATH.unshift File.dirname(File.expand_path(__FILE__))
-   
-if File::ALT_SEPARATOR
-  require 'test_sys_filesystem_windows'
-else
-  require 'test_sys_filesystem_unix'
-end

data/test/test_sys_filesystem_unix.rb

@@ -1,329 +0,0 @@
-####################################################################
-# test_sys_filesystem_unix.rb
-#
-# Test case for the Sys::Filesystem.stat method and related stuff.
-# This test suite should be run via the 'rake test' task.
-####################################################################
-require 'test-unit'
-require 'sys-filesystem'
-require 'mkmf-lite'
-include Sys
-include Mkmf::Lite
-
-class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
-  def self.startup
-    @@solaris = RbConfig::CONFIG['host_os'] =~ /solaris/i
-    @@linux   = RbConfig::CONFIG['host_os'] =~ /linux/i
-    @@freebsd = RbConfig::CONFIG['host_os'] =~ /freebsd/i
-    @@darwin  = RbConfig::CONFIG['host_os'] =~ /darwin/i
-  end
-
-  def setup
-    @dir   = "/"
-    @stat  = Filesystem.stat(@dir)
-    @mnt   = Filesystem.mounts[0]
-    @size  = 58720256
-    @array = []
-  end
-
-  test "version number is set to the expected value" do
-    assert_equal('1.3.3', Filesystem::VERSION)
-    assert_true(Filesystem::VERSION.frozen?)
-  end
-
-  test "stat path works as expected" do
-    assert_respond_to(@stat, :path)
-    assert_equal("/", @stat.path)
-  end
-
-  test "stat block_size works as expected" do
-    assert_respond_to(@stat, :block_size)
-    assert_kind_of(Numeric, @stat.block_size)
-  end
-
-  test "stat fragment_size works as expected" do
-    assert_respond_to(@stat, :fragment_size)
-    assert_kind_of(Numeric, @stat.fragment_size)
-  end
-
-  test "stat fragment_size is a plausible value" do
-    assert_true(@stat.fragment_size >= 512)
-    assert_true(@stat.fragment_size <= 16384)
-  end
-
-  test "stat blocks works as expected" do
-    assert_respond_to(@stat, :blocks)
-    assert_kind_of(Numeric, @stat.blocks)
-  end
-
-  test "stat blocks_free works as expected" do
-    assert_respond_to(@stat, :blocks_free)
-    assert_kind_of(Numeric, @stat.blocks_free)
-  end
-
-  test "stat blocks_available works as expected" do
-    assert_respond_to(@stat, :blocks_available)
-    assert_kind_of(Numeric, @stat.blocks_available)
-  end
-
-  test "stat files works as expected" do
-    assert_respond_to(@stat, :files)
-    assert_kind_of(Numeric, @stat.files)
-  end
-
-  test "stat inodes is an alias for files" do
-    assert_respond_to(@stat, :inodes)
-    assert_true(@stat.method(:inodes) == @stat.method(:files))
-  end
-
-  test "stat files tree works as expected" do
-    assert_respond_to(@stat, :files_free)
-    assert_kind_of(Numeric, @stat.files_free)
-  end
-
-  test "stat inodes_free is an alias for files_free" do
-    assert_respond_to(@stat, :inodes_free)
-    assert_true(@stat.method(:inodes_free) == @stat.method(:files_free))
-  end
-
-  test "stat files_available works as expected" do
-    assert_respond_to(@stat, :files_available)
-    assert_kind_of(Numeric, @stat.files_available)
-  end
-
-  test "stat inodes_available is an alias for files_available" do
-    assert_respond_to(@stat, :inodes_available)
-    assert_true(@stat.method(:inodes_available) == @stat.method(:files_available))
-  end
-
-  test "stat filesystem_id works as expected" do
-    assert_respond_to(@stat, :filesystem_id)
-    assert_kind_of(Integer, @stat.filesystem_id)
-  end
-
-  test "stat flags works as expected" do
-    assert_respond_to(@stat, :flags)
-    assert_kind_of(Numeric, @stat.flags)
-  end
-
-  test "stat name_max works as expected" do
-    assert_respond_to(@stat, :name_max)
-    assert_kind_of(Numeric, @stat.name_max)
-  end
-
-  test "stat base_type works as expected" do
-    omit_unless(@@solaris, "base_type test skipped except on Solaris")
-
-    assert_respond_to(@stat, :base_type)
-    assert_kind_of(String, @stat.base_type)
-  end
-
-  test "stat constants are defined" do
-    assert_not_nil(Filesystem::Stat::RDONLY)
-    assert_not_nil(Filesystem::Stat::NOSUID)
-
-    omit_unless(@@solaris, "NOTRUNC test skipped except on Solaris")
-
-    assert_not_nil(Filesystem::Stat::NOTRUNC)
-  end
-
-  test "stat bytes_total works as expected" do
-    assert_respond_to(@stat, :bytes_total)
-    assert_kind_of(Numeric, @stat.bytes_total)
-  end
-
-  test "stat bytes_free works as expected" do
-    assert_respond_to(@stat, :bytes_free)
-    assert_kind_of(Numeric, @stat.bytes_free)
-    assert_equal(@stat.bytes_free, @stat.blocks_free * @stat.fragment_size)
-  end
-
-  test "stat bytes_available works as expected" do
-    assert_respond_to(@stat, :bytes_available)
-    assert_kind_of(Numeric, @stat.bytes_available)
-    assert_equal(@stat.bytes_available, @stat.blocks_available * @stat.fragment_size)
-  end
-
-  test "stat bytes works as expected" do
-    assert_respond_to(@stat, :bytes_used)
-    assert_kind_of(Numeric, @stat.bytes_used)
-  end
-
-  test "stat percent_used works as expected" do
-    assert_respond_to(@stat, :percent_used)
-    assert_kind_of(Float, @stat.percent_used)
-  end
-
-  test "stat singleton method requires an argument" do
-    assert_raises(ArgumentError){ Filesystem.stat }
-  end
-
-  test "stat case_insensitive method works as expected" do
-    expected = @@darwin ? true : false
-    assert_equal(expected, @stat.case_insensitive?)
-    assert_equal(expected, Filesystem.stat(Dir.home).case_insensitive?)
-  end
-
-  test "stat case_sensitive method works as expected" do
-    expected = @@darwin ? false : true
-    assert_equal(expected, @stat.case_sensitive?)
-    assert_equal(expected, Filesystem.stat(Dir.home).case_sensitive?)
-  end
-
-  test "numeric helper methods are defined" do
-    assert_respond_to(@size, :to_kb)
-    assert_respond_to(@size, :to_mb)
-    assert_respond_to(@size, :to_gb)
-    assert_respond_to(@size, :to_tb)
-  end
-
-  test "to_kb works as expected" do
-    assert_equal(57344, @size.to_kb)
-  end
-
-  test "to_mb works as expected" do
-    assert_equal(56, @size.to_mb)
-  end
-
-  test "to_gb works as expected" do
-    assert_equal(0, @size.to_gb)
-  end
-
-  # Filesystem::Mount tests
-
-  test "mounts singleton method works as expected without a block" do
-    assert_nothing_raised{ @array = Filesystem.mounts }
-    assert_kind_of(Filesystem::Mount, @array[0])
-  end
-
-  test "mounts singleton method works as expected with a block" do
-    assert_nothing_raised{ Filesystem.mounts{ |m| @array << m } }
-    assert_kind_of(Filesystem::Mount, @array[0])
-  end
-
-  test "calling the mounts singleton method a large number of times does not cause issues" do
-    assert_nothing_raised{ 1000.times{ @array = Filesystem.mounts } }
-  end
-
-  test "mount name method works as expected" do
-    assert_respond_to(@mnt, :name)
-    assert_kind_of(String, @mnt.name)
-  end
-
-  test "mount fsname is an alias for name" do
-    assert_respond_to(@mnt, :fsname)
-    assert_true(@mnt.method(:fsname) == @mnt.method(:name))
-  end
-
-  test "mount point method works as expected" do
-    assert_respond_to(@mnt, :mount_point)
-    assert_kind_of(String, @mnt.mount_point)
-  end
-
-  test "mount dir is an alias for mount_point" do
-    assert_respond_to(@mnt, :dir)
-    assert_true(@mnt.method(:dir) == @mnt.method(:mount_point))
-  end
-
-  test "mount mount_type works as expected" do
-    assert_respond_to(@mnt, :mount_type)
-    assert_kind_of(String, @mnt.mount_type)
-  end
-
-  test "mount options works as expected" do
-    assert_respond_to(@mnt, :options)
-    assert_kind_of(String, @mnt.options)
-  end
-
-  test "mount opts is an alias for options" do
-    assert_respond_to(@mnt, :opts)
-    assert_true(@mnt.method(:opts) == @mnt.method(:options))
-  end
-
-  test "mount time works as expected" do
-    assert_respond_to(@mnt, :mount_time)
-
-    if @@solaris
-      assert_kind_of(Time, @mnt.mount_time)
-    else
-      assert_nil(@mnt.mount_time)
-    end
-  end
-
-  test "mount dump_frequency works as expected" do
-    msg = 'dump_frequency test skipped on this platform'
-    omit_if(@@solaris || @@freebsd || @@darwin, msg)
-    assert_respond_to(@mnt, :dump_frequency)
-    assert_kind_of(Numeric, @mnt.dump_frequency)
-  end
-
-  test "mount freq is an alias for dump_frequency" do
-    assert_respond_to(@mnt, :freq)
-    assert_true(@mnt.method(:freq) == @mnt.method(:dump_frequency))
-  end
-
-  test "mount pass_number works as expected" do
-    msg = 'pass_number test skipped on this platform'
-    omit_if(@@solaris || @@freebsd || @@darwin, msg)
-    assert_respond_to(@mnt, :pass_number)
-    assert_kind_of(Numeric, @mnt.pass_number)
-  end
-
-  test "mount passno is an alias for pass_number" do
-    assert_respond_to(@mnt, :passno)
-    assert_true(@mnt.method(:passno) == @mnt.method(:pass_number))
-  end
-
-  test "mount_point singleton method works as expected" do
-    assert_respond_to(Filesystem, :mount_point)
-    assert_nothing_raised{ Filesystem.mount_point(Dir.pwd) }
-    assert_kind_of(String, Filesystem.mount_point(Dir.pwd))
-  end
-
-  test "mount singleton method is defined" do
-    assert_respond_to(Sys::Filesystem, :mount)
-  end
-
-  test "umount singleton method is defined" do
-    assert_respond_to(Sys::Filesystem, :umount)
-  end
-
-  # FFI
-
-  test "ffi functions are private" do
-    assert_false(Filesystem.methods.include?('statvfs'))
-    assert_false(Filesystem.methods.include?('strerror'))
-  end
-
-  test "statfs struct is expected size" do
-    header = @@freebsd || @@darwin ? 'sys/mount.h' : 'sys/statfs.h'
-    assert_equal(check_sizeof('struct statfs', header), Filesystem::Structs::Statfs.size)
-  end
-
-  test "statvfs struct is expected size" do
-    assert_equal(check_sizeof('struct statvfs', 'sys/statvfs.h'), Filesystem::Structs::Statvfs.size)
-  end
-
-  test "mnttab struct is expected size" do
-    omit_unless(@@solaris, "mnttab test skipped except on Solaris")
-    assert_equal(check_sizeof('struct mnttab', 'sys/mnttab.h'), Filesystem::Structs::Mnttab.size)
-  end
-
-  test "mntent struct is expected size" do
-    omit_unless(@@linux, "mnttab test skipped except on Linux")
-    assert_equal(check_sizeof('struct mntent', 'mntent.h'), Filesystem::Structs::Mntent.size)
-  end
-
-  def teardown
-    @dir   = nil
-    @stat  = nil
-    @array = nil
-  end
-
-  def self.shutdown
-    @@solaris = nil
-    @@linux   = nil
-    @@freebsd = nil
-    @@darwin  = nil
-  end
-end