win32-dir 0.4.7 → 0.7.2

data/lib/win32/dir/constants.rb

@@ -1,4 +1,4 @@
-require 'ffi'
+require "ffi" unless defined?(FFI)
 
 module Dir::Constants
   include FFI::Library
@@ -18,6 +18,9 @@ module Dir::Constants
   SHGFI_DISPLAYNAME            = 0x000000200
   SHGFI_PIDL                   = 0x000000008
 
-  INVALID_HANDLE_VALUE    = FFI::Pointer.new(-1).address
-  INVALID_FILE_ATTRIBUTES = FFI::Pointer.new(-1).address
+  # ((DWORD)-1)
+  INVALID_FILE_ATTRIBUTES = 0xFFFFFFFF
+
+  # ((HANDLE)-1)
+  INVALID_HANDLE_VALUE = FFI::Pointer.new(-1).address
 end

data/lib/win32/dir/functions.rb

@@ -1,10 +1,10 @@
 # Necessary to force JRuby to use the gem, not its builtin version
-if RUBY_PLATFORM == 'java'
-  require 'rubygems'
-  gem 'ffi'
+if RUBY_PLATFORM == "java"
+  require "rubygems" unless defined?(Gem)
+  gem "ffi"
 end
 
-require 'ffi'
+require "ffi" unless defined?(FFI)
 
 module Dir::Functions
   module FFI::Library
@@ -25,9 +25,9 @@ module Dir::Functions
   ffi_lib :shell32
   ffi_convention :stdcall
 
-  attach_pfunc :SHGetFolderPathW, [:hwnd, :int, :handle, :dword, :buffer_out], :dword
-  attach_pfunc :SHGetFolderLocation, [:hwnd, :int, :handle, :dword, :ptr], :dword
-  attach_pfunc :SHGetFileInfo, [:dword, :dword, :ptr, :uint, :uint], :dword
+  attach_pfunc :SHGetFolderPathW, %i{hwnd int handle dword buffer_out}, :dword
+  attach_pfunc :SHGetFolderLocation, %i{hwnd int handle dword ptr}, :dword
+  attach_pfunc :SHGetFileInfo, %i{uint64 dword ptr uint uint}, :dword
 
   ffi_lib :shlwapi
   ffi_convention :stdcall
@@ -38,15 +38,15 @@ module Dir::Functions
   ffi_convention :stdcall
 
   attach_pfunc :CloseHandle, [:handle], :bool
-  attach_pfunc :CreateDirectoryW, [:buffer_in, :ptr], :bool
-  attach_pfunc :CreateFileW, [:buffer_in, :dword, :dword, :ptr, :dword, :dword, :handle], :handle
-  attach_pfunc :DeviceIoControl, [:handle, :dword, :ptr, :dword, :ptr, :dword, :ptr, :ptr], :bool
-  attach_pfunc :GetCurrentDirectoryW, [:dword, :buffer_out], :dword
+  attach_pfunc :CreateDirectoryW, %i{buffer_in ptr}, :bool
+  attach_pfunc :CreateFileW, %i{buffer_in dword dword ptr dword dword handle}, :handle
+  attach_pfunc :DeviceIoControl, %i{handle dword ptr dword ptr dword ptr ptr}, :bool
+  attach_pfunc :GetCurrentDirectoryW, %i{dword buffer_out}, :dword
   attach_pfunc :GetFileAttributesW, [:buffer_in], :dword
   attach_pfunc :GetLastError, [], :dword
-  attach_pfunc :GetShortPathNameW, [:buffer_in, :buffer_out, :dword], :dword
-  attach_pfunc :GetLongPathNameW, [:buffer_in, :buffer_out, :dword], :dword
-  attach_pfunc :GetFullPathNameW, [:buffer_in, :dword, :buffer_out, :ptr], :dword
+  attach_pfunc :GetShortPathNameW, %i{buffer_in buffer_out dword}, :dword
+  attach_pfunc :GetLongPathNameW, %i{buffer_in buffer_out dword}, :dword
+  attach_pfunc :GetFullPathNameW, %i{buffer_in dword buffer_out ptr}, :dword
   attach_pfunc :RemoveDirectoryW, [:buffer_in], :bool
 end
 
