minitest_lucid 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c02895d8df4850cfd91fb00d61b7564c8c238a9abfbccee213f89e308eb82911
-  data.tar.gz: 7c6aab8da3d498470ec0d073ec1c5f5d8c4b880b34d051091144968791d9e471
+  metadata.gz: db2f61b2bf814f8a4dfb3996c36657c18de46ba90864c84181901bd23deabe7a
+  data.tar.gz: e03ac5e893f564a8e80c94e843c97196f6f46c23c36899a46324f9a99ba169cc
 SHA512:
-  metadata.gz: 8b622e00d3f2ab1449646636047c015305266921bfed31e296b771711f1099bcc3f842f0bb11ffaa4fcbc1e6a97a523cfd9049d3720f60c878f8656dd494b6ad
-  data.tar.gz: def26c731f5c73eaf9f2b3d095312a254ab6de7aa01212acc3809f03ee3aab7363084288f5fc3243792516cfc78825d0b3bc3e1df18233da2182a8467905b6e6
+  metadata.gz: 2c4d981321f2d732ecda7c9094999eb1005d16ed596878a89d47ba0d3acf52980060ee62aa04b2b1553d706ddaca19552bddb59fdcfe7c510e7f23638b8471f7
+  data.tar.gz: 505a9e600064104fbf07cc112757f19e0fff4681e03405fac8eb0ca5cccd13125df7835f4792b3ab530dc057ff20dc732d181008304b7c00f8da09c1ac3e27b7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minitest_lucid (0.1.0)
+    minitest_lucid (1.0.0)
       diff-lcs (~> 1.3)
 
 GEM

data/README.md

@@ -1,10 +1,65 @@
 # Minitest Lucid
 
-Use ```minitest_lucid``` to improve error messages from ```minitest```.
+Use ```minitest_lucid``` to improve assertion messages from ```minitest```.
 
+## Usage
+
+To use ```minitest_lucid```, install the gem and then in your tests,
+
+```ruby
+require 'minitest_lucid'
+```
+
+instead of
+
+```ruby
+require 'minitest/autorun'
+```
+
+No other code change is required.
+
+For example, change this test
+
+```not_lucid.rb```:
+```ruby
+require 'minitest/autorun'
+
+class MyTest < Minitest::Test
+
+  def test_foo
+    expected = {:a => 0, :b => 1}
+    actual = {}
+    assert_equal(expected, actual)
+  end
+end
+```
+
+to this
+
+```lucid.rb```:
+```ruby
+require 'minitest_lucid'
+
+class MyTest < Minitest::Test
+
+  def test_foo
+    expected = {:a => 0, :b => 1}
+    actual = {}
+    assert_equal(expected, actual)
+  end
+end
+```
+
+See example outputs below.
 
 ## Supported Classes
 
+For supported classes, method ```assert_equal``` gets elucidated handling.
+
+For other classes and assertion methods, the original assertion behaviors are unchanged.
+
+The supported classes:
+
 - [Hash](#hash)
 - [Set](#set)
 - [Struct](#struct)
@@ -422,7 +477,8 @@ def actual
     'Noabor modo autaa aata.',
     'Ad irab ut cupar.',
     )
-end```
+end
+```
 
 The default ```Minitest::Assertion``` message:
 

data/lib/minitest_lucid.rb

@@ -1,4 +1,4 @@
-require 'minitest'
+require 'minitest/autorun'
 require 'diff/lcs'
 require 'set'
 

data/lib/minitest_lucid/version.rb

@@ -1,3 +1,3 @@
 module MinitestLucid
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/markdown/readme/lucid.rb

@@ -0,0 +1,10 @@
+require 'minitest_lucid'
+
+class MyTest < Minitest::Test
+
+  def test_foo
+    expected = {:a => 0, :b => 1}
+    actual = {}
+    assert_equal(expected, actual)
+  end
+end

data/markdown/readme/not_lucid.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+
+class MyTest < Minitest::Test
+
+  def test_foo
+    expected = {:a => 0, :b => 1}
+    actual = {}
+    assert_equal(expected, actual)
+  end
+end

data/markdown/readme/struct/assert_equal/data.rb

@@ -82,4 +82,4 @@ def actual
     'Noabor modo autaa aata.',
     'Ad irab ut cupar.',
     )
-end
+end

data/markdown/readme/template.md

@@ -1,10 +1,41 @@
 # Minitest Lucid
 
-Use ```minitest_lucid``` to improve error messages from ```minitest```.
+Use ```minitest_lucid``` to improve assertion messages from ```minitest```.
 
+## Usage
+
+To use ```minitest_lucid```, install the gem and then in your tests,
+
+```ruby
+require 'minitest_lucid'
+```
+
+instead of
+
+```ruby
+require 'minitest/autorun'
+```
+
+No other code change is required.
+
+For example, change this test
+
+@[ruby](not_lucid.rb)
+
+to this
+
+@[ruby](lucid.rb)
+
+See example outputs below.
 
 ## Supported Classes
 
+For supported classes, method ```assert_equal``` gets elucidated handling.
+
+For other classes and assertion methods, the original assertion behaviors are unchanged.
+
+The supported classes:
+
 - [Hash](#hash)
 - [Set](#set)
 - [Struct](#struct)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest_lucid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - burdettelamar
@@ -126,6 +126,8 @@ files:
 - markdown/readme/hash/assert_equal/lucid.txt
 - markdown/readme/hash/assert_equal/template.md
 - markdown/readme/hash/template.md
+- markdown/readme/lucid.rb
+- markdown/readme/not_lucid.rb
 - markdown/readme/set/assert_equal/better.txt
 - markdown/readme/set/assert_equal/data.rb
 - markdown/readme/set/assert_equal/default.txt