yard-minitest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28436cd9a0cf13a5d318db3430a2ea1b068f7058
+  data.tar.gz: f06baa4d28717545c249619918ed5b13604880a0
+SHA512:
+  metadata.gz: 9eeb9a4ab7e67a0a1709409aaef7471332d43ea81b93a9764333ef41b8e86b000823f8148380cedd1dcba6d431a06729a78915d5af7d631c2f4fcf725865f0f3
+  data.tar.gz: 74ee30ea51df974393e6733f95bafd265bf8ebe1c0f8b89436da67475839ba09ca49d69546dd368d5d202e6fa2ceaf7640cb2f051cf71a7384591f741fe3566b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Arjan van der Gaag
+
+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,51 @@
+# YARD::Minitest
+
+Parse Minitest files to read all the test case descriptions and include those
+with the relevant classes in your YARD documentation. This works for both
+ActiveSupport-style `test` blocks and regular old `def test_` methods. Test
+cases get listed at the bottom of your class documentation and include the
+test source code, file name and line numbers.
+
+**This is very much a toy project to play with YARD plugins.** If you find it
+useful then pull requests are welcome.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yard-minitest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yard-minitest
+
+## Usage
+
+YARD::Minitest is a YARD plugin, so you can activate it explicitly when you run
+`yardoc`:
+
+    $ yardoc --plugin minitest
+
+Alternatively, you can have YARD always look for any installed plugin by setting
+its `load_plugins` configuration:
+
+    $ yard config load_plugins true
+
+Remember to include your test files when documenting your project; otherwise
+your tests will not be found.
+
+    $ yardoc app/**/*.rb test/**/*.rb
+
+## Contributing
+
+1. Fork it ( https://github.com/avdgaag/yard-minitest/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/yard-minitest.rb

@@ -0,0 +1,4 @@
+require 'yard/minitest/version'
+require 'yard/minitest/method_handler'
+require 'yard/minitest/block_handler'
+YARD::Templates::Engine.register_template_path File.expand_path('../../templates', __FILE__)

data/lib/yard/minitest/block_handler.rb

@@ -0,0 +1,17 @@
+module YARD
+  module Minitest
+    class BlockHandler < YARD::Handlers::Ruby::Base
+      handles method_call(:test)
+
+      def process
+        subject = YARD::Registry.at(namespace.name.to_s.sub(/Test$/, ''))
+        (subject[:tests] ||= []) << {
+          description: statement.parameters.first.jump(:string_content).source,
+          file: parser.file,
+          line: statement.line,
+          source: statement.block[1].source
+        }
+      end
+    end
+  end
+end

data/lib/yard/minitest/method_handler.rb

@@ -0,0 +1,23 @@
+module YARD
+  module Minitest
+    class MethodHandler < YARD::Handlers::Ruby::MethodHandler
+      handles :def
+
+      def process
+        super
+        if namespace.name.to_s =~ /Test$/
+          method_name = statement.method_name(true).to_s
+          if method_name =~ /^test_/
+            subject = YARD::Registry.at(namespace.name.to_s.sub(/Test$/, ''))
+            (subject[:tests] ||= []) << {
+              description: method_name.gsub(/^test|_/, ' ').strip,
+              file: parser.file,
+              line: statement.line,
+              source: statement.block.source
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard/minitest/version.rb

@@ -0,0 +1,5 @@
+module YARD
+  module Minitest
+    VERSION = '0.0.1'
+  end
+end

data/templates/default/class/html/tests.erb

@@ -0,0 +1,26 @@
+<% if object[:tests] %>
+<div class="tests">
+  <h2>Unit Tests</h2>
+  <ul class="see">
+  <% object[:tests].each do |test| %>
+    <li>
+      <%= test[:description] %>
+      <span class="showSource">[<a href="#" class="toggleSource">Show source</a>]</span>
+      <div class="source_code">
+        <table>
+          <tbody>
+            <tr>
+              <td><pre class="lines"><%= test[:source].lines.each_with_index.map { |_, i| test[:line] + i }.join("\n") %></pre></td>
+                <td><pre class="code">
+<span class="info file"># File '<%= test[:file] %>', line <%= test[:line] %></span>
+<%= html_syntax_highlight format_source test[:source] %>
+              </pre></td>
+            </tr>
+          </tbody>
+        </table>
+      </div>
+    </li>
+  <% end %>
+</ul>
+</div>
+<% end %>

data/templates/default/class/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.push :tests
+end

data/yard-minitest.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yard/minitest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yard-minitest'
+  spec.version       = YARD::Minitest::VERSION
+  spec.authors       = ['Arjan van der Gaag']
+  spec.email         = ['arjan@arjanvandergaag.nl']
+  spec.summary       = %q{Include Minitest test case descriptions in your class documentation.}
+  spec.description   = <<EOS
+Parse Minitest files to read all the test case descriptions and include those
+with the relevant classes in your YARD documentation. This works for both
+ActiveSupport-style `test` blocks and regular old `def test_` methods. Test
+cases get listed at the bottom of your class documentation and include the test
+source code, file name and line numbers.
+EOS
+  spec.homepage      = 'https://github.com/avdgaag/yard-minitest'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'yard'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: yard-minitest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arjan van der Gaag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-31 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |
+  Parse Minitest files to read all the test case descriptions and include those
+  with the relevant classes in your YARD documentation. This works for both
+  ActiveSupport-style `test` blocks and regular old `def test_` methods. Test
+  cases get listed at the bottom of your class documentation and include the test
+  source code, file name and line numbers.
+email:
+- arjan@arjanvandergaag.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yard-minitest.rb
+- lib/yard/minitest/block_handler.rb
+- lib/yard/minitest/method_handler.rb
+- lib/yard/minitest/version.rb
+- templates/default/class/html/tests.erb
+- templates/default/class/setup.rb
+- yard-minitest.gemspec
+homepage: https://github.com/avdgaag/yard-minitest
+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.2
+signing_key: 
+specification_version: 4
+summary: Include Minitest test case descriptions in your class documentation.
+test_files: []
+has_rdoc: