tap_report_parser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 441006e2fd8efd6863b0143c79c98bd6b5bc10c3
+  data.tar.gz: 104dfa944e078867d1075be2537e8e9b5d7de8df
+SHA512:
+  metadata.gz: 4d4ac757cb99a3ffdbdcc07198dab47a9e5b96d3555773feabcde02f72b8d295f3e631f7329f859f5bd8e284f4f0057de5532a0cc192cdff03cabdcab2a1b036
+  data.tar.gz: ea94d39fe4af33674052a47e73e933796a3a857b448fb824bb3e1277cd7111dd6be9e3b8fe4ebf8ac093a546d4794d8c249cc1e689efc44fde362a8ffa2d3e41

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.2

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 abhisinghabhimanyu@gmail.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 [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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tap_report_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Abhimanyu Singh
+
+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,103 @@
+# TapReportParser
+
+This gem parses a TAP report per the specifications listed on https://testanything.org/tap-specification.html. Each of the tests has six attributes: `number`, `description`, `status`, `directive`, `diagnostic` and `passing`.
+
+- The `number` is test number. If the `number` is not present, the parser maintains its own count.
+- The `description` is the text describing the test. If the `description` is not present, then its value is empty string.
+- The `status` is represented by one of the four values: `success` (when test is passing), `failure` (when test is failing), `skipped` (when test is marked as skipped irrespective of success or failure), and `ignore` (when test is marked as todo irrespective of success or failure).
+- The `directive` is either skipped or todo.
+- The `diagnostic` is a YAML block or text. If it is YAML then its value is ruby Hash, otherwise string. If the `diagnostic` is not present, then its value is empty string.
+- The value of the `passing` is `true` if test status is either `passing` or `ignored`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tap_report_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tap_report_parser
+
+## Usage
+
+You can parse report either from file or text, i.e.,
+```ruby
+report = TapReportParser::Report.from_text(text)
+report = TapReportParser::Report.from_file(file)
+```
+
+For example, consider the following TAP report:
+```tap
+TAP version 13
+1..6
+#
+# Create a new Board and Tile, then place
+# the Tile onto the board.
+#
+ok 1 - The object is a Board
+ok 2 - Board size is zero
+ok 3 - The object is a Tile
+ok 4 - Get possible places to put the Tile
+ok 5 - Placing the tile produces no error
+ok 6 - Board size is 1
+```
+
+Parsing the report from text will return the `TapReportParser::Report` object, which has the following three attributes:
+
+- `test_count`: The test count
+- `tests`: Array of `TapReportParser::Test` objects each describing the test. Each of the test object has six attributes: `number`, `description`, `status`, `directive`, `diagnostic` and `passing`.
+- `passing`: A boolean value which is `true` if all the tests are passing, i.e., the status is either `success` or `ignored`, otherwise `false`.
+
+```ruby
+# Tests count
+report.test_count
+ => 6
+# All the tests passing?
+report.passing
+ => true
+# Tests
+ => [#<TapReportParser::Test:0x00007f943a97d968 @status="success", @directive="", @passing=true, @number=1, @description="The object is a Board", @diagnostic="">, #<TapReportParser::Test:0x00007f943a97d580 @status="success", @directive="", @passing=true, @number=2, @description="Board size is zero", @diagnostic="">, #<TapReportParser::Test:0x00007f943a97d198 @status="success", @directive="", @passing=true, @number=3, @description="The object is a Tile", @diagnostic="">, #<TapReportParser::Test:0x00007f943a97cd88 @status="success", @directive="", @passing=true, @number=4, @description="Get possible places to put the Tile", @diagnostic="">, #<TapReportParser::Test:0x00007f943a97c978 @status="success", @directive="", @passing=true, @number=5, @description="Placing the tile produces no error", @diagnostic="">, #<TapReportParser::Test:0x00007f943a97c590 @status="success", @directive="", @passing=true, @number=6, @description="Board size is 1", @diagnostic="">]
+# Test number
+report.tests.first.number
+ => 1
+# Test description
+report.tests.first.description
+ => "The object is a Board"
+# Test status
+report.tests.first.status
+ => "success"
+# Test passing?
+report.tests.first.passing
+ => true
+# Test directive
+report.tests.first.directive
+ => ""
+# Test diagnostic
+report.tests.first.diagnostic
+ => ""
+```
+
+## 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/avmnu-sng/tap_report_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 TapReportParser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/avmnu-sng/tap_report_parser/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 "tap_report_parser"
+
+# 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/tap_report_parser/version.rb

@@ -0,0 +1,3 @@
+module TapReportParser
+  VERSION = "1.0.0"
+end

data/lib/tap_report_parser.rb

@@ -0,0 +1,117 @@
+require "active_support/core_ext/object/blank"
+require "yaml"
+require "tap_report_parser/version"
+
+module TapReportParser
+  class Report
+    attr_reader :test_count, :tests, :passing
+
+    def initialize(report)
+      @report = report
+      @test_count = 0
+      @tests = []
+    end
+
+    def self.from_file(file)
+      parser = Report.new(File.read(file))
+      parser.parse_report
+
+      parser
+    end
+
+    def self.from_text(text)
+      parser = Report.new(text)
+      parser.parse_report
+
+      parser
+    end
+
+    def parse_report
+      test_number = 1
+
+      @report.strip.split("\n").each do |line|
+        test_number = parse_line(line, test_number)
+      end
+
+      if @test_count != 0
+        ((1..@test_count).to_a - @tests.map(&:number)).each do |num|
+          @tests << Test.new("failure", num, "", "")
+        end
+      else
+        @test_count = @tests.count
+      end
+
+      @passing = @test_count != 0 && @tests.map(&:passing).count(true) == @test_count
+      @tests.each { |test| test.convert_diagnostic_yaml_to_hash }
+    end
+
+    def parse_line(line, test_number)
+      test_count = /1\.\.(\d+)(\s*#\s*.*)?/.match(line)&.captures&.first.to_i
+
+      if test_count != 0
+        @test_count = test_count
+
+        return test_number
+      end
+
+      matches = /^(ok|not ok)\s*(\d*)\s*-?\s*([^#]*)\s*(#\s*(.*))?/.match(line)&.captures&.map(&:to_s)
+
+      if matches.present?
+        matches = matches.map(&:strip)
+
+        matches[0] = matches[0] == "ok" ? "success" : "failure"
+        matches[1] = matches[1].present? ? matches[1].to_i : test_number
+
+        @tests << Test.new(matches[0], matches[1], matches[2], matches[4])
+
+        return matches[1] + 1
+      end
+
+      diagnostic = /^(#\s*)?(.*)$/.match(line)&.captures&.last&.rstrip
+
+      @tests.last.add_diagnostic(diagnostic) if @tests.present?
+
+      test_number
+    end
+  end
+
+  class Test
+    attr_reader :status, :passing, :number, :description, :directive, :diagnostic
+
+    def initialize(status, number, description, directive)
+      if (directive =~ /^skip.*/i).present?
+        @status = "skipped"
+        @directive = /(^skip)(.*)/i.match(directive)&.captures&.last&.strip
+      elsif (directive =~ /^todo.*/i).present?
+        @status = "ignored"
+        @directive = /(^todo)(.*)/i.match(directive)&.captures&.last&.strip
+      else
+        @status = status
+        @directive = directive
+      end
+
+      @passing = ["success", "ignored"].include?(@status)
+
+      @number = number
+      @description = description
+
+      @diagnostic = ""
+    end
+
+    def add_diagnostic(diagnostic)
+      return if /\s*?\.\.\./.match?(diagnostic)
+
+      if @diagnostic.empty?
+        @diagnostic = diagnostic
+      else
+        @diagnostic = "#{@diagnostic}\n#{diagnostic}"
+      end
+    end
+
+    def convert_diagnostic_yaml_to_hash
+      leading_spaces = @diagnostic[/\A */].length
+
+      @diagnostic = YAML.safe_load(@diagnostic.split("\n").map { |s| s[leading_spaces..-1] }.join("\n")) || ""
+    end
+  end
+end

data/tap_report_parser.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tap_report_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tap_report_parser"
+  spec.version       = TapReportParser::VERSION
+  spec.authors       = ["Abhimanyu Singh"]
+  spec.email         = ["abhisinghabhimanyu@gmail.com"]
+
+  spec.summary       = %q{Parse a TAP test report.}
+  spec.description   = %q{A TAP test report defines several properties for each tests.
+                         The objective of the gem is to provide all the specified properties
+                         after parsing the report either from the file or text.}
+  spec.homepage      = "https://www.github.com/avmnu-sng/tap_report_parser"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # 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 do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: tap_report_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Abhimanyu Singh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  A TAP test report defines several properties for each tests.
+                           The objective of the gem is to provide all the specified properties
+                           after parsing the report either from the file or text.
+email:
+- abhisinghabhimanyu@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/tap_report_parser.rb
+- lib/tap_report_parser/version.rb
+- tap_report_parser.gemspec
+homepage: https://www.github.com/avmnu-sng/tap_report_parser
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Parse a TAP test report.
+test_files: []