yard-doctest 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e060a6fdecfeb740798431f7a26212efb2565771
-  data.tar.gz: 3f4c8f9c7a9ab960a26e3b10dba993cb6c5bbb5c
+  metadata.gz: eba9b291cde3beb389b61654c7c322867eda5c85
+  data.tar.gz: b0ed6bad33e7898a33aacbc1c297ef876da20bcf
 SHA512:
-  metadata.gz: aaee894607b41aa9a01378fe6b1eeda09058512a37a6687180a96788c3e0f204863c0afd1c34929f0c09e3dd3f322d6c44eecf7dc29491ddfa45a5c86b06a977
-  data.tar.gz: dd6f612d02bdddd778cc8bb4315dca7e4928149697a8331ed0106a1f81ec0d8d52ea8b8130eb9aa1a6e8cbf918f600e3ec88d9e7a32ed8a5059cfa3c864aba45
+  metadata.gz: 9c3694a20bd31d53e3716d83a9f6062c958478b80f8f4e39ff26c5e32f5c911a5414dc4086230a66b46f654f2b5fa4af3dc4e1ebed56f2efbad446abb39749fa
+  data.tar.gz: f184b05173e542846f4b5d4c46907e1ed25b1edf80b82cf2831507758bdd3659ed3a06d7e91c244f76bccc0314bcaa2092c644b7cdb06d09378d0081beaf1307

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.12
+
+* Reworked the construction of context where examples are evaluated.
+
 ## 0.1.11
 
 * Remove constants defined during test execution for better isolation.

data/features/yard-doctest.feature

@@ -597,7 +597,7 @@ Feature: yard doctest
 
       class A
         # @example
-        #   A.foo => true
+        #   A.foo #=> true
         def self.foo
           true
         end
@@ -625,6 +625,27 @@ Feature: yard doctest
     When I run `bundle exec yard doctest`
     Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"
 
+  Scenario: shares instance variables in local context binding
+    Given a file named "doctest_helper.rb" with:
+      """
+      require 'app/app'
+
+      YARD::Doctest.before do
+        @flag = true
+      end
+      """
+    And a file named "app/app.rb" with:
+      """
+      class App
+        # @example
+        #   @flag #=> true
+        def self.foo
+        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: isolates constants per test
     Given a file named "doctest_helper.rb" with:
       """
@@ -636,13 +657,42 @@ Feature: yard doctest
       #   ::FOO = 123
       #   ::FOO #=> 123
       #   ::BAR #=> raise NameError, 'uninitialized constant BAR'
+      #   FOO = 456
+      #   FOO #=> 456
+      #   BAR #=> raise NameError, 'uninitialized constant App::BAR'
       #
       # @example
       #   ::BAR = 123
       #   ::BAR #=> 123
       #   ::FOO #=> raise NameError, 'uninitialized constant FOO'
+      #   BAR = 123
+      #   BAR #=> 123
+      #   FOO #=> raise NameError, 'uninitialized constant App::FOO'
       class App
       end
       """
     When I run `bundle exec yard doctest`
-    Then the output should contain "2 runs, 4 assertions, 0 failures, 0 errors, 0 skips"
+    Then the output should contain "2 runs, 8 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario: allows to run a single test
+    Given a file named "doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      class A
+        # @example First
+        #   A.foo #=> true
+        #
+        # @example Second
+        #   A.foo #=> false
+        def self.foo
+          true
+        end
+      end
+      """
+    When I run `bundle exec yard doctest -v --name=/First/`
+    Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"
+    When I run `bundle exec yard doctest -v --name=/Second/`
+    Then the output should contain "1 runs, 1 assertions, 1 failures, 0 errors, 0 skips"

data/lib/yard/doctest/example.rb

@@ -44,7 +44,8 @@ module YARD
             register_hooks(example_name, YARD::Doctest.hooks)
 
             it this.name do
-              constants = Object.constants
+              global_constants = Object.constants
+              scope_constants = scope.constants if scope
               this.asserts.each do |assert|
                 expected, actual = assert[:expected], assert[:actual]
                 if expected.empty?
@@ -53,7 +54,8 @@ module YARD
                   assert_example(this, expected, actual, scope)
                 end
               end
-              clear_extra_constants(constants)
+              clear_extra_constants(Object, global_constants)
+              clear_extra_constants(scope, scope_constants) if scope
             end
           end
         end
@@ -83,13 +85,25 @@ module YARD
       end
 
       def evaluate(code, bind)
-        context.eval code
-      rescue NameError
-        bind ? bind.__send__(:eval, code) : raise
+        context(bind).eval(code)
       end
 
-      def context
-        @binding ||= binding
+      def context(bind)
+        @context ||= begin
+          if bind
+            context = bind.class_eval('binding', __FILE__, __LINE__)
+            # Oh my god, what is happening here?
+            # We need to transplant instance variables from the current binding.
+            instance_variables.each do |instance_variable_name|
+              local_variable_name = "__yard_doctest__#{instance_variable_name.to_s.delete('@')}"
+              context.local_variable_set(local_variable_name, instance_variable_get(instance_variable_name))
+              context.eval("#{instance_variable_name} = #{local_variable_name}")
+            end
+            context
+          else
+            binding
+          end
+        end
       end
 
       def add_filepath_to_backtrace(exception, filepath)
@@ -100,9 +114,9 @@ module YARD
         exception.set_backtrace backtrace
       end
 
-      def clear_extra_constants(constants)
-        (Object.constants - constants).each do |constant|
-          Object.__send__(:remove_const, constant)
+      def clear_extra_constants(scope, constants)
+        (scope.constants - constants).each do |constant|
+          scope.__send__(:remove_const, constant)
         end
       end
 

data/lib/yard/doctest/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module Doctest
-    VERSION = '0.1.11'
+    VERSION = '0.1.12'
   end
 end

data/yard-doctest.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'yard'
   spec.add_runtime_dependency 'minitest'
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'relish'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-doctest
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Alex Rodionov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-01 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: relish
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Doctests from YARD examples