win 0.3.25 → 0.3.26

data/HISTORY

@@ -94,3 +94,7 @@
 == 0.3.25 / 2010-10-17
 
 * Minor refactoring
+
+== 0.3.26 / 2011-03-14
+
+* Win::Time.now returns enhanced-precision Time value with granularity below microsecond

data/VERSION

@@ -1 +1 @@
-0.3.25
+0.3.26

data/lib/win/time.rb

@@ -10,7 +10,8 @@ module Win
   # The caller of these functions should not rely on more than second granularity.
   # In fact, granularity of all the GetTime... functions is about ~16msec on Windows.
   # You'll need to mess with QueryPerformanceFrequency() and QueryPerformanceCounter()
-  # to get real msec granularity on MS Windows;
+  # to get real msec granularity on MS Windows; OR, just use Win::Time.now() for
+  # enhanced-precision Time values
   #
   module Time
     extend Win::Library
@@ -136,5 +137,21 @@ module Win
     try_function :TzSpecificLocalTimeToSystemTime, 'PPP', :int8, boolean: true
 
 
+    # The problem: granularity of standard Time.now on Windows is about ~16 milliseconds!
+    # Here we try to add enhanced-precision Time support on Windows.
+    # Use it like this: t = Win::Time.now
+    # It returns enhanced-precision Time value with granularity below microsecond.
+    begin
+      COUNTER_FREQUENCY = query_performance_frequency()
+      INITIAL_COUNTER = query_performance_counter()
+      INITIAL_TIME = ::Time.now
+
+      # Returns enhanced-precision Time value with granularity below microsecond.
+      def self.now
+        INITIAL_TIME + (query_performance_counter()-INITIAL_COUNTER).to_f/COUNTER_FREQUENCY
+      end
+    rescue Exception
+     raise "Unable to initiate enhanced-precision timer"
+    end
   end
 end

data/spec/win/time_spec.rb

@@ -34,7 +34,7 @@ describe Win::Time do
       count.should be > 500000000000
     end
 
-    it "successive function calls return (slightly) incremented counter values" do
+    it "return (slightly) incremented counter values in successive function calls" do
       100.times do
         count1 = query_performance_counter()
         count2 = query_performance_counter()
@@ -43,6 +43,37 @@ describe Win::Time do
         diff.should be < 50000 # GC calls make it hard to guarantee uniform measurements?
       end
     end
+
+    it 'returns correct counter counts' do
+      count1 = query_performance_counter()
+      sleep 0.3
+      count2 = query_performance_counter()
+      seconds_passed = (count2 - count1).to_f/query_performance_frequency()
+      seconds_passed.should be_within(0.02).of(0.3)
+    end
   end # describe query_performance_counter
 
+  describe '.now' do
+    it 'returns enhanced-precision Time on Windows platform' do
+      time = Win::Time.now
+      time.should be_a_kind_of ::Time
+    end
+
+    it 'is really really enhanced precision' do
+      normal_moved = 0
+      hi_res_moved = 0
+      100.times do
+        normal = ::Time.now
+        hi_res = Win::Time.now
+#        puts "Normal Time.now: #{normal.strftime('%Y-%m-%d %H:%M:%S.%6N')}," +
+#                 "Win::Time.now: #{hi_res.strftime('%Y-%m-%d %H:%M:%S.%6N')} "
+        normal1 = ::Time.now
+        hi_res1 = Win::Time.now
+        normal_moved += 1 if normal1 != normal
+        hi_res_moved += 1 if hi_res1 != hi_res
+      end
+      normal_moved.should be < 5
+      hi_res_moved.should == 100
+    end
+  end
 end # describe Win::Time

metadata

@@ -2,7 +2,7 @@
 name: win
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.25
+  version: 0.3.26
 platform: ruby
 authors: 
 - arvicco