sus-fixtures-time 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9184183528fd5ea79bfab1932b3d59f93ecfcee6a067726e14a866ca00dd1623
+  data.tar.gz: 03a56c62889f1950bfca0fd9c83bda2496243272828a0016ca57c75830beb077
+SHA512:
+  metadata.gz: ddc8526ba5b3b97eb7d8bc44dfa718f222197a76225a88917d2038697fb1919e024e66cc7b4451af44a98fead7fb51eef2d0a0b99da3475b0cab4f7fbbbc6f55
+  data.tar.gz: 1cff6d88529eeb390cefbb5949ebc54f11f37ce0f6dfed5fbbe01feade018363f696493719e3838a54f53957ff0d2682b53d4ddbad7100310b3d2be98924225f

data/lib/sus/fixtures/time/current_context.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require 'time'
+require 'date'
+
+module Sus
+	module Fixtures
+		module Time
+			# Mocks the current time.
+			CurrentContext = Sus::Shared("mocked time context") do |time|
+				attr_accessor :current_time
+				
+				def time_travel(time)
+					current_time = @current_time
+					@current_time = time
+					yield
+				ensure
+					@current_time = current_time
+				end
+				
+				before do
+					@current_time = time
+					
+					mock(::Time) do |mock|
+						mock.wrap(:now) do |original|
+							if @current_time
+								@current_time.dup
+							else
+								original.call
+							end
+						end
+						
+						mock.wrap(:new) do |original, *arguments|
+							if arguments.empty? && @current_time
+								@current_time.dup
+							else
+								original.call(*arguments)
+							end
+						end
+					end
+					
+					mock(::Date) do |mock|
+						mock.wrap(:today) do |original|
+							if @current_time
+								@current_time.to_date
+							else
+								original.call
+							end
+						end
+					end
+					
+					mock(::DateTime) do |mock|
+						mock.wrap(:now) do |original|
+							if @current_time
+								@current_time.to_datetime
+							else
+								original.call
+							end
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/sus/fixtures/time/measured_context.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require_relative 'quantum'
+
+module Sus
+	module Fixtures
+		module Time
+			# A context for comparing measured durations, taking into account the overhead (quantum) of the system.
+			module MeasuredContext
+				# The measured duration is less than the given duration plus the quantum.
+				#
+				# @parameter duration [Numeric] The expected duration.
+				def be_measured_faster_than(duration)
+					be < (duration + QUANTUM)
+				end
+				
+				# The measured duration is greater than the given duration minus the quantum.
+				#
+				# @parameter duration [Numeric] The expected duration.
+				def be_measured_slower_than(duration)
+					be > (duration - QUANTUM)
+				end
+				
+				# The measured duration is within the given duration plus or minus the quantum.
+				#
+				# @parameter duration [Numeric] The expected duration.
+				def be_measured_within(duration)
+					be_within(QUANTUM).of(duration)
+				end
+			end
+		end
+	end
+end

data/lib/sus/fixtures/time/quantum.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2024, by Samuel Williams.
+
+module Sus
+	module Fixtures
+		module Time
+			# Represents the smallest possible time interval that can be measured given the current system overheads.
+			class Quantum
+				# Resolve the quantum for the current system.
+				#
+				# @returns [Float] The quantum for the current system in seconds.
+				def self.resolve
+					self.new.to_f
+				end
+				
+				# @returns [Float] the quantum for the current system in seconds.
+				def to_f
+					precision
+				end
+				
+				# Lazily compute the precision of the current system.
+				#
+				# @returns [Float] the quantum for the current system in seconds.
+				def precision
+					@precision ||= self.measure_host_precision
+				end
+				
+				# Measure the precision of the current system.
+				#
+				# @parameter repeats [Integer] The number of times to repeat the measurement.
+				# @parameter duration [Float] The duration of the measurement in seconds.
+				# @parameter factor [Float] A scaling factor to apply to the measured overhead.
+				# @returns [Float] the quantum for the current system in seconds.
+				def measure_host_precision(repeats: 1000, duration: 0.1, factor: 2.0)
+					step = duration / repeats
+					
+					start_time = self.now
+					repeats.times do
+						sleep(step)
+					end
+					end_time = self.now
+					
+					actual_duration = end_time - start_time
+					
+					if actual_duration < duration
+						warn "Expected to sleep for #{duration}+ seconds, but only slept for #{actual_duration} seconds."
+						error = 0.1
+					else
+						# Total execution time, minus the expected execution time = overhead.
+						error = actual_duration - duration
+					end
+					
+					# It's not like this is a precise measurement anyway...
+					return error * factor
+				end
+				
+				private
+				
+				def now
+					Process.clock_gettime(Process::CLOCK_MONOTONIC)
+				end
+			end
+			
+			QUANTUM = Quantum.resolve
+		end
+	end
+end

data/lib/sus/fixtures/time/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+module Sus
+	module Fixtures
+		module Time
+			VERSION = "0.1.0"
+		end
+	end
+end

data/lib/sus/fixtures/time.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require_relative 'time/quantum'
+require_relative 'time/version'
+
+# @namespace
+module Sus
+	# @namespace
+	module Fixtures
+		# @namespace
+		module Time
+		end
+	end
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2023-2024, by Samuel Williams.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,33 @@
+# Sus::Fixtures::Time
+
+Provides a convenient fixtures for time-related tests.
+
+[![Development Status](https://github.com/socketry/sus-fixtures-time/workflows/Test/badge.svg)](https://github.com/socketry/sus-fixtures-time/actions?workflow=Test)
+
+## Motivation
+
+Time-related tests are notoriously flakey due to changes in hardware performance and software load. Typically, a test that measures duration will work fine locally, but fail on a continuous integration (CI) server. This is because the CI server is under load which results in significantly slower test execution times. This gem provides a mechanism to try and measure this overhead, and adjust the test expectations to account for it. This is done by measuring the time taken to perform a simple operation, and then using that as a baseline.
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/sus-fixtures-time/) for more details.
+
+  - [Getting Started](https://socketry.github.io/sus-fixtures-time/guides/getting-started/index) - This guide explains how to use the `sus-fixtures-time` gem to test time-related code.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: sus-fixtures-time
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2024-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sus/fixtures/time.rb
+- lib/sus/fixtures/time/current_context.rb
+- lib/sus/fixtures/time/measured_context.rb
+- lib/sus/fixtures/time/quantum.rb
+- lib/sus/fixtures/time/version.rb
+- license.md
+- readme.md
+homepage: https://github.com/socketry/sus-fixtures-time
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://socketry.github.io/sus-fixtures-time/
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/sus-fixtures-time.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Test fixtures for manipulating time.
+test_files: []