win32-file 0.6.8 → 0.6.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: bc3e4da61ae4cf054befbe20694d8977bb5e9aa7
4
+ data.tar.gz: cf28cb16d84a87265e5de6be73513e3de01b0ad2
5
+ SHA512:
6
+ metadata.gz: 72c1985a82ca669a19b1728e86c0d8bcb354150fabb2cedc2cb8fb314fddcad96cb931c192d16bbd6ae77e12c4e235c80bb7b5479ec54df53bf255dee7a25212
7
+ data.tar.gz: 2632f743be21c9f4b3f523bcd8b0ae37c49527760864e97a57cd57e89221e8b290ad4c27eaa65af7a9e2d9937354508e82b31404fa0040f4e510785ad8ba02ab
data/CHANGES CHANGED
@@ -1,197 +1,202 @@
1
- == 0.6.8 - 6-Apr-2012
2
- * Fixed some unused variable warnings for 1.9.3.
3
- * Minor cleanup of the Rakefile.
4
- * Fixed an issue with a blockdev test.
5
-
6
- == 0.6.7 - 23-Nov-2011
7
- * Fixed an encoding problem with File.set_permissions for Ruby 1.9.x.
8
- * Fixed a bug in File.basename where an error could be caused by trailing
9
- slashes. Thanks go to paz for the spot and patch.
10
- * Updated the clean task in the Rakefile.
11
-
12
- == 0.6.6 - 3-Sep-2010
13
- * Fixed a bug in the custom File.dirname where trailing slashes were
14
- affecting the result. Trailing slashes are now ignored.
15
- * Added a global test task and a default rake task. Both run all tests.
16
-
17
- == 0.6.5 - 19-Jul-2010
18
- * Removed debug print statement (oops!).
19
-
20
- == 0.6.4 - 3-Jun-2010
21
- * Redefined the File.join method so that it converts all forward slashes
22
- to back slashes.
23
- * Refactored the Rakefile and path tests a bit.
24
- * Bumped the minimum test-unit version to 2.0.7.
25
-
26
- == 0.6.3 - 24-Aug-2009
27
- * Refactored the File.directory? method so that it checks against the
28
- INVALID_FILE_ATTRIBUTES constant instead of a hard coded value.
29
- * Updated windows-pr dependency to 1.0.8.
30
-
31
- == 0.6.2 - 19-Dec-2009
32
- * Changed the license to Artistic 2.0.
33
- * Several gemspec updates, including the license and description.
34
-
35
- == 0.6.1 - 9-Feb-2009
36
- * Fixed a bug in the custom File.directory? method with regards to
37
- non-existent directories. Thanks go to Montgomery Kosma for the spot.
38
-
39
- == 0.6.0 - 14-Nov-2008
40
- * Converted methods to use wide character handling.
41
- * Added working implementations for the File.readlink, File.symlink and
42
- File.symlink? singleton methods. These require Windows Vista or later to
43
- work properly. Otherwise, they follow current MRI behavior.
44
- * To work properly in conjunction with win32-file-stat, a custom version
45
- of the File.directory? method was implemented.
46
- * Changed VERSION to WIN32_FILE_VERSION to be more consistent with other
47
- Win32Utils libraries, and to avoid any potential conflicts with Ruby itself.
48
- * Prerequisite updates.
49
-
50
- == 0.5.6 - 30-Sep-2008
51
- * The File.long_path and File.short_path methods now return the full path
52
- instead of just the basename of the path. I really have no idea why I was
53
- doing that before, but it's fixed now.
54
- * Fixed error handling in the File#compressed= and File#sparse= methods.
55
- * All tests were renamed and refactored to use test-unix 2.x, which is now
56
- a pre-requisite for this library.
57
- * Some gemspec updates, including a rubyforge project.
58
-
59
- == 0.5.5 - 22-Nov-2007
60
- * Fixed a bug in the File.dirname method with regards to relative paths.
61
- Thanks go to an Laust Rud for the spot.
62
- * Removed the install.rb file. Use the 'rake install' task instead.
63
- * Added more tests to ensure the File.dirname method works properly and
64
- did some test refactoring in general.
65
-
66
- == 0.5.4 - 8-Apr-2007
67
- * Now runs -w clean.
68
- * Added a Rakefile. Manual installation and testing should now be handled
69
- by the Rake tasks.
70
- * Some updates to the README file.
71
-
72
- == 0.5.3 - 2-Nov-2006
73
- * Added the File.lstat method. It's abscence caused problems for cross
74
- platform packages (such as the 'find' module) which were expecting a result
75
- for File.lstat. Thanks go to "Oliver" (python152) from the mailing list
76
- for the spot.
77
-
78
- == 0.5.2 - 12-May-2006
79
- * Added explicit File.stat and File#stat methods to ensure that the File::Stat
80
- object returned is the one defined in the win32-file-stat package.
81
-
82
- == 0.5.1 - 27-Apr-2006
83
- * Added the File.content_indexed? alias for File.indexed?
84
- * Added the corresponding File::CONTENT_INDEXED constant alias.
85
- * Fixed an issue with the Windows::Error module not being extended the way
86
- it should have been.
87
- * Updated the ts_all.rb file to actually include *all* the tests.
88
-
89
- == 0.5.0 - 22-Apr-2006
90
- * Replaced C version with pure Ruby version.
91
- * Added a gem.
92
- * Requires the win32-file-stat package. Some methods are just a facade for
93
- File::Stat methods.
94
- * Removed the native IO methods and related attributes - nread, nwrite, flags,
95
- creation_mode, share_mode, access_mode. These will be moved into their own
96
- package (win32-io) eventually.
97
- * The File.get_permissions method now takes an optional hostname as the second
98
- argument. If it isn't provided, it defaults to localhost.
99
- * The File.set_attr method was renamed to File.set_attributes (though an alias
100
- has been provided for backwards compatibility).
101
- * The File.unset_attr method was renamed to File.remove_attributes. Again, an
102
- alias was created for backwards compatibility.
103
- * The File.content_indexed? method is now just File.indexed? Likewise, the
104
- File::CONTENT_INDEXED constant is now just File::INDEXED.
105
-
106
- == 0.4.6 - 20-Nov-2005
107
- * Fixed potential segfaults caused by passing invalid types. This affects
108
- most methods.
109
- * Added more tests to look for explicit TypeError's.
110
-
111
- == 0.4.5 - 17-Sep-2005
112
- * Fixed bug in File.basename and File.dirname where receiver was being
113
- modified.
114
- * Overrode the File.split method to handle UNC paths properly.
115
- * More tests.
116
-
117
- == 0.4.4 - 20-Aug-2005
118
- * Fixed some bugs in the File.basename method.
119
- * Added more tests for the File.basename method.
120
-
121
- == 0.4.3 - 25-May-2005
122
- * Added custom versions of File.basename and File.dirname so that they work
123
- with UNC paths correctly. This requires linking against libshlwapi, which
124
- was added in the extconf.rb file.
125
- * Better Unicode support (I think).
126
- * Added some safe string handling.
127
- * Tests added for File.basename and File.dirname.
128
- * Removed the file.rd file. You can run rdoc over the file.txt file to
129
- generate html documentation if you wish.
130
-
131
- == 0.4.2 - 1-Feb-2005
132
- * Added a macro check for EncryptFile(), which turns out to only be supported
133
- on Windows 2000 or later. Thanks go to Takaaki Tateishi for the spot.
134
-
135
- == 0.4.1 - 30-Nov-2004
136
- * Added working implementations for File.blockdev? and File.chardev?
137
- * Corresponding test suite and doc additions.
138
- * Corrected the release date for 0.4.0.
139
-
140
- == 0.4.0 - 26-Nov-2004
141
- * Added the File.nopen class method, and File#nread and File#nwrite instance
142
- methods. These are wrappers for Window's native methods. See documentation
143
- for more details. Also see some examples in the 'examples' directory.
144
- * Added my own implementation of File.size, because the current version is not
145
- 64 bit aware (i.e. does not return correct values for sizes over 2 GB). I
146
- will remove this once Ruby has been updated.
147
- * Modified File#path to use GetFullPathName() internally if Ruby's own
148
- File#path method fails. This was mostly done for internal usage, but it
149
- has the effect of making File#path a little more robust on Windows I think.
150
-
151
- == 0.3.0 - 10-Nov-2004
152
- * Added the archive=, hidden=, normal=, compressed=, content_indexed=,
153
- offline=, readonly=, sparse=, system=, and temporary= instance methods.
154
- * Changed set_permission to set_permissions, and get_permission to
155
- get_permissions, respectively.
156
- * Moved the examples directory to the toplevel directory.
157
- * Added and/or modified some files to be rdoc friendly.
158
- * Documentation and test suite updates.
159
-
160
- == 0.2.2 - 17-Aug-2004
161
- * Added the encrypt() and decrypt() class methods. These are wrappers
162
- for the EncryptFile() and DecryptFile() Win32 functions.
163
- * Corresponding test suite and documentation additions.
164
- * Added a crypt and decrypt test example, crypt_test.rb, under doc/examples.
165
-
166
- == 0.2.1 - 10-Aug-2004
167
- * Replaced all occurrences of the deprecated STR2CSTR() function with
168
- StringValuePtr(). That means that, as of this release, this package
169
- requires Ruby 1.8.0 or later.
170
- * Added the long_path method (may not be supported on NT).
171
- * Documentation and test suite additions
172
- * Some code cleanup and reorganization.
173
- * Moved sample scripts to doc/examples.
174
- * Removed the file.html file from the doc directory. You can generate the
175
- html documentation with rd2 if you like.
176
-
177
- == 0.2.0 - 8-May-2004
178
- * Removed the toplevel Win32 module/namespace (except for the require line).
179
- I felt that having to put "Win32::" in front of all the methods was too
180
- painful.
181
- * Added the CACLS attribute getter and setter (Park).
182
- * Updated docs to reflect changes, added warranty information.
183
- * Moved the pure ruby version to its own directory. In lieu of the installer
184
- now available for our packages, this version is no longer guaranteed to be
185
- maintained, but I'll leave it in the package for now.
186
-
187
- == 0.1.1 - 3-Nov-2003
188
- * Added the content_indexed? method
189
- * Added the set_attr and unset_attr methods
190
- * Added constants that apply to set_attr and unset_attr
191
- * Replaced GetFileAttributesEx() with the simpler GetFileAttributes().
192
- The former provides no additional information that isn't already covered by File::Stat.
193
- * Test suite additions
194
- * Documentation additions
195
-
196
- == 0.1.0 - 29-Oct-2003
197
- * Initial release
1
+ == 0.6.9 - 11-Dec-2013
2
+ * Added back some missing require statements.
3
+ * Updated the dependency versions and added Rake as a development dependency.
4
+ * Updated the create task in the Rakefile for Rubygems 2.x.
5
+
6
+ == 0.6.8 - 6-Apr-2012
7
+ * Fixed some unused variable warnings for 1.9.3.
8
+ * Minor cleanup of the Rakefile.
9
+ * Fixed an issue with a blockdev test.
10
+
11
+ == 0.6.7 - 23-Nov-2011
12
+ * Fixed an encoding problem with File.set_permissions for Ruby 1.9.x.
13
+ * Fixed a bug in File.basename where an error could be caused by trailing
14
+ slashes. Thanks go to paz for the spot and patch.
15
+ * Updated the clean task in the Rakefile.
16
+
17
+ == 0.6.6 - 3-Sep-2010
18
+ * Fixed a bug in the custom File.dirname where trailing slashes were
19
+ affecting the result. Trailing slashes are now ignored.
20
+ * Added a global test task and a default rake task. Both run all tests.
21
+
22
+ == 0.6.5 - 19-Jul-2010
23
+ * Removed debug print statement (oops!).
24
+
25
+ == 0.6.4 - 3-Jun-2010
26
+ * Redefined the File.join method so that it converts all forward slashes
27
+ to back slashes.
28
+ * Refactored the Rakefile and path tests a bit.
29
+ * Bumped the minimum test-unit version to 2.0.7.
30
+
31
+ == 0.6.3 - 24-Aug-2009
32
+ * Refactored the File.directory? method so that it checks against the
33
+ INVALID_FILE_ATTRIBUTES constant instead of a hard coded value.
34
+ * Updated windows-pr dependency to 1.0.8.
35
+
36
+ == 0.6.2 - 19-Dec-2009
37
+ * Changed the license to Artistic 2.0.
38
+ * Several gemspec updates, including the license and description.
39
+
40
+ == 0.6.1 - 9-Feb-2009
41
+ * Fixed a bug in the custom File.directory? method with regards to
42
+ non-existent directories. Thanks go to Montgomery Kosma for the spot.
43
+
44
+ == 0.6.0 - 14-Nov-2008
45
+ * Converted methods to use wide character handling.
46
+ * Added working implementations for the File.readlink, File.symlink and
47
+ File.symlink? singleton methods. These require Windows Vista or later to
48
+ work properly. Otherwise, they follow current MRI behavior.
49
+ * To work properly in conjunction with win32-file-stat, a custom version
50
+ of the File.directory? method was implemented.
51
+ * Changed VERSION to WIN32_FILE_VERSION to be more consistent with other
52
+ Win32Utils libraries, and to avoid any potential conflicts with Ruby itself.
53
+ * Prerequisite updates.
54
+
55
+ == 0.5.6 - 30-Sep-2008
56
+ * The File.long_path and File.short_path methods now return the full path
57
+ instead of just the basename of the path. I really have no idea why I was
58
+ doing that before, but it's fixed now.
59
+ * Fixed error handling in the File#compressed= and File#sparse= methods.
60
+ * All tests were renamed and refactored to use test-unix 2.x, which is now
61
+ a pre-requisite for this library.
62
+ * Some gemspec updates, including a rubyforge project.
63
+
64
+ == 0.5.5 - 22-Nov-2007
65
+ * Fixed a bug in the File.dirname method with regards to relative paths.
66
+ Thanks go to an Laust Rud for the spot.
67
+ * Removed the install.rb file. Use the 'rake install' task instead.
68
+ * Added more tests to ensure the File.dirname method works properly and
69
+ did some test refactoring in general.
70
+
71
+ == 0.5.4 - 8-Apr-2007
72
+ * Now runs -w clean.
73
+ * Added a Rakefile. Manual installation and testing should now be handled
74
+ by the Rake tasks.
75
+ * Some updates to the README file.
76
+
77
+ == 0.5.3 - 2-Nov-2006
78
+ * Added the File.lstat method. It's abscence caused problems for cross
79
+ platform packages (such as the 'find' module) which were expecting a result
80
+ for File.lstat. Thanks go to "Oliver" (python152) from the mailing list
81
+ for the spot.
82
+
83
+ == 0.5.2 - 12-May-2006
84
+ * Added explicit File.stat and File#stat methods to ensure that the File::Stat
85
+ object returned is the one defined in the win32-file-stat package.
86
+
87
+ == 0.5.1 - 27-Apr-2006
88
+ * Added the File.content_indexed? alias for File.indexed?
89
+ * Added the corresponding File::CONTENT_INDEXED constant alias.
90
+ * Fixed an issue with the Windows::Error module not being extended the way
91
+ it should have been.
92
+ * Updated the ts_all.rb file to actually include *all* the tests.
93
+
94
+ == 0.5.0 - 22-Apr-2006
95
+ * Replaced C version with pure Ruby version.
96
+ * Added a gem.
97
+ * Requires the win32-file-stat package. Some methods are just a facade for
98
+ File::Stat methods.
99
+ * Removed the native IO methods and related attributes - nread, nwrite, flags,
100
+ creation_mode, share_mode, access_mode. These will be moved into their own
101
+ package (win32-io) eventually.
102
+ * The File.get_permissions method now takes an optional hostname as the second
103
+ argument. If it isn't provided, it defaults to localhost.
104
+ * The File.set_attr method was renamed to File.set_attributes (though an alias
105
+ has been provided for backwards compatibility).
106
+ * The File.unset_attr method was renamed to File.remove_attributes. Again, an
107
+ alias was created for backwards compatibility.
108
+ * The File.content_indexed? method is now just File.indexed? Likewise, the
109
+ File::CONTENT_INDEXED constant is now just File::INDEXED.
110
+
111
+ == 0.4.6 - 20-Nov-2005
112
+ * Fixed potential segfaults caused by passing invalid types. This affects
113
+ most methods.
114
+ * Added more tests to look for explicit TypeError's.
115
+
116
+ == 0.4.5 - 17-Sep-2005
117
+ * Fixed bug in File.basename and File.dirname where receiver was being
118
+ modified.
119
+ * Overrode the File.split method to handle UNC paths properly.
120
+ * More tests.
121
+
122
+ == 0.4.4 - 20-Aug-2005
123
+ * Fixed some bugs in the File.basename method.
124
+ * Added more tests for the File.basename method.
125
+
126
+ == 0.4.3 - 25-May-2005
127
+ * Added custom versions of File.basename and File.dirname so that they work
128
+ with UNC paths correctly. This requires linking against libshlwapi, which
129
+ was added in the extconf.rb file.
130
+ * Better Unicode support (I think).
131
+ * Added some safe string handling.
132
+ * Tests added for File.basename and File.dirname.
133
+ * Removed the file.rd file. You can run rdoc over the file.txt file to
134
+ generate html documentation if you wish.
135
+
136
+ == 0.4.2 - 1-Feb-2005
137
+ * Added a macro check for EncryptFile(), which turns out to only be supported
138
+ on Windows 2000 or later. Thanks go to Takaaki Tateishi for the spot.
139
+
140
+ == 0.4.1 - 30-Nov-2004
141
+ * Added working implementations for File.blockdev? and File.chardev?
142
+ * Corresponding test suite and doc additions.
143
+ * Corrected the release date for 0.4.0.
144
+
145
+ == 0.4.0 - 26-Nov-2004
146
+ * Added the File.nopen class method, and File#nread and File#nwrite instance
147
+ methods. These are wrappers for Window's native methods. See documentation
148
+ for more details. Also see some examples in the 'examples' directory.
149
+ * Added my own implementation of File.size, because the current version is not
150
+ 64 bit aware (i.e. does not return correct values for sizes over 2 GB). I
151
+ will remove this once Ruby has been updated.
152
+ * Modified File#path to use GetFullPathName() internally if Ruby's own
153
+ File#path method fails. This was mostly done for internal usage, but it
154
+ has the effect of making File#path a little more robust on Windows I think.
155
+
156
+ == 0.3.0 - 10-Nov-2004
157
+ * Added the archive=, hidden=, normal=, compressed=, content_indexed=,
158
+ offline=, readonly=, sparse=, system=, and temporary= instance methods.
159
+ * Changed set_permission to set_permissions, and get_permission to
160
+ get_permissions, respectively.
161
+ * Moved the examples directory to the toplevel directory.
162
+ * Added and/or modified some files to be rdoc friendly.
163
+ * Documentation and test suite updates.
164
+
165
+ == 0.2.2 - 17-Aug-2004
166
+ * Added the encrypt() and decrypt() class methods. These are wrappers
167
+ for the EncryptFile() and DecryptFile() Win32 functions.
168
+ * Corresponding test suite and documentation additions.
169
+ * Added a crypt and decrypt test example, crypt_test.rb, under doc/examples.
170
+
171
+ == 0.2.1 - 10-Aug-2004
172
+ * Replaced all occurrences of the deprecated STR2CSTR() function with
173
+ StringValuePtr(). That means that, as of this release, this package
174
+ requires Ruby 1.8.0 or later.
175
+ * Added the long_path method (may not be supported on NT).
176
+ * Documentation and test suite additions
177
+ * Some code cleanup and reorganization.
178
+ * Moved sample scripts to doc/examples.
179
+ * Removed the file.html file from the doc directory. You can generate the
180
+ html documentation with rd2 if you like.
181
+
182
+ == 0.2.0 - 8-May-2004
183
+ * Removed the toplevel Win32 module/namespace (except for the require line).
184
+ I felt that having to put "Win32::" in front of all the methods was too
185
+ painful.
186
+ * Added the CACLS attribute getter and setter (Park).
187
+ * Updated docs to reflect changes, added warranty information.
188
+ * Moved the pure ruby version to its own directory. In lieu of the installer
189
+ now available for our packages, this version is no longer guaranteed to be
190
+ maintained, but I'll leave it in the package for now.
191
+
192
+ == 0.1.1 - 3-Nov-2003
193
+ * Added the content_indexed? method
194
+ * Added the set_attr and unset_attr methods
195
+ * Added constants that apply to set_attr and unset_attr
196
+ * Replaced GetFileAttributesEx() with the simpler GetFileAttributes().
197
+ The former provides no additional information that isn't already covered by File::Stat.
198
+ * Test suite additions
199
+ * Documentation additions
200
+
201
+ == 0.1.0 - 29-Oct-2003
202
+ * Initial release
data/MANIFEST CHANGED
@@ -1,13 +1,13 @@
1
- * CHANGES
2
- * MANIFEST
3
- * Rakefile
4
- * README
5
- * win32-file.gemspec
6
- * lib/win32/file.rb
7
- * test/sometestfile.txt
8
- * test/test_win32_file_attributes.rb
9
- * test/test_win32_file_constants.rb
10
- * test/test_win32_file_encryption.rb
11
- * test/test_win32_file_path.rb
12
- * test/test_win32_file_security.rb
1
+ * CHANGES
2
+ * MANIFEST
3
+ * Rakefile
4
+ * README
5
+ * win32-file.gemspec
6
+ * lib/win32/file.rb
7
+ * test/sometestfile.txt
8
+ * test/test_win32_file_attributes.rb
9
+ * test/test_win32_file_constants.rb
10
+ * test/test_win32_file_encryption.rb
11
+ * test/test_win32_file_path.rb
12
+ * test/test_win32_file_security.rb
13
13
  * test/test_win32_file_stat.rb
