yard-doctest 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 723dea9f19d8563896620983b07e9c10c8ffd675fec6c630265dd1b7c9296137
-  data.tar.gz: fe76d9dee40e4ced8ceaea99cc0b6e985e9dc347e6b74dc373f6d568e8c00bb8
+  metadata.gz: c75c418a5cbe791e718cb9ba2deff5f1b187c00ae8578a79d149cda39f567d05
+  data.tar.gz: e48f64151a5273ddbbc8d0f8efe5327c2f7798d744473ed7ac82e0b49e1b0842
 SHA512:
-  metadata.gz: 222ad5b8623b913c3c16dd7ea76731e9b2b889285f3221c242de8ade6cf55870b09d541d71a9e239611867737306a06f75994f51cc5f39c77cd0c504ff512431
-  data.tar.gz: 1715dab13e1e08605bda7ed64c61a978c8c6230745470beddd78bba79b8a2f970577d667980b65c4c64109e426e45986efc201387c3a73b6a2525a0a1900088f
+  metadata.gz: a6f46775edc0057a440ae41adcc1377a2125015981ac9dc7fd8cc5481754e8f4d4289a66262b7db51489b0ef1039c6dcd12ac825700d5bd22b687f6228979722
+  data.tar.gz: 69cfad611e30b3f5cd1fc6f672aed1326efd330cc9e6a8a2124316541431d2adf92b0edb71a2a5404f2b0f0a11fac218eec98f1653b36cb6316b80754f1e4c6a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.16
+
+* Pass example instance to hooks to allow for its inspection (thanks @nrser)
+
 ## 0.1.15
 
 * Fix an issue when exception is swallowed in assertion phase

data/features/yard-doctest.feature

@@ -590,6 +590,26 @@ Feature: yard doctest
     When I run `bundle exec yard doctest`
     Then the output should contain "2 runs, 2 assertions, 0 failures, 0 errors, 0 skips"
 
+  Scenario: passes example to hooks to allow for inspection
+    Given a file named "doctest_helper.rb" with:
+      """
+      YARD::Doctest.before do |example|
+        require example.filepath.split(':').first
+      end
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   App.foo #=> 'bar'
+      class App
+        def self.foo
+          'bar'
+        end
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"
+
   Scenario: can skip tests
     Given a file named "doctest_helper.rb" with:
       """

data/lib/yard/doctest/example.rb

@@ -26,12 +26,6 @@ module YARD
 
           return if YARD::Doctest.skips.any? { |skip| this.definition.include?(skip) }
 
-          begin
-            object_name = this.definition.split(/#|\./).first
-            scope = Object.const_get(object_name) if const_defined?(object_name)
-          rescue NameError
-          end
-
           describe this.definition do
             # Append this.name to this.definition if YARD's @example tag is followed by
             # descriptive text, to support hooks for multiple examples per code object.
@@ -41,9 +35,15 @@ module YARD
                              "#{this.definition}@#{this.name}"
                            end
 
-            register_hooks(example_name, YARD::Doctest.hooks)
+            register_hooks(example_name, YARD::Doctest.hooks, this)
 
             it this.name do
+              begin
+                object_name = this.definition.split(/#|\./).first
+                scope = Object.const_get(object_name) if self.class.const_defined?(object_name)
+              rescue NameError
+              end
+
               global_constants = Object.constants
               scope_constants = scope.constants if scope
               this.asserts.each do |assert|
@@ -140,12 +140,19 @@ module YARD
         end
       end
 
-      def self.register_hooks(example_name, all_hooks)
-        all_hooks.each do |type, hooks|
-          global_hooks = hooks.select { |hook| !hook[:test] }
-          test_hooks = hooks.select { |hook| hook[:test] && example_name.include?(hook[:test]) }
-          __send__(type) do
-            (global_hooks + test_hooks).each { |hook| instance_exec(&hook[:block]) }
+      class << self
+        protected
+
+        # @param [String] example_name The name of the example.
+        # @param [Hash<Symbol, Array<Hash<(test: String, block: Proc)>>] all_hooks
+        # @param [Example] example
+        def register_hooks(example_name, all_hooks, example)
+          all_hooks.each do |type, hooks|
+            global_hooks = hooks.reject { |hook| hook[:test] }
+            test_hooks   = hooks.select { |hook| hook[:test] && example_name.include?(hook[:test]) }
+            __send__(type) do
+              (global_hooks + test_hooks).each { |hook| instance_exec(example, &hook[:block]) }
+            end
           end
         end
       end

data/lib/yard/doctest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-doctest
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - Alex Rodionov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard