sys-filesystem 1.3.4 → 1.4.0

data/spec/sys_filesystem_windows_spec.rb

@@ -0,0 +1,344 @@
+####################################################################
+# sys_filesystem_windows_spec.rb
+#
+# Specs for the Sys::Filesystem.stat method and related stuff.
+# This should be run via the 'rake spec' task.
+####################################################################
+require 'spec_helper'
+require 'sys/filesystem'
+require 'pathname'
+
+RSpec.describe Sys::Filesystem, :windows => true do
+  let(:root) { 'C:/' }
+
+  before do
+    @stat  = Sys::Filesystem.stat(root)
+    @size  = 58720256
+  end
+
+  example "version number is set to the expected value" do
+    expect(Sys::Filesystem::VERSION).to eq('1.4.0')
+    expect(Sys::Filesystem::VERSION).to be_frozen
+  end
+
+  example "stat path works as expected" do
+    expect(@stat).to respond_to(:path)
+    expect(@stat.path).to eq(root)
+  end
+
+  example "stat block_size works as expected" do
+    expect(@stat).to respond_to(:block_size)
+    expect(@stat.block_size).to be_kind_of(Numeric)
+  end
+
+  example "stat works with or without trailing slash on standard paths" do
+    expect(Sys::Filesystem.stat("C:/").path).to eq("C:/")
+    expect(Sys::Filesystem.stat("C:/Users").path).to eq("C:/Users")
+    expect(Sys::Filesystem.stat("C:/Users/").path).to eq("C:/Users/")
+    expect(Sys::Filesystem.stat("C:/Users/").path).to eq("C:/Users/")
+  end
+
+  example "stat works with or without trailing slash on UNC paths" do
+    expect(Sys::Filesystem.stat("//127.0.0.1/C$").path).to eq("//127.0.0.1/C$")
+    expect(Sys::Filesystem.stat("//127.0.0.1/C$/").path).to eq("//127.0.0.1/C$/")
+    expect(Sys::Filesystem.stat("\\\\127.0.0.1\\C$").path).to eq("\\\\127.0.0.1\\C$")
+    expect(Sys::Filesystem.stat("\\\\127.0.0.1\\C$\\").path).to eq("\\\\127.0.0.1\\C$\\")
+  end
+
+  example "stat fragment_size works as expected" do
+    expect(@stat).to respond_to(:fragment_size)
+    expect(@stat.fragment_size).to be_nil
+  end
+
+  example "stat blocks works as expected" do
+    expect(@stat).to respond_to(:blocks)
+    expect(@stat.blocks).to be_kind_of(Numeric)
+  end
+
+  example "stat blocks_free works as expected" do
+    expect(@stat).to respond_to(:blocks_free)
+    expect(@stat.blocks_free).to be_kind_of(Numeric)
+  end
+
+  example "stat blocks_available works as expected" do
+    expect(@stat).to respond_to(:blocks_available)
+    expect(@stat.blocks_available).to be_kind_of(Numeric)
+  end
+
+  example "block stats return expected relative values" do
+    expect(@stat.blocks >= @stat.blocks_free).to be true
+    expect(@stat.blocks_free >= @stat.blocks_available).to be true
+  end
+
+  example "stat files works as expected" do
+    expect(@stat).to respond_to(:files)
+    expect(@stat.files).to be_nil
+  end
+
+  example "stat inodes is an alias for files" do
+    expect(@stat.method(:inodes)).to eq(@stat.method(:files))
+  end
+
+  example "stat files_free works as expected" do
+    expect(@stat).to respond_to(:files_free)
+    expect(@stat.files_free).to be_nil
+  end
+
+  example "stat inodes_free is an alias for files_free" do
+    expect(@stat).to respond_to(:inodes_free)
+  end
+
+  example "stat files available works as expected" do
+    expect(@stat).to respond_to(:files_available)
+    expect(@stat.files_available).to be_nil
+  end
+
+  example "stat inodes_available is an alias for files_available" do
+    expect(@stat.method(:inodes_available)).to eq(@stat.method(:files_available))
+  end
+
+  example "stat filesystem_id works as expected" do
+    expect(@stat).to respond_to(:filesystem_id)
+    expect(@stat.filesystem_id).to be_kind_of(Integer)
+  end
+
+  example "stat flags works as expected" do
+    expect(@stat).to respond_to(:flags)
+    expect(@stat.flags).to be_kind_of(Numeric)
+  end
+
+  example "stat name_max works as expected" do
+    expect(@stat).to respond_to(:name_max)
+    expect(@stat.name_max).to be_kind_of(Numeric)
+  end
+
+  example "stat base_type works as expected" do
+    expect(@stat).to respond_to(:base_type)
+    expect(@stat.base_type).to be_kind_of(String)
+  end
+
+  example "stat bytes_total basic functionality" do
+    expect(@stat).to respond_to(:bytes_total)
+    expect(@stat.bytes_total).to be_kind_of(Numeric)
+  end
+
+  example "stat bytes_free basic functionality" do
+    expect(@stat).to respond_to(:bytes_free)
+    expect(@stat.bytes_free).to be_kind_of(Numeric)
+    expect(@stat.blocks_free * @stat.block_size).to eq(@stat.bytes_free)
+  end
+
+  example "stat bytes_available basic functionality" do
+    expect(@stat).to respond_to(:bytes_available)
+    expect(@stat.bytes_available).to be_kind_of(Numeric)
+    expect(@stat.blocks_available * @stat.block_size).to eq(@stat.bytes_available)
+  end
+
+  example "stat bytes_used basic functionality" do
+    expect(@stat).to respond_to(:bytes_used)
+    expect(@stat.bytes_used).to be_kind_of(Numeric)
+  end
+
+  example "stat percent_used basic functionality" do
+    expect(@stat).to respond_to(:percent_used)
+    expect(@stat.percent_used).to be_kind_of(Float)
+  end
+
+  example "case_insensitive returns expected result" do
+    expect(@stat).to respond_to(:case_insensitive?)
+    expect(@stat.case_insensitive?).to eq(true)
+  end
+
+  context "Filesystem.stat(Pathname)" do
+    before do
+      @stat_pathname = Sys::Filesystem.stat(Pathname.new(root))
+    end
+
+    example "stat with Pathname argument works as expected" do
+      expect(@stat_pathname.class).to eq(@stat.class)
+      expect(@stat_pathname.path).to eq(@stat.path)
+      expect(@stat_pathname.block_size).to eq(@stat.block_size)
+      expect(@stat_pathname.fragment_size).to eq(@stat.fragment_size)
+      expect(@stat_pathname.blocks).to eq(@stat.blocks)
+      expect(@stat_pathname.blocks_free).to eq(@stat.blocks_free)
+      expect(@stat_pathname.blocks_available).to eq(@stat.blocks_available)
+      expect(@stat_pathname.files).to eq(@stat.files)
+      expect(@stat_pathname.files_free).to eq(@stat.files_free)
+      expect(@stat_pathname.files_available).to eq(@stat.files_available)
+      expect(@stat_pathname.filesystem_id).to eq(@stat.filesystem_id)
+      expect(@stat_pathname.flags).to eq(@stat.flags)
+      expect(@stat_pathname.name_max).to eq(@stat.name_max)
+      expect(@stat_pathname.base_type).to eq(@stat.base_type)
+    end
+  end
+
+  context "Filesystem.stat(Dir)" do
+    before do
+      @stat_dir = Dir.open(root){ |dir| Sys::Filesystem.stat(dir) }
+    end
+
+    example "stat with Dir argument works as expected" do
+      expect( @stat_dir.class).to eq(@stat.class)
+      expect( @stat_dir.path).to eq(@stat.path)
+      expect( @stat_dir.block_size).to eq(@stat.block_size)
+      expect( @stat_dir.fragment_size).to eq(@stat.fragment_size)
+      expect( @stat_dir.blocks).to eq(@stat.blocks)
+      expect( @stat_dir.blocks_free).to eq(@stat.blocks_free)
+      expect( @stat_dir.blocks_available).to eq(@stat.blocks_available)
+      expect( @stat_dir.files).to eq(@stat.files)
+      expect( @stat_dir.files_free).to eq(@stat.files_free)
+      expect( @stat_dir.files_available).to eq(@stat.files_available)
+      expect( @stat_dir.filesystem_id).to eq(@stat.filesystem_id)
+      expect( @stat_dir.flags).to eq(@stat.flags)
+      expect( @stat_dir.name_max).to eq(@stat.name_max)
+      expect( @stat_dir.base_type).to eq(@stat.base_type)
+    end
+  end
+
+  context "mount_point" do
+    example "mount_point singleton method basic functionality" do
+      expect(Sys::Filesystem).to respond_to(:mount_point)
+      expect{ Sys::Filesystem.mount_point(Dir.pwd) }.not_to raise_error
+      expect(Sys::Filesystem.mount_point(Dir.pwd)).to be_kind_of(String)
+    end
+
+    example "mount_point singleton method returns expected value" do
+      expect(Sys::Filesystem.mount_point("C:\\Users\\foo")).to eq("C:\\")
+      expect(Sys::Filesystem.mount_point("//foo/bar/baz")).to eq("\\\\foo\\bar")
+    end
+
+    example "mount_point works with Pathname object" do
+      expect{ Sys::Filesystem.mount_point(Pathname.new("C:/Users/foo")) }.not_to raise_error
+      expect(Sys::Filesystem.mount_point("C:\\Users\\foo")).to eq("C:\\")
+      expect(Sys::Filesystem.mount_point("//foo/bar/baz")).to eq("\\\\foo\\bar")
+    end
+  end
+
+  example "filesystem constants are defined" do
+    expect(Sys::Filesystem::CASE_SENSITIVE_SEARCH).not_to be_nil
+    expect(Sys::Filesystem::CASE_PRESERVED_NAMES).not_to be_nil
+    expect(Sys::Filesystem::UNICODE_ON_DISK).not_to be_nil
+    expect(Sys::Filesystem::PERSISTENT_ACLS).not_to be_nil
+    expect(Sys::Filesystem::FILE_COMPRESSION).not_to be_nil
+    expect(Sys::Filesystem::VOLUME_QUOTAS).not_to be_nil
+    expect(Sys::Filesystem::SUPPORTS_SPARSE_FILES).not_to be_nil
+    expect(Sys::Filesystem::SUPPORTS_REPARSE_POINTS).not_to be_nil
+    expect(Sys::Filesystem::SUPPORTS_REMOTE_STORAGE).not_to be_nil
+    expect(Sys::Filesystem::VOLUME_IS_COMPRESSED).not_to be_nil
+    expect(Sys::Filesystem::SUPPORTS_OBJECT_IDS).not_to be_nil
+    expect(Sys::Filesystem::SUPPORTS_ENCRYPTION).not_to be_nil
+    expect(Sys::Filesystem::NAMED_STREAMS).not_to be_nil
+    expect(Sys::Filesystem::READ_ONLY_VOLUME).not_to be_nil
+  end
+
+  example "stat singleton method defaults to root path if proviced" do
+    expect{ Sys::Filesystem.stat("C://Program Files") }.not_to raise_error
+  end
+
+  example "stat singleton method accepts a Pathname object" do
+    expect{ Sys::Filesystem.stat(Pathname.new("C://Program Files")) }.not_to raise_error
+  end
+
+  example "stat singleton method requires a single argument" do
+    expect{ Sys::Filesystem.stat }.to raise_error(ArgumentError)
+    expect{ Sys::Filesystem.stat(Dir.pwd, Dir.pwd) }.to raise_error(ArgumentError)
+  end
+
+  example "stat singleton method raises an error if path is not found" do
+    expect{ Sys::Filesystem.stat("C://Bogus//Dir") }.to raise_error(Errno::ESRCH)
+  end
+
+  context "Filesystem::Mount" do
+    let(:mount){ Sys::Filesystem.mounts[0] }
+
+    before do
+      @array = []
+    end
+
+    example "mount singleton method exists" do
+      expect(Sys::Filesystem).to respond_to(:mount)
+    end
+
+    example "umount singleton method exists" do
+      expect(Sys::Filesystem).to respond_to(:umount)
+    end
+
+    example "mounts singleton method basic functionality" do
+      expect(Sys::Filesystem).to respond_to(:mounts)
+      expect{ Sys::Filesystem.mounts }.not_to raise_error
+      expect{ Sys::Filesystem.mounts{}.not_to raise_error }
+    end
+
+    example "mounts singleton method returns the expected value" do
+      expect(Sys::Filesystem.mounts).to be_kind_of(Array)
+      expect(Sys::Filesystem.mounts[0]).to be_kind_of(Sys::Filesystem::Mount)
+    end
+
+    example "mounts singleton method works as expected when a block is provided" do
+      expect(Sys::Filesystem.mounts{}).to be_nil
+      expect{ Sys::Filesystem.mounts{ |mt| @array << mt } }.not_to raise_error
+      expect(@array[0]).to be_kind_of(Sys::Filesystem::Mount)
+    end
+
+    example "mount name works as expected" do
+      expect(mount).to respond_to(:name)
+      expect(mount.name).to be_kind_of(String)
+    end
+
+    example "mount_time works as expected" do
+      expect(mount).to respond_to(:mount_time)
+      expect(mount.mount_time).to be_kind_of(Time)
+    end
+
+    example "mount type works as expected" do
+      expect(mount).to respond_to(:mount_type)
+      expect(mount.mount_type).to be_kind_of(String)
+    end
+
+    example "mount point works as expected" do
+      expect(mount).to respond_to(:mount_point)
+      expect(mount.mount_point).to be_kind_of(String)
+    end
+
+    example "mount options works as expected" do
+      expect(mount).to respond_to(:options)
+      expect(mount.options).to be_kind_of(String)
+    end
+
+    example "mount pass_number works as expected" do
+      expect(mount).to respond_to(:pass_number)
+      expect(mount.pass_number).to be_nil
+    end
+
+    example "mount frequency works as expected" do
+      expect(mount).to respond_to(:frequency)
+      expect(mount.frequency).to be_nil
+    end
+
+    example "mounts singleton method does not accept any arguments" do
+      expect{ Sys::Filesystem.mounts("C:\\") }.to raise_error(ArgumentError)
+    end
+  end
+
+  example "custom Numeric#to_kb method works as expected" do
+    expect(@size).to respond_to(:to_kb)
+    expect(@size.to_kb).to eq(57344)
+  end
+
+  example "custom Numeric#to_mb method works as expected" do
+    expect(@size).to respond_to(:to_mb)
+    expect(@size.to_mb).to eq(56)
+  end
+
+  example "custom Numeric#to_gb method works as expected" do
+    expect(@size).to respond_to(:to_gb)
+    expect(@size.to_gb).to eq(0)
+  end
+
+  context "FFI" do
+    example "internal ffi functions are not public" do
+      expect(Sys::Filesystem.methods.include?(:GetVolumeInformationA)).to eq(false)
+      expect(Sys::Filesystem.instance_methods.include?(:GetVolumeInformationA)).to eq(false)
+    end
+  end
+end