data/README CHANGED
@@ -1,97 +1,108 @@
1
- == Description
2
- Additional methods for the File class on MS Windows. Plus, several existing
3
- methods have been redefined to make them work properly on MS Windows.
4
-
5
- == Prerequisites
6
- * windows-pr
7
- * win32-file-stat
8
-
9
- == Installation
10
- gem install win32-file
11
-
12
- == Synopsis
13
- require 'win32/file'
14
-
15
- p File.hidden?(somefile)
16
- p File.attributes(somefile)
17
-
18
- File.open(somefile){ |fh|
19
- fh.hidden = true
20
- }
21
-
22
- == Singleton Methods Added
23
- * File.attributes
24
- * File.archive?
25
- * File.compressed?
26
- * File.decrypt
27
- * File.encrypt
28
- * File.encrypted?
29
- * File.get_permissions
30
- * File.hidden?
31
- * File.indexed?
32
- * File.longpath
33
- * File.normal?
34
- * File.offline?
35
- * File.readonly?
36
- * File.remove_attributes
37
- * File.reparse_point?
38
- * File.securities
39
- * File.set_attributes
40
- * File.set_permissions
41
- * File.shortpath
42
- * File.sparse?
43
- * File.system?
44
- * File.temporary?
45
-
46
- == Instance Methods Added
47
- * File#archive=
48
- * File#compressed=
49
- * File#hidden=
50
- * File#indexed=
51
- * File#normal=
52
- * File#offline=
53
- * File#readonly=
54
- * File#sparse=
55
- * File#system=
56
- * File#temporary=
57
-
58
- == Singleton Methods Redefined
59
- * File.basename # UNC path issues
60
- * File.blksize # Not implemented in MRI
61
- * File.blockdev? # Not implemented in MRI
62
- * File.chardev? # Not implemented in MRI
63
- * File.directory? # Wide character string handling
64
- * File.dirname # UNC path issues
65
- * File.lstat # Not implemented in MRI
66
- * File.readlink # Not implemented in MRI
67
- * File.size # 2GB limitation
68
- * File.split # UNC path issues
69
- * File.stat # Uses object returned by win32-file-stat
70
- * File.symlink # Not implemented in MRI
71
- * File.symlink? # Not implemented in MRI
72
-
73
- == Known issues or bugs
74
- None that I'm aware of.
75
-
76
- Please report any issues you find on the github page at:
77
-
78
- https://github.com/djberg96/win32-file/issues
79
-
80
- Or the Win32Utils project page at:
81
-
82
- http://www.rubyforge.org/projects/win32utils.
83
-
84
- == License
85
- Artistic 2.0
86
-
87
- == Copyright
88
- (C) 2003-2012, Daniel J. Berger, All Rights Reserved
89
-
90
- == Warranty
91
- This package is provided "as is" and without any express or
92
- implied warranties, including, without limitation, the implied
93
- warranties of merchantability and fitness for a particular purpose.
94
-
95
- == Authors
96
- * Daniel J. Berger
97
- * Park Heesob
1
+ == Description
2
+ Additional methods for the File class on MS Windows. Plus, several existing
3
+ methods have been redefined to make them work properly on MS Windows.
4
+
5
+ == Prerequisites
6
+ * windows-pr
7
+ * win32-file-stat
8
+
9
+ == Installation
10
+ gem install win32-file
11
+
12
+ == Synopsis
13
+ require 'win32/file'
14
+
15
+ p File.hidden?(somefile)
16
+ p File.attributes(somefile)
17
+
18
+ File.open(somefile){ |fh|
19
+ fh.hidden = true
20
+ }
21
+
22
+ == Singleton Methods Added
23
+ * File.attributes
24
+ * File.archive?
25
+ * File.compressed?
26
+ * File.decrypt
27
+ * File.encrypt
28
+ * File.encrypted?
29
+ * File.get_permissions
30
+ * File.hidden?
31
+ * File.indexed?
32
+ * File.longpath
33
+ * File.normal?
34
+ * File.offline?
35
+ * File.readonly?
36
+ * File.remove_attributes
37
+ * File.reparse_point?
38
+ * File.securities
39
+ * File.set_attributes
40
+ * File.set_permissions
41
+ * File.shortpath
42
+ * File.sparse?
43
+ * File.system?
44
+ * File.temporary?
45
+
46
+ == Instance Methods Added
47
+ * File#archive=
48
+ * File#compressed=
49
+ * File#hidden=
50
+ * File#indexed=
51
+ * File#normal=
52
+ * File#offline=
53
+ * File#readonly=
54
+ * File#sparse=
55
+ * File#system=
56
+ * File#temporary=
57
+
58
+ == Singleton Methods Redefined
59
+ * File.basename # UNC path issues
60
+ * File.blksize # Not implemented in MRI
61
+ * File.blockdev? # Not implemented in MRI
62
+ * File.chardev? # Not implemented in MRI
63
+ * File.directory? # Wide character string handling
64
+ * File.dirname # UNC path issues
65
+ * File.lstat # Not implemented in MRI
66
+ * File.readlink # Not implemented in MRI
67
+ * File.size # 2GB limitation
68
+ * File.split # UNC path issues
69
+ * File.stat # Uses object returned by win32-file-stat
70
+ * File.symlink # Not implemented in MRI
71
+ * File.symlink? # Not implemented in MRI
72
+
73
+ == Known issues or bugs
74
+ None that I'm aware of.
75
+
76
+ Please report any issues you find on the github page at:
77
+
78
+ https://github.com/djberg96/win32-file/issues
79
+
80
+ Or the Win32Utils project page at:
81
+
82
+ http://www.rubyforge.org/projects/win32utils.
83
+
84
+ == Version Issues
85
+ As of 0.7.0, this gem has been significantly altered. Many of the
86
+ methods included here have been split out into separate gems, and
87
+ other methods have been overridden. In addition, as of 0.7.0, this
88
+ gem uses FFI instead of win32-api. The 0.6.x series is to be
89
+ considered deprecated.
90
+
91
+ If you ware using win32-file 0.7.0 or later, you will be using
92
+ a different version of win32-file-stat as well. Don't worry, the
93
+ gemspec has been updated to use the correct gems.
94
+
95
+ == License
96
+ Artistic 2.0
97
+
98
+ == Copyright
99
+ (C) 2003-2013, Daniel J. Berger, All Rights Reserved
100
+
101
+ == Warranty
102
+ This package is provided "as is" and without any express or
103
+ implied warranties, including, without limitation, the implied
104
+ warranties of merchantability and fitness for a particular purpose.
105
+
106
+ == Authors
107
+ * Daniel J. Berger
108
+ * Park Heesob