sys-filesystem 1.4.3 → 1.5.0

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
 

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.0')
+    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