@@ -54,13 +54,13 @@ class String
   # Convenience method for converting strings to UTF-16LE for wide character
   # functions that require it.
   def wincode
-    (self.tr(File::SEPARATOR, File::ALT_SEPARATOR) + 0.chr).encode('UTF-16LE')
+    (tr(File::SEPARATOR, File::ALT_SEPARATOR) + 0.chr).encode("UTF-16LE")
   end
 
   # Read a wide character string up until the first double null, and delete
   # any remaining null characters.
   def wstrip
-    self.force_encoding('UTF-16LE').encode('UTF-8',:invalid=>:replace,:undef=>:replace).
-    split("\x00")[0].encode(Encoding.default_external)
+    force_encoding("UTF-16LE").encode("UTF-8", invalid: :replace, undef: :replace)
+      .split("\x00")[0].encode(Encoding.default_external)
   end
 end

data/lib/win32/dir/structs.rb

@@ -1,4 +1,4 @@
-require 'ffi'
+require "ffi" unless defined?(FFI)
 
 module Dir::Structs
   extend FFI::Library

data/lib/win32/dir/version.rb

@@ -0,0 +1,6 @@
+module Win32
+  class Dir
+    # The version of the win32-taskscheduler library
+    VERSION = "0.7.2".freeze
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32-dir
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.7.2
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -9,50 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-26 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.4.0
 description: |2
       The win32-dir library provides extra methods and constants for the
       builtin Dir class. The constants provide a convenient way to identify
@@ -62,23 +34,15 @@ description: |2
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- CHANGES
-- MANIFEST
+extra_rdoc_files: []
 files:
-- CHANGES
-- MANIFEST
-- README
-- Rakefile
-- examples/dir_example.rb
+- lib/win32-dir.rb
 - lib/win32/dir.rb
 - lib/win32/dir/constants.rb
 - lib/win32/dir/functions.rb
 - lib/win32/dir/structs.rb
-- test/test_win32_dir.rb
-- win32-dir.gemspec
-homepage: http://github.com/djberg96/win32-dir
+- lib/win32/dir/version.rb
+homepage: https://github.com/chef/win32-dir
 licenses:
 - Artistic 2.0
 metadata: {}
@@ -88,19 +52,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: win32utils
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Extra constants and methods for the Dir class on Windows.
-test_files:
-- test/test_win32_dir.rb
+test_files: []

data/CHANGES

