allure-rspec 2.13.3 → 2.13.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d0dae51e4db6c27206a0030078093da323272cfe37474a258f9202628bc23dd
-  data.tar.gz: e007ebdab6c1657dfa63bf2c6c47d6bad790f01f245df579dd41d2e3453b1e22
+  metadata.gz: 25e23dd81f6ecb2cd12dab863888d69d2b353003d44cdac2978e1e5ba808c314
+  data.tar.gz: f411339041c10eaaed80e56bdbf9b766de22b3ceed683c94eac41afcaeb24728
 SHA512:
-  metadata.gz: 45c5a098080a3eb4110bf997dd7f927a38447460fd0882b3e4e2e91f7ddaf76337b93af85ec1ac980c88c4730e2cb299f0428c1cc3dd41559491ab3e0e0b2d33
-  data.tar.gz: fbd4ed49c73f18ec326f3775d44b58bfc5ce177b747d01872b9f126f7e211aaec7f2bf81046d85a60e27df25f85b00be30e146c6c25d0e48e75bddf079f7af30
+  metadata.gz: bb49976110e00089942fcb8093af0238e1a07f94b2e586af9d780db94d4af7aa360278007eb2a4befe5fb51377386278fb43e7933a9705a8b352ece971f8cd3c
+  data.tar.gz: 10ab87cf135248292de6678519dc0bce8048c3f3a391e16207ae4b5b30835bc7cc732193e62d27bb064a1c8331a077ab8e82c714efe535187edfc1942946265f

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

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require "ruby2_keywords"
 require "rspec/core"
 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
 
@@ -20,7 +23,7 @@ module AllureRspec
 
     RSpec::Core::Example.class_eval do
       Allure.singleton_methods.each do |method|
-        define_method(method) { |*args, &block| Allure.__send__(method, *args, &block) }
+        ruby2_keywords define_method(method) { |*args, &block| Allure.__send__(method, *args, &block) }
       end
     end
 
@@ -56,7 +59,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
 
@@ -48,6 +49,21 @@ module AllureRspec
 
     private
 
+    # @param [RSpec::Core::Example] example
+    # @return [Array<Allure::Label>]
+    def links(example)
+      tms_links(example.metadata) + issue_links(example.metadata)
+    end
+
+    # Get allure status from result
+    # @param [RSpec::Core::Example::ExecutionResult] result
+    # @return [Symbol]
+    def status(result)
+      return Allure::ResultUtils.status(result.exception) if result.status == :failed
+
+      ALLURE_STATUS[result.status]
+    end
+
     # @param [RSpec::Core::Example] example
     # @return [Array<Allure::Label>]
     def labels(example)
@@ -58,8 +74,8 @@ module AllureRspec
         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(*suite_labels(example.example_group))
         labels.push(*tag_labels(example.metadata))
+        labels.push(*suite_labels(example.example_group))
       end
     end
 
@@ -67,28 +83,30 @@ module AllureRspec
     # @param [RSpec::Core::ExampleGroup] example_group
     # @return [Array<Allure::Label>]
     def suite_labels(example_group)
-      example_group.parent_groups.map(&:description).yield_self do |parents|
-        [].tap do |labels|
-          labels << Allure::ResultUtils.suite_label((parents.length == 1) ? parents.last : parents[-2])
-          labels << Allure::ResultUtils.parent_suite_label(parents.last) if parents.length > 1
-          labels << Allure::ResultUtils.sub_suite_label(parents[0..-3].join(" > ")) if parents.length > 2
-        end
+      [].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
     end
 
-    # @param [RSpec::Core::Example] example
-    # @return [Array<Allure::Label>]
-    def links(example)
-      tms_links(example.metadata) + issue_links(example.metadata)
+    # @param [Array<String>] parents
+    # @return [String]
+    def suite(parents)
+      parents.length == 1 ? parents.last : parents[-2]
     end
 
-    # Get allure status from result
-    # @param [RSpec::Core::Example::ExecutionResult] result
-    # @return [Symbol]
-    def status(result)
-      return Allure::ResultUtils.status(result.exception) if result.status == :failed
+    # @param [Array<String>] parents
+    # @return [String]
+    def parent_suite(parents)
+      parents.length > 1 ? parents.last : nil
+    end
 
-      ALLURE_STATUS[result.status]
+    # @param [Array<String>] parents
+    # @return [String]
+    def sub_suites(parents)
+      parents.length > 2 ? parents[0..-3].join(" > ") : nil
     end
 
     # Strip relative ./ form path

data/lib/allure_rspec/tag_parser.rb

@@ -7,27 +7,23 @@ module AllureRspec
     # @param [Hash] metadata
     # @return [Array<Allure::Label>]
     def tag_labels(metadata)
-      return [] unless Allure::Config.link_tms_pattern && metadata.keys.any? { |k| allure?(k) }
+      return [] unless metadata.keys.any? { |k| allure?(k) }
 
-      metadata.select { |k, _v| allure?(k) }.values.map { |v| Allure::ResultUtils.tag_label(v) }
+      metadata.select { |k| allure?(k) }.values.map { |v| Allure::ResultUtils.tag_label(v) }
     end
 
     # Get tms links
     # @param [Hash] metadata
     # @return [Array<Allure::Link>]
     def tms_links(metadata)
-      return [] unless Allure::Config.link_tms_pattern && metadata.keys.any? { |k| tms?(k) }
-
-      metadata.select { |k, _v| tms?(k) }.values.map { |v| Allure::ResultUtils.tms_link(v) }
+      matching_links(metadata, :tms)
     end
 
     # Get issue links
     # @param [Hash] metadata
     # @return [Array<Allure::Link>]
     def issue_links(metadata)
-      return [] unless Allure::Config.link_issue_pattern && metadata.keys.any? { |k| issue?(k) }
-
-      metadata.select { |k, _v| issue?(k) }.values.map { |v| Allure::ResultUtils.issue_link(v) }
+      matching_links(metadata, :issue)
     end
 
     # Get severity
@@ -50,6 +46,20 @@ module AllureRspec
 
     private
 
+    # @param [Hash] metadata
+    # @param [Symbol] type
+    # @return [Array<Allure::Link>]
+    def matching_links(metadata, type)
+      unless AllureRspec.configuration.public_send("link_#{type}_pattern") &&
+             metadata.keys.any? { |k| __send__("#{type}?", k) }
+        return []
+      end
+
+      metadata
+        .select { |k| __send__("#{type}?", k) }.values
+        .map { |v| Allure::ResultUtils.public_send("#{type}_link", v) }
+    end
+
     # Does key match custom allure label
     # @param [Symbol] key
     # @return [boolean]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-rspec
 version: !ruby/object:Gem::Version
-  version: 2.13.3
+  version: 2.13.6
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-07 00:00:00.000000000 Z
+date: 2020-06-03 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.3
+        version: 2.13.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.3
+        version: 2.13.6
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 description: Cucumber adaptor to generate rich allure test reports
 email: andrejs.cunskis@gmail.com
 executables: []
@@ -46,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
@@ -73,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Allure rspec ruby adaptor