allure-rspec 2.13.4 → 2.13.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afcc5a2dfc396dc25bdf88815e525a64150e6929b6888b7d416ecbcb458abf8e
-  data.tar.gz: 4566d418f42a82c7cbdb03f08f9812afc468ff2cf9866dafeb42e37e8e0031a3
+  metadata.gz: 0f26f885d375599cb9e3903ca34bf49e6339a5ec1554d804796706679178b62d
+  data.tar.gz: aa23237291bd90b696d814797d353d8bf61e7b16769a61235d020b6ffa278317
 SHA512:
-  metadata.gz: 21da1ae0df8fc7c5b1baa1c7fa561366f24cb77f0de0a79fe31389ce79d263b9de6ba23ec864fe66f6f32383a0d5080890794085d2f3c95632be37fce615b8ee
-  data.tar.gz: c46c715f9a11543e910cea93a8bc087aa02daab854ca8baa2e8d993496ce5bed06690957e43cb5e9c50a317b6db0dacd6f453c69d9ff17d6aa0ba756df11e654
+  metadata.gz: 9009680c99face3c98206ecb186e97f17f3ff1b90f2e2acda6010e8d982783981b147235babe4dc3f9cba3bd7185ab1380f0c6fd66b96c36951fe2b6b5b99791
+  data.tar.gz: 78373bf141e0ff17ab36f78d82438180b486d067775606e511e798c11aac5897dca94f935dacb97a4f8fe3bf66d108eb98c305a82e917eaf24a8fd2b9a9ab2b6

data/README.md

@@ -1,4 +1,5 @@
 # allure-rspec
