recls-ruby 2.13.0.1 → 2.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e34f60c35aebc4cf9cb1e217c1e7cf3e0211abee3eddb8e6306daa601c36461
-  data.tar.gz: 888951b3419b4be2b453449a3f25b0ee725e78539449caf469c767bbc329fbd4
+  metadata.gz: 0da3b80a1f5ba1babc0fdfbd56abf30433e53d39f2996fe2661d0142ad4b386d
+  data.tar.gz: 47fca376aac5eb7559fe2b7e014b8a79d23bc828fcbd999b75ce133a52a4e255
 SHA512:
-  metadata.gz: d0756416a3dc1d95aae37a46e7d3db1bbea1347e7b0cc369088910662698361dcedf718da31d818b976fc78b342766dd155c969fab8593f90e6c644e8cc44d04
-  data.tar.gz: 85291a5a45c3b430f92fbed82f9033bc53d524fa67dde8fd40b6f85581032b625c0756e944ab57fb6a74c3b9f60e92264f05dd7cdd606f2e5ecd8f61b1cd774e
+  metadata.gz: b1c79afd72e02b47c8c9ce9291c08d1c825e96e5e66a826a36a004c08774b82e77aa5610edc0c986ebfa28b10c95f5baea75ed9bdfba12ac35a36a377fd7b747
+  data.tar.gz: dcdfee4db3cddd95879d7faf833def2daea1cdc8d91809981dfbbb3703dacc37ce77b4c1671b33dafb60d7ec446ffee6afe3a389b5de97d4063b157c5ace4b63

data/lib/recls/version.rb

@@ -4,7 +4,7 @@
 # Purpose:  Version for recls library
 #
 # Created:  14th February 2014
-# Updated:  21st April 2024
+# Updated:  2nd April 2024
 #
 # Author:   Matthew Wilson
 #
@@ -43,7 +43,7 @@
 module Recls
 
   # Current version of the recls.Ruby library
-  VERSION           = '2.13.0.1'
+  VERSION           = '2.13.1'
 
   private
   # @!visibility private

data/lib/recls/ximpl/windows.rb

@@ -4,7 +4,7 @@
 # Purpose:  Windows-specific constructs for the recls library.
 #
 # Created:  19th February 2014
-# Updated:  21st April 2024
+# Updated:  2nd June 2024
 #
 # Author:   Matthew Wilson
 #
@@ -37,7 +37,14 @@
 # ######################################################################## #
 
 
-require 'Win32API'
+if RUBY_VERSION >= '2'
+
+  require 'fiddle'
+  require 'fiddle/import'
+else
+
+  require 'Win32API'
+end
 
 
 =begin
@@ -49,46 +56,136 @@ module Recls
   module Ximpl # :nodoc: all
 
     # @!visibility private
-    class FileStat < File::Stat # :nodoc:
+    module Kernel32
+
+      MAX_PATH              = 260
+      NULL                  = 0x00000000
+      OPEN_EXISTING         = 0x00000003
+    end # module Kernel32
+
+    if RUBY_VERSION >= '2'
+
+      module Kernel32
+        extend Fiddle::Importer
+
+        dlload 'kernel32.dll'
+
+        typealias 'BOOL', 'int'
+        typealias 'DWORD', 'unsigned long'
+        typealias 'HANDLE', 'void*'
+
+        BY_HANDLE_FILE_INFORMATION = struct [
+          'DWORD dwFileAttributes',
+          'DWORD ftCreationTime_0',
+          'DWORD ftCreationTime_1',
+          'DWORD ftLastAccessTime_0',
+          'DWORD ftLastAccessTime_1',
+          'DWORD ftLastWriteTime_0',
+          'DWORD ftLastWriteTime_1',
+          'DWORD dwVolumeSerialNumber',
+          'DWORD nFileSizeHigh',
+          'DWORD nFileSizeLow',
+          'DWORD nNumberOfLinks',
+          'DWORD nFileIndexHigh',
+          'DWORD nFileIndexLow',
+        ]
+
+        extern 'BOOL CloseHandle(HANDLE)'
+        extern 'HANDLE CreateFileA(const char*, DWORD, DWORD, void*, DWORD, DWORD, HANDLE)'
+        extern 'DWORD GetFileAttributesA(const char*)'
+        extern 'BOOL GetFileInformationByHandle(HANDLE, BY_HANDLE_FILE_INFORMATION*)'
+        extern 'DWORD GetShortPathNameA(const char*, char*, DWORD)'
+
+        INVALID_HANDLE_VALUE  = Fiddle::Pointer[-1]
+      end # module Kernel32
+
+      module Kernel32
+        def self.get_file_attributes(path)
+
+          attributes = GetFileAttributesA(path)
+
+          (0xFFFFFFFF == attributes) ? 0 : attributes
+        end
 