data/sys-filesystem.gemspec

@@ -2,27 +2,25 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-filesystem'
-  spec.version    = '1.3.4'
+  spec.version    = '1.4.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.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.4')
   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/ffi/CHANGES.rdoc',
     '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,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: sys-filesystem
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,119 +35,106 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 
+date: 2020-11-06 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.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !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:
-- CHANGES.rdoc
-- MANIFEST.rdoc
-- README.rdoc
+extra_rdoc_files: []
 files:
+- CHANGES.md
+- Gemfile
 - LICENSE
-- test
-- test/test_sys_filesystem_windows.rb
-- test/test_sys_filesystem_unix.rb
-- test/test_sys_filesystem.rb
+- MANIFEST.md
+- README.md
 - Rakefile
-- sys-filesystem.gemspec
-- certs
 - certs/djberg96_pub.pem
-- examples
-- examples/example_stat.rb
 - examples/example_mount.rb
-- lib
+- examples/example_stat.rb
 - lib/sys-filesystem.rb
-- lib/sys
-- lib/sys/unix
-- lib/sys/unix/sys
-- lib/sys/unix/sys/filesystem
-- lib/sys/unix/sys/filesystem/structs.rb
+- lib/sys/filesystem.rb
+- lib/sys/unix/sys/filesystem.rb
 - 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/unix/sys/filesystem/structs.rb
+- lib/sys/windows/sys/filesystem.rb
 - lib/sys/windows/sys/filesystem/constants.rb
 - lib/sys/windows/sys/filesystem/functions.rb
-- lib/sys/windows/sys/filesystem.rb
-- CHANGES.rdoc
-- MANIFEST.rdoc
-- README.rdoc
+- lib/sys/windows/sys/filesystem/helper.rb
+- spec/spec_helper.rb
+- spec/sys_filesystem_unix_spec.rb
+- spec/sys_filesystem_windows_spec.rb
+- 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/ffi/CHANGES
+  changelog_uri: https://github.com/djberg96/sys-filesystem/blob/ffi/CHANGES.rdoc
   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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,11 +149,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A Ruby interface for getting file system information.
 test_files:
-- test/test_sys_filesystem_windows.rb
-- test/test_sys_filesystem_unix.rb
-- test/test_sys_filesystem.rb
+- spec/sys_filesystem_windows_spec.rb
+- spec/sys_filesystem_unix_spec.rb