rspec-checkstyle_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de9dda2822872bb1e8002c3f35fdf52f17e3230e721bda18d8f214d4b80f4898
+  data.tar.gz: 4a40aba22f92ddd10b658c57a0ec882d5ac99a0a4ccaf33e12a27fb5a8124395
+SHA512:
+  metadata.gz: 7d8ae2db64c9e7bf4f5ef38b9115999474456e869104b658fa0b913c35c5110e092bfc2b74289affaa0904884626c1993aa5a3f3ae60ba5f8bee6127b283fd31
+  data.tar.gz: 6729994c1b14bb8d4c293bd1ff853b04843d1284481357e7e308a97190ef7f8fa83fe128510d72b01aad354ff3eaf6c3183acf5b9e241d478e27318f8bf12186

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

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 astronoka@users.noreply.github.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,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-checkstyle_formatter.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 astronoka
+
+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,44 @@
+# RSpec::CheckstyleFormatter
+
+Format the results of the rspec execution into checksytle format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-checkstyle_formatter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rspec-checkstyle_formatter
+
+## Usage
+
+'''
+$ bundle exec rspec --format RSpec::CheckstyleFormatter
+'''
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/rspec-checkstyle_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-checkstyle_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::CheckstyleFormatter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rspec-checkstyle_formatter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/checkstyle_formatter"
+
+# 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(__FILE__)

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'rexml/document'
+require 'rspec/core/formatters/base_formatter'
+
+module RSpec
+  # Format the results of rspec into a checkstyle format.
+  # See reporter implementation for details.
+  # https://github.com/rspec/rspec-core/blob/main/lib/rspec/core/reporter.rb
+  class CheckstyleFormatter < RSpec::Core::Formatters::BaseFormatter
+    RSpec::Core::Formatters.register self,
+                                     :example_failed,
+                                     :close
+
+    def initialize(output)
+      super(output)
+      @xml_document = REXML::Document.new
+      @xml_document << REXML::XMLDecl.new
+      @checkstyle = REXML::Element.new('checkstyle', @xml_document)
+      @failed_notifications_group_by_filename = {}
+    end
+
+    def example_failed(notification)
+      unless @failed_notifications_group_by_filename.key?(notification.example.file_path)
+        @failed_notifications_group_by_filename[notification.example.file_path] = []
+      end
+      @failed_notifications_group_by_filename[notification.example.file_path] << notification
+    end
+
+    def close(_null_notification)
+      @failed_notifications_group_by_filename.each do |filename, failed_notifications|
+        file_element = REXML::Element.new('file', @checkstyle)
+        file_element.attributes['name'] = filename
+        append_errors(file_element, failed_notifications)
+      end
+      @xml_document.write(@output, 2)
+    end
+
+    private
+
+    def append_errors(file_element, failed_notifications)
+      failed_notifications.each do |notification|
+        error_element = REXML::Element.new('error', file_element)
+        # How do I extract the column numbers? Set it to 1 for now.
+        error_element.add_attributes({
+                                       'line' => notification.example.location.split(':').last,
+                                       'column' => 1,
+                                       'severity' => 'error',
+                                       'message' => build_message(notification),
+                                       'source' => notification.description
+                                     })
+      end
+    end
+
+    def build_message(notification)
+      notification.message_lines.map { |s| remove_non_printables(s) }.join("\n") +
+        "\n\n" +
+        notification.formatted_backtrace.map { |s| remove_non_printables(s) }.join("\n")
+    end
+
+    def remove_non_printables(str)
+      # XML is very sensitive.
+      str.gsub(/[^[:print:]]/, '')
+    end
+  end
+end

data/rspec-checkstyle_formatter.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec-checkstyle_formatter'
+  spec.version       = '0.1.0'
+  spec.authors       = ['astronoka']
+  spec.email         = ['skulituniga@gmail.com']
+
+  spec.summary       = 'Outputs the result of rspec as a checkstyle format.'
+  spec.description   = 'Outputs the result of rspec as a checkstyle format.'
+  spec.homepage      = 'https://github.com/astronoka/rspec-checkstyle_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"]   = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(__dir__)) 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_runtime_dependency 'rspec-core', '~> 3.0'
+
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rubocop', '~> 0.93.0'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rspec-checkstyle_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- astronoka
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.0
+description: Outputs the result of rspec as a checkstyle format.
+email:
+- skulituniga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/checkstyle_formatter.rb
+- rspec-checkstyle_formatter.gemspec
+homepage: https://github.com/astronoka/rspec-checkstyle_formatter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/astronoka/rspec-checkstyle_formatter
+  source_code_uri: https://github.com/astronoka/rspec-checkstyle_formatter
+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.4
+signing_key:
+specification_version: 4
+summary: Outputs the result of rspec as a checkstyle format.
+test_files: []