-      private
-      GetFileAttributes           = Win32API.new('kernel32', 'GetFileAttributes', [ 'P' ], 'I')
-      GetFileInformationByHandle  = Win32API.new('kernel32', 'GetFileInformationByHandle', [ 'L', 'P' ], 'I')
-      GetShortPathName            = Win32API.new('kernel32', 'GetShortPathName', [ 'P', 'P', 'L' ], 'L')
-      CreateFile                  = Win32API.new('kernel32', 'CreateFile', [ 'P', 'L', 'L', 'L', 'L', 'L', 'L' ], 'L')
-      CloseHandle                 = Win32API.new('kernel32', 'CloseHandle', [ 'L' ], 'L')
-      FILE_ATTRIBUTE_READONLY     = 0x00000001
-      FILE_ATTRIBUTE_HIDDEN       = 0x00000002
-      FILE_ATTRIBUTE_SYSTEM       = 0x00000004
-      FILE_ATTRIBUTE_DIRECTORY    = 0x00000010
-      FILE_ATTRIBUTE_ARCHIVE      = 0x00000020
-      FILE_ATTRIBUTE_DEVICE       = 0x00000040
-      FILE_ATTRIBUTE_NORMAL       = 0x00000080
-      FILE_ATTRIBUTE_TEMPORARY    = 0x00000100
-      FILE_ATTRIBUTE_COMPRESSED   = 0x00000800
-      FILE_ATTRIBUTE_ENCRYPTED    = 0x00004000
+        def self.get_short_path_name(path)
 
-      OPEN_EXISTING               = 0x00000003
-      FILE_FLAG_OVERLAPPED        = 0x40000000
-      NULL                        = 0x00000000
-      INVALID_HANDLE_VALUE        = 0xFFFFFFFF
+          buff = ' ' * MAX_PATH
 
-      MAX_PATH                    = 260
+          buf = Fiddle::Pointer[buff]
 
-      BHFI_pack_string            = 'LQQQLLLLLL'
+          n = GetShortPathNameA(path, buf, buf.size)
 
-      # @!visibility private
-      class ByHandleInformation # :nodoc:
+          (0 == n) ? nil : buff[0...n]
+        end
 
-        # @!visibility private
-        def initialize(path) # :nodoc:
+        def self.get_stat_shared(path)
+
+          volume_id   = 0
+          file_index  = 0
+          num_links   = 0
 
-          @volume_id  = 0
-          @file_index = 0
-          @num_links  = 0
+          hFile = CreateFileA(path, 0, 0, NULL, OPEN_EXISTING, 0, NULL)
+
+          if INVALID_HANDLE_VALUE != hFile
+
+            begin
+              bhfi = BY_HANDLE_FILE_INFORMATION.malloc
+
+              if GetFileInformationByHandle(hFile, bhfi)
+
+                volume_id   = bhfi.dwVolumeSerialNumber
+                file_index  = (bhfi.nFileIndexHigh << 32) | bhfi.nFileIndexLow
+                num_links   = bhfi.nNumberOfLinks
+              end
+            ensure
+
+              CloseHandle(hFile)
+            end
+          end
+
+          [ volume_id, file_index, num_links ]
+        end
+      end # module Kernel32
+    else
+
+      module Kernel32
+
+        CloseHandle                 = Win32API.new('kernel32', 'CloseHandle', [ 'L' ], 'L')
+        CreateFile                  = Win32API.new('kernel32', 'CreateFile', [ 'P', 'L', 'L', 'L', 'L', 'L', 'L' ], 'L')
+        GetFileAttributes           = Win32API.new('kernel32', 'GetFileAttributes', [ 'P' ], 'I')
+        GetFileInformationByHandle  = Win32API.new('kernel32', 'GetFileInformationByHandle', [ 'L', 'P' ], 'I')
+        GetShortPathName            = Win32API.new('kernel32', 'GetShortPathName', [ 'P', 'P', 'L' ], 'L')
+
+        INVALID_HANDLE_VALUE        = -1
+
+        BHFI_pack_string            = 'LQQQLLLLLL'
+      end # module Kernel32
+
+      module Kernel32
+        def self.get_file_attributes(path)
+
+          attributes = GetFileAttributes.call(path)
+
+          (0xFFFFFFFF == attributes) ? 0 : attributes
+        end
+
+        def self.get_short_path_name(path)
+
+          buff = ' ' * MAX_PATH
+
+          n = GetShortPathName.call(path, buff, buff.length)
+
+          (0 == n) ? nil : buff[0...n]
+        end
+
+        def self.get_stat_shared(path)
+
+          volume_id   = 0
+          file_index  = 0
+          num_links   = 0
+
+          hFile = CreateFile.call(path, 0, 0, NULL, OPEN_EXISTING, 0, NULL)
 
-          # for some reason not forcing this new string causes 'can't modify frozen string (TypeError)' (in Ruby 1.8.x)
-          hFile = CreateFile.call("#{path}", 0, 0, NULL, OPEN_EXISTING, 0, NULL);
           if INVALID_HANDLE_VALUE != hFile
 
             begin
