yard-doctest 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 216ca29f83eef3428bc20ff8a2ca765b605e8428
-  data.tar.gz: 4c821cbbd5d8c861c365fb57d6defa9f99726002
+  metadata.gz: 396c212a7f20383346628549f84472faa0bb150b
+  data.tar.gz: abb37e7c096350ef190fef1084d448f117f0ab75
 SHA512:
-  metadata.gz: 831c02685ac564f579baeb4ecde9d6994e7ee09a34db02556bcac5f3ee799eda2c816905a524a659602d1316b5a3bc4c9b18a0a89f1502add3a9dce86e2a11db
-  data.tar.gz: 360322c342fb9d2b567c8d250968a3087b5a7f4ee2e5a4270ce2ee6de6161d8ad0fce80fb37557e502376ca9a9ca92884666bf9e4b6f6a628315118d8028f8d4
+  metadata.gz: ee6657e890518cd8f8f72c164c3802f7db7f61e2ac4b8dcb5d283ea056cba27af3cf55e22e08471bd31e5475bdf90ef9a5d455788446937856927b2762a1445c
+  data.tar.gz: 2831f3ed0dad1391fcfb5a700792ccaefade4ca27e3d744b0735f8486b2cf9673066440c2fae126b9cd44988bbdfae92cd919f49f2985177b450679487cac545

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+## 0.1.6
+
+* Support per-example hooks [#3](https://github.com/p0deje/yard-doctest/pull/3)
+
+## 0.1.5
+
+* Support testing for exceptions [#2](https://github.com/p0deje/yard-doctest/pull/2)
+
+## 0.1.4
+
+* Allow to keep doctest_helper in support/ directory
+
+## 0.1.3
+
+* Rake task exits with non-zero code when doctests fail
+
+## 0.1.2
+
+* Allow skipping tests
+* Allow configuring yard-doctest
+* Rename helper from yard-doctest_helper to doctest_helper
+
+## 0.1.1
+
+* Refactoring
+
+## 0.1.0
+
+* Initial version

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Alex Rodionov
+Copyright (c) 2016 Alex Rodionov
 
 MIT License
 

data/README.md

@@ -1,4 +1,4 @@
-# yard-doctest [![Gem Version](https://badge.fury.io/rb/yard-doctest.svg)](http://badge.fury.io/rb/yard-doctest) [![Build Status](https://travis-ci.org/p0deje/yard-doctest.png?branch=master)](https://travis-ci.org/p0deje/yard-doctest)
+# yard-doctest [![Gem Version](https://badge.fury.io/rb/yard-doctest.svg)](http://badge.fury.io/rb/yard-doctest) [![Build Status](https://travis-ci.org/p0deje/yard-doctest.svg?branch=master)](https://travis-ci.org/p0deje/yard-doctest)
 
 Have you ever wanted to turn your amazing code examples into something that really make sense, is always up-to-date and bullet-proof? Were looking at an amazing [Python doctest](https://docs.python.org/3/library/doctest.html)? Well, look no longer!
 
@@ -289,6 +289,10 @@ YARD::Doctest.configure do |doctest|
   doctest.after('MyClass#foo') do
     # this will only be called for doctests of `MyClass#foo`
   end
+
+  doctest.before('MyClass#foo@Example one') do
+    # this will only be called for example `Example one` of `MyClass#foo`
+  end
 end
 ```
 

data/features/yard-doctest.feature

@@ -124,8 +124,12 @@ Feature: yard doctest
     When I run `bundle exec yard doctest`
     Then the output should contain:
       """
-      Expected: 2
-        Actual: "2"
+      --- expected
+      +++ actual
+      @@ -1 +1,2 @@
+      -2
+      +# encoding: US-ASCII
+      +"2"
       """
 
   Scenario: asserts exceptions
@@ -494,6 +498,32 @@ 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: supports test-name hooks for multiple examples on the same code object
+    Given a file named "doctest_helper.rb" with:
+      """
+      require 'app/app'
+
+      YARD::Doctest.before('#flag') do
+        @flag = true
+      end
+
+      YARD::Doctest.before('#flag@Second example for flag') do
+        @flag = false
+      end
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   flag #=> true
+      # @example Second example for flag
+      #   flag #=> false
+      def flag
+        @flag
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "2 runs, 2 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,7 +26,15 @@ module YARD
 
           return if YARD::Doctest.skips.any? { |skip| this.definition.include?(skip) }
           describe this.definition do
-            register_hooks(this.definition, YARD::Doctest.hooks)
+            # 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.
+            example_name = if this.name.empty?
+              this.definition
+            else
+              "#{this.definition}@#{this.name}"
+            end
+
+            register_hooks(example_name, YARD::Doctest.hooks)
 
             it this.name do
               this.asserts.each do |assert|
@@ -65,12 +73,14 @@ module YARD
         exception.set_backtrace backtrace
       end
 
-      def self.register_hooks(definition, all_hooks)
+
+
+      def self.register_hooks(example_name, all_hooks)
         all_hooks.each do |type, hooks|
           hooks.each do |hook|
             if hook[:test]
               # test-name hooks
-              send(type, &hook[:block]) if definition.include?(hook[:test])
+              send(type, &hook[:block]) if example_name.include?(hook[:test])
             else
               # global hooks
               send(type, &hook[:block])

data/lib/yard/doctest/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module Doctest
-    VERSION = '0.1.5'
+    VERSION = '0.1.6'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-doctest
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Alex Rodionov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -88,6 +88,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -120,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Doctests from YARD examples