regtest 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b91c5f1f5b30d309f77eaf7c3c218529bd82321a7af578b37c52a4bed09d53e4
-  data.tar.gz: f66632f3eb0f2844ab43068f83c30e62aca2805dad460543436b9df0620c3598
+  metadata.gz: 84ca27fae1d12f7b8616fa32743dbacccfb64fc25b7783b9ec19e7ddc8c8ef2b
+  data.tar.gz: c414dd15ee7d42cd2717caac6530556232a6930c4c107270a16d2138226947c9
 SHA512:
-  metadata.gz: 38257004b8aab5bbad388e430b85362e80b5759be4ca1729756ce0e2704a6cc85f12e3899c17b28df32afc1380251228321f750fb7f8bc4bd951a56e1ca27690
-  data.tar.gz: 2a2f5f808848caccb56db4a4d90a9e34babf70a79d30bf49182317c77081985bcae89289c77acab5ba4a029483330ba3533a37d91be6fbdfc7b63b3cfd397948
+  metadata.gz: 5a43f2252a7cb0993eaef29d017e9132b908930fdc298c599f714331053e900bf602655294cfd8fbd24363e01e7053bea6cff90fd2ff11ba7afcdafa6277bbbf
+  data.tar.gz: b3b77f936f251b850246799aa4a0eb01adead35ad758f9e8fefa6c9d02cc00d4017905af2b08dc822de0ace51e4ebabea1b5c294aaf2d52b86f04183fa2ac48d

data/.aspell.pws

@@ -1,17 +1,26 @@
-personal_ws-1.1 en 26 
+personal_ws-1.1 en 37 
 Bugfix
 ENV
 Friedrich
 Gemfile
+Matz
 NOREGTESTRC
+OpenStruct
 README
+Rakefile
 Regtest
 SCM
+STDERR
 SemVer
 SemVerTag
 YAML
+arg
+ary
+backtrace
+backtraces
 basename
 bitbucket
+catched
 dir
 exiftool
 gettime
@@ -19,20 +28,11 @@ github
 md
 metatest
 metatests
+ostruct
 rb
 rc
 regtest
 regtestrc
 scripref
-yml
-arg
-Matz
-ary
-Matz
-OpenStruct
-Rakefile
-arg
-ary
-catched
-ostruct
 yaml
+yml

data/Changelog

@@ -1,3 +1,11 @@
+2.3.0
+Remove regtest/colorize use regtest/colors instead.
+Add Regtest::Git.work_tree and Regtest::Git.git_dir to be more flexible when
+using different git repositories.
+Add flag Regtest.show_exceptions for easier analysing problems when unexpected
+exceptions occur.
+Optimize some internals.
+
 2.2.1
 Adapt git output to work with different git versions.
 Simplify determination of filenames for outputs.

data/LICENSE

@@ -1,3 +1,3 @@
-Copyright 2014, 2015, 2017-2019 by Jan Friedrich <janfri26@gmail.com>
+Copyright 2014, 2015, 2017-2019, 2021, 2024 by Jan Friedrich <janfri26@gmail.com>
 
 Regtest is licensed under the same terms as Ruby itself.

data/README.md

@@ -54,7 +54,7 @@ require 'regtest'
 
 Regtest.sample 'String result' do
   # Doing something to get the result of the sample
-  # end make sure it is the result of the block
+  # and ensure it is the result of the block
   'some text'
 end
 
@@ -151,7 +151,7 @@ corresponding results files should be taken under version control.
 The key idea behind regtest is to produce values that are invariant and check
 if this assumption is true at another (mostly later) state of code. But often
 there are temporary or specific values which changes or could change at each
-run of regtest. This could be for example an id for a created record or the
+run of regtest. This could be for example an id of a created record or the
 version of a used external service or some time-relevant values. Sometimes it
 is useful, to know the actual value of one of these.
 
@@ -219,6 +219,22 @@ Because the log files contains only temporary stuff they should normally not
 checked in the SCM.
 
 
