yard-doctest 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eaf710b790298916a7621aa89f1ccfc8f958d4a8
-  data.tar.gz: 3170484780f834944b8b2b23b4fd845d96b3f83b
+  metadata.gz: cd5ed8e592d798085c06707ac39cc89772b80bca
+  data.tar.gz: 026c3d35c873ddb3ee9c5847d5ca8d89cb46b599
 SHA512:
-  metadata.gz: 39ad0fa507a041b04f5d040a5609f1269ac38c8780cd3e4868a5a4d608babeafb289857b09ada303ddd0ed414e34af82fde8b8a253483493c2f422d012448441
-  data.tar.gz: 5a3d8827d8da6d84f690f51fb1374fb42171254b320a20db767bbbefe7b45cb355178331dbbb8c026fd826dc5c3f82833b2ba5ae18617d88e0b5687e8a26f461
+  metadata.gz: 98762b209916d0d4e5da1f62f30b5189cacb07ed56f3c066abb3f3b15f12db2b84f6d5b2123a7254ee914bb7e7cbd20ca75b88cf4f5b993c7bb9dd72808f599f
+  data.tar.gz: 695cb4f162d40bafa601b1736fe8c9d2f639e3094ffbab6b2a7cd128bec756698741433c87a8ec13db42481665a57b682f3899acb39982e6c4a773bcb49362db

data/README.md

@@ -9,7 +9,7 @@ Meet `YARD::Doctest` - simple and magical gem, which automatically parses your `
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'yardoctest'
+gem 'yard-doctest'
 ```
 
 And then execute:

data/lib/yard-doctest.rb

@@ -1,5 +1,6 @@
 require 'yard'
 require 'minitest'
+require 'minitest/spec'
 
 require 'yard/cli/doctest'
 require 'yard/doctest/example'
@@ -10,14 +11,34 @@ module YARD
   module Doctest
 
     class << self
+      #
+      # Passed block called before each example and
+      # evaluated in the same context as example.
+      #
+      # @param [Proc] blk
+      #
       def before(&blk)
         block_given? ? @before = blk : @before
       end
 
+      #
+      # Passed block called after each example and
+      # evaluated in the same context as example.
+      #
+      # @param [Proc] blk
+      #
       def after(&blk)
         block_given? ? @after = blk : @after
       end
 
+      #
+      # Passed block called after all examples and
+      # evaluated in the different context from examples.
+      #
+      # It actually just sends block to `Minitest.after_run`.
+      #
+      # @param [Proc] blk
+      #
       def after_run(&blk)
         Minitest.after_run &blk
       end
@@ -26,4 +47,5 @@ module YARD
   end # Doctest
 end # YARD
 
+
 YARD::CLI::CommandParser.commands[:doctest] = YARD::CLI::Doctest

data/lib/yard/cli/doctest.rb

@@ -6,6 +6,13 @@ module YARD
         'Doctests from @example tags'
       end
 
+      #
+      # Runs the command line, parsing arguments
+      # and generating tests.
+      #
+      # @param [Array<String>] args Switches are passed to minitest,
+      #   everything else is treated as the list of directories/files or glob
+      #
       def run(*args)
         files = args.select { |arg| arg !~ /^-/ }
 
@@ -13,14 +20,8 @@ module YARD
         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)
+        generate_tests(examples)
       end
 
       private
@@ -45,11 +46,8 @@ module YARD
         registry.all.map { |object| object.tags(:example) }.flatten
       end
 
-      def generate_tests(examples, hooks)
+      def generate_tests(examples)
         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('# =>', '#=>')
@@ -69,7 +67,11 @@ module YARD
             end
           end
 
-          YARD::Doctest::Example.new(path, file, name, asserts, hooks)
+          spec = YARD::Doctest::Example.new(example.name)
+          spec.definition = example.object.path
+          spec.filepath = "#{Dir.pwd}/#{example.object.files.first.join(':')}"
+          spec.asserts = asserts
+          spec.generate
         end
       end
 
@@ -77,10 +79,6 @@ module YARD
         $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

@@ -2,44 +2,42 @@ require 'sourcify'
 
 module YARD
   module Doctest
-    class Example
+    class Example < ::Minitest::Spec
+
+      # @return [String] namespace path of example (e.g. `Foo#bar`)
+      attr_accessor :definition
+
+      # @return [String] filepath to definition (e.g. `app/app.rb:10`)
+      attr_accessor :filepath
+
+      # @return [Array<Hash>] assertions to be done
+      attr_accessor :asserts
 
       #
-      # 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.
+      # Generates a spec and registers it to Minitest runner.
       #
+      def generate
+        this = self
 
-      def initialize(path, file, name, asserts, hooks)
-        Object.instance_eval do
-          context = binding
-
+        Class.new(this.class).class_eval do
           require 'minitest/autorun'
-          context.eval "require 'yard-doctest_helper'"
+          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]
+          describe this.definition do
+            before { evaluate YARD::Doctest.before } if YARD::Doctest.before.is_a?(Proc)
+            after  { evaluate YARD::Doctest.after  } if YARD::Doctest.after.is_a?(Proc)
 
-            it name do
-              asserts.each do |assert|
+            it this.name do
+              this.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
+                    assert_equal evaluate(expected), actual
+                  rescue Minitest::Assertion => error
+                    add_filepath_to_backtrace(error, this.filepath)
+                    raise error
                   end
                 end
               end
@@ -48,6 +46,25 @@ module YARD
         end
       end
 
+      protected
+
+      def evaluate(code)
+        code = code.to_source(strip_enclosure: true) if code.is_a?(Proc)
+        context.eval(code)
+      end
+
+      def context
+        @binding ||= binding
+      end
+
+      def add_filepath_to_backtrace(exception, filepath)
+        backtrace = exception.backtrace
+        line = backtrace.find { |line| line =~ %r(lib/yard/doctest/example) }
+        index = backtrace.index(line)
+        backtrace = backtrace.insert(index, filepath)
+        exception.set_backtrace backtrace
+      end
+
     end # Example
   end # Doctest
 end # YARD

data/lib/yard/doctest/rake.rb

@@ -5,8 +5,13 @@ module YARD
   module Doctest
     class RakeTask < ::Rake::TaskLib
 
+      # @return [String] the name of the task
       attr_accessor :name
+
+      # @return [Array<String>] options to pass to test runner
       attr_accessor :doctest_opts
+
+      # @return [String] list of files/dirs separated with space or glob
       attr_accessor :pattern
 
       def initialize(name = 'yard:doctest')

data/lib/yard/doctest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-doctest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Rodionov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard