allure-cucumber 2.13.5.rc.1 → 2.13.5.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 660dd75c5884bb993804ca888ccb2babc2e997bf38a3c4c12105dfffe9948394
-  data.tar.gz: 06fd91978393b639e8d92b6b87b7ce752778d254a5a50caf19565d34fefd9f31
+  metadata.gz: fdf3884804a541bfabeb89cd582eab7cba97549b5a63ba62270ed6b4bd7017b5
+  data.tar.gz: 6f8d77e4269b5bdfbe3232471e6db4f92e3cf59059903a3f23283e19da4f0249
 SHA512:
-  metadata.gz: dec76bf5806c56bfaa484797b2e27e794dae083ab48cbd741e654cd72adf9e19e280723be0d96c3a6b218c826dc4caa757883e22427eb81273ea39f1bca561b6
-  data.tar.gz: 2fdc18e522ead6101e5fab6d73e973861bc576167a778b268cc3eaf32e0e45a9866df8f93860705c09c33cd2dfbe04694bb6258508414578f32fa193e40badd0
+  metadata.gz: 727c03e2dde205128fba827ec975f7962077a2a3e5467a8b2bb6f5f61a4e72ebea8c75a03b7741847a25e30e8fa09cf25e63d2f513df89cfc56c010a35390dca
+  data.tar.gz: 8498977b32174a251db8b13fcb08698fc526a84f9abc3a8aa66a94b90f70f712857b3137f75c15af66374285dae11c2db2e655703e670ba931b518670bab3cea

data/README.md

@@ -4,12 +4,17 @@
 
 This repository contains Allure adaptor for [Cucumber](http://cukes.info/) framework.
 
+## Cucumber versions
+
+allure-cucumber versions <= 2.13.4 support only cucumber 3 and lower\
+allure-cucumber versions >= 2.13.5 only support cucumber 4 and are not backwards compatible with cucumber 3 and lower
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'allure-cucumber'
+gem "allure-cucumber"
 ```
 
 And then execute:
@@ -24,27 +29,30 @@ Or install it yourself as:
   gem install allure-cucumber
 ```
 
-## Cucumber versions
+Require in "support/env.rb":
 
-allure-cucumber versions <= 2.13.4 support only cucumber 3 and lower\
-allure-cucumber versions >= 2.13.5 only support cucumber 4 and are not backwards compatible with cucumber 3 and lower
+```ruby
+require "allure-cucumber"
+```
 
 ## Configuration
 
-Common allure configuration is set via `Allure.configure` method. To change id, add the following in `features/support/env.rb` file:
+Common allure configuration is set via `AllureCucumber.configure` method. To change it, add the following in `features/support/env.rb` file:
 
 ```ruby
-Allure.configure do |c|
-  c.results_directory = "/whatever/you/like"
-  c.clean_results_directory = true
-  c.logging_level = Logger::INFO
+require "allure-cucumber"
+
+AllureCucumber.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
-  c.link_tms_pattern = "http://www.jira.com/browse/{}"
-  c.link_issue_pattern = "http://www.jira.com/browse/{}"
+  config.link_tms_pattern = "http://www.jira.com/browse/{}"
+  config.link_issue_pattern = "http://www.jira.com/browse/{}"
 end
 ```
 
-By default, allure-cucumber will analyze your cucumber tags looking for Test Management, Issue Management, and Severity hooks. Links to TMS and ISSUE and test severity will be displayed in the report. By default these prefixes are used:
+By default, allure-cucumber will analyze your cucumber tags looking for Test Management, Issue Management, and Severity tag. Links to TMS and ISSUE and test severity will be displayed in the report. By default these prefixes are used:
 
 ```ruby
     DEFAULT_TMS_PREFIX      = 'TMS:'
@@ -64,10 +72,10 @@ Example:
 You can configure these prefixes as well as tms and issue tracker urls like this:
 
 ```ruby
-AllureCucumber.configure do |c|
-  c.tms_prefix      = 'HIPTEST--'
-  c.issue_prefix    = 'JIRA++'
-  c.severity_prefix = 'URGENCY:'
+AllureCucumber.configure do |config|
+  config.tms_prefix      = 'HIPTEST--'
+  config.issue_prefix    = 'JIRA++'
+  config.severity_prefix = 'URGENCY:'
 end
 ```
 
@@ -84,12 +92,6 @@ Additional special tags exists for setting status detail of test scenarios, allu
 
 ## Usage
 
-Put the following in your `features/support/env.rb` file:
-
-```ruby
-require 'allure-cucumber'
-```
-
 Use `--format AllureCucumber::CucumberFormatter --out where/you-want-results` while running cucumber or add it to `cucumber.yml`. Note that cucumber `--out` option overrides `results_directory` set via `Allure.configure` method.
 
 You can also manually attach screenshots and links to test steps and test cases by interacting with allure lifecycle directly. For more info check out `allure-ruby-commons`

data/lib/allure-cucumber.rb

@@ -12,7 +12,7 @@ module AllureCucumber
     # Get allure cucumber configuration
     # @return [Allure::CucumberConfig]
     def configuration
-      CucumberConfig
+      CucumberConfig.instance
     end
 
     # Set allure configuration
@@ -20,7 +20,7 @@ module AllureCucumber
     # @yieldreturn [void]
     # @return [void]
     def configure
-      yield(CucumberConfig)
+      yield(configuration)
     end
   end
 end

data/lib/allure_cucumber/config.rb

@@ -1,32 +1,52 @@
 # frozen_string_literal: true
 
+require "singleton"
+require "forwardable"
+
 module AllureCucumber
   # Allure cucumber configuration
-  class CucumberConfig
-    class << self
-      # @return [String] default tms tag prefix
-      DEFAULT_TMS_PREFIX = "TMS:"
-      # @return [String] default issue tag prefix
-      DEFAULT_ISSUE_PREFIX = "ISSUE:"
-      # @return [String] default severity tag prefix
-      DEFAULT_SEVERITY_PREFIX = "SEVERITY:"
-
-      attr_writer :tms_prefix, :issue_prefix, :severity_prefix
-
-      # @return [String]
-      def tms_prefix
-        @tms_prefix || DEFAULT_TMS_PREFIX
-      end
-
-      # @return [String]
-      def issue_prefix
-        @issue_prefix || DEFAULT_ISSUE_PREFIX
-      end
-
-      # @return [String]
-      def severity_prefix
-        @severity_prefix || DEFAULT_SEVERITY_PREFIX
-      end
+  class CucumberConfig < Allure::Config
+    include Singleton
+    extend Forwardable
+
+    # @return [String] default tms tag prefix
+    DEFAULT_TMS_PREFIX = "TMS:"
+    # @return [String] default issue tag prefix
+    DEFAULT_ISSUE_PREFIX = "ISSUE:"
+    # @return [String] default severity tag prefix
+    DEFAULT_SEVERITY_PREFIX = "SEVERITY:"
+
+    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=
+
+    attr_writer :tms_prefix, :issue_prefix, :severity_prefix
+
+    def initialize
+      @allure_config = Allure.configuration
+    end
+
+    # @return [String]
+    def tms_prefix
+      @tms_prefix || DEFAULT_TMS_PREFIX
+    end
+
+    # @return [String]
+    def issue_prefix
+      @issue_prefix || DEFAULT_ISSUE_PREFIX
+    end
+
+    # @return [String]
+    def severity_prefix
+      @severity_prefix || DEFAULT_SEVERITY_PREFIX
     end
   end
 end

data/lib/allure_cucumber/models/tag_parser.rb

@@ -14,7 +14,7 @@ module AllureCucumber
     # @param [Array<String>] tags
     # @return [Array<Allure::Link>]
     def tms_links(tags)
-      return [] unless Allure::Config.link_tms_pattern
+      return [] unless AllureCucumber.configuration.link_tms_pattern
 
       matching_links(tags, :tms)
     end
@@ -22,7 +22,7 @@ module AllureCucumber
     # @param [Array<String>] tags
     # @return [Array<Allure::Link>]
     def issue_links(tags)
-      return [] unless Allure::Config.link_issue_pattern
+      return [] unless AllureCucumber.configuration.link_issue_pattern
 
       matching_links(tags, :issue)
     end
@@ -63,9 +63,9 @@ module AllureCucumber
     # @return [Hash<Symbol, Regexp>]
     def reserved_patterns
       @reserved_patterns ||= {
-        tms: /@#{CucumberConfig.tms_prefix}(?<tms>\S+)/,
-        issue: /@#{CucumberConfig.issue_prefix}(?<issue>\S+)/,
-        severity: /@#{CucumberConfig.severity_prefix}(?<severity>\S+)/,
+        tms: /@#{AllureCucumber.configuration.tms_prefix}(?<tms>\S+)/,
+        issue: /@#{AllureCucumber.configuration.issue_prefix}(?<issue>\S+)/,
+        severity: /@#{AllureCucumber.configuration.severity_prefix}(?<severity>\S+)/,
         flaky: /@flaky/,
         muted: /@muted/,
         known: /@known/,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-cucumber
 version: !ruby/object:Gem::Version
-  version: 2.13.5.rc.1
+  version: 2.13.5.rc.2
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-28 00:00:00.000000000 Z
+date: 2020-03-29 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.5.rc.1
+        version: 2.13.5.rc.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.5.rc.1
+        version: 2.13.5.rc.2
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement