win32-file 0.6.1 → 0.6.2

data/CHANGES

@@ -1,6 +1,13 @@
+== 0.6.2 - 21-Aug-2009
+* Changed the license to Artistic 2.0.
+* Several gemspec updates, including the license and description.
+* Refactored the File.attributes method so that it isn't making a bunch
+  of calls to File::Stat.
+* Some documentation updates.
+
 == 0.6.1 - 9-Feb-2009
 * Fixed a bug in the custom File.directory? method with regards to
-  non-existent directories.
+  non-existent directories. Thanks go to Montgomery Kosma for the spot.
 
 == 0.6.0 - 14-Nov-2008
 * Converted methods to use wide character handling.

data/README

@@ -1,16 +1,18 @@
-= Description
+== Description
 Extra or redefined methods for the File class on MS Windows.
 
-= Prerequisites
+== Prerequisites
 * Ruby 1.8.0 or later
 * windows-pr 0.3.0 or later
 * win32-file-stat 1.2.0 or later
 
-= Installation
-   rake test (optional)
-   rake install (standard) or rake install_gem (rubygems)
+== Installation
+=== Gem installation
+   gem install win32-file
+=== Local installation
+   rake install
 
-= Synopsis
+== Synopsis
    require 'win32/file'
 
    p File.hidden?(somefile)
@@ -20,7 +22,7 @@ Extra or redefined methods for the File class on MS Windows.
       fh.hidden = true
    }
 
-= Class methods added - see documentation for details
+== Class methods added - see documentation for details
 * File.attributes
 * File.archive?
 * File.compressed?
@@ -44,7 +46,7 @@ Extra or redefined methods for the File class on MS Windows.
 * File.system?
 * File.temporary?
 
-= Instance methods added - see documentation for details
+== Instance methods added - see documentation for details
 * File#archive=
 * File#compressed=
 * File#hidden=
@@ -56,7 +58,7 @@ Extra or redefined methods for the File class on MS Windows.
 * File#system=
 * File#temporary=
 
-= Class methods redefined
+== Class methods redefined and the reason for redefining them
 * File.basename  # UNC path issues
 * File.blksize   # Wasn't implemented
 * File.blockdev? # Wasn't implemented
@@ -65,30 +67,21 @@ Extra or redefined methods for the File class on MS Windows.
 * 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
+== 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
+== License
+Artistic 2.0
+
+== Copyright
+(C) 2003-2009, Daniel J. Berger, All Rights Reserved
 
-= Warranty
+== 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
+== Authors
 * Daniel J. Berger
 * Park Heesob

data/lib/win32/file.rb

@@ -19,31 +19,63 @@ class File
    extend Windows::Handle
    
    # The version of the win32-file library
-   WIN32_FILE_VERSION  = '0.6.1'
+   WIN32_FILE_VERSION  = '0.6.2'
 
    # Abbreviated attribute constants for convenience
 
-   ARCHIVE    = FILE_ATTRIBUTE_ARCHIVE
+   # The file or directory is an archive. Typically used to mark files for
+   # backup or removal.
+   ARCHIVE = FILE_ATTRIBUTE_ARCHIVE
+
+   # The file or directory is encrypted. For a file, this means that all
+   # data in the file is encrypted. For a directory, this means that
+   # encryption is # the default for newly created files and subdirectories.
    COMPRESSED = FILE_ATTRIBUTE_COMPRESSED
-   HIDDEN     = FILE_ATTRIBUTE_HIDDEN
-   NORMAL     = FILE_ATTRIBUTE_NORMAL
-   OFFLINE    = FILE_ATTRIBUTE_OFFLINE
-   READONLY   = FILE_ATTRIBUTE_READONLY
-   SYSTEM     = FILE_ATTRIBUTE_SYSTEM
-   TEMPORARY  = FILE_ATTRIBUTE_TEMPORARY
-   INDEXED    = 0x0002000
-   CONTENT_INDEXED = 0x0002000
+
+   # The file is hidden. Not included in an ordinary directory listing.
+   HIDDEN = FILE_ATTRIBUTE_HIDDEN
+
+   # A file that does not have any other attributes set.
+   NORMAL = FILE_ATTRIBUTE_NORMAL
+
+   # The data of a file is not immediately available. This attribute indicates
+   # that file data is physically moved to offline storage.
+   OFFLINE = FILE_ATTRIBUTE_OFFLINE
+
+   # The file is read only. Apps can read it, but not write to it or delete it.
+   READONLY = FILE_ATTRIBUTE_READONLY
+
+   # The file is part of or used exclusively by an operating system.
+   SYSTEM = FILE_ATTRIBUTE_SYSTEM
+
+   # The file is being used for temporary storage.
+   TEMPORARY = FILE_ATTRIBUTE_TEMPORARY
+
+   # The file or directory is to be indexed by the content indexing service.
+   # Note that we have inverted the traditional definition.
+   INDEXED = 0x0002000
+
+   # Synonym for File::INDEXED.
+   CONTENT_INDEXED = INDEXED
 
    # Custom Security rights  
 
+   # Full security rights - read, write, append, execute, and delete.
    FULL = STANDARD_RIGHTS_ALL | FILE_READ_DATA | FILE_WRITE_DATA |
       FILE_APPEND_DATA | FILE_READ_EA | FILE_WRITE_EA | FILE_EXECUTE |
       FILE_DELETE_CHILD | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES
 
+   # Generic write, generic read, execute and delete privileges
    CHANGE = FILE_GENERIC_WRITE | FILE_GENERIC_READ | FILE_EXECUTE | DELETE
-   READ   = FILE_GENERIC_READ | FILE_EXECUTE
-   ADD    = 0x001201bf
-   
+
+   # Read and execute privileges
+   READ = FILE_GENERIC_READ | FILE_EXECUTE
+
+   # Add privileges
+   ADD = 0x001201bf
+
+   # :stopdoc:
+
    SECURITY_RIGHTS = {
       'FULL'    => FULL,
       'DELETE'  => DELETE, 
@@ -52,9 +84,14 @@ class File
       'ADD'     => ADD
    }
 
+   # :startdoc: 
+
    ### Class Methods
 
    class << self
+
+      # :stopdoc:
+
       # Strictly for making this code -w clean. They are removed later.
       alias basename_orig basename
       alias blockdev_orig blockdev?
@@ -69,11 +106,13 @@ class File
       alias symlink_orig symlink
       alias symlink_orig? symlink?
 
+      # :startdoc:
+
       ## Security
       
       # Sets the file permissions for the given file name.  The 'permissions'
       # argument is a hash with an account name as the key, and the various
-      # permission constants as possible values.  The possible constant values
+      # permission constants as possible values. The possible constant values
       # are:
       #
       # * FILE_READ_DATA
@@ -370,8 +409,6 @@ class File
       # Requires exclusive access to the file being encrypted, and will fail if
       # another process is using the file.  If the file is compressed,
       # EncryptFile will decompress the file before encrypting it.
-      # 
-      # Windows 2000 or later only.
       #
       def encrypt(file)
          unless EncryptFileW(multi_to_wide(file))
@@ -796,27 +833,27 @@ class File
    # temporary
    #
    def self.attributes(file)
-      file = multi_to_wide(file)
-      attributes = GetFileAttributesW(file)
-      arr = []
+      attributes = GetFileAttributesW(multi_to_wide(file))
       
       if attributes == INVALID_FILE_ATTRIBUTES
          raise ArgumentError, get_last_error
       end
-      
-      arr.push('archive') if archive?(file)
-      arr.push('compressed') if compressed?(file)
-      arr.push('directory') if directory?(file)
-      arr.push('encrypted') if encrypted?(file)
-      arr.push('hidden') if hidden?(file)
-      arr.push('indexed') if indexed?(file)
-      arr.push('normal') if normal?(file)
-      arr.push('offline') if offline?(file)
-      arr.push('readonly') if readonly?(file)
-      arr.push('reparse_point') if reparse_point?(file)
-      arr.push('sparse') if sparse?(file)
-      arr.push('system') if system?(file)
-      arr.push('temporary') if temporary?(file)
+
+      arr = []
+
+      arr << 'archive' if attributes & FILE_ATTRIBUTE_ARCHIVE > 0
+      arr << 'compressed' if attributes & FILE_ATTRIBUTE_COMPRESSED > 0
+      arr << 'directory' if attributes & FILE_ATTRIBUTE_DIRECTORY > 0
+      arr << 'encrypted' if attributes & FILE_ATTRIBUTE_ENCRYPTED > 0
+      arr << 'hidden' if attributes & FILE_ATTRIBUTE_HIDDEN > 0
+      arr << 'indexed' if attributes & FILE_ATTRIBUTE_NOT_CONTENT_INDEXED == 0
+      arr << 'normal' if attributes & FILE_ATTRIBUTE_NORMAL > 0
+      arr << 'offline' if attributes & FILE_ATTRIBUTE_OFFLINE > 0
+      arr << 'readonly' if attributes & FILE_ATTRIBUTE_READONLY > 0
+      arr << 'reparse_point' if attributes & FILE_ATTRIBUTE_REPARSE_POINT > 0
+      arr << 'sparse' if attributes & FILE_ATTRIBUTE_SPARSE_FILE > 0
+      arr << 'system' if attributes & FILE_ATTRIBUTE_SYSTEM > 0
+      arr << 'temporary' if attributes & FILE_ATTRIBUTE_TEMPORARY > 0
       
       arr
    end

data/test/test_win32_file_attributes.rb

@@ -15,7 +15,7 @@ class TC_Win32_File_Attributes < Test::Unit::TestCase
    extend Windows::File
 
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
+      Dir.chdir(File.dirname(File.expand_path(File.basename(__FILE__))))
       @@file = File.join(Dir.pwd, 'test_file.txt')
       File.open(@@file, 'w'){ |fh| fh.puts "This is a test." }
    end
@@ -26,7 +26,7 @@ class TC_Win32_File_Attributes < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('0.6.1', File::WIN32_FILE_VERSION)
+      assert_equal('0.6.2', File::WIN32_FILE_VERSION)
    end
    
    def test_is_directory

data/test/test_win32_file_encryption.rb

@@ -14,7 +14,7 @@ require 'win32/file'
 
 class TC_Win32_File_Encryption < Test::Unit::TestCase
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
+      Dir.chdir(File.dirname(File.expand_path(File.basename(__FILE__))))
       @@file = File.join(Dir.pwd, 'encryption_test.txt')
       File.open(@@file, 'w'){ |fh| fh.puts "This is an encryption test." }
    end

data/test/test_win32_file_path.rb

@@ -12,7 +12,7 @@ require 'win32/file'
 
 class TC_Win32_File_Path < Test::Unit::TestCase
    def self.startup
-      Dir.chdir('test') rescue nil #unless File.basename(Dir.pwd) == 'test'
+      Dir.chdir(File.dirname(File.expand_path(File.basename(__FILE__))))
       @@file = File.join(Dir.pwd, 'path_test.txt')
       File.open(@@file, 'w'){ |fh| fh.puts "This is a path test." }
    end

data/test/test_win32_file_security.rb

@@ -16,7 +16,7 @@ require 'socket'
 
 class TC_Win32_File_Security < Test::Unit::TestCase
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
+      Dir.chdir(File.dirname(File.expand_path(File.basename(__FILE__))))
       @@host = Socket.gethostname
       @@file = File.join(Dir.pwd, 'security_test.txt')
       File.open(@@file, 'w'){ |fh| fh.puts "This is a security test." }

data/test/test_win32_file_stat.rb

@@ -15,7 +15,7 @@ class TC_Win32_File_Stat < Test::Unit::TestCase
    extend Windows::Volume
 
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
+      Dir.chdir(File.dirname(File.expand_path(File.basename(__FILE__))))
       @@file = File.join(Dir.pwd, 'stat_test.txt')
       File.open(@@file, 'w'){ |fh| fh.puts "This is a test." }
 

data/win32-file.gemspec

@@ -1,28 +1,34 @@
-require "rubygems"
+require 'rubygems'
 
 spec = Gem::Specification.new do |gem|
