regtest 0.5.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbb002804580991f8d6be0a8b3eddd8ef0883f81
-  data.tar.gz: 23a0d3d370e2a9d896ff9112c740b3b15a48eb02
+  metadata.gz: accc98eaba516d684361d2dbe6a3d3bb13699ba8
+  data.tar.gz: 55c62a159fcbd0f218aaeb2ff69a70b4914a1f9f
 SHA512:
-  metadata.gz: 03ea7cf106bb192422c2e9c1292f2974389001528cebf2ac3644e5c8f6fd8a93ad3f29b09128fa6aea14348a485a2ca73dc1db333843b97123c0d589dba464eb
-  data.tar.gz: 361aee80e72f09fb16c6bd5e966b174f86a023c15a3a74452215d8746c3d32f762828a4e0f0af3fe302b9fd73804e67207259dd8fe5325ed80d98a73c21de53d
+  metadata.gz: 15f9eca32bcfb978ff004972b19e51dbab4542a2f0fe098aebdb8c9600d76b836b0bead6e0c922d0c2a03773775113b9bd32aa867a1da548cf725295d622a329
+  data.tar.gz: d39493f32b6cdaa8dc1bce1874f48cba1e75ce18b3b925ac2682c291d091c2035981c23e19bfdf560749c64fb6f07eeaa769ff5acdcc7b0d38dd248d54ebd125

data/Changelog

@@ -1,3 +1,6 @@
+1.0.0
+Some updates in documentation and project description.
+
 0.5.3
 Use rim/regtest to include regtest files in gem.
 Update homepage.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

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

data/README.md

@@ -2,119 +2,178 @@
 
 ## Description
 
-This library support a very simple way to do regression testing in Ruby projects.
-I am using it for integration testing of my projects
-[mini_exiftool](https://github.com/janfri/mini_exiftool/tree/master/regtest)
-and [multi_exiftool](https://github.com/janfri/multi_exiftool-redesign/tree/master/regtest)
-to check if exiftool itself returns different values or
-new tags in newer versions.
+This library support a very simple way to do regression testing in Ruby
+projects.  You write Ruby scripts with samples. Run these and get the sample
+results as YAML output besides your scripts. Check both the scripts and the YAML
+files with the results in you Source Code Control System.  When you run the
+scrips on a later (or even previous) version of your code a simple diff show you
+if and how the changes in your code impact the results of your samples.
+
+This is not a replacement for unit testing but a complement: You can produce a
+lot of samples with a small amount of Ruby code (e.g. a large number of
+combinations of data).
+
 
 ## Installation
 
-Installing the gem with
+Installing the gem on the command line with
+
+```sh
+gem install regtest
+```
 
-    gem install regtest
+or add
+
+```ruby
+gem 'regtest'
+```
+to your Gemfile or put a copy of `regtest.rb` in your project.
 
-or put a copy of regtest.rb in your project.
 
 ## Using
 
 The idea behind regtest is the following workflow:
   1. Writing samples
   2. Running samples
-  3. Checking results (differences between the actual results and the
-  results of a previous run of your samples)
+  3. Checking results (differences between the actual results and the results of
+     a previous run of your samples using the diff functionality of your Source
+     Code Control System)
+
 
 ### Writing Samples
 
-A samples file is a simple Ruby script with one ore more samples,
-for example
+A samples file is a simple Ruby script with one ore more samples, for example
+
+```ruby
+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
+  'some text'
+end
+
+Regtest.sample 'Division by zero' do
+  # If an exception occurs while execution of the
+  # block it is catched and used as value for the
+  # sample
+  2 / 0
+end
+```
+
+The name of the sample (parameter of the `Regtest.sample` method) and the
+results of the samples (return value of the block) are stored in YAML format. So
+it should be a YAML friendly value as `String`, `Number`, `Boolean value`,
+`Symbol`.  Results could also be an `Array` or `Hash` with such values.
+
+
+#### Helpers
 
-    require 'regtest'
+There is a method `Regtest.combinations` to generate a lot of combinations the
+easy way. An example:
 
-    Regtest.sample 'String result' do
-      # Doing something to get the result of the sample
-      # end make sure it is the result of the block
-      'some text'
-    end
+```ruby
+require 'ostruct'
+require 'regtest'
 
-    Regtest.sample 'Division by zero' do
-      # If an exception occurs while execution of the
-      # block it is catched and used as value for the
-      # sample
-      2 / 0
-    end
+o = OpenStruct.new
+o.a = [1,2,3]
+o.b = [:x, :y]
+Regtest.combinations(o).map(&:to_h)
+# => [{:a=>1, :b=>:x}, {:a=>1, :b=>:y}, {:a=>2, :b=>:x}, {:a=>2, :b=>:y}, {:a=>3, :b=>:x}, {:a=>3, :b=>:y}]
+```
 
-The name of the sample (parameter of the `Regtest.sample` method)
-and the results of the samples (return value of the block) are stored
-in YAML format. So it should be a YAML friendly value as String,
-Number, Boolean value, Symbol.
-Results could also be an Array or Hash with such values.
+See also the combinations example in the `regtest` folder.
 
-You can also include Regtest to have the sample method at
-top level.
+You can also include `Regtest` to have the `sample` and `combinations method at top level.
 
-    require 'regtest'
-    include Regtest
+```ruby
+require 'regtest'
+include Regtest
 
-    sample :x do
-      :x
-    end
+sample :x do
+  :x
+end
+```
 
-By convention sample files are stored in a directory `regtest`
-in your Ruby application.
+By convention sample files are stored in a directory `regtest` in your Ruby application.
 
 
 ### Running Samples
 
 Whether you run your examples manually
 
-    ruby -I lib regtest/*.rb
+```sh
+ruby -I lib regtest/*.rb
+```
 
-or using the Rake task of regtest:
-Add the line
+or using the Rake task of regtest and add
 
-    require 'regtest/task'
+```ruby
+require 'regtest/task'
+```
+
+to your `Rakefile` and you can run your samples with `rake regtest`.
 
-to your Rakefile and you can run your samples with `rake regtest`.
 
 ### Checking Results
 
-The results of each samples file are stored as a collection of
-YAML documents in a corresponding results file (YAML) per samples
-file.
-For example for the samples files
+The results of each samples file are stored as a collection of YAML documents in
+a corresponding results file (YAML) per samples file.  For example for the
+samples files
 
-    regtest/foo.rb
-    regtest/bar.rb
+```sh
+regtest/foo.rb
+regtest/bar.rb
+```
 
 are the corresponding results files
 
-    regtest/foo.yml
-    regtest/bar.yml
+```sh
+regtest/foo.yml
+regtest/bar.yml
+```
 
 So the content of the results file of the example above is
 
-    ---
-    sample: String result
-    result: some text
-    ---
-    sample: Division by zero
-    exception: divided by 0
-
-Each time you run one ore more samples file the corresponding
-results file will be overwritten (or generated if not yet
-existent) with the actual result values of your samples.
-So source code version control program is the tool to determine
-changes between older runs of the samples.
-Therefore the samples file and their corresponding results files
-should be taken under version control.
+```yaml
+---
+sample: String result
+result: some text
+---
+sample: Division by zero
+exception: divided by 0
+```
+
+Note: Each sample is represented by a YAML document in the corresponding YAML
+file.
+
+Each time you run one ore more samples file the corresponding results file will
+be overwritten (or generated if not yet existent) with the actual result values
+of your samples.  So Source Code Version Control program is the tool to
+determine changes between older runs of the samples.  Therefore the samples file
+and their corresponding results files should be taken under version control.
+
+
+## Further information
+
+I use `regtest` in my project [scripref](https://github.com/janfri/scripref) to
+generate a lot of malformed input data to check regressions in the behaviour of
+the parser and text processor.
+
+A little different is the usage in my projects
+[mini_exiftool](https://github.com/janfri/mini_exiftool/tree/master/regtest) and
+[multi_exiftool](https://github.com/janfri/multi_exiftool-redesign/tree/master/regtest).
+There regtest is used for integration testing to check if Exiftool itself (an
+external program that I do not develop) returns different values or new tags in
+newer versions.
+
 
 ## Source Code
 
 The code is hosted on [github](https://github.com/janfri/regtest) and
-[gitorious](https://gitorious.org/regtest).
-Change it to your needs. Release a fork. It is open source.
+[bitbucket](https://bitbucket.org/janfri/regtest) Change it to your needs.
+Release a fork. It is open source.
 
 ## Author
 

data/Rakefile

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'rim/tire'
 require 'rim/regtest'
 require 'rim/version'
@@ -7,12 +10,23 @@ require 'regtest/task'
 
 Rim.setup do |p|
   p.name = 'regtest'
-  p.version = '0.5.3'
+  p.version = '1.0.0'
   p.authors = 'Jan Friedrich'
   p.email = 'janfri26@gmail.com'
-  p.summary = 'Regression testing in Ruby.'
+  p.summary = 'Simple regression testing for Ruby projects.'
   p.license = 'Ruby'
-  p.description = p.summary
+  p.description = <<-END.gsub(/^ +/, '')
+    This library support a very simple way to do regression testing in Ruby
+    projects.  You write Ruby scripts with samples. Run these and get the sample
+    results as YAML output besides your scripts. Check both the scripts and the YAML
+    files with the results in you Source Code Control System.  When you run the
+    scrips on a later (or even previous) version of your code a simple diff show you
+    if and how the changes in your code impact the results of your samples.
+    
+    This is not a replacement for unit testing but a complement: You can produce a
+    lot of samples with a small amount of Ruby code (e.g. a large number of
+    combinations of data).
+  END
   p.homepage = 'https://github.com/janfri/regtest'
 end
 

data/lib/regtest.rb

@@ -1,7 +1,9 @@
+# encoding: utf-8
+# frozen_string_literal: true
 #
 # Regtest - Simple Regression Testing For Ruby Projects
 #
-# Copyright 2014, 2015 by Jan Friedrich (janfri26@gmail.com)
+# Copyright 2014, 2015 by Jan Friedrich <janfri26@gmail.com>
 # License: Regtest is licensed under the same terms as Ruby itself.
 #
 

data/lib/regtest/task.rb

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

data/regtest.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+# stub: regtest 1.0.0 ruby lib
+#
+# This file is automatically generated by rim.
+# PLEASE DO NOT EDIT IT DIRECTLY!
+# Change the values in Rim.setup in Rakefile instead.
+
+Gem::Specification.new do |s|
+  s.name = "regtest"
+  s.version = "1.0.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 = "2017-08-19"
+  s.description = "This library support a very simple way to do regression testing in Ruby\nprojects.  You write Ruby scripts with samples. Run these and get the sample\nresults as YAML output besides your scripts. Check both the scripts and the YAML\nfiles with the results in you Source Code Control System.  When you run the\nscrips on a later (or even previous) version of your code a simple diff show you\nif and how the changes in your code 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 = ["Changelog", "Gemfile", "LICENSE", "README.md", "Rakefile", "lib/regtest", "lib/regtest.rb", "lib/regtest/task.rb", "regtest.gemspec", "regtest/combinations.rb", "regtest/combinations.yml", "regtest/example.rb", "regtest/example.yml", "regtest/no_samples.rb"]
+  s.homepage = "https://github.com/janfri/regtest"
+  s.licenses = ["Ruby"]
+  s.rubygems_version = "2.6.12"
+  s.summary = "Simple regression testing for Ruby projects."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rim>, ["~> 2.11"])
+      s.add_development_dependency(%q<regtest>, ["~> 0.4"])
+    else
+      s.add_dependency(%q<rim>, ["~> 2.11"])
+      s.add_dependency(%q<regtest>, ["~> 0.4"])
+    end
+  else
+    s.add_dependency(%q<rim>, ["~> 2.11"])
+    s.add_dependency(%q<regtest>, ["~> 0.4"])
+  end
+end

data/regtest/combinations.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'ostruct'
 require 'regtest'
 

data/regtest/example.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'regtest'
 
 Regtest.sample 'String result' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regtest
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2017-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rim
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: regtest
   requirement: !ruby/object:Gem::Requirement
@@ -38,17 +38,30 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-description: Regression testing in Ruby.
+description: |
+  This library support a very simple way to do regression testing in Ruby
+  projects.  You write Ruby scripts with samples. Run these and get the sample
+  results as YAML output besides your scripts. Check both the scripts and the YAML
+  files with the results in you Source Code Control System.  When you run the
+  scrips on a later (or even previous) version of your code a simple diff show you
+  if and how the changes in your code impact the results of your samples.
+
+  This is not a replacement for unit testing but a complement: You can produce a
+  lot of samples with a small amount of Ruby code (e.g. a large number of
+  combinations of data).
 email: janfri26@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - Changelog
+- Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/regtest.rb
 - lib/regtest/task.rb
+- regtest.gemspec
 - regtest/combinations.rb
 - regtest/combinations.yml
 - regtest/example.rb
@@ -74,8 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: Regression testing in Ruby.
+summary: Simple regression testing for Ruby projects.
 test_files: []