yard-doctest 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d05d9acd352595e01d0810a9b5a28c5f765339a9
-  data.tar.gz: 39de91d11961df2ae8ac5825d35adb973ad885ab
+  metadata.gz: 216ca29f83eef3428bc20ff8a2ca765b605e8428
+  data.tar.gz: 4c821cbbd5d8c861c365fb57d6defa9f99726002
 SHA512:
-  metadata.gz: 876ea8d1f88bbb88b7c3cc2ec06318985122d86a5fb96f36f66c08cb47c74073e55a1e0dd287b7a1414b85f7d1b9a5985fe4374a622cc4942157551b1906fb75
-  data.tar.gz: dd9b9c3afea9b45560a421b2d9ad15563db3c510e33e90fc18df6d21601847e2a23c2af8d6b1db70f10c319decdf46002207ad5223c173f5c557bf7904ab3ebb
+  metadata.gz: 831c02685ac564f579baeb4ecde9d6994e7ee09a34db02556bcac5f3ee799eda2c816905a524a659602d1316b5a3bc4c9b18a0a89f1502add3a9dce86e2a11db
+  data.tar.gz: 360322c342fb9d2b567c8d250968a3087b5a7f4ee2e5a4270ce2ee6de6161d8ad0fce80fb37557e502376ca9a9ca92884666bf9e4b6f6a628315118d8028f8d4

data/.travis.yml

@@ -1,5 +1,4 @@
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
 

data/LICENSE.txt

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

data/README.md

@@ -1,4 +1,4 @@
-# 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)
+# 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)
 
 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!
 
@@ -99,6 +99,8 @@ 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
 ```
 
 ```ruby
@@ -195,6 +197,22 @@ It is actually delegated to amazing [minitest](https://github.com/seattlerb/mini
 
 ## Advanced usage
 
+### Exceptions
+
+If you want to use example that raises exception, this can be achieved by specifying the correct expected value:
+
+```ruby
+class Calculator
+  # @example
+  #   divide(1, 0) #=> raise ZeroDivisionError, "divided by 0"
+  def divide(one, two)
+    one / two
+  end
+end
+```
+
+The comparison of raised exceptions is being done by string containing the class and message of exceptions. With that said, you have to use the same message in expected value as the one that is used in actual.
+
 ### Test helper
 
 You can define any methods and instance variables in test helper and they will be available in examples.
@@ -302,6 +320,10 @@ end
 $ bundle exec rake yard:doctest
 ```
 
+## Is it really used?
+
+Well, yeah. A great example of using yard-doctest is [watir-webdriver](https://github.com/watir/watir-webdriver).
+
 ## Testing
 
 There are some system tests implemented with [Aruba](https://github.com/cucumber/aruba):

data/features/yard-doctest.feature

@@ -128,6 +128,22 @@ Feature: yard doctest
         Actual: "2"
       """
 
+  Scenario: asserts exceptions
+    Given a file named "doctest_helper.rb" with:
+      """
+      require 'app/app'
+      """
+    And a file named "app/app.rb" with:
+      """
+      # @example
+      #   divide(1, 0) #=> raise ZeroDivisionError, "divided by 0"
+      def divide(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 Outline: properly handles different return values
     Given a file named "doctest_helper.rb" with:
       """
@@ -428,9 +444,11 @@ Feature: yard doctest
       """
       require 'app/app'
 
-      YARD::Doctest.before { @flag = false  }
-      YARD::Doctest.after { @flag = true  }
-      YARD::Doctest.after_run { puts 'Run after all by minitest' }
+      YARD::Doctest.configure do |doctest|
+        doctest.before { @flag = false  }
+        doctest.after { @flag = true  }
+        doctest.after_run { puts 'Run after all by minitest' }
+      end
       """
     And a file named "app/app.rb" with:
       """

data/lib/yard/doctest/example.rb

@@ -1,5 +1,3 @@
-require 'sourcify'
-
 module YARD
   module Doctest
     class Example < ::Minitest::Spec
@@ -21,29 +19,25 @@ module YARD
 
         Class.new(this.class).class_eval do
           require 'minitest/autorun'
-          if File.exists?('doctest_helper.rb')
-            require 'doctest_helper'
-          elsif File.exists?('support/doctest_helper.rb')
-            require 'support/doctest_helper'
+
+          %w[. support].each do |dir|
+            require "#{dir}/doctest_helper" if File.exist?("#{dir}/doctest_helper.rb")
           end
 
-          unless YARD::Doctest.skips.any? { |skip| this.definition.include?(skip) }
-            describe this.definition do
-              register_hooks(this.definition, YARD::Doctest.hooks)
+          return if YARD::Doctest.skips.any? { |skip| this.definition.include?(skip) }
+          describe this.definition do
+            register_hooks(this.definition, YARD::Doctest.hooks)
 
-              it this.name do
-                this.asserts.each do |assert|
-                  expected, actual = assert[:expected], assert[:actual]
-                  actual = context.eval(actual)
+            it this.name do
+              this.asserts.each do |assert|
+                expected, actual = assert[:expected], assert[:actual]
+                next if expected.empty?
 
-                  unless expected.empty?
-                    begin
-                      assert_equal evaluate(expected), actual
-                    rescue Minitest::Assertion => error
-                      add_filepath_to_backtrace(error, this.filepath)
-                      raise error
-                    end
-                  end
+                begin
+                  assert_equal evaluate(expected), evaluate(actual)
+                rescue Minitest::Assertion => error
+                  add_filepath_to_backtrace(error, this.filepath)
+                  raise error
                 end
               end
             end
@@ -54,8 +48,9 @@ module YARD
       protected
 
       def evaluate(code)
-        code = code.to_source(strip_enclosure: true) if code.is_a?(Proc)
         context.eval(code)
+      rescue StandardError => error
+        "#<#{error.class}: #{error}>"
       end
 
       def context
@@ -64,7 +59,7 @@ module YARD
 
       def add_filepath_to_backtrace(exception, filepath)
         backtrace = exception.backtrace
-        line = backtrace.find { |l| l =~ %r(lib/yard/doctest/example) }
+        line = backtrace.find { |l| l =~ %r{lib/yard/doctest/example} }
         index = backtrace.index(line)
         backtrace = backtrace.insert(index, filepath)
         exception.set_backtrace backtrace
@@ -75,12 +70,10 @@ module YARD
           hooks.each do |hook|
             if hook[:test]
               # test-name hooks
-              if definition.include?(hook[:test])
-                send(type) { evaluate(hook[:block]) }
-              end
+              send(type, &hook[:block]) if definition.include?(hook[:test])
             else
               # global hooks
-              send(type) { evaluate(hook[:block]) }
+              send(type, &hook[:block])
             end
           end
         end

data/lib/yard/doctest/version.rb

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

data/lib/yard-doctest.rb

@@ -30,7 +30,7 @@ module YARD
     # @param [Proc] blk
     #
     def before(test = nil, &blk)
-      hooks[:before] << {test: test, block: blk} if block_given?
+      hooks[:before] << {test: test, block: blk}
     end
 
     #
@@ -43,7 +43,7 @@ module YARD
     # @param [Proc] blk
     #
     def after(test = nil, &blk)
-      hooks[:after] << {test: test, block: blk} if block_given?
+      hooks[:after] << {test: test, block: blk}
     end
 
     #

data/yard-doctest.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
 
   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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-doctest
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Alex Rodionov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !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