win32-file 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f6a139f0549b0a2b960a270847d1a889fb9e74f
-  data.tar.gz: 938ff2a79f3abb35d78e3d1d12d57daa3b054c13
+  metadata.gz: 4e7711498726b528b1298a6c03de0e4bb8b8b7f0
+  data.tar.gz: e2888cd5b82f1eb3300ab8f19accaa7d888a78e8
 SHA512:
-  metadata.gz: 7deb66b6745f6c6399c3b083e0aa5af62eadf79b8fdf72a32c4de6a8e52b32ce629486df1269e9435ba133b9a0b93bb068af349f82b779b46fba86ad11ae0b4f
-  data.tar.gz: bc907afe4b105e6eeac4555f7c3ee44ec9edf63447bdcf7465fd8019bdd4dd04172a8355dacf58ec690d970c61a2f6079f2fb620944a658bd7e95530c08971a5
+  metadata.gz: fc3da34d570cd22907250e285e56656f0d46102b8273b4be3c1334f1869f9420c4ab4a223fa94f63b3c312579cea7832771df55b35f21c4051dc72e23ce300ab
+  data.tar.gz: f9eb5764bd2eaba797d8c3e759c650f7955ed4178363687f305672c5546587ee8790abd938318ce48760c4805741f0a18306a3ae01802a698fb1ef550a12c832

data/CHANGES

@@ -1,3 +1,8 @@
+== 0.8.0 - 30-Oct-2015
+* The File.atime, File.ctime and File.mtime methods now accept an optional
+  second argument. If present, those values are set to whatever value that
+  you provided.
+
 == 0.7.3 - 26-Oct-2015
 * This gem is now signed.
 * Fixed a test for File.file?

data/README

@@ -21,10 +21,12 @@
   * File.short_path
 
 == Singleton Methods Redefined
+  * File.atime            # Takes an optional 2nd argument to set the value.
   * File.basename         # UNC path issues, root path differences.
   * File.blksize          # Not implemented in MRI
   * File.blockdev?        # Not implemented in MRI
   * File.chardev?         # Not implemented in MRI
+  * File.ctime            # Takes an optional 2nd argument to set the value.
   * File.directory?       # Better wide character string handling than MRI
   * File.dirname          # UNC path issues in MRI
   * File.executable?      # Not implemented in MRI
@@ -33,6 +35,7 @@
   * File.join             # For uniform handling of path separators.
   * File.grpowned?        # Not implemented in MRI
   * File.lstat            # Not implemented in MRI
+  * File.mtime            # Takes an optional 2nd argument to set the value.
   * File.owned?           # Not implemented in MRI
   * File.pipe?            # Not implemented in MRI
   * File.readable?        # Not implemented in MRI

data/lib/win32/file.rb

@@ -9,16 +9,16 @@ class File
   extend Windows::File::Functions
 
   # The version of the win32-file library
-  WIN32_FILE_VERSION = '0.7.3'
+  WIN32_FILE_VERSION = '0.8.0'
 
   class << self
     alias_method :join_orig, :join
     alias_method :realpath_orig, :realpath
     alias_method :realdirpath_orig, :realdirpath
 
-    remove_method :basename, :blockdev?, :chardev?, :dirname, :directory?
-    remove_method :executable?, :executable_real?, :file?, :ftype, :grpowned?
-    remove_method :join, :lstat, :owned?, :pipe?, :socket?
+    remove_method :atime, :basename, :blockdev?, :chardev?, :ctime, :dirname
+    remove_method :directory?, :executable?, :executable_real?, :file?
+    remove_method :ftype, :grpowned?, :join, :lstat, :owned?, :pipe?, :socket?
     remove_method :readable?, :readable_real?, :readlink, :realpath
     remove_method :realdirpath
     remove_method :split, :stat
@@ -366,6 +366,15 @@ class File
 
   ## STAT METHODS
 
+  # Returns the file's last access time. If a +time+ argument is provided, it
+  # sets the file's access time. The +time+ argument may be a Time object or
+  # a numeric value.
+  #
+  def self.atime(file, time = nil)
+    set_filetime(file, nil, time) if time
+    File::Stat.new(file).atime
+  end
+
   # Returns the filesystem's block size.
   #
   def self.blksize(file)
@@ -387,6 +396,15 @@ class File
     File::Stat.new(file).chardev?
   end
 
+  # Returns the file's creation time. If a +time+ argument is provided, it
+  # sets the file's creation time. The +time+ argument may be a Time object or
+  # a numeric value.
+  #
+  def self.ctime(file, time = nil)
+    set_filetime(file, time) if time
+    File::Stat.new(file).ctime
+  end
+
   # Returns whether or not the file is a directory.
   #
   def self.directory?(file)
@@ -422,6 +440,15 @@ class File
     File::Stat.new(file).grpowned?
   end
 
+  # Returns the file's creation time. If a +time+ argument is provided, it
+  # sets the file's creation time. The +time+ argument may be a Time object or
+  # a numeric value.
+  #
+  def self.mtime(file, time = nil)
+    set_filetime(file, nil, nil, time) if time
+    File::Stat.new(file).mtime
+  end
+
   # Returns whether or not the current process owner is the owner of the file.
   #
   def self.owned?(file)
@@ -502,15 +529,56 @@ class File
   end
 
   # Private singleton methods
-  class << self
-    private
-
-    # Simulate Ruby's string checking
-    def string_check(arg)
-      return arg if arg.is_a?(String)
-      return arg.send(:to_str) if arg.respond_to?(:to_str, true) # MRI allows private to_str
-      return arg.to_path if arg.respond_to?(:to_path)
-      raise TypeError
+  private
+
+  # Simulate Ruby's string checking
+  def self.string_check(arg)
+    return arg if arg.is_a?(String)
+    return arg.send(:to_str) if arg.respond_to?(:to_str, true) # MRI allows private to_str
+    return arg.to_path if arg.respond_to?(:to_path)
+    raise TypeError
+  end
+
+  # Internal method for setting the file time.
+  def self.set_filetime(path, ctime = nil, atime = nil, mtime = nil)
+    begin
+      handle = CreateFileW(
+        path.wincode,
+        FILE_WRITE_ATTRIBUTES,
+        FILE_SHARE_READ | FILE_SHARE_WRITE,
+        nil,
+        OPEN_EXISTING,
+        FILE_ATTRIBUTE_NORMAL,
+        0
+      )
+
+      if handle == INVALID_HANDLE_VALUE
+        raise SystemCallError.new('CreateFile', FFI.errno)
+      end
+
+      ftimes = [] # 0 = ctime, 1 = atime, 2 = mtime
+
+      [ctime, atime, mtime].each{ |time|
+        if time.nil?
+          ftimes << nil
+          next
+        else
+          systime = SYSTEMTIME.new(time)
+          ftime = FILETIME.new
+
+          if SystemTimeToFileTime(systime, ftime)
+            ftimes << ftime
+          else
+            raise SystemCallError.new('SystemTimetoFileTime', FFI.errno)
+          end
+        end
+      }
+
+      unless SetFileTime(handle, ftimes[0], ftimes[1], ftimes[2])
+        raise SystemCallError.new('SetFileTime', FFI.errno)
+      end
+    ensure
+      CloseHandle(handle) if handle
     end
   end
 end

data/lib/win32/file/constants.rb

@@ -7,13 +7,19 @@ module Windows
       FILE_ATTRIBUTE_REPARSE_POINT = 0x00000400
       FILE_FLAG_BACKUP_SEMANTICS = 0x02000000
       FILE_FLAG_OPEN_REPARSE_POINT = 0x00200000
-      FILE_SHARE_READ = 1
+
+      FILE_SHARE_READ  = 1
+      FILE_SHARE_WRITE = 2
+
+      FILE_WRITE_ATTRIBUTES = 256
 
       FILE_TYPE_UNKNOWN = 0x0000
       FILE_TYPE_CHAR    = 0x0002
       NO_ERROR = 0
 
-      GENERIC_READ = 0x80000000
+      GENERIC_READ  = 0x80000000
+      GENERIC_WRITE = 0x40000000
+
       INVALID_HANDLE_VALUE = (1 << FFI::Platform::ADDRESS_SIZE) - 1
       INVALID_FILE_ATTRIBUTES = (1 << FFI::Platform::ADDRESS_SIZE) - 1
       IO_REPARSE_TAG_SYMLINK = 0xA000000C

data/lib/win32/file/functions.rb

@@ -25,6 +25,8 @@ module Windows
       attach_pfunc :GetShortPathNameW, [:buffer_in, :buffer_out, :dword], :dword
       attach_pfunc :GetLongPathNameW, [:buffer_in, :buffer_out, :dword], :dword
       attach_pfunc :QueryDosDeviceA, [:string, :buffer_out, :dword], :dword
+      attach_pfunc :SetFileTime, [:handle, :ptr, :ptr, :ptr], :bool
+      attach_pfunc :SystemTimeToFileTime, [:ptr, :ptr], :bool
 
       ffi_lib :shlwapi
 

data/lib/win32/file/structs.rb

@@ -5,6 +5,36 @@ module Windows
         layout(:dwLowDateTime, :ulong, :dwHighDateTime, :ulong)
       end
 
