regtest 2.0.0.pre → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a917267b567e320d9f372ad942f4602282c42b4
-  data.tar.gz: d2e5e0da3b36b4190db29449c188b31ff6072f23
+  metadata.gz: 28b2ce644b776836dc3a87811ecc3c8accc4365e
+  data.tar.gz: 64b940c2ab67af77fb2bbbf205abdd2e4122f0c1
 SHA512:
-  metadata.gz: 2b439502a95aa227425959e0de2be46d09d71233a3fc70b62a01220650464584d5a8ff1498ffcd41b9197679ad1b69e441d477b91a648a0ccb1910ec28b9cd5c
-  data.tar.gz: 6e3b8462a54c051a5d1ae795572c6ba5871f07df53359c21c34c2eada095b23eab01fc0176e1afa9b17bc6efcdeca48fb9c8e2bddeca03b9911b91cc5b150528
+  metadata.gz: c1bb833f9ae90d7cbbcbb63c503b72a6341df21728378aebabdb4ebcee97168b4567fbf6ca3185ee738434e986f7671f75a207df5d9aed9bcd1f5d151fef7337
+  data.tar.gz: ab381db6009de48d6698aeca01fcc550b3cc860022ecc88880942270ba4731509ee109273d94b43479635707c95a410679499dacf9554d2ca888a73e4d1430dd

data/.aspell.pws

@@ -1,5 +1,6 @@
-personal_ws-1.1 en 24 
+personal_ws-1.1 en 26 
 NOREGTESTRC
+md
 dir
 Bugfix
 ostruct
@@ -22,4 +23,5 @@ Friedrich
 SCM
 regtestrc
 metatest
+README
 OpenStruct

data/Changelog

@@ -1,4 +1,4 @@
-2.0.0.pre Major Release
+2.0.0 Major Release
 
 Incompatibilities to regtest 1.x
 1. The methods sample and combinations are not longer defined as instance
@@ -15,13 +15,18 @@ will not be loaded.
 A simple plugin mechanism is implemented and two plugins are part of regtest:
 regtest/colorize and regtest/git. Plugins are usual activated by require in
 one of the .regtestrc files.
+It is possible to change the exit codes for different return states of
+Regtest.check_results. This is done with changing Regtest.exit_codes see
+README.md for an example.
 
 Further Changes
-Reporting of statistics for writing files is removed because it's not useful.
-Now the full filename for results files are reported when running regtest.
+Reporting of statistics was reduced and the full filename for results files
+are now reported when running regtest.
 Some metatests are added.
 Version constant Regtest::VERSION is also added.
-A lot of internal refactoring and improving documentation.
+Regtest.sample returns now the hash with result information. This could be
+useful for plugins which overload this method.
+A lot of internal refactoring and improving documentation was done.
 
 
 1.1.0

data/README.md

@@ -161,8 +161,8 @@ use git as your SCM:
 ```ruby
 require 'regtest/colorize'
 # adapt some colorizing if wanted
-Regtest::Colorize.mapping[:filename] = :blue
-Regtest::Colorize.mapping[:statistics] = {mode: :italic}
+Regtest::Colorize.mapping[:filename] = :cyan
+Regtest::Colorize.mapping[:statistics] = {color: :blue, mode: :italic}
 
 require 'regtest/git'
 ```
@@ -174,7 +174,8 @@ script is accordingly set. The standard values are: 0 for success, 1 for an
 unknown result (normally a new results file) and 2 for failure. If you use
 plain regtest without a SCM plugin the exit code is 1 (= unknown result).
 
-You can change the exit codes for the states with `Regtest.exit_codes` for example:
+You can change the exit codes for the states with `Regtest.exit_codes`. The
+following example changes the behaviour to the same as in regtest version 1.x.
 
 ```ruby
 Regtest.exit_codes[:unknown_result] = 0 

data/Rakefile

@@ -37,5 +37,11 @@ Rim.setup do |p|
   p.dependencies << %w(colorize ~>0.8)
 end
 
+# JRuby does not support escaping of filenames with spaces in Open3.capture3
+# therefore ignore metatest files when running on JRuby
+if RUBY_ENGINE == 'jruby'
+  REGTEST_FILES_RB.reject! {|fn| fn =~ /metatest/}
+end
+
 task :test => :regtest
 task :default => :test

data/lib/regtest.rb

@@ -15,17 +15,15 @@ module Regtest
 
   @start = Time.now
   @results = {}
-  @statistics = []
   @exit_codes = Hash.new(1)
   @exit_codes.merge!({success: 0, unknown_result: 1, fail: 2})
 
   class << self
 
-    attr_reader :exit_codes, :results, :statistics, :start
+    attr_reader :exit_codes, :results, :start
 
     # Define a sample
-    def sample name, &_
-      start = Time.now
+    def sample name
       h = {}
       name = name.to_s if name.kind_of?(Symbol)
       h['sample'] = name
@@ -34,7 +32,7 @@ module Regtest
       rescue Exception => e
         h['exception'] = e.message
       end
-      output_filename = caller.first.split(/:\d+:/).first.sub(/\.rb/, '') << '.yml'
+      output_filename = determine_output_filename
       unless Regtest.results[output_filename]
         Regtest.report "\n", type: :filename unless Regtest.results.empty?
         Regtest.report output_filename, type: :filename
@@ -42,9 +40,7 @@ module Regtest
       end
       Regtest.results[output_filename] << h
       print '.'; $stdout.flush
-      stop = Time.now
-      Regtest.statistics << OpenStruct.new(filename: output_filename, sample: name, time: stop - start)
-      name
+      h
     end
 
     # Build all combinations of a Hash-like object with arrays as values.
@@ -75,11 +71,18 @@ module Regtest
       res
     end
 
+    # Determine the filename of the ouput file (results file)
+    # with informations from caller
+    def determine_output_filename
+      rest = caller.drop_while {|c| c !~ /in `sample'/}.drop_while {|c| c =~ /in `sample'/}
+      rest.first.split(/:\d+:/).first.sub(/\.rb/, '') << '.yml'
+    end
+
     # Report some statistics, could be overwritten by plugins.
     def report_statistics
       time = Time.now - start
