regtest 2.0.0.pre → 2.2.1

data/lib/regtest/colors.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Regtest
+
+  module Colors
+
+    # Redefine Regtest.report
+    def report *args, type: nil
+      color = Colors.mapping[type]
+      if color && $stdout.tty?
+        args = args.map {|a| Colors.apply(a.to_s, color)}
+      end
+      puts *args
+    end
+
+    class << self
+      # Color mapping
+      # Examples:
+      #   Regtest::Colors.mapping[:filename] = :lightblue
+      #   Regtest::Colors.mapping[:fail] = :@red # '@' prefix means background color
+      #   Regtest::Colors.mapping[:statistics] = %i(cyan italic) # more than one color code is possible
+      attr_accessor :mapping
+
+      # Apply color codes to a string
+      def apply str, *codes
+        codes.flatten.each do |c|
+          num = @codes[c.to_sym]
+          fail format('Code %s not supported.', c) unless num
+          str = format("\e[%dm%s", num, str)
+        end
+        format("%s\e[0m", str)
+      end
+
+      # Get available color codes
+      def codes
+        @codes.keys
+      end
+    end
+
+    private
+
+    @mapping = (%i(success fail unknown_result filename).zip %i(green red yellow blue)).to_h
+    @codes = {}
+
+    %i(bold faint italic underline).each_with_index do |mode, i|
+      @codes[mode] = 1 + i
+    end
+
+    %i(black red green yellow blue magenta cyan white).each_with_index do |color, i|
+      @codes[color] = 30 + i
+      @codes[format('@%s', color).to_sym] = 40 + i
+      @codes[format('light%s', color).to_sym] = 90 + i
+      @codes[format('@light%s', color).to_sym] = 100 + i
+    end
+
+  end
+
+  class << self
+    prepend Colors
+  end
+
+end

data/lib/regtest/task.rb

@@ -1,9 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-#
-# Copyright 2014, 2016, 2017 by Jan Friedrich <janfri26@gmail.com>
-# License: Regtest is licensed under the same terms as Ruby itself.
-#
 
 # Regtest sample files (= Ruby files)
 REGTEST_FILES_RB = FileList.new('regtest/**/*.rb')

data/lib/regtest/version.rb

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

data/regtest.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-# stub: regtest 2.0.0.pre ruby lib
+# stub: regtest 2.2.1 ruby lib
 #
 # This file is automatically generated by rim.
 # PLEASE DO NOT EDIT IT DIRECTLY!
@@ -7,39 +7,32 @@
 
 Gem::Specification.new do |s|
   s.name = "regtest"
-  s.version = "2.0.0.pre"
+  s.version = "2.2.1"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  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 = "2017-09-12"
+  s.date = "2021-02-24"
   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/git.rb", "lib/regtest/task.rb", "lib/regtest/version.rb", "regtest.gemspec", "regtest/combinations.rb", "regtest/combinations.yml", "regtest/example.rb", "regtest/example.yml", "regtest/filename with spaces.rb", "regtest/filename with spaces.yml", "regtest/metatest.rb", "regtest/metatest.yml", "regtest/metatest_git.rb", "regtest/metatest_git.yml", "regtest/no_samples.rb"]
+  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.homepage = "https://github.com/janfri/regtest"
   s.licenses = ["Ruby"]
   s.required_ruby_version = Gem::Requirement.new(">= 2.1.0")
-  s.rubygems_version = "2.6.13"
+  s.rubygems_version = "3.2.3"
   s.summary = "Simple regression testing with Ruby."
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
+  end
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<colorize>, ["~> 0.8"])
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<rim>, ["~> 2.15"])
-      s.add_development_dependency(%q<regtest>, ["~> 1.0"])
-    else
-      s.add_dependency(%q<colorize>, ["~> 0.8"])
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<rim>, ["~> 2.15"])
-      s.add_dependency(%q<regtest>, ["~> 1.0"])
-    end
+  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<colorize>, ["~> 0.8"])
     s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<rim>, ["~> 2.15"])
-    s.add_dependency(%q<regtest>, ["~> 1.0"])
+    s.add_dependency(%q<rim>, ["~> 2.17"])
+    s.add_dependency(%q<regtest>, ["~> 2"])
   end
 end

data/regtest/{example.rb → examples.rb}

@@ -15,3 +15,6 @@ Regtest.sample 'Division by zero' do
   # exception value for the sample.
   2 / 0
 end
+
+# If no block is given => exception no block given (yield)
+Regtest.sample 'no block'

data/regtest/{example.yml → examples.yml}

@@ -4,3 +4,6 @@ result: some text
 ---
 sample: Division by zero
 exception: divided by 0
+---
+sample: no block
+exception: no block given (yield)

data/regtest/log.log

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

data/regtest/log.rb

@@ -0,0 +1,18 @@
+# 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

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

data/regtest/log_append.log

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

data/regtest/log_append.rb

@@ -0,0 +1,32 @@
+# 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

@@ -0,0 +1,18 @@
+---
+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

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

data/regtest/log_rewrite.rb

@@ -0,0 +1,32 @@
+# 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

@@ -0,0 +1,12 @@
+---
+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

@@ -6,8 +6,10 @@ require 'open3'
 require 'regtest'
 require 'tmpdir'
 
+$my_dir = File.expand_path(__dir__)
+
 Dir.mktmpdir('regtest') do |tmpdir|
-  Dir.chdir __dir__ do
+  Dir.chdir $my_dir do
     Dir['*.rb'].each do |filename|
       # Beware of endless recursion.
       next if filename =~ /metatest/
@@ -15,12 +17,13 @@ Dir.mktmpdir('regtest') do |tmpdir|
     end
   end
   Dir.chdir tmpdir do
-    lib_dir = File.join(__dir__, '../lib')
+    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

data/regtest/metatest.yml

@@ -4,12 +4,20 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ..
+    examples.yml
+    ...
     filename with spaces.yml
     .
+    log.yml
+    ..
+    log_append.yml
+    ...
+    log_rewrite.yml
+    ...
+    toplevel.yml
+    .....
 
-    9 samples executed in x.xx s (x.xx samples/s)
+    23 samples executed in x.xx s (x samples/s)
 
     Please check result files manually. Regtest isn't able to do that.
   stderr: ''

data/regtest/metatest_git.rb

@@ -3,21 +3,25 @@
 
 # If git isn't available skip this file
 begin
+  require 'open3'
   Open3.capture2e('git --version')
 
   require 'fileutils'
-  require 'open3'
+  require 'regtest'
   require 'regtest/git'
   require 'tmpdir'
 
+  $my_dir = File.expand_path(__dir__)
+
   def create_sample name
-    lib_dir = File.join(__dir__, '../lib')
+    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
@@ -35,7 +39,7 @@ begin
   END
 
   Dir.mktmpdir('regtest') do |tmpdir|
-    Dir.chdir __dir__ do
+    Dir.chdir $my_dir do
       Dir['*.rb'].each do |filename|
         # Beware of endless recursion.
         next if filename =~ /metatest/
@@ -45,11 +49,11 @@ begin
     Dir.chdir tmpdir do
       execute 'git init'
       create_sample 'all new'
-      execute 'git add *.rb example.yml combinations.yml'
+      execute 'git add *.rb examples.yml combinations.yml'
       create_sample 'only one new'
-      example_rb = File.read('example.rb')
+      example_rb = File.read('examples.rb')
       example_rb << NEW_SAMPLE
-      File.write('example.rb', example_rb)
+      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'

data/regtest/metatest_git.yml

@@ -4,17 +4,29 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ..
+    examples.yml
+    ...
     filename with spaces.yml
     .
+    log.yml
+    ..
+    log_append.yml
+    ...
+    log_rewrite.yml
+    ...
+    toplevel.yml
+    .....
 
-    9 samples executed in x.xx s (x.xx samples/s)
+    23 samples executed in x.xx s (x samples/s)
 
     There is at least one new sample result file.
     ?? combinations.yml
-    ?? example.yml
-    ?? filename with spaces.yml
+    ?? examples.yml
+    ?? "filename with spaces.yml"
+    ?? log.yml
+    ?? log_append.yml
+    ?? log_rewrite.yml
+    ?? toplevel.yml
   stderr: ''
   exitstatus: 1
 ---
@@ -23,17 +35,29 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ..
+    examples.yml
+    ...
     filename with spaces.yml
     .
+    log.yml
+    ..
+    log_append.yml
+    ...
+    log_rewrite.yml
+    ...
+    toplevel.yml
+    .....
 
-    9 samples executed in x.xx s (x.xx samples/s)
+    23 samples executed in x.xx s (x samples/s)
 
     There is at least one new sample result file.
     A  combinations.yml
-    A  example.yml
-    ?? filename with spaces.yml
+    A  examples.yml
+    ?? "filename with spaces.yml"
+    ?? log.yml
+    ?? log_append.yml
+    ?? log_rewrite.yml
+    ?? toplevel.yml
   stderr: ''
   exitstatus: 1
 ---
@@ -42,17 +66,29 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ...
+    examples.yml
+    ....
     filename with spaces.yml
     .
+    log.yml
+    ..
+    log_append.yml
+    ...
+    log_rewrite.yml
+    ...
+    toplevel.yml
+    .....
 
-    10 samples executed in x.xx s (x.xx samples/s)
+    24 samples executed in x.xx s (x samples/s)
 
     There are changes in your sample results!
     A  combinations.yml
-    AM example.yml
-    ?? filename with spaces.yml
+    AM examples.yml
+    ?? "filename with spaces.yml"
+    ?? log.yml
+    ?? log_append.yml
+    ?? log_rewrite.yml
+    ?? toplevel.yml
   stderr: ''
   exitstatus: 2
 ---
@@ -61,16 +97,28 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ...
+    examples.yml
+    ....
     filename with spaces.yml
     .
+    log.yml
+    ..
+    log_append.yml
+    ...
+    log_rewrite.yml
+    ...
+    toplevel.yml
+    .....
 
-    10 samples executed in x.xx s (x.xx samples/s)
+    24 samples executed in x.xx s (x samples/s)
 
     There are changes in your sample results!
-     M example.yml
-    ?? filename with spaces.yml
+     M examples.yml
+    ?? "filename with spaces.yml"
+    ?? log.yml
+    ?? log_append.yml
+    ?? log_rewrite.yml
+    ?? toplevel.yml
   stderr: ''
   exitstatus: 2
 ---
@@ -79,16 +127,28 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ...
+    examples.yml
+    ....
     filename with spaces.yml
     .
+    log.yml
+    ..
+    log_append.yml
+    ...
+    log_rewrite.yml
+    ...
+    toplevel.yml
+    .....
 
-    10 samples executed in x.xx s (x.xx samples/s)
+    24 samples executed in x.xx s (x samples/s)
 
     Looks good. :)
-    M  example.yml
+    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
 ---
@@ -97,12 +157,20 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ...
+    examples.yml
+    ....
     filename with spaces.yml
     .
+    log.yml
+    ..
+    log_append.yml
+    ...
+    log_rewrite.yml
+    ...
+    toplevel.yml
+    .....
 
-    10 samples executed in x.xx s (x.xx samples/s)
+    24 samples executed in x.xx s (x samples/s)
 
     Looks good. :)
   stderr: ''