@@ -1,98 +0,0 @@
-== 0.4.7 - 26-Apr-2014
-* All arguments to methods are now interpolated so that they'll use whatever 
-  to_str implemenation the argument provides instead of assuming String
-  arguments. This change was made because it turns out that at least some
-  of the overridden methods in MRI accept Pathname objects. Thanks go to
-  Josh Cooper/Puppet Labs for the spot.
-* Refactored the Dir.getwd method to use bonafide FFI buffers instead of
-  naked Ruby char buffers.
-* Internally various functions now fail in the event that the resulting
-  paths would exceed their buffers.
-
-== 0.4.6 - 21-Oct-2013
-* Fixed the INVALID_HANDLE_VALUE and INVALID_FILE_ATTRIBUTES constants for
-  64-bit versions of Ruby.
-* Added Rake as a development dependency.
-
-== 0.4.5 - 23-Sep-2013
-* Yet another encoding fix, this time one that affected JRuby.
-* Fixed the Dir[] and Dir.glob methods so they match the spec. Thanks go
-  to Chris Westbrook for the spot.
-
-== 0.4.4 - 22-Sep-2013
-* Yet another encoding fix. Thanks go to Rob Reynolds for the patch.
-
-== 0.4.3 - 24-Jul-2013
-* Changed the Dir.read_junction and CSIDL constant strings so that they
-  use the default external encoding instead of UTF-16LE. This means that
-  they will now work with methods like File.join. Thanks go to Josh Cooper
-  for the patches.
-* Some changes for internal handling of making FFI functions private.
-* Updated gem:create task for rubygems 2.
-
-== 0.4.2 - 8-Apr-2013
-* Fixed the HANDLE function prototypes in the underlying FFI code and added
-  some custom typedefs for convenience. This affects 64 bit Ruby code.
-
-== 0.4.1 - 2-Oct-2012
-* Added the Dir.read_junction method. Thanks go to Gabriel Wilkins for the patch.
-
-== 0.4.0 - 29-Jun-2012
-* Conversion to FFI. Should work with JRuby now.
-* If current versions of Dir::XXX constant values cannot be found
-  then default values are tried.
-* Now requires Ruby 1.9 or later.
-
-== 0.3.7 - 18-Jul-2010
-* Modified Dir.glob and Dir[] to handle backslashes in path names.
-* Added tests for the modified Dir.glob and Dir[] behavior.
-* Removed the old non-gem install Rake task.
-
-== 0.3.6 - 6-Feb-2010
-* Bug fixes for Ruby 1.9.x. Thanks go to Kendall Gifford for the spot and
-  the patch.
-* Minor refactoring of the Dir.create_junction method. This fixed a bug for
-  Ruby 1.9.x, but was also a little cleaner in general.
-* Some Rakefile task and gemspec updates.
-
-== 0.3.5 - 6-Aug-2009
-* Changed the license to Artistic 2.0.
-* Updated the gemspec, including the addition of a license attribute and
-  test-unit as a development dependency.
-
-== 0.3.4 - 5-May-2009
-* Redefined the Dir.getwd (and the Dir.pwd alias) to always return a
-  normalized path.
-* Some gemspec updates.
-
-== 0.3.3 - 30-Mar-2009
-* Virtual folders like Dir::CONTROL, which were previously almost always nil,
-  are now set to their display name.
-* Fixed a bug in the create_junction method.
-* Added an 'example' rake task to run the example code.
-* Renamed the example program from dir_test.rb to dir_example.rb to prevent
-  any potential confusion that it's a genuine test file.
-
-== 0.3.2 - 25-Jul-2007
-* Added a Rakefile with tasks for testing and installation.
-* Removed the install.rb file (the Rakefile handles installation).
-* Minor updates the README, MANIFEST, and test file.
-
-== 0.3.1 - 16-Oct-2006
-* Added the Dir.empty? method.
-* Changed the Dir.reparse_dir? method to Dir.junction? (but kept an alias
-  for backwards compatibility).
-* Added rdoc for Dir.junction? (oops).
-* Some test tweaks and additions.
-
-== 0.3.0 - 28-May-2006
-* Now pure Ruby.
-* Now has a gem.
-* Added a VERSION constant.
-
-== 0.2.0 - 27-Jun-2005
-* Added the Dir.create_junction and Dir.reparse_dir? methods.
-* Added corresponding tests and documentation.
-
-== 0.1.0 - 25-Feb-2005
-* Initial release

data/MANIFEST

@@ -1,8 +0,0 @@
-* README
-* MANIFEST
-* CHANGES
-* Rakefile
-* win32-dir.gemspec
-* examples/dir_example.rb
-* lib/win32/dir.rb
-* test/test_win32_dir.rb

data/README