+## Exceptions an backtraces
+
+If there is an exception raised inside a regtest sample its message is a part
+of the result of the sample. This is intentional because exceptions are
+possible results you want to check.
+
+But sometimes an exception occur inside of a sample that was not the intention
+of the sample code. In such situation it would be helpful to have the full
+exception message with the backtrace, to find the code location where the error
+occurred.
+
+You can do this with setting `Regtest.show_exceptions = true` (normally in a
+local `.regtestrc` file, see below) temporarily. Then the exception and
+backtrace is written to STDERR.
+
+
 ## Configuration and Plugins
 
 You can adapt the behaviour of regtest with plugins. To configure this and
@@ -255,11 +271,27 @@ Regtest.exit_codes[:unknown_result] = 0
 Regtest.exit_codes[:fail] = 0 
 ```
 
-This also should be don in a `.regtest` file and not in the sample files.
+This also should be done in a `.regtest` file and not in the sample files.
 
 Because in a `.regtestrc` file are individual configuration aspects of your
 workflow and environment it should not be checked into your SCM.
 
+
+## Plugin regtest/git
+
+If you use the git plugin (`require 'regtest/git'`) there will be two options
+you can set:
+
+* `Regtest::Git.git_dir`
+* `Regtest::Git.work_tree`
+
+which corresponds to the git parameters `--git-dir` and `--work-path`. Which
+could be helpful if you run `regtest` from inside an other git repository than
+your regtest files. Have a look at the git documentation for more details.
+
+As said above: this should also be done in a local `.regtestrc` file.
+
+
 ## Rake task
 
 Regtest includes a Rake task `regtest`. Per default it runs any `.rb` files

data/Rakefile

@@ -4,7 +4,6 @@
 $:.unshift 'lib'
 
 require 'rim/tire'
-require 'rim/regtest'
 require 'rim/version'
 
 require 'regtest/task'
@@ -42,5 +41,13 @@ if RUBY_ENGINE == 'jruby'
   REGTEST_FILES_RB.reject! {|fn| fn =~ /metatest/}
 end
 
+task :before_regtest do
+  verbose false do
+    rm_rf 'regtest/*.log'
+    rm_rf 'regtest/*.yml'
+  end
+end
+
+task :regtest => :before_regtest
 task :test => :regtest
 task :default => :test

data/lib/regtest/git.rb

@@ -3,54 +3,75 @@
 
 require 'open3'
 
-# Check if git is available and current directory is part of a git repository.
+# Check if git is available
 begin
-  _, ps = Open3.capture2e('git status --porcelain')
-  if ps.exitstatus == 0
-    module Regtest
-
-      # Regtest plugin for git (results are checked automatically when running
-      # regtest)
-      module Git
-
-        # Redefine Regtest.check_results.
-        def check_results
-          output_files = Regtest.results.keys
-          if output_files.empty?
-            report "\nNothing to do.", type: :success
-            return :success
-          end
-          git_stat, _, _ = Open3.capture3(*%w(git status --porcelain --), *output_files)
-          case git_stat
-          when /^.M/ # at least one modified file
-            report "\nThere are changes in your sample results!", type: :fail
-            system *%w(git status -s --), *output_files
-            return :fail
-          when /^.\?/ # at least one unknown file
-            report "\nThere is at least one new sample result file.", type: :unknown_result
-            system *%w(git status -s --), *output_files
-            return :unknown_result
-          when '', /^. / # no changes in (maybe staged) files
-            report "\nLooks good. :)", type: :success
-            system *%w(git status -s --), *output_files
-            return :success
-          else
-            report "\nYour sample results are in a bad condition!", type: :fail
-            system *%w(git status -s --), *output_files
-            return :fail
-          end
-        end
+  Open3.capture2e('git --version')
+  module Regtest
+
+    # Regtest plugin for git (results are checked automatically when running
+    # regtest)
+    module Git
 
+      # Redefine Regtest.check_results.
+      def check_results
+        output_files = Regtest.results.keys
+        if output_files.empty?
+          report "\nNothing to do.", type: :success
+          return :success
+        end
+        git_status = ['git', git_global_args, %w(status -s --)].flatten
+        git_results, stderr, _ = Open3.capture3(*git_status, *output_files)
+        unless stderr.empty?
+          report "\ngit command coud not be executed!", type: :fail
+          return :fail
+        end
+        case git_results
+        when /^.M/ # at least one modified file
+          report "\nThere are changes in your sample results!", type: :fail
+          system *git_status, *output_files
+          return :fail
+        when /^.\?/ # at least one unknown file
+          report "\nThere is at least one new sample result file.", type: :unknown_result
+          system *git_status, *output_files
+          return :unknown_result
+        when '', /^. / # no changes in (maybe staged) files
+          report "\nLooks good. :)", type: :success
+          system *git_status, *output_files
+          return :success
+        else
+          report "\nYour sample results are in a bad condition!", type: :fail
+          system *git_status, *output_files
+          return :fail
+        end
       end
 
       class << self
-        prepend Git
+        # git parameter +--work-tree+
+        attr_accessor :work_tree
+
+        # git parameter +--git-dir+
+        attr_accessor :git_dir
+      end
+
+      private
+
+      def git_global_args
+        args = []
+        if wt = Regtest::Git.work_tree
+          args << format('--work-tree=%s', wt)
+        end
+        if gt = Regtest::Git.git_dir
+          args << format('--git-dir=%s', gt)
+        end
+        args
       end
 
     end
-  else
-    warn 'current directory is not part of a git repository:'
-    warn 'plugin regtest/git disabled'
+
+    class << self
+      prepend Git
+    end
+
   end
 rescue Errno::ENOENT
   warn 'git command not found: plugin regtest/git disabled'

data/lib/regtest/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Regtest
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/lib/regtest.rb

@@ -3,7 +3,8 @@
 #
 # Regtest - Simple Regression Testing With Ruby
 #
-# Copyright 2014, 2015, 2017-2019 by Jan Friedrich <janfri26@gmail.com>
+# Copyright 2014, 2015, 2017-2019, 2021, 2024 by Jan Friedrich
+# <janfri26@gmail.com>
 # License: Regtest is licensed under the same terms as Ruby itself.
 #
 
@@ -21,6 +22,7 @@ module Regtest
   @log_filenames = Set.new
   @exit_codes = Hash.new(1)
   @exit_codes.merge!({success: 0, unknown_result: 1, fail: 2})
+  @show_exceptions = false
 
   # Define a sample
   def sample name
@@ -31,6 +33,9 @@ module Regtest
       h['result'] = yield
     rescue Exception => e
       h['exception'] = e.message
+      if show_exceptions
+        $stderr.puts nil, e.full_message
+      end
     end
     output_filename = Regtest.determine_filename_from_caller('.yml')
     unless Regtest.results[output_filename]
@@ -96,6 +101,9 @@ module Regtest
 
     attr_reader :exit_codes, :log_filenames, :results, :start
 
+    # Flag to show exceptions on STDERR
+    attr_accessor :show_exceptions
+
     # Determine a filename which is derived from the filename of the "real"
     # caller of the calling method
     # @param ext new extension (i.e. '.yml')

data/regtest.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-# stub: regtest 2.2.1 ruby lib
+# stub: regtest 2.3.0 ruby lib
 #
 # This file is automatically generated by rim.
 # PLEASE DO NOT EDIT IT DIRECTLY!
@@ -7,32 +7,23 @@
 
 Gem::Specification.new do |s|
   s.name = "regtest"
-  s.version = "2.2.1"
+  s.version = "2.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Jan Friedrich"]
-  s.date = "2021-02-24"
+  s.date = "2024-09-12"
   s.description = "This library supports a very simple way to do regression testing with Ruby. It\nis not limited to Ruby projects you can use it also in other contexts where you\ncan extract data with Ruby.\n\nYou write Ruby scripts with samples. Run these and get the sample results as\nresults files besides your scripts. Check both the scripts and the results\nfiles in you Source Code Management System (SCM). When you run the scrips on a\nlater (or even previous) version of your code a simple diff show you if and how\nthe changes in your code or environment impact the results of your samples.\n\nThis is not a replacement for unit testing but a complement: You can produce a\nlot of samples with a small amount of Ruby code (e.g. a large number of\ncombinations of data).\n"
   s.email = "janfri26@gmail.com"
-  s.files = ["./.aspell.pws", "Changelog", "Gemfile", "LICENSE", "README.md", "Rakefile", "lib/regtest", "lib/regtest.rb", "lib/regtest/colorize.rb", "lib/regtest/colors.rb", "lib/regtest/git.rb", "lib/regtest/task.rb", "lib/regtest/version.rb", "regtest.gemspec", "regtest/combinations.rb", "regtest/combinations.yml", "regtest/examples.rb", "regtest/examples.yml", "regtest/filename with spaces.rb", "regtest/filename with spaces.yml", "regtest/log.log", "regtest/log.rb", "regtest/log.yml", "regtest/log_append.log", "regtest/log_append.rb", "regtest/log_append.yml", "regtest/log_rewrite.log", "regtest/log_rewrite.rb", "regtest/log_rewrite.yml", "regtest/metatest.rb", "regtest/metatest.yml", "regtest/metatest_git.rb", "regtest/metatest_git.yml", "regtest/no_samples.rb", "regtest/toplevel.log", "regtest/toplevel.rb", "regtest/toplevel.yml"]
+  s.files = ["./.aspell.pws", "Changelog", "Gemfile", "LICENSE", "README.md", "Rakefile", "lib/regtest", "lib/regtest.rb", "lib/regtest/colors.rb", "lib/regtest/git.rb", "lib/regtest/task.rb", "lib/regtest/version.rb", "regtest.gemspec"]
   s.homepage = "https://github.com/janfri/regtest"
   s.licenses = ["Ruby"]
   s.required_ruby_version = Gem::Requirement.new(">= 2.1.0")
-  s.rubygems_version = "3.2.3"
+  s.rubygems_version = "3.6.0.dev"
   s.summary = "Simple regression testing with Ruby."
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-  end
+  s.specification_version = 4
 
-  if s.respond_to? :add_runtime_dependency then
-    s.add_development_dependency(%q<rake>, [">= 0"])
-    s.add_development_dependency(%q<rim>, ["~> 2.17"])
-    s.add_development_dependency(%q<regtest>, ["~> 2"])
-  else
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<rim>, ["~> 2.17"])
-    s.add_dependency(%q<regtest>, ["~> 2"])
-  end
+  s.add_development_dependency(%q<rake>, [">= 0"])
+  s.add_development_dependency(%q<rim>, ["~> 2.17"])
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: regtest
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Jan Friedrich
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,20 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.17'
-- !ruby/object:Gem::Dependency
-  name: regtest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
 description: |
   This library supports a very simple way to do regression testing with Ruby. It
   is not limited to Ruby projects you can use it also in other contexts where you
@@ -78,40 +63,15 @@ files:
 - README.md
 - Rakefile
 - lib/regtest.rb
-- lib/regtest/colorize.rb
 - lib/regtest/colors.rb
 - lib/regtest/git.rb
 - lib/regtest/task.rb
 - lib/regtest/version.rb
 - regtest.gemspec
-- regtest/combinations.rb
-- regtest/combinations.yml
-- regtest/examples.rb
-- regtest/examples.yml
-- regtest/filename with spaces.rb
-- regtest/filename with spaces.yml
-- regtest/log.log
-- regtest/log.rb
-- regtest/log.yml
-- regtest/log_append.log
-- regtest/log_append.rb
-- regtest/log_append.yml
-- regtest/log_rewrite.log
-- regtest/log_rewrite.rb
-- regtest/log_rewrite.yml
-- regtest/metatest.rb
-- regtest/metatest.yml
-- regtest/metatest_git.rb
-- regtest/metatest_git.yml
-- regtest/no_samples.rb
-- regtest/toplevel.log
-- regtest/toplevel.rb
-- regtest/toplevel.yml
 homepage: https://github.com/janfri/regtest
 licenses:
 - Ruby
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,8 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: Simple regression testing with Ruby.
 test_files: []

data/lib/regtest/colorize.rb

@@ -1,8 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'regtest/colors'
-
-Regtest::Colorize = Regtest::Colors
-
-warn 'regtest/colorize is deprecated. use regtest/colors instead.'

data/regtest/combinations.rb

@@ -1,15 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'ostruct'
-require 'regtest'
-
-o = OpenStruct.new
-o.a = [1, 2, 3]
-o.b = [:x, :y]
-
-Regtest.combinations(o).each_with_index do |c, i|
-  Regtest.sample "Combination #{i}" do
-    c.to_h
-  end
-end

data/regtest/combinations.yml

@@ -1,30 +0,0 @@
----
-sample: Combination 0
-result:
-  :a: 1
-  :b: :x
----
-sample: Combination 1
-result:
-  :a: 1
-  :b: :y
----
-sample: Combination 2
-result:
-  :a: 2
-  :b: :x
----
-sample: Combination 3
-result:
-  :a: 2
-  :b: :y
----
-sample: Combination 4
-result:
-  :a: 3
-  :b: :x
----
-sample: Combination 5
-result:
-  :a: 3
-  :b: :y

data/regtest/examples.rb

@@ -1,20 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'regtest'
-
-Regtest.sample 'String result' do
-  # Doing something to get the result of the sample
-  # and make sure it is the result of the block.
-  'some text'
-end
-
-Regtest.sample 'Division by zero' do
-  # If an exception occurs while execution of the
-  # block it is catched and its message is used as
-  # exception value for the sample.
-  2 / 0
-end
-
-# If no block is given => exception no block given (yield)
-Regtest.sample 'no block'

data/regtest/examples.yml

@@ -1,9 +0,0 @@
----
-sample: String result
-result: some text
----
-sample: Division by zero
-exception: divided by 0
----
-sample: no block
-exception: no block given (yield)

data/regtest/filename with spaces.rb

@@ -1,8 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'regtest'
-
-Regtest.sample 'spaces in filenames' do
-  "If you can read this in the results file #{File.basename(__FILE__.sub(/\.rb/, '.yml')).inspect} than regtest can handle filenames with spaces. :)"
-end

data/regtest/filename with spaces.yml

@@ -1,4 +0,0 @@
----
-sample: spaces in filenames
-result: If you can read this in the results file "filename with spaces.yml" than regtest
-  can handle filenames with spaces. :)

data/regtest/log.log

@@ -1,3 +0,0 @@
-2085.99375
-2085.994022
-Logging from outside of a sample works.

data/regtest/log.rb

@@ -1,18 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'regtest'
-
-Regtest.sample 'test' do
-  a = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-  Regtest.log a
-  b = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-  Regtest.log b
-  a < b
-end
-
-Regtest.sample 'invalid mode' do
-  Regtest.log 'foo', mode: 'x'
-end
-
-Regtest.log 'Logging from outside of a sample works.'

data/regtest/log.yml

@@ -1,6 +0,0 @@
----
-sample: test
-result: true
----
-sample: invalid mode
-exception: Mode x is not allowed.

data/regtest/log_append.log

@@ -1,4 +0,0 @@
-initial line
-first log entry
-second log entry
-first log entry

data/regtest/log_append.rb

@@ -1,32 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'regtest'
-require 'fileutils'
-
-
-$log_filename = __FILE__.sub(/\.rb$/, '.log')
-
-# set the initial content of the log file
-File.open($log_filename, 'w') do |f|
-  f.puts 'initial line'
-end
-
-def lines_of_log_file
-  File.readlines($log_filename).map(&:chomp) # keyword chomp is not supported by Ruby versions < 2.4
-end
-
-Regtest.sample 'first log entry appends to file' do
-  Regtest.log 'first log entry', mode: 'a'
-  lines_of_log_file
-end
-
-Regtest.sample 'second log entry appends to file' do
-  Regtest.log 'second log entry'
-  lines_of_log_file
-end
-
-Regtest.sample 'third log entry appends to file' do
-  Regtest.log 'first log entry', mode: 'a'
-  lines_of_log_file
-end

data/regtest/log_append.yml

@@ -1,18 +0,0 @@
----
-sample: first log entry appends to file
-result:
-- initial line
-- first log entry
----
-sample: second log entry appends to file
-result:
-- initial line
-- first log entry
-- second log entry
----
-sample: third log entry appends to file
-result:
-- initial line
-- first log entry
-- second log entry
-- first log entry

data/regtest/log_rewrite.log

@@ -1 +0,0 @@
-third log entry

data/regtest/log_rewrite.rb

@@ -1,32 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'regtest'
-require 'fileutils'
-
-
-$log_filename = __FILE__.sub(/\.rb$/, '.log')
-
-# set the initial content of the log file
-File.open($log_filename, 'w') do |f|
-  f.puts 'initial line'
-end
-
-def lines_of_log_file
-  File.readlines($log_filename).map(&:chomp) # keyword chomp is not supported by Ruby versions < 2.4
-end
-
-Regtest.sample 'first log entry rewrites log file' do
-  Regtest.log 'first log entry'
-  lines_of_log_file
-end
-
-Regtest.sample 'second log entry rewrites log file' do
-  Regtest.log 'second log entry', mode: 'w'
-  lines_of_log_file
-end
-
-Regtest.sample 'third log entry rewrites log file' do
-  Regtest.log 'third log entry', mode: 'w'
-  lines_of_log_file
-end

data/regtest/log_rewrite.yml

@@ -1,12 +0,0 @@
----
-sample: first log entry rewrites log file
-result:
-- first log entry
----
-sample: second log entry rewrites log file
-result:
-- second log entry
----
-sample: third log entry rewrites log file
-result:
-- third log entry

data/regtest/metatest.rb

@@ -1,31 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'fileutils'
-require 'open3'
-require 'regtest'
-require 'tmpdir'
-
-$my_dir = File.expand_path(__dir__)
-
-Dir.mktmpdir('regtest') do |tmpdir|
-  Dir.chdir $my_dir do
-    Dir['*.rb'].each do |filename|
-      # Beware of endless recursion.
-      next if filename =~ /metatest/
-      FileUtils.cp filename, tmpdir
-    end
-  end
-  Dir.chdir tmpdir do
-    lib_dir = File.join($my_dir, '../lib')
-    o, e, ps = Open3.capture3(*[{'NOREGTESTRC' => 'true'}, 'ruby', '-I', lib_dir], *Dir['*.rb'].sort)
-    Regtest.sample 'metatest' do
-      res = {'stdout' => o, 'stderr' => e}
-      # Levelling out runtime specific differences.
-      res['stdout'].gsub!(/\d+\.\d+/, 'x.xx')
-      res['stdout'].gsub!(%r(\d+ samples/s), 'x samples/s')
-      res['exitstatus'] = ps.exitstatus
-      res
-    end
-  end
-end

data/regtest/metatest.yml

@@ -1,24 +0,0 @@
----
-sample: metatest
-result:
-  stdout: |
-    combinations.yml
-    ......
-    examples.yml
-    ...
-    filename with spaces.yml
-    .
-    log.yml
-    ..
-    log_append.yml
-    ...
-    log_rewrite.yml
-    ...
-    toplevel.yml
-    .....
-
-    23 samples executed in x.xx s (x samples/s)
-
-    Please check result files manually. Regtest isn't able to do that.
-  stderr: ''
-  exitstatus: 1

data/regtest/metatest_git.rb

@@ -1,67 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-# If git isn't available skip this file
-begin
-  require 'open3'
-  Open3.capture2e('git --version')
-
-  require 'fileutils'
-  require 'regtest'
-  require 'regtest/git'
-  require 'tmpdir'
-
-  $my_dir = File.expand_path(__dir__)
-
-  def create_sample name
-    lib_dir = File.join($my_dir, '../lib')
-    o, e, ps = Open3.capture3(*[{'NOREGTESTRC' => 'true'}, 'ruby', '-I', lib_dir, '-r', 'regtest/git'], *Dir['*.rb'].sort)
-    Regtest.sample name do
-      res = {'stdout' => o, 'stderr' => e}
-      # Levelling out runtime specific differences.
-      res['stdout'].gsub!(/\d+\.\d+/, 'x.xx')
-      res['stdout'].gsub!(%r(\d+ samples/s), 'x samples/s')
-      res['stdout'].gsub!(/^\?\? filename with spaces.yml$/m, '?? "filename with spaces.yml"')
-      res['exitstatus'] = ps.exitstatus
-      res
-    end
-  end
-
-  def execute cmd
-    Open3.capture2e cmd
-  end
-
-  NEW_SAMPLE = <<-END
-
-  Regtest.sample 'new sample' do
-    'new sample'
-  end
-  END
-
-  Dir.mktmpdir('regtest') do |tmpdir|
-    Dir.chdir $my_dir do
-      Dir['*.rb'].each do |filename|
-        # Beware of endless recursion.
-        next if filename =~ /metatest/
-        FileUtils.cp filename, tmpdir
-      end
-    end
-    Dir.chdir tmpdir do
-      execute 'git init'
-      create_sample 'all new'
-      execute 'git add *.rb examples.yml combinations.yml'
-      create_sample 'only one new'
-      example_rb = File.read('examples.rb')
-      example_rb << NEW_SAMPLE
-      File.write('examples.rb', example_rb)
-      create_sample 'one new one modified to index'
-      execute 'git commit -m "commit"'
-      create_sample 'one new one modified'
-      execute 'git add *.yml'
-      create_sample 'all in index'
-      execute 'git commit -m "commit"'
-      create_sample 'all commited'
-    end
-  end
-rescue Errno::ENOENT
-end

data/regtest/metatest_git.yml

@@ -1,177 +0,0 @@
----
-sample: all new
-result:
-  stdout: |
-    combinations.yml
-    ......
-    examples.yml
-    ...
-    filename with spaces.yml
-    .
-    log.yml
-    ..
-    log_append.yml
-    ...
-    log_rewrite.yml
-    ...
-    toplevel.yml
-    .....
-
-    23 samples executed in x.xx s (x samples/s)
-
-    There is at least one new sample result file.
-    ?? combinations.yml
-    ?? examples.yml
-    ?? "filename with spaces.yml"
-    ?? log.yml
-    ?? log_append.yml
-    ?? log_rewrite.yml
-    ?? toplevel.yml
-  stderr: ''
-  exitstatus: 1
----
-sample: only one new
-result:
-  stdout: |
-    combinations.yml
-    ......
-    examples.yml
-    ...
-    filename with spaces.yml
-    .
-    log.yml
-    ..
-    log_append.yml
-    ...
-    log_rewrite.yml
-    ...
-    toplevel.yml
-    .....
-
-    23 samples executed in x.xx s (x samples/s)
-
-    There is at least one new sample result file.
-    A  combinations.yml
-    A  examples.yml
-    ?? "filename with spaces.yml"
-    ?? log.yml
-    ?? log_append.yml
-    ?? log_rewrite.yml
-    ?? toplevel.yml
-  stderr: ''
-  exitstatus: 1
----
-sample: one new one modified to index
-result:
-  stdout: |
-    combinations.yml
-    ......
-    examples.yml
-    ....
-    filename with spaces.yml
-    .
-    log.yml
-    ..
-    log_append.yml
-    ...
-    log_rewrite.yml
-    ...
-    toplevel.yml
-    .....
-
-    24 samples executed in x.xx s (x samples/s)
-
-    There are changes in your sample results!
-    A  combinations.yml
-    AM examples.yml
-    ?? "filename with spaces.yml"
-    ?? log.yml
-    ?? log_append.yml
-    ?? log_rewrite.yml
-    ?? toplevel.yml
-  stderr: ''
-  exitstatus: 2
----
-sample: one new one modified
-result:
-  stdout: |
-    combinations.yml
-    ......
-    examples.yml
-    ....
-    filename with spaces.yml
-    .
-    log.yml
-    ..
-    log_append.yml
-    ...
-    log_rewrite.yml
-    ...
-    toplevel.yml
-    .....
-
-    24 samples executed in x.xx s (x samples/s)
-
-    There are changes in your sample results!
-     M examples.yml
-    ?? "filename with spaces.yml"
-    ?? log.yml
-    ?? log_append.yml
-    ?? log_rewrite.yml
-    ?? toplevel.yml
-  stderr: ''
-  exitstatus: 2
----
-sample: all in index
-result:
-  stdout: |
-    combinations.yml
-    ......
-    examples.yml
-    ....
-    filename with spaces.yml
-    .
-    log.yml
-    ..
-    log_append.yml
-    ...
-    log_rewrite.yml
-    ...
-    toplevel.yml
-    .....
-
-    24 samples executed in x.xx s (x samples/s)
-
-    Looks good. :)
-    M  examples.yml
-    A  "filename with spaces.yml"
-    A  log.yml
-    A  log_append.yml
-    A  log_rewrite.yml
-    A  toplevel.yml
-  stderr: ''
-  exitstatus: 0
----
-sample: all commited
-result:
-  stdout: |
-    combinations.yml
-    ......
-    examples.yml
-    ....
-    filename with spaces.yml
-    .
-    log.yml
-    ..
-    log_append.yml
-    ...
-    log_rewrite.yml
-    ...
-    toplevel.yml
-    .....
-
-    24 samples executed in x.xx s (x samples/s)
-
-    Looks good. :)
-  stderr: ''
-  exitstatus: 0

data/regtest/no_samples.rb

@@ -1,8 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'regtest'
-
-# If a Ruby file doesn't contain any sample regtest shouldn't
-# generate a corresponding YAML file.
-2 + 2

data/regtest/toplevel.log

@@ -1 +0,0 @@
-0.65204510187786

data/regtest/toplevel.rb

@@ -1,30 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'regtest'
-
-methods_before = methods
-
-extend Regtest
-
-methods_after = methods
-
-Regtest.sample "Toplevel methods defined by 'extend Regtest'" do
-  (methods_after - methods_before).map(&:to_s).sort
-end
-
-Regtest.sample 'metatest' do
-  sample 'sample works at toplevel' do
-    true
-  end
-end
-
-Regtest.sample 'combinations work at toplevel' do
-  combinations(x: %w(a b), y: [1,2]).map(&:to_h)
-end
-
-Regtest.sample 'log works at toplevel' do
-  f = rand.to_s
-  log f
-  File.read(__FILE__.sub(/\.rb$/, '.log')).chomp == f
-end

data/regtest/toplevel.yml

@@ -1,28 +0,0 @@
----
-sample: Toplevel methods defined by 'extend Regtest'
-result:
-- combinations
-- log
-- sample
----
-sample: sample works at toplevel
-result: true
----
-sample: metatest
-result:
-  sample: sample works at toplevel
-  result: true
----
-sample: combinations work at toplevel
-result:
-- :x: a
-  :y: 1
-- :x: a
-  :y: 2
-- :x: b
-  :y: 1
-- :x: b
-  :y: 2
----
-sample: log works at toplevel
-result: true