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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d211dfccb64872fd47535b5707249c8d0f1f0833ef92e40bee8056ecec98b2b
-  data.tar.gz: 5c2cfc994e6eb08eb2c854fa4f7b09789e2523f643a391c76aecd81a0e48ffb8
+  metadata.gz: b6f877f7e8b441cb54130d306d3412f312acb8797897183858835c9f022435b8
+  data.tar.gz: 3c2addeb4d4b3e019f33993bd5b323dde85193c703d72f5e9f61c9045f85a7db
 SHA512:
-  metadata.gz: 9d5b65f235bc3d45081422acf20d06de4504e2da1a2f90b81c82411e5f141cf023ad7d4b9541ef9c02ab2679888c21f09a1cd3a46661328d74260da7515a9738
-  data.tar.gz: fe054a2c43246b668f1d2f508e896536bb09425603d2539c619fb54334e38e556a0b3dfe8b06ede0d0554d7848c56c3c2aa7d3e747f5e645d749621784201e17
+  metadata.gz: c115ec1a95e9f14faed2298b54a29b3dbad62562864c14f635bcec78388fab4be67ef09489dcfa1c5b624fd08c00440f3f408dead25ecf387808630f9ea7e40d
+  data.tar.gz: be99a4b2fa09a6cfde214028c1d79bdd7b8877eb7dc4f178b80a4475d56d08a8016d44cf28f4841e0f8fb125e6e0b088e35ddd5a619e71aca4b794572cf9d063

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,8 +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/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.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: 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