@@ -1,273 +0,0 @@
-= Description
-  A series of extra constants for the Dir class that define special folders
-  on MS Windows systems, as well as methods for creating and detecting
-  junctions, i.e. symlinks for directories.
-
-= Installation
-  gem install win32-dir
-
-= Synopsis
-  require 'win32/dir'
-	
-  # C:\WINNT or C:\WINDOWS
-  puts Dir::WINDOWS
-
-  # C:\Documents and Settings\Daniel\Start Menu\Programs\Administrative Tools	 
-  puts Dir::ADMINTOOLS
-	
-  Dir.mkdir('C:\from')
-  Dir.create_junction('C:\to', 'C:\from')
-
-= Constants
-  Not all of these are guaranteed to be defined on your system. Also note
-  that the directories are merely defined. It doesn't necessarily mean they
-  actually exist.
-	
-== The following constants should be defined:	
-Dir::ADMINTOOLS
-  The file system directory that is used to store administrative tools for an
-  individual user. The Microsoft Management Console (MMC) will save
-  customized consoles to this directory, and it will roam with the user.
-
-Dir::COMMON_ADMINTOOLS
-  The file system directory containing administrative tools for all users
-  of the computer.
-	
-Dir::APPDATA
-  The file system directory that serves as a common repository for
-  application-specific data. A typical path is
-  C:\Documents and Settings\<user>\Application Data.
-   
-  This CSIDL is supported by the redistributable shfolder.dll for
-  systems that do not have the Microsoft Internet Explorer 4.0
-  integrated Shell installed.
-	
-Dir::COMMON_APPDATA
-  The file system directory containing application data for all users. A
-  typical path is C:\Documents and Settings\All Users\Application Data.
-	
-Dir::COMMON_DOCUMENTS
-  The file system directory that contains documents that are common to all
-  users. A typical paths is C:\Documents and Settings\All Users\Documents.
-	
-Dir::COOKIES
-  The file system directory that serves as a common repository for Internet
-  cookies. A typical path is C:\Documents and Settings\<user>\Cookies.
-
-Dir::HISTORY
-  The file system directory that serves as a common repository for Internet
-  history items.
-
-Dir::INTERNET_CACHE
-  The file system directory that serves as a common repository for temporary
-  Internet files. A typical path is
-  C:\Documents and Settings\<user>\Local Settings\Temporary Internet Files.
-
-Dir::LOCAL_APPDATA
-  The file system directory that serves as a data repository for local
-  (nonroaming) applications. A typical path is
-  C:\Documents and Settings\<user>\Local Settings\Application Data.
-
-Dir::MYPICTURES
-  The file system directory that serves as a common repository for image
-  files. A typical path is
-  C:\Documents and Settings\<user>\My Documents\My Pictures.
-	
-Dir::PERSONAL
-  The virtual folder representing the My Documents desktop item. This is
-  equivalent to Dir::MYDOCUMENTS.
-
-Dir::PROGRAM_FILES
-  The Program Files folder. A typical path is C:\Program Files.
-	
-Dir::PROGRAM_FILES_COMMON
-  A folder for components that are shared across applications. A typical path
-  is C:\Program Files\Common.
-	
-Dir::SYSTEM
-  The Windows System folder. A typical path is C:\Windows\System32.
-	
-Dir::WINDOWS
-  The Windows directory or SYSROOT. This corresponds to the %windir% or
-  %SYSTEMROOT% environment variables. A typical path is C:\Windows.
-	 
-== The following constants may or may not be defined:
-Dir::ALTSTARTUP
-  The file system directory that corresponds to the user's nonlocalized
-  Startup program group.
-	
-Dir::BITBUCKET
-  The virtual folder containing the objects in the user's Recycle Bin.
-	
-Dir::CDBURN_AREA
-  The file system directory acting as a staging area for files waiting to
-  be written to CD.
-
-Dir::COMMON_ALTSTARTUP
-  The file system directory that corresponds to the nonlocalized Startup
-  program group for all users.
-
-Dir::COMMON_DESKTOPDIRECTORY
-  The file system directory that contains files and folders that appear on
-  the desktop for all users. A typical path is
-  C:\Documents and Settings\All Users\Desktop.
-
-Dir::COMMON_FAVORITES
-  The file system directory that serves as a common repository for favorite
-  items common to all users.
-
-Dir::COMMON_MUSIC
-  The file system directory that serves as a repository for music files
-  common to all users.
-
-Dir::COMMON_PICTURES
-  The file system directory that serves as a repository for image files
-  common to all users.
-
-Dir::COMMON_PROGRAMS
-  The file system directory that contains the directories for the common
-  program groups that appear on the Start menu for all users. 
-
-Dir::COMMON_STARTMENU
-  The file system directory that contains the programs and folders that
-  appear on the Start menu for all users.
-
-Dir::COMMON_STARTUP
-  The file system directory that contains the programs that appear in the
-  Startup folder for all users.
-
-Dir::COMMON_TEMPLATES
-  The file system directory that contains the templates that are available
-  to all users.
-
-Dir::COMMON_VIDEO
-  The file system directory that serves as a repository for video files
-  common to all users.
-
-Dir::CONTROLS
-  The virtual folder containing icons for the Control Panel applications.
-
-Dir::DESKTOP
-  The virtual folder representing the Windows desktop, the root of the
-  namespace.
-
-Dir::DESKTOPDIRECTORY
-  The file system directory used to physically store file objects on the
-  desktop (not to be confused with the desktop folder itself).
-
-Dir::DRIVES
-  The virtual folder representing My Computer, containing everything on
-  the local computer: storage devices, printers, and Control Panel. The
-  folder may also contain mapped network drives.
-
-Dir::FAVORITES
-  The file system directory that serves as a common repository for the
-  user's favorite items.
-
-Dir::FONTS
-  A virtual folder containing fonts.
-	
-Dir::INTERNET
-  A virtual folder representing the Internet.
-
-Dir::MYDOCUMENTS
-  The virtual folder representing the My Documents desktop item.  See also
-  Dir::PERSONAL.
-
-Dir::MYMUSIC
-  The file system directory that serves as a common repository for music files.
-
-Dir::MYVIDEO
-  The file system directory that serves as a common repository for video files.
-
-Dir::NETHOOD
-  A file system directory containing the link objects that may exist in the
-  My Network Places virtual folder. It is not the same as Dir::NETWORK, which
-  represents the network namespace root.
-
-Dir::NETWORK
-  A virtual folder representing Network Neighborhood, the root of the network
-  namespace hierarchy.
-
-Dir::PRINTERS
-  The virtual folder containing installed printers.
-
-Dir::PRINTHOOD
-  The file system directory that contains the link objects that can exist in
-  the "Printers" virtual folder.
-
-Dir::PROFILE
-  The user's profile folder.
-
-Dir::PROFILES
-  The file system directory containing user profile folders.
-
-Dir::PROGRAMS
-  The file system directory that contains the user's program groups (which
-  are themselves file system directories).
-
-Dir::RECENT
-  The file system directory that contains shortcuts to the user's most
-  recently used documents.
-
-Dir::SENDTO
-  The file system directory that contains Send To menu items.
-
-Dir::STARTMENU
-  The file system directory containing Start menu items.
-
-Dir::STARTUP
-  The file system directory that corresponds to the user's Startup program
-  group.
-
-Dir::TEMPLATES
-  The file system directory that serves as a common repository for document
-  templates.
-
-== Developer's Notes
-  The SHGetFolderPath() documentation on MSDN is somewhat vague about which
-  CSIDL constants are guaranteed to be defined.  However, there are 15 which
-  *should* be defined (see docs above). The rest I cannot vouch for.
-   
-  Some of these folders are virtual, and the value will be the display name
-  only instead of an actual path.
-	
-== Known Bugs
-  The Dir.create_junction and Dir.read_junction methods do not work with JRuby.
-
-  Please log any bug reports on the project page at
-  http://www.github.com/djberg96/win32-dir
-
-== Future Plans
-  Suggestions welcome.
-
-== Acknowledgements
-  Shashank Date and Zach Dennis for the suggestion and supporting comments
-  on the mailing list.
-	
-  Timothy Byrd and Autrijus Tang for help (directly or indirectly) with the
-  junction methods. Timothy provided a pure Ruby version of the junction
-  code that I later borrowed from.
-	
-  Most of the documentation was copied from the MSDN web site.
-
-== License
-  Artistic 2.0
-
-== Contributions
-  Although this library is free, please consider having your company
-  setup a gittip if used by your company professionally.
-
-  http://www.gittip.com/djberg96/
-    
-== Copyright
-  (C) 2003-2014 Daniel J. Berger, All Rights Reserved
-    
-== Warranty
-  This package 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.
-    
-== Authors
-  Daniel J. Berger
-  Park Heesob