yard-doctest 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4952a0dc4b12093ceb7ae21eae44e735412b0c7e5b17e1b71d435f2fbbdce964
-  data.tar.gz: 6b583b324be15b5519435a021293691a3266ce039789928c19bcb59d4a67d4e0
+  metadata.gz: 723dea9f19d8563896620983b07e9c10c8ffd675fec6c630265dd1b7c9296137
+  data.tar.gz: fe76d9dee40e4ced8ceaea99cc0b6e985e9dc347e6b74dc373f6d568e8c00bb8
 SHA512:
-  metadata.gz: 0560d34f0aeaa28034eaa640e0319539098a1848820696044a1cf805f5f77aeca07206d94394cc74b1dc75a1a3f375cb60d91e51c8d623b200dc33d0a2279b4d
-  data.tar.gz: 1092ec6db552c0355bdf7765df7581b6d29ec555ad33143b5a150721f1830083703f823d6f13e8157ec4c4fd5768ee702b7a00b7dcb89551a90724a39262c474
+  metadata.gz: 222ad5b8623b913c3c16dd7ea76731e9b2b889285f3221c242de8ade6cf55870b09d541d71a9e239611867737306a06f75994f51cc5f39c77cd0c504ff512431
+  data.tar.gz: 1715dab13e1e08605bda7ed64c61a978c8c6230745470beddd78bba79b8a2f970577d667980b65c4c64109e426e45986efc201387c3a73b6a2525a0a1900088f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.15
+
+* Fix an issue when exception is swallowed in assertion phase
+
 ## 0.1.14
 
 * Allow to use without Rake installed. If you want to use Rake task, please add

data/features/yard-doctest.feature

@@ -5,7 +5,7 @@ Feature: yard doctest
   I want to automatically parse YARD's @example tags
   And use them as tests
   Just like doctest in Python
-  
+
   Background:
     # YARD stopped auto-loading all plugins at 0.6.2, so anything newer needs
     # the plugin explicitly loaded. A simple way to do this is to always have
@@ -138,6 +138,10 @@ Feature: yard doctest
       #foo#test_0001_:
       RuntimeError: Fails with exception
       """
+    And the output should contain:
+      """
+      app/app.rb:4:in `foo'
+      """
 
   Scenario: asserts using equality
     Given a file named "doctest_helper.rb" with:
@@ -735,3 +739,29 @@ Feature: yard doctest
       """
     When I run `bundle exec yard doctest`
     Then the output should contain "1 runs, 0 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario: shows exception when assert raises one
+    Given a file named "doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   foo #=> 1
+      def foo
+        raise 'Fails with exception'
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the exit status should be 1
+    And the output should contain:
+      """
+      1) Error:
+      #foo#test_0001_:
+      RuntimeError: Fails with exception
+      """
+    And the output should contain:
+      """
+      app/app.rb:4:in `foo'
+      """

data/lib/yard/doctest/example.rb

@@ -71,8 +71,16 @@ module YARD
       end
 
       def assert_example(example, expected, actual, bind)
-        assert_equal(evaluate_with_assertion(expected, bind),
-                     evaluate_with_assertion(actual, bind))
+        expected = evaluate_with_assertion(expected, bind)
+        actual = evaluate_with_assertion(actual, bind)
+
+        if both_are_errors?(expected, actual)
+          assert_equal("#<#{expected.class}: #{expected}>", "#<#{actual.class}: #{actual}>")
+        elsif (error = only_one_is_error?(expected, actual))
+          raise error
+        else
+          assert_equal(expected, actual)
+        end
       rescue Minitest::Assertion => error
         add_filepath_to_backtrace(error, example.filepath)
         raise error
@@ -81,7 +89,7 @@ module YARD
       def evaluate_with_assertion(code, bind)
         evaluate(code, bind)
       rescue StandardError => error
-        "#<#{error.class}: #{error}>"
+        error
       end
 
       def evaluate(code, bind)
@@ -106,6 +114,18 @@ module YARD
         end
       end
 
+      def both_are_errors?(expected, actual)
+        expected.is_a?(StandardError) && actual.is_a?(StandardError)
+      end
+
+      def only_one_is_error?(expected, actual)
+        if expected.is_a?(StandardError) && !actual.is_a?(StandardError)
+          expected
+        elsif !expected.is_a?(StandardError) && actual.is_a?(StandardError)
+          actual
+        end
+      end
+
       def add_filepath_to_backtrace(exception, filepath)
         backtrace = exception.backtrace
         line = backtrace.find { |l| l =~ %r{lib/yard/doctest/example} }

data/lib/yard/doctest/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module Doctest
-    VERSION = '0.1.14'
+    VERSION = '0.1.15'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-doctest
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Alex Rodionov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-04 00:00:00.000000000 Z
+date: 2019-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -120,8 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Doctests from YARD examples