specify_html_reporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 686bb5892af39dd3816a22c1187e20336a66e93ec399519ebf45735f7f06959f
+  data.tar.gz: f131e7e4cf200f2c94b08c7ca86b131c6c6a1d322eaf9413c812fba2bc220360
+SHA512:
+  metadata.gz: 2398bee6ecec1c4e673599ae99dd8d8fe2e56d1eb907e7da956f71fa5591300b7f9ec506550d1a2ab8721ffebb8aa47105ddf8fd2bee4f47fcf9ffa22d81bf66
+  data.tar.gz: c1e348cdf3ec823f20993ab1502dffb038c33ac1c7222437b097e64f3b445385430dc21c7227c9c9b32dd561b86085db4c0af269bbdd3693e1edb552e04d9dab

data/.gitignore

@@ -0,0 +1,49 @@
+# Ruby Generated
+
+/Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/coverage/
+/tmp/
+
+# Generated Reports
+reports/
+
+# Rspec Failure Tracking
+
+.rspec_status
+
+# IDE Files
+
+.idea/
+*.iml
+*.iws
+*.ipr
+.vscode/
+.settings/
+.metadata
+.classpath
+.loadpath
+.buildpath
+.project
+
+# OS Files
+
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+$RECYCLE.BIN/
+Desktop.ini
+*.tmp
+*.bak
+*.swp
+*~.nib

data/.hound.yml

@@ -0,0 +1,73 @@
+AllCops:
+  Exclude:
+    - specify_html_reporter.gemspec
+    - spec/**/*
+
+# Removing need for frozen string literal comment.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Removing the preference for string single quotes.
+Style/StringLiterals:
+  Enabled: false
+
+# Missing top-level module documentation comment.
+Style/Documentation:
+  Enabled: false
+
+# Prefer reduce over inject.
+Style/CollectionMethods:
+  PreferredMethods:
+    reduce: 'inject'
+
+# Use each_with_object instead of inject.
+Style/EachWithObject:
+  Enabled: false
+
+# Prefer fail over raise.
+Style/SignalException:
+  Enabled: false
+
+# This never works for validations.
+Layout/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+# Align multi-line params with previous line.
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# Indent `when` clause one step from `case`.
+Layout/CaseIndentation:
+  IndentOneStep: true
+
+# Don't force bad var names for reduce/inject loops.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# For method chains, keep the dot with the method name.
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+# Stop nesting so hard.
+Metrics/BlockNesting:
+  Max: 2
+
+# Encourage short methods.
+Metrics/MethodLength:
+  Max: 15
+
+# Encourage short (as possible) modules.
+Metrics/ModuleLength:
+  Max: 100
+
+# Encourage fewer parameters.
+Metrics/ParameterLists:
+  Max: 4
+
+# Remove execute permissions check.
+Lint/ScriptPermission:
+  Enabled: false
+
+# Specify HTML Reporter Additions
+Metrics/AbcSize:
+  Max: 18

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--format SpecifyHtmlReport
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+inherit_from:
+  - .hound.yml

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.5.1
+
+before_install: gem install bundler
+
+branches:
+  only:
+    - master

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jeff.nyman@yello.co. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "coveralls", require: false
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jeff Nyman
+
+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,87 @@
+# Specify HTML Reporter
+
+[![Gem Version](https://badge.fury.io/rb/specify_html_reporter.svg)](http://badge.fury.io/rb/specify_html_reporter)
+[![Build Status](https://travis-ci.org/jeffnyman/specify_html_reporter.svg)](https://travis-ci.org/jeffnyman/specify_html_reporter)
+[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jeffnyman/specify_html_reporter/blob/master/LICENSE.md)
+[![Maintainability](https://api.codeclimate.com/v1/badges/3a112fb395c56c961d87/maintainability)](https://codeclimate.com/github/jeffnyman/specify_html_reporter/maintainability)
+
+This gem provides a custom formatter for RSpec execution that generates an HTML-based repository of results files.
+
+While this projet was designed to augment my [Specify](https://github.com/jeffnyman/specify) tool, it will generate reports for any RSpec execution.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'specify_html_reporter'
+```
+
+To get the latest code:
+
+```ruby
+gem 'specify_html_reporter', git: 'https://github.com/jeffnyman/specify_html_reporter'
+```
+
+After doing one of the above, execute the following command:
+
+```
+$ bundle
+```
+
+You can also install Specify HTML Reporter just as you would any other gem:
+
+```
+$ gem install specify_html_reporter
+```
+
+## Usage
+
+The usage is fairly simple and follows the standard pattern you would use for any RSpec formatter. Make sure to require the gem in your `spec_helper.rb` file:
+
+```ruby
+require "specify_html_reporter"
+```
+
+Then, in your `.rspec` file, make sure the following line is in place:
+
+```ruby
+--format SpecifyHtmlReport
+```
+
+If you aren't using an `.rspec` file, just provide `--format SpecifyHtmlReport` as part of your `rspec` execution command.
+
+With the above being done, upon execution of your RSpec suite, you should get a directory called `reports` and within that you'll find an `overview.html` file that serves as the entry point for all reporting. Each spec file is given its own report format and is linked to from the overview file.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec:all` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To experiment with the code, run `bin/console` for an interactive prompt. If you want to make changes and see how they work as a gem installed on your local machine, run `bundle exec rake install`.
+
+The default `rake` command will run all tests as well as a Rubocop analysis.
+
+If you have rights to deploy a new version, make sure to update the version number in `version.rb`, and then run `bundle exec rake release`. This 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/jeffnyman/specify_html_reporter](https://github.com/jeffnyman/specify_html_reporter). The testing ecosystem of Ruby is very large and this project is intended to be a welcoming arena for collaboration on yet another test-supporting tool. As such, contributors are very much welcome but are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) which is provided as a [code of conduct](https://github.com/jeffnyman/specify_html_reporter/blob/master/CODE_OF_CONDUCT.md).
+
+The Specify HTML Reporter gem follows [semantic versioning](http://semver.org).
+
+To contribute to Specify HTML Reporter:
+
+1. [Fork the project](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+2. Create your feature branch. (`git checkout -b my-new-feature`)
+3. Commit your changes. (`git commit -am 'new feature'`)
+4. Push the branch. (`git push origin my-new-feature`)
+5. Create a new [pull request](https://help.github.com/articles/using-pull-requests).
+
+## Author
+
+* [Jeff Nyman](http://testerstories.com)
+
+## License
+
+Specify HTML Reporter is distributed under the [MIT](http://www.opensource.org/licenses/MIT) license.
+See the [LICENSE](https://github.com/jeffnyman/specify_html_reporter/blob/master/LICENSE.md) file for details.

data/Rakefile

@@ -0,0 +1,36 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rdoc/task"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  desc 'Clean all generated reports'
+  task :clean do
+    system('rm -rf spec/reports')
+    system('rm -rf spec/coverage')
+  end
+
+  RSpec::Core::RakeTask.new(all: :clean) do |config|
+    options  = %w[--color]
+    options += %w[--format documentation]
+    options += %w[--format SpecifyHtmlReport]
+    options += %w[--format html --out spec/reports/test-report.html]
+
+    config.rspec_opts = options
+  end
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.main = 'README.md'
+  rdoc.title = "Specify HTML Reporter #{SpecifyHtmlReporter::VERSION}"
+  rdoc.rdoc_files.include('README*', 'lib/**/*.rb')
+end
+
+task default: ['spec:all', :rubocop]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "specify_html_reporter"
+
+require "pry"
+Pry.start

data/bin/setup

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

data/lib/specify_html_reporter/example.rb

@@ -0,0 +1,120 @@
+require "rouge"
+require "active_support"
+require "active_support/core_ext/numeric"
+
+require "specify_html_reporter/problem"
+
+class Example
+  attr_reader :duration, :status, :run_time, :exception, :file_path,
+    :metadata, :spec, :screen_grab, :video_record
+
+  def initialize(example)
+    @spec = nil
+    @example = example
+    setup_execution_result
+    setup_example_data
+    setup_metadata
+    setup_exception
+  end
+
+  def result_type(prefix = 'label-')
+    class_map = {
+      passed: "#{prefix}success",
+      failed: "#{prefix}danger",
+      pending: "#{prefix}warning"
+    }
+
+    class_map[@status.to_sym]
+  end
+
+  def example_title
+    full_title = @example_group.to_s.split('::') - %w[RSpec ExampleGroups]
+    full_title.push @description
+    full_title.join(' → ')
+  end
+
+  def exception?
+    !@exception.problem.nil?
+  end
+
+  def spec?
+    !@spec.nil?
+  end
+
+  def screen_grab?
+    !@screen_grab.nil? && !@screen_grab.empty?
+  end
+
+  def video_record?
+    !@video_record.nil?
+  end
+
+  def comment
+    ERB::Util.html_escape(@comment)
+  end
+
+  def comment?
+    !@comment.nil?
+  end
+
+  def create_spec_line(spec_text)
+    formatter = Rouge::Formatters::HTML.new(css_class: 'highlight')
+    lexer = Rouge::Lexers::Gherkin.new
+    @spec = formatter.format(lexer.lex(spec_text.gsub('#->', '')))
+  end
+
+  def self.load_spec_comments!(examples)
+    examples.group_by(&:file_path).each do |file_path, file_examples|
+      lines = File.readlines(file_path)
+
+      file_examples.zip(file_examples.rotate).each do |example, next_ex|
+        determine_lexical_next(example, next_ex)
+        process_spec_lines(example, next_ex, lines)
+      end
+    end
+  end
+
+  private
+
+  class << self
+    private
+
+    def determine_lexical_next(example, next_ex)
+      @lexical = next_ex &&
+                 next_ex.file_path == example.file_path &&
+                 next_ex.metadata[:line_number] > example.metadata[:line_number]
+    end
+
+    def process_spec_lines(example, next_ex, lines)
+      start_line = example.metadata[:line_number] - 1
+      next_start = (@lexical ? next_ex.metadata[:line_number] : lines.size) - 1
+      spec_lines = lines[start_line...next_start].select { |l| l.match(/#->/) }
+      example.create_spec_line(spec_lines.join) unless spec_lines.empty?
+    end
+  end
+
+  def setup_execution_result
+    @execution_result = @example.execution_result
+    @run_time = @execution_result.run_time.round(5)
+    @status = @execution_result.status.to_s
+    @duration = @execution_result.run_time.to_s(:rounded, precision: 5)
+  end
+
+  def setup_example_data
+    @example_group = @example.example_group.to_s
+    @description = @example.description
+    @full_description = @example.full_description
+    @metadata = @example.metadata
+  end
+
+  def setup_metadata
+    @file_path = @metadata[:file_path]
+    @comment = @metadata[:comment]
+    @screen_grab = @metadata[:screen_grab]
+    @video_record = @metadata[:video_record]
+  end
+
+  def setup_exception
+    @exception = Problem.new(@example, @file_path)
+  end
+end

data/lib/specify_html_reporter/problem.rb

@@ -0,0 +1,93 @@
+require "rouge"
+require "rbconfig"
+
+class Problem
+  attr_reader :problem, :explanation, :backtrace_message, :highlighted_source
+
+  def initialize(example, file_path)
+    @example = example
+    @file_path = file_path
+    @exception = @example.exception
+
+    return if @exception.nil?
+
+    @problem = @exception.class
+    @message = @exception.message.encode("utf-8")
+    @backtrace_message = format_backtrace
+    @highlighted_source = format_source
+    @explanation = format_message
+  end
+
+  def format_message
+    formatter = Rouge::Formatters::HTML.new(css_class: 'highlight')
+    lexer = Rouge::Lexers::Ruby.new
+    formatter.format(lexer.lex(@message))
+  end
+
+  def format_backtrace
+    formatted_backtrace(@example, @exception).map do |entry|
+      ERB::Util.html_escape(entry)
+    end
+  end
+
+  def formatted_backtrace(example, exception)
+    # This logic is in place to avoid an error in the format_backtrace method
+    # for the RSpec formatter. RSpec versions below 3.5 will throw an exception.
+    return [] unless example
+
+    formatter = RSpec.configuration.backtrace_formatter
+    formatter.format_backtrace(exception.backtrace, example.metadata)
+  end
+
+  def format_source
+    return '' if @backtrace_message.empty?
+
+    data = @backtrace_message.first.split(':')
+
+    return if data.empty?
+
+    if os == :windows
+      file_path = data[0] + ':' + data[1]
+      line_number = data[2].to_i
+    else
+      file_path = data.first
+      line_number = data[1].to_i
+    end
+
+    format_source_context(file_path, line_number)
+  end
+
+  def format_source_context(file_path, line_number)
+    lines = File.readlines(file_path)
+    start_line = line_number - 2
+    end_line = line_number + 3
+
+    source = lines[start_line..end_line].join("")
+
+    formatter = Rouge::Formatters::HTML.new(
+      css_class: 'highlight', line_numbers: true, start_line: start_line + 1
+    )
+
+    lexer = Rouge::Lexers::Ruby.new
+    formatter.format(lexer.lex(source.encode('utf-8')))
+  end
+
+  def os
+    @os ||= begin
+      host_os = RbConfig::CONFIG['host_os']
+
+      case host_os
+        when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+          :windows
+        when /darwin|mac os/
+          :macosx
+        when /linux/
+          :linux
+        when /solaris|bsd/
+          :unix
+        else
+          raise Exception, "Unknown operating system: #{host_os.inspect}"
+      end
+    end
+  end
+end

data/lib/specify_html_reporter/version.rb

@@ -0,0 +1,3 @@
+module SpecifyHtmlReporter
+  VERSION = "0.1.0".freeze
+end