+
 [![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/allure-rspec)
 
 Allure adapter for [rspec](https://rspec.info/) testing framework
@@ -8,32 +9,45 @@ Allure adapter for [rspec](https://rspec.info/) testing framework
 Add it to gemfile:
 
 ```ruby
-gem 'allure-rspec'
+gem "allure-rspec"
 ```
 
 Require in `spec_helper` or any other setup file:
 
 ```ruby
-require `allure-rspec`
+require "allure-rspec"
 ```
 
 ## Configuration
 
-There are no rspec adapter specific configuration options. Main allure configuration is described [here](https://github.com/allure-framework/allure-ruby/blob/master/allure-ruby-commons/README.md#configuration)
+Following configuration options are supported:
+
+```ruby
+    AllureRspec.configure do |config|
+      config.results_directory = "/whatever/you/like"
+      config.clean_results_directory = true
+      config.logging_level = Logger::INFO
+      # these are used for creating links to bugs or test cases where {} is replaced with keys of relevant items
+      config.link_tms_pattern = "http://www.jira.com/browse/{}"
+      config.link_issue_pattern = "http://www.jira.com/browse/{}"
+    end
+```
 
 ## Usage
 
-Via commandline, simply add:
+Via commandline arguments, simply add:
 
 ```bash
 --format AllureRspecFormatter
 ```
 
-RSpec configuration:
+or
+
+Via RSpec configuration:
 
 ```ruby
-RSpec.configure do |c|
-  c.formatter = AllureRspecFormatter
+RSpec.configure do |config|
+  config.formatter = AllureRspecFormatter
 end
 ```
 
@@ -42,8 +56,8 @@ end
 Configure tms link pattern:
 
 ```ruby
-Allure.configure do |c|
-  c.link_tms_pattern = "http://www.jira.com/browse/{}"
+AllureRspec.configure do |config|
+  config.link_tms_pattern = "http://www.jira.com/browse/{}"
 end
 ```
 
@@ -68,8 +82,8 @@ end
 Configure issue link pattern:
 
 ```ruby
-Allure.configure do |c|
-  c.link_issue_pattern = "http://www.jira.com/browse/{}"
+AllureRspec.configure do |config|
+  config.link_issue_pattern = "http://www.jira.com/browse/{}"
 end
 ```
 

data/lib/allure-rspec.rb

@@ -2,7 +2,27 @@
 # frozen_string_literal: true
 
 require "allure-ruby-commons"
+require "allure_rspec/config"
 require "allure_rspec/formatter"
 
+module AllureRspec
+  class << self
+    # Get allure cucumber configuration
+    # @return [RspecConfig]
+    def configuration
+      RspecConfig.instance
+    end
+
+    # Set allure configuration
+    # @yieldparam [RspecConfig]
+    # @yieldreturn [void]
+    # @return [void]
+    def configure
+      yield(configuration)
+    end
+  end
+end
+
+# Rspec formatter class shorthand
 AllureRspecFormatter = AllureRspec::RSpecFormatter
 # rubocop:enable Naming/FileName

data/lib/allure_rspec/config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "singleton"
+
+module AllureRspec
+  # Shorthand configuration class
+  class RspecConfig < Allure::Config
+    include Singleton
+    extend Forwardable
+
+    def_delegators :@allure_config,
+      :clean_results_directory,
+      :clean_results_directory=,
+      :link_issue_pattern,
+      :link_issue_pattern=,
+      :link_tms_pattern,
+      :link_tms_pattern=,
+      :logging_level,
+      :logging_level=,
+      :results_directory,
+      :results_directory=
+
+    def initialize
+      @allure_config = Allure.configuration
+    end
+  end
+end

data/lib/allure_rspec/formatter.rb

@@ -6,7 +6,9 @@ require "rspec/core/formatters/base_formatter"
 
 require_relative "rspec_model"
 
+# Main allure-rspec module
 module AllureRspec
+  # Main rspec formatter class translating rspec events to allure lifecycle
   class RSpecFormatter < RSpec::Core::Formatters::BaseFormatter
     include AllureRspecModel
 
@@ -36,9 +38,10 @@ module AllureRspec
     # @param [RSpec::Core::Notifications::GroupNotification] example_group_notification
     # @return [void]
     def example_group_started(example_group_notification)
-      lifecycle.start_test_container(
-        Allure::TestResultContainer.new(name: example_group_notification.group.description),
-      )
+      description = example_group_notification.group.description.yield_self do |desc|
+        desc.empty? ? "Anonymous" : desc
+      end
+      lifecycle.start_test_container(Allure::TestResultContainer.new(name: description))
     end
 
     # Starts example
@@ -57,7 +60,7 @@ module AllureRspec
     end
 
     # Starts example group
-    # @param [RSpec::Core::Notifications::GroupNotification] example_group_notification
+    # @param [RSpec::Core::Notifications::GroupNotification] _example_group_notification
     # @return [void]
     def example_group_finished(_example_group_notification)
       lifecycle.stop_test_container

data/lib/allure_rspec/rspec_model.rb

@@ -6,6 +6,7 @@ require "pathname"
 require_relative "tag_parser"
 
 module AllureRspec
+  # Support class for transforming rspec test entities in to allure model entities
   module AllureRspecModel
     include TagParser
 
@@ -66,28 +67,30 @@ module AllureRspec
     # @param [RSpec::Core::Example] example
     # @return [Array<Allure::Label>]
     def labels(example)
-      [].tap do |labels|
-        labels << Allure::ResultUtils.framework_label("rspec")
-        labels << Allure::ResultUtils.feature_label(example.example_group.description)
-        labels << Allure::ResultUtils.package_label(Pathname.new(strip_relative(example.file_path)).parent.to_s)
-        labels << Allure::ResultUtils.story_label(example.description)
-        labels << Allure::ResultUtils.test_class_label(File.basename(example.file_path, ".rb"))
-        labels << severity(example.metadata)
-        labels.push(*tag_labels(example.metadata))
-        labels.push(*suite_labels(example.example_group))
-      end
+      labels = []
+      labels << Allure::ResultUtils.framework_label("rspec")
+      labels << Allure::ResultUtils.feature_label(example.example_group.description)
+      labels << Allure::ResultUtils.package_label(Pathname.new(strip_relative(example.file_path)).parent.to_s)
+      labels << Allure::ResultUtils.story_label(example.description)
+      labels << Allure::ResultUtils.test_class_label(File.basename(example.file_path, ".rb"))
+      labels << severity(example.metadata)
+      labels.push(*tag_labels(example.metadata))
+      labels.push(*suite_labels(example.example_group))
+
+      labels
     end
 
     # Add suite labels
     # @param [RSpec::Core::ExampleGroup] example_group
     # @return [Array<Allure::Label>]
     def suite_labels(example_group)
-      [].tap do |labels|
-        parents = example_group.parent_groups.map(&:description)
-        labels << Allure::ResultUtils.suite_label(suite(parents))
-        labels << Allure::ResultUtils.parent_suite_label(parent_suite(parents))
-        labels << Allure::ResultUtils.sub_suite_label(sub_suites(parents))
-      end
+      parents = example_group.parent_groups.map { |group| group.description.empty? ? "Anonymous" : group.description }
+      labels = []
+      labels << Allure::ResultUtils.suite_label(suite(parents))
+      labels << Allure::ResultUtils.parent_suite_label(parent_suite(parents)) if parent_suite(parents)
+      labels << Allure::ResultUtils.sub_suite_label(sub_suites(parents)) if sub_suites(parents)
+
+      labels
     end
 
     # @param [Array<String>] parents

data/lib/allure_rspec/tag_parser.rb

@@ -50,7 +50,8 @@ module AllureRspec
     # @param [Symbol] type
     # @return [Array<Allure::Link>]
     def matching_links(metadata, type)
-      unless Allure::Config.public_send("link_#{type}_pattern") && metadata.keys.any? { |k| __send__("#{type}?", k) }
+      unless AllureRspec.configuration.public_send("link_#{type}_pattern") &&
+             metadata.keys.any? { |k| __send__("#{type}?", k) }
         return []
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-rspec
 version: !ruby/object:Gem::Version
-  version: 2.13.4
+  version: 2.13.6.1
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-25 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allure-ruby-commons
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.4
+        version: 2.13.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.4
+        version: 2.13.6.1
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +60,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/allure-rspec.rb
+- lib/allure_rspec/config.rb
 - lib/allure_rspec/formatter.rb
 - lib/allure_rspec/rspec_model.rb
 - lib/allure_rspec/tag_parser.rb