win32-file 0.5.3

data/CHANGES

@@ -0,0 +1,126 @@
+== 0.5.3 - 2-Nov-2006
+* Added the File.lstat method.  It's abscence caused problems for cross
+  platform packages (such as the 'find' module) which were expecting a result
+  for File.lstat.  Thanks go to "Oliver" (python152) from the mailing list
+  for the spot.
+
+== 0.5.2 - 12-May-2006
+* Added explicit File.stat and File#stat methods to ensure that the File::Stat
+  object returned is the one defined in the win32-file-stat package.
+
+== 0.5.1 - 27-Apr-2006
+* Added the File.content_indexed? alias for File.indexed?
+* Added the corresponding File::CONTENT_INDEXED constant alias.
+* Fixed an issue with the Windows::Error module not being extended the way
+  it should have been.
+* Updated the ts_all.rb file to actually include *all* the tests.
+
+== 0.5.0 - 22-Apr-2006
+* Replaced C version with pure Ruby version.
+* Added a gem.
+* Requires the win32-file-stat package.  Some methods are just a facade for
+  File::Stat methods.
+* Removed the native IO methods and related attributes - nread, nwrite, flags,
+  creation_mode, share_mode, access_mode.  These will be moved into their own
+  package (win32-io) eventually.
+* The File.get_permissions method now takes an optional hostname as the second
+  argument.  If it isn't provided, it defaults to localhost.
+* The File.set_attr method was renamed to File.set_attributes (though an alias
+  has been provided for backwards compatibility). 
+* The File.unset_attr method was renamed to File.remove_attributes.  Again, an
+  alias was created for backwards compatibility.
+* The File.content_indexed? method is now just File.indexed?  Likewise, the
+  File::CONTENT_INDEXED constant is now just File::INDEXED.
+
+== 0.4.6 - 20-Nov-2005
+* Fixed potential segfaults caused by passing invalid types.  This affects
+  most methods.
+* Added more tests to look for explicit TypeError's.
+
+== 0.4.5 - 17-Sep-2005
+* Fixed bug in File.basename and File.dirname where receiver was being
+  modified.
+* Overrode the File.split method to handle UNC paths properly.
+* More tests.
+
+== 0.4.4 - 20-Aug-2005
+* Fixed some bugs in the File.basename method.
+* Added more tests for the File.basename method.
+
+== 0.4.3 - 25-May-2005
+* Added custom versions of File.basename and File.dirname so that they work
+  with UNC paths correctly.  This requires linking against libshlwapi, which
+  was added in the extconf.rb file.
+* Better Unicode support (I think).
+* Added some safe string handling.
+* Tests added for File.basename and File.dirname.
+* Removed the file.rd file.  You can run rdoc over the file.txt file to
+  generate html documentation if you wish.
+
+== 0.4.2 - 1-Feb-2005
+* Added a macro check for EncryptFile(), which turns out to only be supported
+  on Windows 2000 or later.  Thanks go to Takaaki Tateishi for the spot.
+
+== 0.4.1 - 30-Nov-2004
+* Added working implementations for File.blockdev? and File.chardev?
+* Corresponding test suite and doc additions.
+* Corrected the release date for 0.4.0.
+
+== 0.4.0 - 26-Nov-2004
+* Added the File.nopen class method, and File#nread and File#nwrite instance
+  methods.  These are wrappers for Window's native methods.  See documentation
+  for more details.  Also see some examples in the 'examples' directory.
+* Added my own implementation of File.size, because the current version is not
+  64 bit aware (i.e. does not return correct values for sizes over 2 GB).  I
+  will remove this once Ruby has been updated.
+* Modified File#path to use GetFullPathName() internally if Ruby's own
+  File#path method fails.  This was mostly done for internal usage, but it
+  has the effect of making File#path a little more robust on Windows I think.
+
+== 0.3.0 - 10-Nov-2004
+* Added the archive=, hidden=, normal=, compressed=, content_indexed=,
+  offline=, readonly=, sparse=, system=, and temporary= instance methods.
+* Changed set_permission to set_permissions, and get_permission to
+  get_permissions, respectively.
+* Moved the examples directory to the toplevel directory.
+* Added and/or modified some files to be rdoc friendly.
+* Documentation and test suite updates.
+
+== 0.2.2 - 17-Aug-2004
+* Added the encrypt() and decrypt() class methods.  These are wrappers
+  for the EncryptFile() and DecryptFile() Win32 functions.
+* Corresponding test suite and documentation additions.
+* Added a crypt and decrypt test example, crypt_test.rb, under doc/examples.
+
+== 0.2.1 - 10-Aug-2004
+* Replaced all occurrences of the deprecated STR2CSTR() function with
+  StringValuePtr().  That means that, as of this release, this package
+  requires Ruby 1.8.0 or later.
+* Added the long_path method (may not be supported on NT).
+* Documentation and test suite additions
+* Some code cleanup and reorganization.
+* Moved sample scripts to doc/examples.
+* Removed the file.html file from the doc directory.  You can generate the
+  html documentation with rd2 if you like.
+
+== 0.2.0 - 8-May-2004
+* Removed the toplevel Win32 module/namespace (except for the require line).
+  I felt that having to put "Win32::" in front of all the methods was too
+  painful.
+* Added the CACLS attribute getter and setter (Park).
+* Updated docs to reflect changes, added warranty information.
+* Moved the pure ruby version to its own directory.  In lieu of the installer
+  now available for our packages, this version is no longer guaranteed to be
+  maintained, but I'll leave it in the package for now.
+
+== 0.1.1 - 3-Nov-2003
+* Added the content_indexed? method
+* Added the set_attr and unset_attr methods
+* Added constants that apply to set_attr and unset_attr
+* Replaced GetFileAttributesEx() with the simpler GetFileAttributes().
+  The former provides no additional information that isn't already covered by File::Stat.
+* Test suite additions
+* Documentation additions
+
+== 0.1.0 - 29-Oct-2003
+* Initial release

