test_suite_time_machine 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7327c01503b11ebf46af35ebc39484b6b2d39be94326279e7de5aab88716336
+  data.tar.gz: 8f8c2e0aaaebd345003f17db241fdb51f42efb7d08bc6ffcaebbe295e50fa167
+SHA512:
+  metadata.gz: f50eabb434c67a34cacaab07453f08357f0c7509e3f2dc34b7b97e38bae2033d98d3f31119625b3ea14ea2e5546b7c84b40e61d5ec10ddff5cbb4ae41c2026d5
+  data.tar.gz: 2295cb61a6fc4ab7a8dd77c76680e5a59988123e22f3bbbe76d8f813364ee43c02b67546b6685e1f2c4fdeb44948804e667777c81de7339ef681db2dc4d34f6c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,224 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+# New
+
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/DevelopmentDependencies: # new in 1.44
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/MixedCaseRange: # new in 1.53
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RedundantRegexpQuantifiers: # new in 1.53
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MapToSet: # new in 1.42
+  Enabled: true
+Style/MinMaxComparison: # new in 1.42
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantArrayConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantConstantBase: # new in 1.40
+  Enabled: true
+Style/RedundantCurrentDirectoryInPath: # new in 1.53
+  Enabled: true
+Style/RedundantDoubleSplatHashBraces: # new in 1.41
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantRegexpArgument: # new in 1.53
+  Enabled: true
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+Style/YAMLFileRead: # new in 1.53
+  Enabled: true
+
+# Changed
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Layout/CaseIndentation:
+  Enabled: false
+Layout/EndAlignment:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+Metrics/MethodLength:
+  Max: 15

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [Unreleased]
+
+- Initial release

data/LICENCE.txt

@@ -0,0 +1,21 @@
+The MIT Licence (MIT)
+
+Copyright (c) 2023 Elliot Crosby-McCullough
+
+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,103 @@
+# Test Suite Time Machine (TSTM)
+
+This library operates on the principle that time is a variable like any other,
+and should be controlled for in a test suite.  It builds on top of Timecop to
+provide an intuitive interface to set and manipulate time at different levels
+of your test suite, whether to set a specific time for a single test, or to
+pretend to run the entire suite on New Year's Day 2038.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+### Full suite
+
+Use `TestSuiteTimeMachine.pretend_it_is(datetime)` to set and freeze the time for the entire test suite.
+Usually this is done in your `rails_helper` or `spec_helper` file
+immediately after your gems are loaded.
+
+This is also your opportunity to pass in a specific date and time
+if you want to run your suite on that specific date.
+
+```ruby
+TestSuiteTimeMachine.pretend_it_is(ENV.fetch('TEST_DATE_AND_TIME', 'real_world'))
+```
+
+The options are:
+- `'real_world'` - the default, uses the real date and time
+- `'n.days.from_now'` - e.g. `'1.day.from_now'`
+- Any Ruby-parseable timestamp, usually ISO8601
+
+TSTM will always return to this baseline after each test.
+
+### Group-level
+
+To set the date/time for a given group of tests, such as a `describe` block, or `context` block, use `TestSuiteTimeMachine.travel_permanently_to(...)` before the tests in question.  This will move and freeze time as specified, and return to the baseline after the test has finished.
+
+### Test-level
+
+Once you're in the test itself, use the following methods to manipulate time as needed:
+
+- `TestSuiteTimeMachine.advance` - move time forward by 1 second
+- `TestSuiteTimeMachine.advance_time_by(seconds)` - move time forward by the specified number of seconds
+- `TestSuiteTimeMachine.advance_time_to(datetime)` - move time forward to the specified datetime
+
+You cannot use these methods to move time backwards; if you arbitrarily step backwards and forwards in a test, it confuses people.
+
+If you need to move backwards in time e.g. to set up some records
+created in the past, either use `travel_permanently_to` to set the
+time for the entire test group, or use `travel_temporarily_to` to set the time for the duration of the given block.
+
+### RSpec
+
+If you're using RSpec, TSTM provides a set of helpers for clarity
+and convenience, as well as reducing coupling between your tests
+and this library.
+
+```ruby
+RSpec.configure do |config|
+  config.include TestSuiteTimeMachine::RSpecHelpers
+end
+```
+
+This provides the following functionality:
+- adds `set_time(...)` as an alias for `TestSuiteTimeMachine.travel_permanently_to(...)`
+- adds `advance_time` as an alias for `TestSuiteTimeMachine.advance`
+- adds `advance_time_by(seconds)` as an alias for `TestSuiteTimeMachine.advance_time_by(seconds)`
+- adds `advance_time_to(datetime)` as an alias for `TestSuiteTimeMachine.advance_time_to(datetime)`
+- adds `travel_temporarily_to(datetime)` as an alias for `TestSuiteTimeMachine.travel_temporarily_to(datetime)`
+
+It also adds the RSpec tag `time` which is a succinct way of invoking
+`travel_temporarily_to` for a given test.
+
+```ruby
+RSpec.describe "Santa's schedule" do
+  context "when it Christmas Eve", time: '2023-12-24 10:00' do
+    it "is extremely busy" do
+      # ...
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SmartCasual/test_suite_time_machine
+
+## Licence
+
+The gem is available as open source under the terms of the [MIT Licence](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/test_suite_time_machine/version.rb

@@ -0,0 +1,3 @@
+module TestSuiteTimeMachine
+  VERSION = "1.0.0".freeze
+end

data/lib/test_suite_time_machine.rb

@@ -0,0 +1,149 @@
+require_relative "test_suite_time_machine/version"
+require "timecop"
+
+module TestSuiteTimeMachine
+  DAY = 60 * 60 * 24
+
+  def self.pretend_it_is(datetime)
+    if baseline
+      raise TimeTravelError, "TestSuiteTimeMachine.pretend_it_is cannot be called more than once per test run (currently set to `#{baseline}`, use `travel_temporarily_to` instead)." # rubocop:disable Layout/LineLength
+    end
+
+    datetime = "real_world" if datetime.nil? || datetime.strip.empty?
+
+    self.baseline = Timecop.baseline = case datetime
+      when "real_world"
+        now
+      when /\A(\d+).days.from_now\z/
+        days_from_now(::Regexp.last_match(1).to_i)
+      else
+        parse(datetime)
+      end
+
+    Timecop.safe_mode = false
+    Timecop.freeze
+  end
+
+  def self.travel_temporarily_to(*datetime, freeze: true, &block)
+    raise TimeTravelError, "TestSuiteTimeMachine.travel_temporarily_to requires a block" unless block_given?
+
+    if freeze
+      Timecop.freeze(*datetime, &block)
+    else
+      Timecop.travel(*datetime, &block)
+    end
+  end
+
+  def self.advance_time_to(datetime, **kwargs)
+    if parse(datetime) < now
+      raise TimeTravelError,
+            "TestSuiteTimeMachine.advance_time_to cannot be called with a date in the past (#{datetime})"
+    end
+
+    travel_permanently_to(datetime, **kwargs)
+  end
+
+  def self.advance_time_by(duration, **kwargs)
+    advance_time_to(now + duration, **kwargs)
+  end
+
+  def self.advance
+    advance_time_by(1) # 1 second
+  end
+
+  def self.travel_permanently_to(*datetime, freeze: true)
+    if freeze
+      Timecop.freeze(*datetime)
+    else
+      Timecop.travel(*datetime)
+    end
+  end
+
+  def self.reset
+    unless baseline # rubocop:disable Style/IfUnlessModifier
+      raise TimeTravelError, "a baseline time must be set first (#{baseline})"
+    end
+
+    Timecop.return_to_baseline
+    Timecop.freeze(baseline)
+
+    if now.to_i != baseline.to_i # rubocop:disable Style/GuardClause
+      raise TimeTravelError, "Time leak! Expected '#{now}' to be at baseline '#{baseline}' after a reset"
+    end
+  end
+
+  def self.revert_to_real_world_time
+    Timecop.return.tap do
+      Timecop.safe_mode = true
+      self.baseline = nil
+    end
+  end
+
+  def self.unfreeze!
+    Timecop.travel(now)
+  end
+
+  def self.baseline
+    Thread.current[:tstm_baseline_set]
+  end
+
+  def self.baseline=(datetime)
+    Thread.current[:tstm_baseline_set] = datetime
+  end
+
+  def self.now
+    if Time.respond_to?(:zone)
+      Time.zone.now
+    else
+      Time.now
+    end
+  end
+
+  def self.parse(datetime)
+    return datetime unless datetime.is_a?(String)
+
+    if Time.respond_to?(:zone)
+      Time.zone.parse(datetime)
+    else
+      Time.parse(datetime)
+    end
+  end
+
+  def self.days_from_now(days)
+    if days.respond_to?(:days)
+      days.days.from_now
+    else
+      now + (days * DAY)
+    end
+  end
+
+  module RSpecHelpers
+    def set_time(...)
+      TestSuiteTimeMachine.travel_permanently_to(...)
+    end
+
+    def advance_time
+      TestSuiteTimeMachine.advance
+    end
+
+    def advance_time_by(...)
+      TestSuiteTimeMachine.advance_time_by(...)
+    end
+
+    def advance_time_to(...)
+      TestSuiteTimeMachine.advance_time_to(...)
+    end
+
+    def travel_temporarily_to(...)
+      TestSuiteTimeMachine.travel_temporarily_to(...)
+    end
+
+    def self.included(config)
+      config.before(:each, :time) do |example|
+        set_time(example.metadata[:time])
+      end
+    end
+  end
+
+  class TimeTravelError < StandardError; end
+end

data/sig/test_suite_time_machine.rbs

@@ -0,0 +1,4 @@
+module TestSuiteTimeMachine
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/test_suite_time_machine.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/test_suite_time_machine/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "test_suite_time_machine"
+  spec.version = TestSuiteTimeMachine::VERSION
+  spec.authors = ["Elliot Crosby-McCullough"]
+  spec.email = ["elliot.cm@gmail.com"]
+
+  spec.summary = "A small utility to help manage the current date and time in your test suite."
+  spec.description = "Built atop Timecop, this gem provides a more intuitive interface for managing the current date and time across the test suite." # rubocop:disable Layout/LineLength
+  spec.homepage = "https://github.com/SmartCasual/test_suite_time_machine"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ spec/ .git .github Gemfile])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "timecop", "~> 0.9"
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: test_suite_time_machine
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Elliot Crosby-McCullough
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Built atop Timecop, this gem provides a more intuitive interface for
+  managing the current date and time across the test suite.
+email:
+- elliot.cm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENCE.txt
+- README.md
+- Rakefile
+- lib/test_suite_time_machine.rb
+- lib/test_suite_time_machine/version.rb
+- sig/test_suite_time_machine.rbs
+- test_suite_time_machine.gemspec
+homepage: https://github.com/SmartCasual/test_suite_time_machine
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SmartCasual/test_suite_time_machine
+  source_code_uri: https://github.com/SmartCasual/test_suite_time_machine
+  changelog_uri: https://github.com/SmartCasual/test_suite_time_machine/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.17
+signing_key:
+specification_version: 4
+summary: A small utility to help manage the current date and time in your test suite.
+test_files: []