regtest 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e1feb2ecc25dc41c27accec0f36a65f978b118c
-  data.tar.gz: 6fa8a1f8005373e60f44477bcaae010ed5bd9563
+  metadata.gz: abd6f8185f73664165e398cca0bef2b0939745a4
+  data.tar.gz: 4365febeeb57037f5f07d8719307926364ca0764
 SHA512:
-  metadata.gz: f439ea61e766fdfdd68771b3d1f219dcbcf820126e3e58c79a37312806b75a434b554a6f9961ebff8397282da34e8ea1a6ac16ee580ce638e03d0cff791f13e5
-  data.tar.gz: 45ce675a07a44e166a983aa9494c3038cab1c4de18f0b5b6e0661d0615f87dfd8acee43bbf282a79bb7055828b76dc45359793c690e563eff3423ace2156a471
+  metadata.gz: 9cc05a81f6ab89b4c049e495a7936ed43ca608cab90b13e2e02ad365f7565f97f73b798d5bd0f6d31db4fb1eefaef102a781727bb12a53296f893406d41a6653
+  data.tar.gz: 2fb9fe69b682acfc98c660de78e1ad699da386c85e04a8ec60be3666ecf66e8e64d782fbbcd9081c9402ba4f687eb748a18bc5e1f56adf8b162db1d8db75838a

data/Changelog

@@ -1,3 +1,8 @@
+0.3.0
+Printing some statistics.
+Using regtest itself.
+Update documentation.
+
 0.2.0
 Update rake task (set lib directory to $LOAD_PATH).
 

data/README.md

@@ -0,0 +1,114 @@
+# Regtest - Simple Regression Testing For Ruby Projects
+
+## 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.
+
+## Installation
+
+Installing the gem with
+    gem install regtest
+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)
+
+### Writing Samples
+
+A samples file is a simple Ruby script with one ore more samples,
+for example
+    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.
+
+You can also include Regtest to have the sample method at
+top level.
+    require 'regtest'
+    include Regtest
+
+    sample :x do
+      :x
+    end
+
+By convention sample files are stored in a directory `regtest`
+in your Ruby application.
+
+
+### Running Samples
+
+Wether you run your examples manually
+    ruby -I lib regtest/*.rb
+or using the Rake task of regtest:
+Add the line
+    require 'regtest/task'
+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
+    regtest/foo.rb
+    regtest/bar.rb
+are the corresponding results files
+    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
+existend) with the actual result values of your samples.
+So source code version control programm 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.
+
+## 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.
+
+## Author
+
+Jan Friedrich <janfri26@gmail.com>
+
+## License
+
+Regtest is licensed under the same terms as Ruby itself.

data/Rakefile

@@ -2,9 +2,12 @@ require 'rim'
 require 'rim/check_version'
 require 'rim/gem'
 
+$:.unshift 'lib'
+require 'regtest/task'
+
 Rim.setup do |p|
   p.name = 'regtest'
-  p.version = '0.2.0'
+  p.version = '0.3.0'
   p.authors = 'Jan Friedrich'
   p.email = 'janfri26@gmail.com'
   p.summary = 'Regression testing in Ruby.'

data/lib/regtest.rb

@@ -1,15 +1,17 @@
 #
-# Regtest - Regression testing for Ruby
+# Regtest - Simple Regression Testing For Ruby Projects
 #
 # Copyright 2014 by Jan Friedrich (janfri26@gmail.com)
-# License: Rubys License
+# License: Regtest is licensed under the same terms as Ruby itself.
 #
 
 require 'yaml'
 
 module Regtest
 
-  @@results = {}
+  @count = 0
+  @results = {}
+  @start = Time.now
 
   def sample name
     h = {}
@@ -21,17 +23,18 @@ module Regtest
       h['exception'] = e.message
     end
     output_filename = caller.first.split(/:/).first.sub(/\.rb/, '') << '.yml'
-    unless @@results[output_filename]
-      puts unless @@results.empty?
+    unless Regtest.results[output_filename]
+      puts unless Regtest.results.empty?
       puts File.basename(output_filename, '.yml')
-      @@results[output_filename] = []
+      Regtest.results[output_filename] = []
     end
-    @@results[output_filename] << h
+    Regtest.results[output_filename] << h
+    Regtest.count += 1
     print '.'; $stdout.flush
   end
 
-  def self.results
-    @@results
+  class << self
+    attr_accessor :count, :results, :start
   end
 
   module_function :sample
@@ -40,7 +43,10 @@ end
 
 at_exit do
   ARGV.each {|a| load a}
-  puts
+  sample_count = Regtest.count
+  sample_time = Time.now - Regtest.start
+  puts format("\n\n%d samples executed in %.2f s (%.2f samples/s)", sample_count, sample_time, sample_count / sample_time)
+  save_start = Time.now
   Regtest.results.each_pair do |filename,arr|
     File.open(filename, 'w') do |f|
       arr.each do |h|
@@ -48,4 +54,7 @@ at_exit do
       end
     end
   end
+  files_count = Regtest.results.size
+  save_time = Time.now - save_start
+  puts format("%d files written in %.2f s (%.2f files/s)", files_count, save_time, files_count / save_time)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regtest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rim
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.8.1
 description: Regression testing in Ruby.
 email: janfri26@gmail.com
 executables: []
@@ -31,6 +31,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Changelog
+- README.md
 - Rakefile
 - lib/regtest.rb
 - lib/regtest/task.rb
@@ -54,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Regression testing in Ruby.