-   gem.name        = "win32-file"
-   gem.version     = "0.6.1"
-   gem.authors     = ["Daniel J. Berger", "Park Heesob"]
-   gem.email       = "djberg96@gmail.com"
-   gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
-   gem.platform    = Gem::Platform::RUBY
-   gem.summary     = "Extra or redefined methods for the File class on Windows."
-   gem.description = "Extra or redefined methods for the File class on Windows."
-   gem.test_files  = Dir["test/test*"]
-   gem.has_rdoc    = true
-   gem.files       = Dir["lib/win32/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"]
-   gem.files.reject! { |fn| fn.include? "CVS" }
-   gem.require_path = "lib"
-   gem.extra_rdoc_files = ["README", "CHANGES"]
-   gem.add_dependency("win32-api", ">= 1.2.1")
-   gem.add_dependency("win32-file-stat", ">= 1.3.2")
-   gem.add_dependency("test-unit", ">= 2.0.1")
-   gem.add_dependency("windows-pr", ">= 0.9.7")
-   gem.rubyforge_project = "win32utils"
-end
+   gem.name       = 'win32-file'
+   gem.version    = '0.6.2'
+   gem.authors    = ['Daniel J. Berger', 'Park Heesob']
+   gem.license    = 'Artistic 2.0'
+   gem.email      = 'djberg96@gmail.com'
+   gem.homepage   = 'http://www.rubyforge.org/projects/win32utils'
+   gem.platform   = Gem::Platform::RUBY
+   gem.summary    = 'Extra or redefined methods for the File class on Windows.'
+   gem.test_files = Dir['test/test*']
+   gem.has_rdoc   = true
+   gem.files      = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
+   gem.rubyforge_project = 'win32utils'
+   gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+
+   gem.add_dependency('win32-api', '>= 1.4.4')
+   gem.add_dependency('win32-file-stat', '>= 1.3.2')
+   gem.add_dependency('windows-pr', '>= 1.0.6')
 
-if $0 == __FILE__
-   Gem.manage_gems if Gem::RubyGemsVersion.to_f < 1.0
-   Gem::Builder.new(spec).build
+   gem.add_development_dependency('test-unit', '>= 2.0.3')
+
+   gem.description = <<-EOF
+      The win32-file library adds several methods to the core File class which
+      are specific to MS Windows, such as the ability to set and retrieve file
+      attributes. In addition, several core methods have been redefined in
+      order to work properly on MS Windows, such as File.blksize. See the
+      README file for more details.
+   EOF
 end
+
+Gem::Builder.new(spec).build

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win32-file
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-09 00:00:00 -07:00
+date: 2009-08-21 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +21,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.1
+        version: 1.4.4
     version: 
 - !ruby/object:Gem::Dependency 
   name: win32-file-stat
@@ -34,26 +34,26 @@ dependencies:
         version: 1.3.2
     version: 
 - !ruby/object:Gem::Dependency 
-  name: test-unit
+  name: windows-pr
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.1
+        version: 1.0.6
     version: 
 - !ruby/object:Gem::Dependency 
-  name: windows-pr
-  type: :runtime
+  name: test-unit
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.9.7
+        version: 2.0.3
     version: 
-description: Extra or redefined methods for the File class on Windows.
+description: "      The win32-file library adds several methods to the core File class which\n      are specific to MS Windows, such as the ability to set and retrieve file\n      attributes. In addition, several core methods have been redefined in\n      order to work properly on MS Windows, such as File.blksize. See the\n      README file for more details.\n"
 email: djberg96@gmail.com
 executables: []
 
@@ -62,23 +62,24 @@ extensions: []
 extra_rdoc_files: 
 - README
 - CHANGES
+- MANIFEST
 files: 
+- CHANGES
 - lib/win32/file.rb
+- MANIFEST
+- Rakefile
+- README
 - test/test_win32_file_attributes.rb
 - test/test_win32_file_constants.rb
 - test/test_win32_file_encryption.rb
 - test/test_win32_file_path.rb
 - test/test_win32_file_security.rb
 - test/test_win32_file_stat.rb
-- CHANGES
-- lib
-- MANIFEST
-- Rakefile
-- README
-- test
 - win32-file.gemspec
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/win32utils
+licenses: 
+- Artistic 2.0
 post_install_message: 
 rdoc_options: []
 
@@ -99,9 +100,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: win32utils
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Extra or redefined methods for the File class on Windows.
 test_files: 
 - test/test_win32_file_attributes.rb