@@ -99,15 +196,43 @@ module Recls
 
                 bhfi = bhfi.unpack(BHFI_pack_string)
 
-                @volume_id  = bhfi[4]
-                @file_index = (bhfi[8] << 32) | bhfi[9]
-                @num_links  = bhfi[7]
-              else
+                volume_id   = bhfi[4]
+                file_index  = (bhfi[8] << 32) | bhfi[9]
+                num_links   = bhfi[7]
               end
             ensure
+
               CloseHandle.call(hFile)
             end
           end
+
+          [ volume_id, file_index, num_links ]
+        end
+      end # module Kernel32
+    end
+
+    # @!visibility private
+    class FileStat < File::Stat # :nodoc:
+
+      private
+      FILE_ATTRIBUTE_READONLY     = 0x00000001
+      FILE_ATTRIBUTE_HIDDEN       = 0x00000002
+      FILE_ATTRIBUTE_SYSTEM       = 0x00000004
+      FILE_ATTRIBUTE_DIRECTORY    = 0x00000010
+      FILE_ATTRIBUTE_ARCHIVE      = 0x00000020
+      FILE_ATTRIBUTE_DEVICE       = 0x00000040
+      FILE_ATTRIBUTE_NORMAL       = 0x00000080
+      FILE_ATTRIBUTE_TEMPORARY    = 0x00000100
+      FILE_ATTRIBUTE_COMPRESSED   = 0x00000800
+      FILE_ATTRIBUTE_ENCRYPTED    = 0x00004000
+
+      # @!visibility private
+      class ByHandleInformation # :nodoc:
+
+        # @!visibility private
+        def initialize(path) # :nodoc:
+
+          @volume_id, @file_index, @num_links = Kernel32.get_stat_shared(path)
         end
 
         # @!visibility private
@@ -129,27 +254,18 @@ module Recls
       # @!visibility private
       def initialize(path) # :nodoc:
 
-        @path = path
-
-        # for some reason not forcing this new string causes 'can't modify frozen string (TypeError)'
-        attributes = GetFileAttributes.call("#{path}")
+        path = path.to_str
 
-        if 0xffffffff == attributes
+        @path = path
 
-          @attributes = 0
-        else
-
-          @attributes = attributes
-        end
+        @attributes = Kernel32.get_file_attributes(path)
 
         super(path)
 
         @by_handle_information = ByHandleInformation.new(path)
 
-        buff = ' ' * MAX_PATH
-        # not forcing this new string causes 'can't modify frozen string (TypeError)'
-        n = GetShortPathName.call("#{path}", buff, buff.length)
-        @short_path = (0 == n) ? nil : buff[0...n]
+        @short_path = Kernel32.get_short_path_name(path)
+
       end
 
       public
@@ -165,7 +281,7 @@ module Recls
       # @!visibility private
       def hidden? # :nodoc:
 
-        0 != (FILE_ATTRIBUTE_HIDDEN & @attributes)
+        has_attribute_? FILE_ATTRIBUTE_HIDDEN
       end
 
       # Windows-specific attributes
@@ -215,7 +331,7 @@ module Recls
 
       public
       # @!visibility private
-      def FileStat.stat(path) # :nodoc:
+      def self.stat(path) # :nodoc:
 
         Recls::Ximpl::FileStat.new(path)
       end

data/test/unit/tc_recls_entry.rb

@@ -19,7 +19,7 @@ class Test_Recls_entry < Test::Unit::TestCase
 
   def setup
 
-    @cwd = Dir.pwd
+    @cwd = Dir.pwd.freeze
   end
 
   def test_entry_does_not_mark_directory
@@ -51,5 +51,22 @@ class Test_Recls_entry < Test::Unit::TestCase
 
     assert_not_equal cwd.object_id, cwd2.object_id
   end
+
+  if Recls.windows?
+
+    def test_entry_file_short_name
+
+      cwd = Recls.stat @cwd
+
+      if cwd.file_short_name
+
+        if cwd.file_full_name != cwd.file_short_name
+
+          assert cwd.file_short_name =~ /^.{0,8}\..{0,3}$/, "'#{cwd.file_short_name}' does not match expected 8.3 form"
+          assert_equal cwd.file_short_name.upcase, cwd.file_short_name, "'#{cwd.file_short_name}' is not uppercase as expected"
+        end
+      end
+    end
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recls-ruby
 version: !ruby/object:Gem::Version
-  version: 2.13.0.1
+  version: 2.13.1
 platform: ruby
 authors:
 - Matt Wilson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-21 00:00:00.000000000 Z
+date: 2024-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xqsr3
@@ -26,7 +26,7 @@ dependencies:
         version: '0.31'
 description: 'RECursive LS for Ruby
 
-'
+  '
 email: matthew@synesis.com.au
 executables: []
 extensions: []
@@ -83,7 +83,7 @@ homepage: http://github.com/synesissoftware/recls.Ruby
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,8 +98,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: recls.Ruby
 test_files: []