+      class SYSTEMTIME < FFI::Struct
+        layout(
+          :wYear, :ushort,
+          :wMonth, :ushort,
+          :wDayOfWeek, :ushort,
+          :wDay, :ushort,
+          :wHour, :ushort,
+          :wMinute, :ushort,
+          :wSecond, :ushort,
+          :wMilliseconds, :ushort
+        )
+
+        # Allow a time object or raw numeric in constructor
+        def initialize(time = nil)
+          super()
+
+          time = Time.at(time) if time.is_a?(Numeric)
+          time = time.utc unless time.utc?
+
+          self[:wYear] = time.year
+          self[:wMonth] = time.month
+          self[:wDayOfWeek] = time.wday
+          self[:wDay] = time.day
+          self[:wHour] = time.hour
+          self[:wMinute] = time.min
+          self[:wSecond] = time.sec
+          self[:wMilliseconds] = time.nsec / 1000000
+        end
+      end
+
       class WIN32_FIND_DATA < FFI::Struct
         layout(
           :dwFileAttributes, :ulong,

data/test/test_win32_file_misc.rb

@@ -6,7 +6,7 @@ require 'test-unit'
 
 class TC_Win32_File_Misc < Test::Unit::TestCase
   test "version constant is set to expected value" do
-    assert_equal('0.7.3', File::WIN32_FILE_VERSION)
+    assert_equal('0.8.0', File::WIN32_FILE_VERSION)
   end
 
   test "ffi functions are private" do

data/test/test_win32_file_stat.rb

@@ -42,6 +42,7 @@ class TC_Win32_File_Stat < Test::Unit::TestCase
 
   def setup
     @blksize = 4096 # Most likely
+    @time_file = 'stat_time.txt'
   end
 
   test "File::Stat class returned is from win32-file-stat library" do
@@ -50,6 +51,20 @@ class TC_Win32_File_Stat < Test::Unit::TestCase
     assert_nothing_raised{ File.stat(@@txt_file).hidden? }
   end
 
+  test "atime method basic functionality" do
+    assert_nothing_raised{ File.atime(@@txt_file) }
+    assert_kind_of(Time, File.atime(@@txt_file))
+  end
+
+  test "atime with two arguments sets the creation time" do
+    FileUtils.touch(@time_file)
+    original_time = File.atime(@time_file)
+    updated_time = original_time - 100000
+
+    assert_equal(updated_time, File.atime(@time_file, updated_time))
+    assert_equal(updated_time, File.atime(@time_file))
+  end
+
   test "blksize basic functionality" do
     assert_respond_to(File, :blksize)
     assert_kind_of(Fixnum, File.blksize(@@txt_file))
@@ -109,6 +124,20 @@ class TC_Win32_File_Stat < Test::Unit::TestCase
     assert_raises(ArgumentError){ File.chardev?(@@txt_file, 'foo') }
   end
 
+  test "ctime method basic functionality" do
+    assert_nothing_raised{ File.ctime(@@txt_file) }
+    assert_kind_of(Time, File.ctime(@@txt_file))
+  end
+
+  test "ctime with two arguments sets the creation time" do
+    FileUtils.touch(@time_file)
+    original_time = File.ctime(@time_file)
+    updated_time = original_time - 100000
+
+    assert_equal(updated_time, File.ctime(@time_file, updated_time))
+    assert_equal(updated_time, File.ctime(@time_file))
+  end
+
   test "lstat is an alias for stat" do
     assert_respond_to(File, :lstat)
     assert_alias_method(File, :stat, :lstat)
@@ -177,6 +206,20 @@ class TC_Win32_File_Stat < Test::Unit::TestCase
     assert_false(File.grpowned?('bogus'))
   end
 
+  test "mtime method basic functionality" do
+    assert_nothing_raised{ File.mtime(@@txt_file) }
+    assert_kind_of(Time, File.mtime(@@txt_file))
+  end
+
+  test "mtime with two arguments sets the creation time" do
+    FileUtils.touch(@time_file)
+    original_time = File.mtime(@time_file)
+    updated_time = original_time - 100000
+
+    assert_equal(updated_time, File.mtime(@time_file, updated_time))
+    assert_equal(updated_time, File.mtime(@time_file))
+  end
+
   test "owned? method basic functionality" do
     assert_respond_to(File, :owned?)
     assert_nothing_raised{ File.owned?(Dir.pwd) }
@@ -269,7 +312,10 @@ class TC_Win32_File_Stat < Test::Unit::TestCase
   end
 
   def teardown
+    File.delete(@time_file) if File.exist?(@time_file)
+
     @blksize = nil
+    @time_file = nil
   end
 
   def self.shutdown

data/win32-file.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'win32-file'
-  spec.version    = '0.7.3'
+  spec.version    = '0.8.0'
   spec.authors    = ['Daniel J. Berger', 'Park Heesob']
   spec.license    = 'Artistic 2.0'
   spec.email      = 'djberg96@gmail.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32-file
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -31,7 +31,7 @@ cert_chain:
   EJYzxdPOrx2n6NYR3Hk+vHP0U7UBSveI6+qx+ndQYaeyCn+GRX2PKS9h66YF/Q1V
   tGSHgAmcLlkdGgan182qsE/4kKM=
   -----END CERTIFICATE-----
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi

metadata.gz.sig

@@ -1 +1 @@
-4�C|J`�jh�����/�k�2X�j�Kc�}�)�N����u�ϫ@�Sh��"�����R<JX|a#��~O/��?��-A�E)\'v��d�W�tJ-ݗ^2l��nE�J����P"yF$�M~dH)&���,
QHYU	u�?汦�����}&��
��MXG����a���O%��޳�9�:�t�:0����@*�(�o';/We�R��qFu[A`�<q>�Q�$�r<������++��}�IZ�
+q{`b'D��z�k�PO���]^$^A-�l�����H7�D{g�FwN�uwj�b6�{m~X>}��w:9/q��).݂�S�e�29�����<9}E�O8�BG���#�D���J��%�a$Bç�;b*a�l�tۋ�!T
&m�s-��:�����&���d(s