-      sample_count = statistics.size
-      report format("\n\n%d samples executed in %.2f s (%.2f samples/s)", sample_count, time, sample_count / time), type: :statistics
+      sample_count = results.values.map(&:size).reduce(0, &:+)
+      report format("\n\n%d samples executed in %.2f s (%d samples/s)", sample_count, time, sample_count / time), type: :statistics
     end
 
     # Save all results to the corresponding files.

data/lib/regtest/colorize.rb

@@ -9,7 +9,8 @@ begin
     # (see https://rubygems.org/gems/colorize)
     module Colorize
 
-      @mapping = (%i(success fail unknown_result filename statistics).zip %i(green red yellow cyan default)).to_h
+      @mapping = (%i(success fail unknown_result filename).zip %i(green red yellow blue)).to_h
+      @mapping[:statistics] = {mode: :italic}
 
       class << self
         # Color mapping (all parameters of ColorizedString.colorize are supported

data/lib/regtest/version.rb

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

data/regtest.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-# stub: regtest 2.0.0.pre ruby lib
+# stub: regtest 2.0.0 ruby lib
 #
 # This file is automatically generated by rim.
 # PLEASE DO NOT EDIT IT DIRECTLY!
@@ -7,15 +7,15 @@
 
 Gem::Specification.new do |s|
   s.name = "regtest"
-  s.version = "2.0.0.pre"
+  s.version = "2.0.0"
 
-  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 = "2017-09-22"
   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/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/metatest.rb", "regtest/metatest.yml", "regtest/metatest_git.rb", "regtest/metatest_git.yml", "regtest/no_samples.rb"]
   s.homepage = "https://github.com/janfri/regtest"
   s.licenses = ["Ruby"]
   s.required_ruby_version = Gem::Requirement.new(">= 2.1.0")

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/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,12 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ..
+    examples.yml
+    ...
     filename with spaces.yml
     .
 
-    9 samples executed in x.xx s (x.xx samples/s)
+    10 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

@@ -10,8 +10,10 @@ begin
   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}
@@ -35,7 +37,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 +47,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,16 +4,16 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ..
+    examples.yml
+    ...
     filename with spaces.yml
     .
 
-    9 samples executed in x.xx s (x.xx samples/s)
+    10 samples executed in x.xx s (x samples/s)
 
     There is at least one new sample result file.
     ?? combinations.yml
-    ?? example.yml
+    ?? examples.yml
     ?? filename with spaces.yml
   stderr: ''
   exitstatus: 1
@@ -23,16 +23,16 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ..
+    examples.yml
+    ...
     filename with spaces.yml
     .
 
-    9 samples executed in x.xx s (x.xx samples/s)
+    10 samples executed in x.xx s (x samples/s)
 
     There is at least one new sample result file.
     A  combinations.yml
-    A  example.yml
+    A  examples.yml
     ?? filename with spaces.yml
   stderr: ''
   exitstatus: 1
@@ -42,16 +42,16 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ...
+    examples.yml
+    ....
     filename with spaces.yml
     .
 
-    10 samples executed in x.xx s (x.xx samples/s)
+    11 samples executed in x.xx s (x samples/s)
 
     There are changes in your sample results!
     A  combinations.yml
-    AM example.yml
+    AM examples.yml
     ?? filename with spaces.yml
   stderr: ''
   exitstatus: 2
@@ -61,15 +61,15 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ...
+    examples.yml
+    ....
     filename with spaces.yml
     .
 
-    10 samples executed in x.xx s (x.xx samples/s)
+    11 samples executed in x.xx s (x samples/s)
 
     There are changes in your sample results!
-     M example.yml
+     M examples.yml
     ?? filename with spaces.yml
   stderr: ''
   exitstatus: 2
@@ -79,15 +79,15 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ...
+    examples.yml
+    ....
     filename with spaces.yml
     .
 
-    10 samples executed in x.xx s (x.xx samples/s)
+    11 samples executed in x.xx s (x samples/s)
 
     Looks good. :)
-    M  example.yml
+    M  examples.yml
     A  "filename with spaces.yml"
   stderr: ''
   exitstatus: 0
@@ -97,12 +97,12 @@ result:
   stdout: |
     combinations.yml
     ......
-    example.yml
-    ...
+    examples.yml
+    ....
     filename with spaces.yml
     .
 
-    10 samples executed in x.xx s (x.xx samples/s)
+    11 samples executed in x.xx s (x samples/s)
 
     Looks good. :)
   stderr: ''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regtest
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre
+  version: 2.0.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2017-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -99,8 +99,8 @@ files:
 - regtest.gemspec
 - regtest/combinations.rb
 - regtest/combinations.yml
-- regtest/example.rb
-- regtest/example.yml
+- regtest/examples.rb
+- regtest/examples.yml
 - regtest/filename with spaces.rb
 - regtest/filename with spaces.yml
 - regtest/metatest.rb
@@ -123,9 +123,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13