minitest-documentation 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22b083b54f6ddb41e1eae4099bb14b596438302c
+  data.tar.gz: d2644d28c8bfc063d5ccb8e7b65e45fd62b31f6d
+SHA512:
+  metadata.gz: 405f1b23faca6d8888d618fd833f8fc7284dd14935b38889bda84255f6ebb6236ddb1e304bd1ca31a6a1e8951970549c26ca044286fa2625db9b8586ac88f84b
+  data.tar.gz: 53481d606f908c4a1c0a6cb738cc19b5c295ef0723b9c92761eaaee1e9e192a9e9b1ec77560ee1797764a8ea21fa6824ab5dafa499355107383f7baf23361609

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in minitest-documentation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Teo Ljungberg
+
+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,82 @@
+# Minitest::Documentation
+
+A documentation format for [minitest](https://github.com/seattlerb/minitest)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'minitest-documentation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-documentation
+
+## Requirements
+
+Minitest >= 5.0.0
+
+## Usage
+
+Just pass `--documentation` as an argument while running your tests
+
+## What's the difference?
+
+```bash
+Run options: --documentation --seed 17962
+
+# Running:
+
+ExampleTest
+  flunk
+  pass
+  skip
+
+
+Finished in 0.001199s, 2502.0851 runs/s, 1668.0567 assertions/s.
+
+  1) Failure:
+ExampleTest#test_flunk [example_test.rb:9]:
+Epic Fail!
+
+3 runs, 2 assertions, 1 failures, 0 errors, 1 skips
+
+You have skipped tests. Run with --verbose for details.
+```
+
+vs
+
+```bash
+Run options: --seed 51722
+
+# Running:
+
+SF.
+
+Finished in 0.001132s, 2650.1767 runs/s, 1766.7845 assertions/s.
+
+  1) Failure:
+ExampleTest#test_flunk [example_test.rb:9]:
+Epic Fail!
+
+3 runs, 2 assertions, 1 failures, 0 errors, 1 skips
+
+You have skipped tests. Run with --verbose for details.
+```
+
+Aaaaand, it's colorized!
+`Pass` => Green
+`Skip` => Yellow
+`Fail` => Red
+
+## Contributing
+
+1. Fork it ( http://github.com/teoljungberg/minitest-documentation/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 new Pull Request

data/Rakefile

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

data/example_test.rb

@@ -0,0 +1,15 @@
+require 'minitest/autorun'
+
+class ExampleTest < Minitest::Test
+  def test_pass
+    pass
+  end
+
+  def test_flunk
+    flunk
+  end
+
+  def test_skip
+    skip
+  end
+end

data/lib/minitest/documentation.rb

@@ -0,0 +1,52 @@
+module Minitest
+  class DocumentationReporter < Reporter
+    ESC    = "\e["
+    NND    = "#{ESC}0m"
+    GREEN  = "#{ESC}32m"
+    RED    = "#{ESC}31m"
+    YELLOW = "#{ESC}33m"
+
+    def self.documentation!
+      @documentation = true
+    end
+
+    def self.documentation?
+      @documentation ||= false
+    end
+
+    def record result
+      color_code = case result.result_code
+                   when "."
+                     GREEN
+                   when "E", "F"
+                     RED
+                   when "S"
+                     YELLOW
+                   end
+
+      output_klass_name result.class
+      test = test_name result
+
+      io.print color_code
+      io.print "  "
+      io.puts test.
+        sub("test_", "").
+        gsub("_", " ")
+      io.print NND
+    end
+
+    private
+    attr_accessor :klass
+
+    def output_klass_name k
+      if k != klass
+        self.klass = k
+        io.puts klass
+      end
+    end
+
+    def test_name o
+      o.instance_variable_get "@NAME"
+    end
+  end
+end

data/lib/minitest/documentation_plugin.rb

@@ -0,0 +1,17 @@
+require 'minitest/documentation'
+
+module Minitest
+  def self.plugin_documentation_options opts, options
+    opts.on "--documentation", "Documentation formatter" do
+      DocumentationReporter.documentation!
+    end
+  end
+
+  def self.plugin_documentation_init options
+    return unless DocumentationReporter.documentation?
+
+    io = options.delete(:io) || $stdout
+    self.reporter.reporters.reject! {|o| o.is_a? ProgressReporter }
+    self.reporter.reporters << DocumentationReporter.new(io, options)
+  end
+end

data/minitest-documentation.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-documentation"
+  spec.version       = "0.0.2"
+  spec.authors       = ["Teo Ljungberg"]
+  spec.email         = ["teo.ljungberg@gmail.com"]
+  spec.summary       = %q{Rspec like documentation for Minitest}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/teoljungberg/minitest-documentation"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "minitest"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: minitest-documentation
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Teo Ljungberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-12 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: Rspec like documentation for Minitest
+email:
+- teo.ljungberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example_test.rb
+- lib/minitest/documentation.rb
+- lib/minitest/documentation_plugin.rb
+- minitest-documentation.gemspec
+homepage: https://github.com/teoljungberg/minitest-documentation
+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: Rspec like documentation for Minitest
+test_files: []