rspec-github-actions-formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 781da4bb8f3efbc09d80174d5ac3e3e84233750370ac609dca294bdac9adad5d
+  data.tar.gz: ba58cf117e2f896d6426fe66cbefc25ef9aa895a55266f564ce85c5ccb3bace9
+SHA512:
+  metadata.gz: e79067ab9c853f93a22c6f9f89dced12c7859d5ce85d30cb1def8017b0c290f93e85fb1aca5f4363aa8109122e86285690ae3d2d64acb9460922c59f2931a68a
+  data.tar.gz: a9f774943edd415a01192cd19d43aa01a1f0158fe24fe1bec61a860eb3d5cf937a8cec1913c3798e0375bc0b36f3626cd7fc8d58039165e47467061677b2cb88

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+Please see the releases on GitHub for the changelog.

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 steve.hill@divido.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec-github-actions-formatter.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    rspec-github-actions-formatter (0.1.0)
+      rspec (~> 3.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec-github-actions-formatter!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Steve Hill
+
+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,59 @@
+# rspec-github-actions-formatter
+
+This is a custom formatter for use with RSpec 3.9 and above.
+
+It's designed to integrate with GitHub Actions, so that failing and
+pending specs are annotated correctly, but it also solves an issue
+I had with the way that actions handles streaming to STDOUT.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-github-actions-formatter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rspec-github-actions-formatter
+
+If you're using this with Rails, you can probably just add it to
+the `test` group in your Gemfile.
+
+## Usage
+
+Once you've installed the gem, you'll need to tell Rspec to use it.
+This can be done by adding this line to the `.rspec` file:
+
+    --format RspecGithubActionsFormatter
+    
+You could also require it directly when executing RSpec:
+
+    $ bundle exec rspec --format RspecGithubActionsFormatter
+
+The annotations output won't be very useful unless you're executing
+your tests within GitHub Actions, but the progress display is quite
+useful no matter where you run your tests!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/rspec-github-actions-formatter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rspec-github-actions-formatter/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rspec::Github::Actions::Formatter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rspec-github-actions-formatter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

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/rspec_github_actions_formatter.rb

@@ -0,0 +1,116 @@
+require "rspec/core/formatters/progress_formatter"
+
+class RspecGithubActionsFormatter < RSpec::Core::Formatters::ProgressFormatter
+  VERSION = "0.1.0"
+
+  RSpec::Core::Formatters.register self, :dump_pending, :dump_failures, :example_passed, :example_pending, :example_failed, :example_started, :start
+
+  def start(example_count)
+    @example_count = example_count.count
+    @examples_executed = 0
+    @tests_per_line = terminal_width - progress_display_width(@example_count)
+
+    super
+  end
+
+  def example_started(_notification)
+    @examples_executed += 1
+  end
+
+  def example_passed(notification)
+    super
+
+    split_progress_into_lines(notification)
+  end
+
+  def example_pending(notification)
+    super
+
+    split_progress_into_lines(notification)
+  end
+
+  def example_failed(notification)
+    super
+
+    split_progress_into_lines(notification)
+  end
+
+  def dump_pending(notification)
+    if notification.pending_examples.length > 0
+      super
+      @output << pending_examples_output(notification)
+    end
+  end
+
+  def dump_failures(notification)
+    if notification.failed_examples.length > 0
+      super
+      @output << failed_examples_output(notification)
+    end
+  end
+
+  private
+
+  def split_progress_into_lines(_notification)
+    if @examples_executed % @tests_per_line == 0 || @examples_executed == @example_count
+      output.print progress_display(@examples_executed, @example_count)
+    end
+  end
+
+  def pending_examples_output(notification)
+    pending_examples_output = notification.pending_examples.map do |example|
+      pending_example_output(example)
+    end
+    build_examples_output(pending_examples_output)
+  end
+
+  def pending_example_output(example)
+    execution_result = example.execution_result
+    message = execution_result.pending_message
+    file, line = file_and_line(example.location)
+
+    "::warning file=#{file},line=#{line},#{message}"
+  end
+
+  # Loops through all of the failed examples and rebuilds the exception message
+  def failed_examples_output(notification)
+    failed_examples_output = notification.failed_examples.map do |example|
+      failed_example_output example
+    end
+    build_examples_output(failed_examples_output)
+  end
+
+  # Extracts the full_description, location and formats the message of each example exception
+  def failed_example_output(example)
+    execution_result = example.execution_result
+    message = escape_newlines(execution_result.exception.message)
+    file, line = file_and_line(example.location)
+
+    "::error file=#{file},line=#{line},#{message}"
+  end
+
+  def build_examples_output(output)
+    output.join("\n")
+  end
+
+  def escape_newlines(message)
+    message.gsub('\n', '\\n')
+  end
+
+  def file_and_line(location)
+    location.delete_prefix("./").split(":")
+  end
+
+  def terminal_width
+    `tput cols`.to_i || 80
+  end
+
+  def progress_display(executed_examples, total_examples)
+    max_width = total_examples.to_s.size
+    sprintf " [%#{max_width}d / %#{max_width}d]", executed_examples, total_examples
+  end
+
+  def progress_display_width(example_count)
+    progress_display(example_count, example_count).size
+  end
+end

data/rspec-github-actions-formatter.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-github-actions-formatter"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Steve Hill"]
+  spec.email         = ["steve@stevehill.xyz"]
+
+  spec.summary       = %q{RSpec formatter for use with GitHub Actions.}
+  spec.description   = %q{This custom formatter provides a line-streaming output for RSpec, and will also output annotations from any pending, skipped or failing tests in the format GitHub Actions requires.}
+  spec.homepage      = "https://github.com/stevehill1981/rspec-github-actions-formatter"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/stevehill1981/rspec-github-actions-formatter/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "~> 3.9.0"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: rspec-github-actions-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Hill
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+description: This custom formatter provides a line-streaming output for RSpec, and
+  will also output annotations from any pending, skipped or failing tests in the format
+  GitHub Actions requires.
+email:
+- steve@stevehill.xyz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- lib/rspec_github_actions_formatter.rb
+- rspec-github-actions-formatter.gemspec
+homepage: https://github.com/stevehill1981/rspec-github-actions-formatter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stevehill1981/rspec-github-actions-formatter
+  source_code_uri: https://github.com/stevehill1981/rspec-github-actions-formatter
+  changelog_uri: https://github.com/stevehill1981/rspec-github-actions-formatter/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: RSpec formatter for use with GitHub Actions.
+test_files: []