minitest-documentation 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dec6b2d7fa607ee600072484f32f0d80253b90b8
-  data.tar.gz: ebd2945b00789c8e69263f6aee6c15d12e258ae3
+  metadata.gz: 903b024afaacd5c5e1d47f8f01e86f457210fd09
+  data.tar.gz: 733731c8074c9ae06ded824f5235bd8dccfdaa3f
 SHA512:
-  metadata.gz: 5b460e721becf923ab7d88f8956688d822d3d84e24cf7007c4e9b0a4de0397643dbb202bea22a23b2844f1485522f1a5fe5cc2c4e926640feef99e0cc765d4aa
-  data.tar.gz: d200be636df5cba7ffb1af5cb21b45a61917906e05767a89fe06e9c3de6cd58ccdee552231da10e8eab99e64173f8ccf9cd05a201c318999d60f0270e57b25fc
+  metadata.gz: 774dced2d39c8a68e4a1f0aa7ff9572e0997cefaa686b72afcedd2535803e36c21af74b5823a0e451a626a896e51d4074223756ec935fa6c5ce16bbf35464214
+  data.tar.gz: 16ec6acee8ad707ecdc3a78a9d67ec2697c23a83c1a97e41cee6962bf8d1eb94b356dae44688da8d30116c12a736e9c6f1795f482c9a0f2176303f9d615804b1

data/README.md

@@ -22,7 +22,8 @@ Minitest >= 5.0.0
 
 ## Usage
 
-Just pass `--documentation` as an argument while running your tests
+Just pass `--documentation` as an argument while running your tests.
+Or require `minitest/documentation` in your tests.
 
 ## What's the difference?
 
@@ -68,12 +69,6 @@ Epic Fail!
 You have skipped tests. Run with --verbose for details.
 ```
 
-### Color
-If you add `--color` as an argument the output will be colorized
-- `pass` => Green
-- `skip` => Yellow
-- `fail` => Red
-
 ## Contributing
 
 1. Fork it ( http://github.com/teoljungberg/minitest-documentation/fork )

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  ENV["RUBYOPT"] = "-w"
+  t.pattern      = "test/**/*_test.rb"
+  t.libs         << "test"
+end
+task :default => :test

data/lib/minitest/documentation.rb

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

data/lib/minitest/documentation_plugin.rb

@@ -1,21 +1,56 @@
-require 'minitest/documentation'
+require 'minitest'
 
 module Minitest
   def self.plugin_documentation_options opts, options
     opts.on "--documentation", "Documentation formatter" do
-      DocumentationReporter.documentation!
-    end
-
-    opts.on "--color", "Colorize the output" do
-      DocumentationReporter.color!
+      Documentation.documentation!
     end
   end
 
   def self.plugin_documentation_init options
-    if DocumentationReporter.documentation? || DocumentationReporter.color?
+    if Documentation.documentation?
       io = options.delete(:io) || $stdout
       self.reporter.reporters.reject! {|o| o.is_a? ProgressReporter }
-      self.reporter.reporters << DocumentationReporter.new(io, options)
+      self.reporter.reporters << Documentation.new(io, options)
+    end
+  end
+
+  class Documentation < Reporter
+    INDENT = "  "
+
+    def self.documentation!
+      @documentation = true
+    end
+
+    def self.documentation?
+      @documentation ||= false
+    end
+
+    def record result
+      format_test_klass result
+
+      io.print INDENT
+      io.puts format_test_name(result)
+    end
+
+    private
+
+    def format_test_klass klass
+      @klass ||= ""
+      if klass.class != @klass
+        @klass = klass.class
+        io.puts @klass
+      end
+    end
+
+    def test_name o
+      o.instance_variable_get "@NAME"
+    end
+
+    def format_test_name test
+      test_name(test).
+        sub("test_", "").
+        gsub("_", " ")
     end
   end
 end

data/minitest-documentation.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "minitest-documentation"
-  spec.version       = "0.0.4"
+  spec.version       = "1.0.0"
   spec.authors       = ["Teo Ljungberg"]
   spec.email         = ["teo.ljungberg@gmail.com"]
   spec.summary       = %q{Rspec like documentation for Minitest}

data/test/minitest/documentation_test.rb

@@ -0,0 +1,26 @@
+require_relative 'test_case'
+require 'minitest/documentation'
+
+module Minitest
+  class DocumentationFormatTest < TestCase
+    def setup
+      Documentation.documentation!
+      ExampleTest.generate_tests!
+      self.reporter = Documentation.new io
+    end
+    attr_accessor :reporter
+
+    def test_documentation_format
+      ExampleTest.run reporter
+
+      exp_format = <<-EOS
+Minitest::TestCase::ExampleTest
+  a very long sentence
+  pass
+  verbosity
+      EOS
+
+      assert_equal exp_format, io.string
+    end
+  end
+end

data/test/minitest/test_case.rb

@@ -0,0 +1,20 @@
+require 'minitest/autorun'
+require 'stringio'
+
+module Minitest
+  class TestCase < Test
+    ExampleTest = Class.new(Test) {
+      i_suck_and_my_tests_are_order_dependent!
+
+      def self.generate_tests!
+        define_method(:test_pass)                 { assert 'truthy' }
+        define_method(:test_verbosity)            { assert 'truthy' }
+        define_method(:test_a_very_long_sentence) { assert 'truthy' }
+      end
+    }
+
+    def io
+      @io ||= StringIO.new
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-documentation
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Teo Ljungberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-18 00:00:00.000000000 Z
+date: 2014-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -68,6 +68,8 @@ files:
 - lib/minitest/documentation.rb
 - lib/minitest/documentation_plugin.rb
 - minitest-documentation.gemspec
+- test/minitest/documentation_test.rb
+- test/minitest/test_case.rb
 homepage: https://github.com/teoljungberg/minitest-documentation
 licenses:
 - MIT
@@ -88,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Rspec like documentation for Minitest