yard-doctest 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cd1fc903edfa86337db79cf3b40f762fbf2cadc
-  data.tar.gz: 408b814a356c164e4d894f1c9320ce422ffb8706
+  metadata.gz: 47ff35130e3241348736458652887da1bca96512
+  data.tar.gz: 76d18f3e48943bab0d1058082291d98fc3167477
 SHA512:
-  metadata.gz: 0fba50d53837f55aef654d3e675ff8b3bca2128668f2599db051c0f4e0c1d11c4c9a1bb1b6d1b7fa697eff0c930675aea6f0e885336a70dc6db3cfc6db64e508
-  data.tar.gz: c1b06e9a0119434cc69a5212a7d06982e69adfa2d1e025513299fc50646c5158a81d209341237ec3945c774386616c0a88089ab0d2d90dee2bd4d07c6c0b8744
+  metadata.gz: 00f1a7d01a6f625d858f275e6356f223d7af8487fe4faaafdd36f1e98fcd4193f8b20754ee332196a9df8878f1005cf269ef41ca634dbf16bba53437517a4711
+  data.tar.gz: 4f29c14960eb13d008ae1ef5ab97dbe763441c7d38b6bfee8064c529d160083d832f3b78c8548e0fc329773ab88eae0efee6e984c908d3c10960fcbf29c05845

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.9
+
+* Allow to have `doctest_helper.rb` in `spec/` directory [#4](https://github.com/p0deje/yard-doctest/pull/4)
+* Allow to use local context in doctest (i.e. not type full path to object) [#5](https://github.com/p0deje/yard-doctest/pull/5)
+
 ## 0.1.8
 
 * Fixed a bug when test was passing even though exception was raised in example

data/README.md

@@ -99,8 +99,7 @@ Next, you'll need to create test helper, which will be required before each of y
 
 ```bash
 $ touch doctest_helper.rb
-# or if you don't want to have it in root
-$ touch support/doctest_helper.rb
+# or move it into either the `support` or `spec` directory
 ```
 
 ```ruby

data/features/yard-doctest.feature

@@ -425,6 +425,7 @@ Feature: yard doctest
       | directory |
       | .         |
       | support   |
+      | spec      |
 
   Scenario: shares binding between asserts
     Given a file named "doctest_helper.rb" with:
@@ -595,3 +596,22 @@ Feature: yard doctest
       """
     When I run `bundle exec yard doctest`
     Then the output should contain "0 runs, 0 assertions, 0 failures, 0 errors, 0 skips"
+
+    Scenario: allow binding to local context
+      Given a file named "doctest_helper.rb" with:
+        """
+        require 'app/app'
+        """
+      And a file named "app/app.rb" with:
+        """
+        class App
+          # @example
+          #   a, b = 1, 2
+          #   sum(a, b) #=> 3
+          def self.sum(one, two)
+            one + two
+          end
+        end
+        """
+      When I run `bundle exec yard doctest`
+      Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"

data/lib/yard/doctest/example.rb

@@ -20,11 +20,18 @@ module YARD
         Class.new(this.class).class_eval do
           require 'minitest/autorun'
 
-          %w[. support].each do |dir|
+          %w[. support spec].each do |dir|
             require "#{dir}/doctest_helper" if File.exist?("#{dir}/doctest_helper.rb")
           end
 
           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.
@@ -40,9 +47,9 @@ module YARD
               this.asserts.each do |assert|
                 expected, actual = assert[:expected], assert[:actual]
                 if expected.empty?
-                  evaluate_example(this, actual)
+                  evaluate_example(this, actual, scope)
                 else
-                  assert_example(this, expected, actual)
+                  assert_example(this, expected, actual, scope)
                 end
               end
             end
@@ -52,22 +59,22 @@ module YARD
 
       protected
 
-      def evaluate_example(example, actual)
-        context.eval(actual)
+      def evaluate_example(example, actual, bind)
+        (bind || context).send(:eval, actual)
       rescue StandardError => error
         add_filepath_to_backtrace(error, example.filepath)
         raise error
       end
 
-      def assert_example(example, expected, actual)
-        assert_equal evaluate(expected), evaluate(actual)
+      def assert_example(example, expected, actual, bind)
+        assert_equal evaluate(expected, bind), evaluate(actual, bind)
       rescue Minitest::Assertion => error
         add_filepath_to_backtrace(error, example.filepath)
         raise error
       end
 
-      def evaluate(code)
-        context.eval(code)
+      def evaluate(code, bind)
+        (bind || context).send(:eval, code)
       rescue StandardError => error
         "#<#{error.class}: #{error}>"
       end

data/lib/yard/doctest/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module Doctest
-    VERSION = '0.1.8'
+    VERSION = '0.1.9'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-doctest
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Alex Rodionov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-30 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -121,11 +121,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Doctests from YARD examples
 test_files:
 - features/support/env.rb
 - features/yard-doctest.feature
-has_rdoc: