minitest-hyper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 811a9cc416d40c66ecd0fedc9a529fce0a82a708
+  data.tar.gz: e2c0cde2163ba305e467e5f0639b74fd08c12263
+SHA512:
+  metadata.gz: 0cb8b60f1190b02abfabec01868a96cb93952d52370726b346543458a1b32ba4e587049802622768d34598ebfeb76cd10dbc4e9a5f840f6480643cffe9505d02
+  data.tar.gz: 619549060baacfd77b99a98d7e911ff22a0d3b3c9881793b46cd0c9ca46ccadccea4ce541b9af32b97cf2ecce261f4fb987f3bb413ef6fa97f39ceb4fa9343e0

data/.gitignore

@@ -0,0 +1,52 @@
+# Editor temporary files
+#
+*~
+\#*\#
+.\#*
+*.swp
+*.swo
+
+
+# Other common temporary files
+#
+*.bak
+*.old
+*.orig
+*.rbc
+/tmp/*
+
+
+# Bundler artifacts
+#
+/.bundle/
+/Gemfile.lock
+/vendor/bundle/
+
+
+# RubyGems-related artifacts
+#
+/*.gem
+
+
+# Testing artifacts and temp files
+#
+/coverage/
+/test/reports/
+/test/tmp/
+**/test/version_tmp
+
+
+# Documentation
+#
+/.yardoc
+/_yardoc/
+/doc/
+/rdoc/
+
+
+# Keep files
+#
+!**/.gitkeep
+!**/.keep
+
+

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Kottom
+
+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,49 @@
+# Minitest::Hyper
+
+Generates attractive, self-contained HTML reports for your Minitest runs.
+
+This gem was created as a demonstration of how to build a Minitest extension for [The Minitest Cookbook](http://chriskottom.com/minitestcookbook/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "minitest-hyper", require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-hyper
+
+## Usage
+
+To generate reports using Minitest::Hyper, you'll need to pass the `-H` or `--html` flag to Minitest on the command line in one of the usual ways.
+
+    $ ruby -H test/foo_test.rb
+    $ TEST_OPTS="--html" rake test
+
+You can also switch on report generation globally for every test run by putting the following in your test helper:
+
+```ruby
+require "minitest/hyper"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/minitest-hyper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "minitest/hyper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/minitest/hyper.rb

@@ -0,0 +1,4 @@
+require "minitest/hyper_plugin"
+
+Minitest.load_plugins
+Minitest::Hyper.enable!

data/lib/minitest/hyper/report.rb

@@ -0,0 +1,63 @@
+require "erb"
+require "fileutils"
+
+module Minitest
+  module Hyper
+    class Report
+      attr_reader :reporter
+
+      def initialize(reporter)
+        @reporter = reporter
+      end
+
+      def url
+        "file://#{ REPORT_FILE.gsub(/\\/, "/") }"
+      end
+
+      def write
+        ensure_output_dir
+        move_existing_file
+        write_file
+      end
+
+      private
+
+      def ensure_output_dir
+        unless Dir.exist?(REPORTS_DIR)
+          FileUtils.mkdir_p REPORTS_DIR
+        end
+      end
+
+      def move_existing_file
+        if File.exist?(REPORT_FILE)
+          ctime = File.ctime(REPORT_FILE)
+          time_str = ctime.strftime("%Y%m%d%H%M%S")
+          new_name = REPORT_FILE.sub(/\.html$/, "_#{ time_str }.html")
+          FileUtils.mv(REPORT_FILE, new_name)
+        end
+      end
+
+      def write_file
+        page_info = {
+          title: "Minitest::Hyper Test Report",
+          styles: css_string,
+          timestamp: Time.now
+        }
+        test_info = reporter.to_h
+
+        erb = ERB.new(template_string)
+        File.open(REPORT_FILE, "wb") do |file|
+          file.write erb.result(binding)
+        end
+      end
+
+      def css_string
+        File.read(CSS_TEMPLATE)
+      end
+
+      def template_string
+        File.read(HTML_TEMPLATE)
+      end
+    end
+  end
+end

data/lib/minitest/hyper/reporter.rb

@@ -0,0 +1,100 @@
+require "minitest"
+
+module Minitest
+  module Hyper
+    class Reporter < Minitest::StatisticsReporter
+      attr_accessor :all_results
+
+      def initialize(io = $stdout, options = {})
+        super
+        self.all_results = []
+      end
+
+      def record(result)
+        super
+        all_results << result
+      end
+
+      def report
+        super
+        @report = Report.new(self)
+        @report.write
+      end
+
+      def passed?
+        super
+        io.puts "Wrote HTML test report to #{ @report.url }"
+      end
+
+      def to_h
+        HashFormatter.as_hash(self)
+      end
+
+      class HashFormatter
+        def self.as_hash(reporter)
+          self.new(reporter).to_h
+        end
+
+        def initialize(reporter)
+          @reporter = reporter
+        end
+
+        def reporter
+          @reporter
+        end
+
+        def to_h
+          {
+            count: reporter.count,
+            assertions: reporter.assertions,
+            start_time: reporter.start_time,
+            total_time: reporter.total_time,
+            failures: reporter.failures,
+            errors: reporter.errors,
+            skips: reporter.skips,
+            results: result_data(reporter.all_results),
+            non_passing: result_data(reporter.results)
+          }
+        end
+
+        def result_data(results)
+          collection = []
+          results.each do |result|
+            collection << {
+              name: result.name,
+              code: result_code(result),
+              class: result_class(result),
+              outcome: result_string(result),
+              time: result.time,
+              assertions: result.assertions,
+              location: result.location,
+              failure: result.failure
+            }
+          end
+          collection
+        end
+
+        def result_code(result)
+          case result.failure
+          when Skip
+            :skip
+          when UnexpectedError
+            :error
+          when Assertion
+            :fail
+          else
+            :pass
+          end
+        end
+
+        def result_class(result)
+          result_code(result).to_s
+        end
+
+        def result_string(result)
+          result_code(result).to_s.capitalize
+        end
+      end
+    end
+  end
+end

data/lib/minitest/hyper_plugin.rb

@@ -0,0 +1,51 @@
+require "minitest"
+
+require "minitest/hyper/reporter"
+require "minitest/hyper/report"
+
+module Minitest
+  # Mandatory Minitest initializer hook
+  # Detected by Minitest.load_plugins, invoked during Minitest.init_plugins
+  def self.plugin_hyper_init(options)
+    if Hyper.enabled?
+      reporter.reporters << Hyper::Reporter.new(options[:io], options)
+    end
+  end
+
+  # Optional hook for command line params handling
+  # Invoked by Minitest.process_args
+  def self.plugin_hyper_options(opts, options)
+    description = "Generate an HTML test report with Minitest::Hyper"
+    opts.on "-H", "--html", description do
+      Hyper.enable!
+    end
+  end
+
+  module Hyper
+    GEM_DIR       = File.join(File.dirname(__FILE__), "../..")
+    WORKING_DIR   = Dir.pwd
+
+    REPORTS_DIR   = File.join(WORKING_DIR, "test/reports/hyper")
+    REPORT_FILE   = File.join(REPORTS_DIR, "index.html")
+
+    TEMPLATE_DIR  = File.join(GEM_DIR, "lib/templates")
+    CSS_TEMPLATE  = File.join(TEMPLATE_DIR, "hyper.css")
+    HTML_TEMPLATE = File.join(TEMPLATE_DIR, "index.html.erb")
+    
+    VERSION = "0.1.0"
+
+    @@enabled = false
+    
+    def self.enabled?
+      @@enabled
+    end
+
+    def self.enable!
+      @@enabled = true
+    end
+
+    def config(options)
+      @options = options
+    end
+  end
+end

data/lib/templates/hyper.css

@@ -0,0 +1,111 @@
+body { padding-top: 70px; }
+
+.row {
+  margin-bottom: 20px;
+}
+
+/*
+ *  SUMMARY ROW
+ */
+#summary .widget {
+  border: 3px solid #eef;
+  border-radius: 10px;
+  margin-right: 2.5%;
+  padding: 10px;
+  width: 18%;
+}
+
+#summary .widget:last-child {
+  margin-right: 0;
+}
+
+#summary .counter {
+  display: block;
+  font-size: 4em;
+  font-weight: bold;
+  text-align: center;
+}
+
+#summary .metric {
+  display: block;
+  font-size: 1.1em;
+  font-weight: bold;
+  text-align: center;
+}
+
+
+/*
+ *  INDIVIDUAL TEST RESULTS
+ */
+#test-results {
+  margin: 0;
+}
+
+#test-results .result {
+  border: solid;
+  border-width: 3px thin;
+  font-size: 14px;
+  margin-bottom: 3px;
+  padding: 6px;
+  width: 100%;
+}
+
+#test-results .result span.outcome-name,
+#test-results .result span.time {
+  display: inline-block;
+  font-size: 15px;
+  font-weight: bold;
+}
+
+#test-results .result span.outcome-name {
+  overflow: hidden;
+  max-width: 85%;
+  white-space: nowrap;
+  text-overflow: ellipsis;
+}
+
+#test-results .result span.time {
+  float: right;
+  width: 15%;
+}
+
+#test-results .result .failure-details {
+  clear: both;
+}
+
+#test-results .result.pass {
+  background-color: #eef;
+  border-color: green;
+  font-color: dark-green;
+}
+
+#test-results .result.fail {
+  background-color: #ffe4b2;
+  border-color: orange;
+}
+
+#test-results .result.error {
+  background-color: #fdd;
+  border-color: red;
+}
+
+#test-results .result.skip {
+  background-color: #f0f0f0;
+  border-color: #aaa;
+}
+
+
+/*
+ *  CHARTS
+ */
+#charts h3 {
+  margin: 0;
+  text-align: center;
+}
+
+#charts canvas {
+  display: block;
+  height: 300px;
+  margin: 0 auto;
+  width: 90%;
+}

data/lib/templates/index.html.erb

@@ -0,0 +1,101 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title><%= page_info[:title] %></title>
+
+    <link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.6/flatly/bootstrap.min.css" rel="stylesheet">
+    <style media="screen" type="text/css">
+     <%= page_info[:styles] %>
+    </style>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.6/js/bootstrap.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/1.0.2/Chart.min.js"></script>
+  </head>
+
+  <body>
+    <div id="main">
+      <div class="container">
+	<div id="summary" class="row">
+	  <div id="count" class="widget col-md-2">
+	    <span class="counter"><%= test_info[:count] %></span>
+	    <span class="metric">Tests Run</span>
+	  </div>
+	  <div id="assertions" class="widget col-md-2">
+	    <span class="counter"><%= test_info[:assertions] %></span>
+	    <span class="metric">Assertions</span>
+	  </div>
+	  <div id="failures" class="widget col-md-2">
+	    <span class="counter"><%= test_info[:failures] %></span>
+	    <span class="metric">Failed</span>
+	  </div>
+	  <div id="errors" class="widget col-md-2">
+	    <span class="counter"><%= test_info[:errors] %></span>
+	    <span class="metric">Errors</span>
+	  </div>
+	  <div id="skips" class="widget col-md-2">
+	    <span class="counter"><%= test_info[:skips] %></span>
+	    <span class="metric">Skipped</span>
+	  </div>
+	</div>
+
+	<div class="row">
+	  <h2>Test Results</h2>
+
+	  <div id="test-results" class="col-md-8">
+	    <% test_info[:results].each do |result| %>
+	      <div class="result clearfix <%= result[:class] %>">
+		<span class="outcome-name">
+		  <%= result[:outcome].upcase %>: <%= result[:name] %>
+		</span>
+		<span class="time"><%= sprintf("%.2f", result[:time] * 1000.0) %> ms</span>
+		<div class="failure-details">
+		  <%= result[:result] %>
+		</div>
+	      </div>
+	    <% end %>
+	  </div>
+
+	  <div id="charts" class="col-md-4">
+	    <h3>Results by Type</h3>
+	    <canvas id="results-by-type"></canvas>
+	  </div>
+	</div>
+      </div>
+    </div>
+    <script>
+     // Results by type pie chart
+     var resultsByTypeData = [
+       {
+	 label: "Failures",
+	 color: "#bd0000",
+	 highlight: "#ed0000",
+	 value: <%= test_info[:failures] %>
+	},
+       {
+	 label: "Errors",
+	 color: "#b34100",
+	 highlight: "#cc4b00",
+	 value: <%= test_info[:errors] %>
+	},
+       {
+	 label: "Skips",
+	 color: "#006e99",
+	 highlight: "#00a8eb",
+	 value: <%= test_info[:skips] %>
+	},
+       {
+	 label: "Passed",
+	 color: "#009e18",
+	 highlight: "#00d620",
+	 value: <%= test_info[:count] - test_info[:skips] - test_info[:errors] - test_info[:failures] %>
+	}
+     ];
+
+     var ctx = document.getElementById("results-by-type").getContext("2d");
+     var resultsByTypeChart = new Chart(ctx).Pie(resultsByTypeData);
+    </script>
+  </body>
+</html>

data/minitest-hyper.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitest/hyper_plugin'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-hyper"
+  spec.version       = Minitest::Hyper::VERSION
+  spec.authors       = ["Chris Kottom"]
+  spec.email         = ["chris@chriskottom.com"]
+
+  spec.summary       = "Pretty HTML reports for Minitest"
+  spec.description   = "Generate attractive, single-page HTML reports for your Minitest runs"
+  spec.homepage      = "https://github.com/chriskottom/minitest-hyper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: minitest-hyper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Kottom
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: Generate attractive, single-page HTML reports for your Minitest runs
+email:
+- chris@chriskottom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minitest/hyper.rb
+- lib/minitest/hyper/report.rb
+- lib/minitest/hyper/reporter.rb
+- lib/minitest/hyper_plugin.rb
+- lib/templates/hyper.css
+- lib/templates/index.html.erb
+- minitest-hyper.gemspec
+homepage: https://github.com/chriskottom/minitest-hyper
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Pretty HTML reports for Minitest
+test_files: []