minitest_log 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 716851f9c685e15ba71ffea59e47dad1da9343cbf2b9bd23c14f6ce343492085
-  data.tar.gz: a9609761116629a1c2d34ffd6caa6d435e4028bdcfe1b22df5f21c6312215027
+  metadata.gz: 236b57c783822edbb9a07679686b08149677797e5a7a047ec73fc093185fb1ba
+  data.tar.gz: 868cc374fad37e8da78356faa0a8d637203132964c47c8ad6b6af6d572175772
 SHA512:
-  metadata.gz: 729a1dc2f378cdce0a14be1ab5d67307aad48e47e8c8bc77f446ccdcb5f80f10d0595f0ad12fea71cc3b3fde733160caf0f6b86bdc7b769af12415274c7192a2
-  data.tar.gz: 2e2418623de37f1f1e6a249f32a6737f68ed719a711315f759f8420f38a70f57979b1368f3fc9d8e3d8c4a85f11eb73bfd685af6c3a7cafaf5cafe45f43ce509
+  metadata.gz: a671ea26b34d7aa17791d9bdef45c0162bc5bd21f1645b47ee100ff1ebfe31e4f9e8f78aecd107453e425864600f98c86f306e78cf721e6ed7ce4a39443f3eb0
+  data.tar.gz: 07caf2ac34f7ef71875eb9167a4b55b3107004665f118d3b563b153c11f21d3b4441510b918cd199d6c60b1c19cdc070e63e31f562b935f099a7fd96229141ac

data/Gemfile.lock

@@ -1,26 +1,26 @@
-PATH
-  remote: .
-  specs:
-    minitest_log (0.2.0)
-      diff-lcs (~> 1.3)
-      minitest (~> 5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    markdown_helper (2.1.0)
-    minitest (5.11.3)
-    rake (10.5.0)
-
-PLATFORMS
-  x64-mingw32
-
-DEPENDENCIES
-  bundler (~> 1.7)
-  markdown_helper (~> 2.0)
-  minitest_log!
-  rake (~> 10.0)
-
-BUNDLED WITH
-   1.17.3
+PATH
+  remote: .
+  specs:
+    minitest_log (1.0.0)
+      diff-lcs (~> 1.3)
+      minitest (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    markdown_helper (2.1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  markdown_helper (~> 2.0)
+  minitest_log!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -1,14 +1,19 @@
-[![Gem Version](https://badge.fury.io/rb/minitest_log.svg)](https://badge.fury.io/rb/minitest_log)
-
 # MinitestLog
 
+[![Gem Version](https://badge.fury.io/rb/minitest_log.svg)](https://badge.fury.io/rb/minitest_log)
 
 ```MinitestLog``` gives you three things:
 
 - **Nested sections:**  Use nested sections to structure your test (and, importantly, its log), so that the test can "tell its story" clearly.
-- **Data explication:**  Use data-logging methods to log objects. Most collections (```Aray```, ```Hash```, etc.) are automatically logged in detail.
+- **Data explication:**  Use data-logging methods to log objects. Most collections (```Array```, ```Hash```, etc.) are automatically logged in detail.
 - **(And of course) Verdicts:** Use verdict methods to express assertions.  Details for the verdict are logged, whether passed or failed.
 
+## Installation
+
+```sh
+gem install minitest_log
+```
+
 ## Contents
 - [Logs and Sections](#logs-and-sections)
   - [Nested Sections](#nested-sections)
@@ -25,6 +30,7 @@
     - [XML Indentation](#xml-indentation)
     - [Summary](#summary)
     - [Error Verdict](#error-verdict)
+    - [Backtrace Filter](#backtrace-filter)
 - [Data](#data)
   - [Strings](#strings)
   - [Hash-Like Objects](#hash-like-objects)
@@ -69,6 +75,8 @@
   - [Use Short Verdict Aliases](#use-short-verdict-aliases)
   - [Avoid Failure Clutter](#avoid-failure-clutter)
   - [Facilitate Post-Processing](#facilitate-post-processing)
+- [Oh, and Tests](#oh-and-tests)
+- [About This README](#about-this-readme)
 
 ## Logs and Sections
 
@@ -278,13 +286,13 @@ end
 ```log.xml```:
 ```xml
 <log>
-  <section_ name='My section with timestamp' timestamp='2019-05-07-Tue-10.58.13.155'>
+  <section_ name='My section with timestamp' timestamp='2019-05-09-Thu-10.32.53.066'>
     Section with timestamp.
   </section_>
   <section_ name='My section with duration' duration_seconds='0.501'>
     Section with duration.
   </section_>
-  <section_ name='My section with both' timestamp='2019-05-07-Tue-10.58.13.656' duration_seconds='0.500'>
+  <section_ name='My section with both' timestamp='2019-05-09-Thu-10.32.53.568' duration_seconds='0.501'>
     Section with both.
   </section_>
 </log>
@@ -356,7 +364,7 @@ end
 ```xml
 <log>
   <section_ name='My unrescued section'>
-    <uncaught_exception_ timestamp='2019-05-07-Tue-10.58.14.602' class='RuntimeError'>
+    <uncaught_exception_ timestamp='2019-05-09-Thu-10.32.54.471' class='RuntimeError'>
       <message_>
         Boo!
       </message_>
@@ -413,7 +421,7 @@ end
 ```log.xml```:
 ```xml
 <log>
-  <section_ name='Section with potpourri of arguments' a='0' b='1' timestamp='2019-05-07-Tue-10.58.11.338' c='2' d='3' duration_seconds='0.502'>
+  <section_ name='Section with potpourri of arguments' a='0' b='1' timestamp='2019-05-09-Thu-10.32.51.426' c='2' d='3' duration_seconds='0.501'>
     Word More words
     <rescued_exception_ class='Exception' message='Boo!'>
       <backtrace_>
@@ -828,6 +836,85 @@ error_verdict.rb:9:in `test_demo'
 </log>
 ```
 
+#### Backtrace Filter
+
+By default, a backtrace omits entries containing the token ```minitest```.  This keeps the backtrace focussed on your code instead of the gems' code.
+
+Override that behavior by specifying ioption ```:backtrace_filter``` with a ```Regexp``` object.  Entries matching that pattern will be omitted from the backtrace.
+
+```backtrace_filter.rb```:
+```ruby
+require 'minitest_log'
+class Test < Minitest::Test
+  def test_demo
+    MinitestLog.new('default_backtrace_filter.xml') do |log|
+      fail 'Boo!'
+    end
+    MinitestLog.new('custom_backtrace_filter.xml', :backtrace_filter => /xxx/) do |log|
+      fail 'Boo!'
+    end
+  end
+end
+```
+
+```default_backtrace_filter.xml```:
+```xml
+<log>
+  <uncaught_exception_ timestamp='2019-05-09-Thu-10.32.49.597' class='RuntimeError'>
+    <message_>
+      Boo!
+    </message_>
+    <backtrace_>
+      <![CDATA[
+backtrace_filter.rb:5:in `block in test_demo'
+backtrace_filter.rb:4:in `new'
+backtrace_filter.rb:4:in `test_demo'
+]]>
+    </backtrace_>
+  </uncaught_exception_>
+</log>
+```
+
+```custom_backtrace_filter.xml```:
+```xml
+<log>
+  <uncaught_exception_ timestamp='2019-05-09-Thu-10.32.49.599' class='RuntimeError'>
+    <message_>
+      Boo!
+    </message_>
+    <backtrace_>
+      <![CDATA[
+backtrace_filter.rb:8:in `block in test_demo'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest_log-0.2.0/lib/minitest_log.rb:59:in `initialize'
+backtrace_filter.rb:7:in `new'
+backtrace_filter.rb:7:in `test_demo'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest/test.rb:98:in `block (3 levels) in run'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest/test.rb:195:in `capture_exceptions'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest/test.rb:95:in `block (2 levels) in run'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:265:in `time_it'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest/test.rb:94:in `block in run'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:360:in `on_signal'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest/test.rb:211:in `with_info_handler'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest/test.rb:93:in `run'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:960:in `run_one_method'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:334:in `run_one_method'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:321:in `block (2 levels) in run'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:320:in `each'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:320:in `block in run'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:360:in `on_signal'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:347:in `with_info_handler'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:319:in `run'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:159:in `block in __run'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:159:in `map'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:159:in `__run'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:136:in `run'
+C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/minitest-5.11.3/lib/minitest.rb:63:in `block in autorun'
+]]>
+    </backtrace_>
+  </uncaught_exception_>
+</log>
+```
+
 
 ## Data
 
@@ -1026,7 +1113,7 @@ end
       (?-mix:Bar)
     </data_>
     <data_ name='My time' class='Time' method=':to_s'>
-      2019-05-07 10:58:07 -0500
+      2019-05-09 10:32:47 -0500
     </data_>
     <data_ name='My uri,' class='URI::HTTPS' method=':to_s'>
       https://www.github.com
@@ -1798,7 +1885,7 @@ end
   <verdict_ method='verdict_assert_same?' outcome='failed' id='another_id' message='Another message'>
     <expected_ class='String' value='&quot;foo&quot;'/>
     <actual_ class='String' value='&quot;foo&quot;'/>
-    <exception_ class='Minitest::Assertion' message='Expected &quot;foo&quot; (oid=27958320) to be the same as &quot;foo&quot; (oid=27958340).'>
+    <exception_ class='Minitest::Assertion' message='Expected &quot;foo&quot; (oid=27933780) to be the same as &quot;foo&quot; (oid=27933800).'>
       <backtrace_>
         <![CDATA[
 verdict_assert_same.rb:6:in `block in test_demo_verdict'
@@ -2579,3 +2666,20 @@ If your logs will be parsed in post-processing, you can make that go smoother by
 - ```:error_verdict => true```: so that a log that has errors will also have at least one failed verdict.
 
 See [Options](#options)
+
+## Oh, and Tests
+
+This project's tests generate 135 [logs and other output files](../../tree/master/test/actual), performing 484 verifications.
+
+- [log_test.rb](../../tree/master/test/log_test.rb)
+- [verdict_test.rb](../../tree/master/test/verdict_test.rb)
+
+## About This README
+
+This README page is kept "green" because in addition to the tests, there's a rake task that:
+
+- Executes the [50 example scripts](markdown/readme), capturing their output.
+- Uses file inclusion to assemble this ```README.md``` file.
+
+Shameless plug:  GitHub flavored markdown does not support file inclusion, but my Ruby gem [markdown_helper](https://rubygems.org/gems/markdown_helper) does.  It's a  [GitHub project](https://github.com/BurdetteLamar/markdown_helper#markdown-helper), too.
+

data/lib/minitest_log/version.rb

@@ -1,3 +1,3 @@
 class MinitestLog
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

data/minitest_log.gemspec

@@ -5,10 +5,11 @@ require 'minitest_log/version'
 Gem::Specification.new do |spec|
   spec.name          = 'minitest_log'
   spec.version       = MinitestLog::VERSION
-  spec.authors       = ['burdettelamar']
+  spec.authors       = ['Burdette Lamar']
   spec.email         = ['burdettelamar@yahoo.com']
 
-  spec.summary       = %q{Logging for Ruby-coded testing}
+  spec.summary       = %q{Logging for testing with Minitest}
+  spec.description   = "Gem minitest_log uses Minitest, adding structured loging, data explication, and verdicts."
   spec.homepage      = "https://github.com/BurdetteLamar/minitest_log"
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest_log
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
-- burdettelamar
+- Burdette Lamar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-07 00:00:00.000000000 Z
+date: 2019-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,7 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: 
+description: Gem minitest_log uses Minitest, adding structured loging, data explication,
+  and verdicts.
 email:
 - burdettelamar@yahoo.com
 executables: []
@@ -126,5 +127,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Logging for Ruby-coded testing
+summary: Logging for testing with Minitest
 test_files: []