data/MANIFEST

@@ -0,0 +1,16 @@
+CHANGES
+MANIFEST
+README
+install.rb
+win32-file.gemspec
+
+lib/win32/file.rb
+
+test/sometestfile.txt
+test/tc_file_attributes.rb
+test/tc_file_constants.rb
+test/tc_file_encryption.rb
+test/tc_file_path.rb
+test/tc_file_security.rb
+test/tc_file_stat.rb
+test/ts_all.rb

data/README

@@ -0,0 +1,98 @@
+= Description
+Extra or redefined methods for the File class on MS Windows.
+
+= Prerequisites
+Ruby 1.8.0 or later
+windows-pr 0.3.0 or later
+win32-file-stat 1.2.0 or later
+
+= Installation
+== Manual install
+ruby test/ts_all.rb # optional
+ruby install.rb
+== Gem Install
+ruby win32-file.gemspec
+gem install win32-file-X.Y.Z-mswin32.gem
+
+= Synopsis
+require 'win32/file'
+
+p File.hidden?(somefile)
+p File.attributes(somefile)
+
+File.open(somefile){ |fh|
+   fh.hidden = true
+}
+
+= Class methods added - see documentation for details
+* File.attributes
+* File.archive?
+* File.compressed?
+* File.decrypt
+* File.encrypt
+* File.encrypted?
+* File.get_permissions
+* File.hidden?
+* File.indexed?
+* File.longpath
+* File.normal?
+* File.offline?
+* File.readonly?
+* File.remove_attributes
+* File.reparse_point?
+* File.securities
+* File.set_attributes
+* File.set_permissions
+* File.shortpath
+* File.sparse?
+* File.system?
+* File.temporary?
+
+= Instance methods added - see documentation for details
+* File#archive=
+* File#compressed=
+* File#hidden=
+* File#indexed=
+* File#normal=
+* File#offline=
+* File#readonly=
+* File#sparse=
+* File#system=
+* File#temporary=
+
+= Class methods redefined
+* File.basename  # UNC path issues
+* File.blksize   # Wasn't implemented
+* File.blockdev? # Wasn't implemented
+* File.chardev?  # Wasn't implemented
+* File.dirname   # UNC path issues
+* File.size      # 2GB limitation
+* File.split     # UNC path issues
+
+= Notes about the test suite
+For all the unit tests to pass, the 'sometestfile.txt' file must have the
+'archive' and 'readonly' attributes set.  Although I have them set on the
+file when I create the zip archive, it seems that file attributes aren't
+guaranteed to survive the process. 
+
+So, please change the file attributes manually if needed before running the
+test suite.  You can do this by right-clicking on the file in Explorer and
+selecting 'properties'.  The readonly attribute check-box is at the bottom
+left corner.  To get to the archive attribute click on the 'Advanced' tab.
+You should see a checkbox at the top.
+
+= Known issues or bugs
+None that I'm aware of. Please report any bugs you find on the project page
+at http://www.rubyforge.org/projects/win32utils.
+
+= License
+Ruby's
+
+= 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

data/install.rb

@@ -0,0 +1,11 @@
+# For those who don't like gems...
+require 'rbconfig'
+require 'ftools'
+include Config
+
+sitelibdir = CONFIG['sitelibdir']
+installdir = sitelibdir + '/win32'
+file = 'lib\win32\file.rb'
+
+Dir.mkdir(installdir) unless File.exists?(installdir)
+File.copy(file, installdir, true)