yard-doctest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eaf710b790298916a7621aa89f1ccfc8f958d4a8
+  data.tar.gz: 3170484780f834944b8b2b23b4fd845d96b3f83b
+SHA512:
+  metadata.gz: 39ad0fa507a041b04f5d040a5609f1269ac38c8780cd3e4868a5a4d608babeafb289857b09ada303ddd0ed414e34af82fde8b8a253483493c2f422d012448441
+  data.tar.gz: 5a3d8827d8da6d84f690f51fb1374fb42171254b320a20db767bbbefe7b45cb355178331dbbb8c026fd826dc5c3f82833b2ba5ae18617d88e0b5687e8a26f461

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+before_script: bundle exec yard config -a autoload_plugins yard-doctest

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Rodionov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,286 @@
+# yard-doctest [![Gem Version](https://badge.fury.io/rb/yard-doctest.png)](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)
+
+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!
+
+Meet `YARD::Doctest` - simple and magical gem, which automatically parses your `@example` tags and turn them into tests!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yardoctest'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install yard-doctest
+```
+
+## Basic usage
+
+Let's imagine you have the following library:
+
+```
+lib/
+  cat.rb
+  dog.rb
+```
+
+Each file contains some class and methods:
+
+```ruby
+# cat.rb
+class Cat
+  # @example
+  #   Cat.word #=> 'meow'
+  def self.word
+    'meow'
+  end
+
+  def initialize(can_hunt_dogs = false)
+    @can_hunt_dogs = can_hunt_dogs
+  end
+
+  # @example Usual cat cannot hunt dogs
+  #   cat = Cat.new
+  #   cat.can_hunt_dogs? #=> false
+  #
+  # @example Lion can hunt dogs
+  #   cat = Cat.new(true)
+  #   cat.can_hunt_dogs? #=> true
+  #
+  # @example Mutated cat can hunt dogs too
+  #   cat = Cat.new
+  #   cat.instance_variable_set(:@can_hunt_dogs, true) # not part of public API
+  #   cat.can_hunt_dogs? #=> true
+  def can_hunt_dogs?
+    @can_hunt_dogs
+  end
+end
+```
+
+```ruby
+# dog.rb
+class Dog
+  # @example
+  #   Dog.word #=> 'meow'
+  def self.word
+    'woof'
+  end
+
+  # @example Dogs never hunt dogs
+  #   dog = Dog.new
+  #   dog.can_hunt_dogs? #=> false
+  def can_hunt_dogs?
+    false
+  end
+end
+```
+
+You can run tests for all the examples you've documented.
+
+First of all, you need to tell YARD to automatically load `yard-doctest` (as well as other plugins):
+
+```bash
+$ bundle exec yard config load_plugins true
+# if you don't want to load other plugins
+$ bundle exec yard config -a autoload_plugins yard-doctest
+```
+
+Next, you'll need to create test helper, which will be required before each of your test. Think about it as `spec_helper.rb` in RSpec or `env.rb` in Cucumber. You should require everything necessary for your examples to run there.
+
+```bash
+$ touch yard-doctest_helper.rb
+```
+
+```ruby
+# yard-doctest_helper.rb
+require 'lib/cat'
+require 'lib/dog'
+```
+
+That's pretty much it, you can now run your examples:
+
+```bash
+$ bundle exec yard doctest
+Run options: --seed 5974
+
+# Running:
+
+..F...
+
+Finished in 0.015488s, 387.3967 runs/s, 387.3967 assertions/s.
+
+  1) Failure:
+Dog.word#test_0001_ [lib/dog.rb:5]:
+Expected: "meow"
+  Actual: "woof"
+
+6 runs, 6 assertions, 1 failures, 0 errors, 0 skips
+```
+
+Oops, let's go back and fix the example by change "meow" to "woof" in `Dog.word` and re-run the examples:
+
+```bash
+$ sed -i.bak s/meow/woof/g lib/dog.rb
+$ bundle exec yard doctest
+Run options: --seed 51966
+
+# Running:
+
+......
+
+Finished in 0.002712s, 2212.3894 runs/s, 2212.3894 assertions/s.
+
+6 runs, 6 assertions, 0 failures, 0 errors, 0 skips
+```
+
+Pretty simple, ain't it? Need more details about the way it parses examples?
+
+Think about `#=>` as equality assertion: everything before is actual result, everything after is expected result and they are asserted using `#==`.
+
+You can use as many assertions as you want in a single example:
+
+```ruby
+class Cat
+  # @example
+  #   cat = Cat.new
+  #   cat.can_hunt_dogs? #=> false
+  #   cat = Cat.new(true)
+  #   cat.can_hunt_dogs? #=> true
+  def can_hunt_dogs?
+    @can_hunt_dogs
+  end
+end
+```
+
+In this case, example will be run as a single test but with multiple assertions:
+
+```bash
+$ bundle exec yard doctest lib/cat.rb
+# ...
+1 runs, 2 assertions, 0 failures, 0 errors, 0 skips
+```
+
+If your example has no assertions, it will still be evaluated to ensure nothing is raised at least:
+
+```ruby
+class Cat
+  # @example
+  #   cat = Cat.new
+  #   cat.can_hunt_dogs?
+  def can_hunt_dogs?
+    @can_hunt_dogs
+  end
+end
+```
+
+```bash
+$ bundle exec yard doctest lib/cat.rb
+# ...
+1 runs, 0 assertions, 0 failures, 0 errors, 0 skips
+```
+
+Pretty simple, ain't it? Need more details about the way it runs the tests?
+
+It is actually delegated to amazing [minitest](https://github.com/seattlerb/minitest) and each example is an instance of `Minitest::Spec`.
+
+## Advanced usage
+
+You can define any methods and instance variables in test helper and they will be available in examples.
+
+For example, if we change the examples for `Cat#can_hunt_dogs?` like that:
+
+```ruby
+# cat.rb
+class Cat
+  # @example Usual cat cannot hunt dogs
+  #   cat.can_hunt_dogs? #=> false
+  def can_hunt_dogs?
+    @can_hunt_dogs
+  end
+end
+```
+
+And run the examples - it will fail because `cat is undefined`:
+
+```bash
+$ bundle exec yard doctest
+  # ...
+  1) Error:
+Cat#can_hunt_dogs?#test_0001_Usual cat cannot hunt dogs:
+NameError: undefined local variable or method `cat' for Object:Class
+  # ...
+```
+
+If you don't want to create new instance of class each time (or include module if you're testing it), you can fix this by defining a method in test helper:
+
+```ruby
+# yard-doctest_helper.rb
+require 'lib/cat'
+require 'lib/dog'
+
+def cat
+  @cat ||= Cat.new
+end
+```
+
+In case you need to do some preparations/cleanup between tests, hooks are at your service to be defined in test helper:
+
+```ruby
+YARD::Doctest.before do
+  # this is called before each example and
+  # evaluated in the same context as example
+  # (i.e. has access to the same instance variables)
+end
+
+YARD::Doctest.after do
+  # same as `before`, but runs after each example
+end
+
+YARD::Doctest.after_run do
+  # runs after all the examples and
+  # has different context
+  # (i.e. no access to instance variables)
+end
+```
+
+There is also a Rake task for you:
+
+```ruby
+# Rakefile
+require 'yard-doctest'
+YARD::Doctest::RakeTask.new do |task|
+  task.doctest_opts = %w[-v]
+  task.pattern = 'lib/**/*.rb'
+end
+```
+
+```bash
+$ bundle exec rake yard:doctest
+```
+
+## Testing
+
+There are some system tests implemented with [Aruba](https://github.com/cucumber/aruba):
+
+```bash
+$ bundle install
+$ bundle exec rake cucumber
+```
+
+## Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new do |task|
+  task.cucumber_opts = '-f progress features'
+end
+
+task default: :cucumber

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require 'yard-doctest'
+require 'aruba/cucumber'

data/features/yard-doctest.feature

@@ -0,0 +1,429 @@
+Feature: yard doctest
+  In order to avoid creating separated from code tests
+  And to keep my code examples correct and meaningful
+  As a developer
+  I want to automatically parse YARD's @example tags
+  And use them as tests
+  Just like doctest in Python
+
+  Scenario: adds new command to yard
+    When I run `bundle exec yard --help`
+    Then the output should contain "doctest  Doctests from @example tags"
+
+  Scenario: looks for files in app/lib directories by default
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      require 'lib/lib'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(2, 2) #=> 4
+      def sum(one, two)
+        one + two
+      end
+      """
+    And a file named "lib/lib.rb" with:
+      """
+      # @example
+      #   sub(2, 2) #=> 0
+      def sub(one, two)
+        one - two
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "2 runs, 2 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario Outline: looks for files only in passed glob
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      require 'lib/lib'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(2, 2) #=> 4
+      def sum(one, two)
+        one + two
+      end
+      """
+    And a file named "lib/lib.rb" with:
+      """
+      # @example
+      #   sub(2, 2) #=> 0
+      def sub(one, two)
+        one - two
+      end
+      """
+    When I run `bundle exec yard doctest <glob>`
+    Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"
+    Examples:
+      | glob        |
+      | app         |
+      | app/*.rb    |
+      | app/**      |
+      | app/**/*.rb |
+      | app/app.rb  |
+
+  Scenario: generates test names from unit name
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(2, 2) #=> 4
+      def sum(one, two)
+        one + two
+      end
+
+      module A
+        # @example
+        #   sub(2, 2) #=> 0
+        def sub(one, two)
+          one - two
+        end
+      end
+
+      class B
+        # @example
+        #   B.multiply(3, 3) #=> 9
+        def self.multiply(one, two)
+          one * two
+        end
+
+        # @example
+        #   div(9, 3) #=> 3
+        def div(one, two)
+          one / two
+        end
+      end
+      """
+    When I run `bundle exec yard doctest -v`
+    Then the output should contain "#sum"
+    And the output should contain "A#sub"
+    And the output should contain "B.multiply"
+    And the output should contain "B#div"
+
+  Scenario: asserts using equality
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(1, 1) #=> 2
+      def sum(one, two)
+        (one + two).to_s
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain:
+      """
+      Expected: 2
+        Actual: "2"
+      """
+
+  Scenario Outline: properly handles different return values
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   foo #=> <value>
+      def foo
+        <value>
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"
+    Examples:
+      | value |
+      | true  |
+      | false |
+      | nil   |
+      | ''    |
+      | ""    |
+      | []    |
+      | {}    |
+      | Class |
+      | 0     |
+      | 10    |
+      | -1    |
+      | 1.0   |
+
+  Scenario: handles multiple @example tags
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(2, 2) #=> 4
+      # @example
+      #   sum(3, 3) #=> 6
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "2 runs, 2 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario: handles multiple return comments
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   a = 1
+      #   sum(a, 2) #=> 3
+      #   sum(a, 3) #=> 4
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "1 runs, 2 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario: runs @example tags without return comment
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(2, 2)
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "1 runs, 0 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario: handles `# =>` return comment
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(2, 2) # => 4
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario: handles return comment on newline
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(2, 2)
+      #   #=> 4
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario: handles multiple lines
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   a = 1
+      #   b = 2
+      #   sum(a, b)
+      #   #=> 3
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario: names test with example title when it's present
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example sums two numbers
+      #   sum(2, 2) #=> 4
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest -v`
+    Then the output should contain "#sum#test_0001_sums two numbers"
+
+  Scenario: doesn't name test when title is not present
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(2, 2) #=> 4
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest -v`
+    Then the output should contain "#sum#test_0001_"
+
+  Scenario: adds unit definition to backtrace on failures
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(2, 2) #=> 5
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "app/app.rb:3"
+
+  Scenario: has rake task to run the tests
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(2, 2) #=> 4
+      def sum(one, two)
+        one + two
+      end
+      """
+    And a file named "Rakefile" with:
+      """
+      require 'yard-doctest'
+      YARD::Doctest::RakeTask.new do |task|
+        task.doctest_opts = %w[-v]
+        task.pattern = 'app/**/*.rb'
+      end
+      """
+    When I run `bundle exec rake yard:doctest`
+    Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario: requires doctest helper
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+
+      def a
+        2
+      end
+
+      def b
+        2
+      end
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   sum(a, b) #=> 4
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario: shares binding between asserts
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   a, b = 1, 2
+      #   sum(a, b) #=> 3
+      #   a = 2
+      #   sum(a, b) #=> 4
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "1 runs, 2 assertions, 0 failures, 0 errors, 0 skips"
+
+  Scenario: does not share binding between examples
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   a, b = 1, 2
+      #   sum(a, b) #=> 3
+      #
+      # @example
+      #   sum(a, b) #=> 4
+      def sum(one, two)
+        one + two
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "NameError: undefined local variable or method `a'"
+
+  Scenario: supports hooks
+    Given a file named "yard-doctest_helper.rb" with:
+      """
+      require 'app/app'
+
+      @flag = true
+
+      YARD::Doctest.before do
+        @flag = false
+      end
+
+      YARD::Doctest.after do
+        @flag = true
+      end
+
+      YARD::Doctest.after_run do
+        puts 'Run after all by minitest'
+      end
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   flag #=> false
+      def flag
+        @flag
+      end
+      """
+    When I run `bundle exec yard doctest`
+    Then the output should contain "1 runs, 1 assertions, 0 failures, 0 errors, 0 skips"
+    And the output should contain "Run after all by minitest"

data/lib/yard/cli/doctest.rb

@@ -0,0 +1,86 @@
+module YARD
+  module CLI
+    class Doctest < Command
+
+      def description
+        'Doctests from @example tags'
+      end
+
+      def run(*args)
+        files = args.select { |arg| arg !~ /^-/ }
+
+        files = parse_files(files)
+        examples = parse_examples(files)
+
+        add_pwd_to_path
+        require_helper
+
+        hooks = {}.tap do |hash|
+          hash[:before] = YARD::Doctest.before if YARD::Doctest.before.is_a?(Proc)
+          hash[:after] = YARD::Doctest.after if YARD::Doctest.after.is_a?(Proc)
+        end
+
+        generate_tests(examples, hooks)
+      end
+
+      private
+
+      def parse_files(globs)
+        globs = %w(app lib) if globs.empty?
+
+        files = globs.map do |glob|
+          if glob !~ /.rb$/
+            glob = "#{glob}/**/*.rb"
+          end
+
+          Dir[glob]
+        end
+
+        files.flatten
+      end
+
+      def parse_examples(files)
+        YARD.parse(files)
+        registry = Registry.load_all
+        registry.all.map { |object| object.tags(:example) }.flatten
+      end
+
+      def generate_tests(examples, hooks)
+        examples.each do |example|
+          path = example.object.path
+          file = "#{Dir.pwd}/#{example.object.files.first.join(':')}"
+          name = example.name
+          text = example.text
+
+          text = text.gsub('# =>', '#=>')
+          text = text.gsub('#=>', "\n#=>")
+          lines = text.split("\n").map(&:strip).reject(&:empty?)
+
+          asserts = [].tap do |arr|
+            until lines.empty?
+              actual = lines.take_while { |l| l !~ /^#=>/ }
+              expected = lines[actual.size] || ''
+              lines.slice! 0..actual.size
+
+              arr << {
+                expected: expected.sub('#=>', '').strip,
+                actual: actual.join("\n"),
+              }
+            end
+          end
+
+          YARD::Doctest::Example.new(path, file, name, asserts, hooks)
+        end
+      end
+
+      def add_pwd_to_path
+        $LOAD_PATH.unshift(Dir.pwd) unless $LOAD_PATH.include?(Dir.pwd)
+      end
+
+      def require_helper
+        require 'yard-doctest_helper'
+      end
+
+    end # Doctest
+  end # CLI
+end # YARD

data/lib/yard/doctest/example.rb

@@ -0,0 +1,53 @@
+require 'sourcify'
+
+module YARD
+  module Doctest
+    class Example
+
+      #
+      # There are a bunch of hacks happening here:
+      #
+      #   1. Everything is done within constructor.
+      #   2. Context (binding) is shared between helper, example and hooks.
+      #   3. Since hooks are blocks, they can't be passed to `#eval`,
+      #      so we translate them into string of Ruby code.
+      #   4. Intercept exception backtrace and add example object definition path.
+      #
+
+      def initialize(path, file, name, asserts, hooks)
+        Object.instance_eval do
+          context = binding
+
+          require 'minitest/autorun'
+          context.eval "require 'yard-doctest_helper'"
+
+          describe path do
+            before { context.eval(hooks[:before].to_source(strip_enclosure: true)) } if hooks[:before]
+            after { context.eval(hooks[:after].to_source(strip_enclosure: true)) } if hooks[:after]
+
+            it name do
+              asserts.each do |assert|
+                expected, actual = assert[:expected], assert[:actual]
+                actual = context.eval(actual)
+
+                unless expected.empty?
+                  begin
+                    assert_equal context.eval(expected), actual
+                  rescue Minitest::Assertion => e
+                    backtrace = e.backtrace
+                    example = backtrace.find { |trace| trace =~ %r(lib/yard/doctest/example) }
+                    example = backtrace.index(example)
+                    backtrace = backtrace.insert(example, file)
+                    e.set_backtrace backtrace
+                    raise e
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+    end # Example
+  end # Doctest
+end # YARD

data/lib/yard/doctest/rake.rb

@@ -0,0 +1,34 @@
+require 'rake'
+require 'rake/tasklib'
+
+module YARD
+  module Doctest
+    class RakeTask < ::Rake::TaskLib
+
+      attr_accessor :name
+      attr_accessor :doctest_opts
+      attr_accessor :pattern
+
+      def initialize(name = 'yard:doctest')
+        @name = name
+        @doctest_opts = []
+        @pattern = ''
+
+        yield self if block_given?
+
+        define
+      end
+
+      protected
+
+      def define
+        desc 'Run YARD doctests'
+        task(name) do
+          command = "yard doctest #{(doctest_opts << pattern).join(' ')}"
+          system(command)
+        end
+      end
+
+    end # RakeTask
+  end # Doctest
+end # YARD

data/lib/yard/doctest/version.rb

@@ -0,0 +1,5 @@
+module YARD
+  module Doctest
+    VERSION = '0.1.0'
+  end
+end

data/lib/yard-doctest.rb

@@ -0,0 +1,29 @@
+require 'yard'
+require 'minitest'
+
+require 'yard/cli/doctest'
+require 'yard/doctest/example'
+require 'yard/doctest/rake'
+require 'yard/doctest/version'
+
+module YARD
+  module Doctest
+
+    class << self
+      def before(&blk)
+        block_given? ? @before = blk : @before
+      end
+
+      def after(&blk)
+        block_given? ? @after = blk : @after
+      end
+
+      def after_run(&blk)
+        Minitest.after_run &blk
+      end
+    end
+
+  end # Doctest
+end # YARD
+
+YARD::CLI::CommandParser.commands[:doctest] = YARD::CLI::Doctest

data/yard-doctest.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yard/doctest/version'
+
+Gem::Specification.new do |spec|
+  spec.name         = 'yard-doctest'
+  spec.version      = YARD::Doctest::VERSION
+  spec.author       = 'Alex Rodionov'
+  spec.email        = 'p0deje@gmail.com'
+  spec.summary      = 'Doctests from YARD examples'
+  spec.description  = 'Execute YARD examples as tests'
+  spec.homepage     = 'https://github.com/p0deje/yard-doctest'
+  spec.license      = 'MIT'
+
+  spec.files        = `git ls-files -z`.split("\x0")
+  spec.test_files   = spec.files.grep(/^features\//)
+  spec.require_path = 'lib'
+
+  spec.add_runtime_dependency 'yard'
+  spec.add_runtime_dependency 'minitest'
+  spec.add_runtime_dependency 'sourcify'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'aruba'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: yard-doctest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Rodionov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sourcify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Execute YARD examples as tests
+email: p0deje@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/support/env.rb
+- features/yard-doctest.feature
+- lib/yard-doctest.rb
+- lib/yard/cli/doctest.rb
+- lib/yard/doctest/example.rb
+- lib/yard/doctest/rake.rb
+- lib/yard/doctest/version.rb
+- yard-doctest.gemspec
+homepage: https://github.com/p0deje/yard-doctest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Doctests from YARD examples
+test_files:
+- features/support/env.rb
+- features/yard-doctest.feature
+has_rdoc: