allure-ruby-commons 2.13.5.rc.1 → 2.13.5.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5e32590e85ab38aeb176662bbc9347d4db8f403b1a79faff049d54cc42ef148
-  data.tar.gz: a9fac0c1035c7a7e17aa4f08f07f461cf08c6d4dad69f10a935b08d0bb1393c1
+  metadata.gz: 581048b28120c18ec370a5f7ece97995f5f9bd0078cb3f17c00ff739eb9d3b2b
+  data.tar.gz: 03f1f125e6f50bd29a46084da967bde18f77d7e1c00c5ef1617b7a68f393bc07
 SHA512:
-  metadata.gz: 9f101580f643b021d6854a9eb21e5aad0ff0d52a379b6dde1777390a50274bc9a513f51c0546729f3500f0d82759e6704fb25176d980e16db73064da79cb8131
-  data.tar.gz: d7acaf42f7f33cc2b7dd6fd81d99a40055603abe06cd1df1136e1472c0de6e2c18824f0b26e520e1ddf7a76be606940dc7de737dcc14a2131a829eccfd5e8c04
+  metadata.gz: 25a402179621527683817fa38945a83b25300cef9794cc7b04c84b694e85deed38681a131c429cc6f0740291b98726cd70a2f2cabdc25e33eecd3168bcc95c1b
+  data.tar.gz: b40a85e6cf5d0867f39dcad5e94fe60e904a65961dd5e2058103f44b4b0b6f72b7d015088f421edd44ec5bb2ce0773f577cac3adff7439d94f245a10076dbb9e

data/README.md

@@ -11,7 +11,7 @@ you can just create the report of any other kind using the basic Allure terms.
 Add the dependency to your Gemfile
 
 ```ruby
- gem 'allure-ruby-commons'
+ gem "allure-ruby-commons"
 ```
 
 ## Configuration
@@ -19,13 +19,13 @@ Add the dependency to your Gemfile
 Following configuration options are supported:
 
 ```ruby
-    Allure.configure do |c|
-      c.results_directory = "/whatever/you/like"
-      c.clean_results_directory = true
-      c.logging_level = Logger::INFO
+    Allure.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
 ```
 

data/lib/allure-ruby-commons.rb

@@ -9,30 +9,30 @@ require_rel "allure_ruby_commons/**/*rb"
 module Allure
   class << self
     # Get thread specific allure lifecycle object
-    # @return [Allure::AllureLifecycle]
+    # @return [AllureLifecycle]
     def lifecycle
       Thread.current[:lifecycle] ||= AllureLifecycle.new
     end
 
     # Set lifecycle object
-    # @param [Allure::AllureLifecycle] lifecycle
+    # @param [AllureLifecycle] lifecycle
     # @return [void]
     def lifecycle=(lifecycle)
       Thread.current[:lifecycle] = lifecycle
     end
 
     # Get allure configuration
-    # @return [Allure::Config]
+    # @return [Config]
     def configuration
-      Config
+      Config.instance
     end
 
     # Set allure configuration
-    # @yieldparam [Allure::Config]
+    # @yieldparam [Config]
     # @yieldreturn [void]
     # @return [void]
     def configure
-      yield(Config)
+      yield(configuration)
     end
 
     # Add epic to current test case
@@ -131,7 +131,7 @@ module Allure
     # Add attachment to current test case or step
     # @param [String] name Attachment name
     # @param [File, String] source File or string to save as attachment
-    # @param [String] type attachment type defined in {Allure::ContentType} or any other valid mime type
+    # @param [String] type attachment type defined in {ContentType} or any other valid mime type
     # @param [Boolean] test_case add attachment to current test case instead of test step
     # @return [void]
     def add_attachment(name:, source:, type:, test_case: false)
@@ -146,7 +146,7 @@ module Allure
     end
 
     # Add categories info
-    # @param [File, Array<Allure::Category>] categories
+    # @param [File, Array<Category>] categories
     # @return [void]
     def add_categories(categories)
       lifecycle.write_categories(categories)
@@ -154,7 +154,7 @@ module Allure
 
     # Add step with provided name and optional status to current test step, fixture or test case
     # @param [String] name
-    # @param [Symbol] status <Allure::Status>, <Allure::Status::PASSED> by default
+    # @param [Symbol] status {Status}, {Status::PASSED} by default
     # @return [void]
     def step(name:, status: nil)
       lifecycle.add_test_step(StepResult.new(name: name, status: status || Status::PASSED, stage: Stage::FINISHED))

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -11,7 +11,7 @@ module Allure
     def initialize
       @test_context = []
       @step_context = []
-      @logger = Logger.new(STDOUT, level: Config.logging_level)
+      @logger = Logger.new(STDOUT, level: Config.instance.logging_level)
       @file_writer = FileWriter.new
     end
 

data/lib/allure_ruby_commons/config.rb

@@ -1,26 +1,27 @@
 # frozen_string_literal: true
 
 require "logger"
+require "singleton"
 
 module Allure
   # Allure configuration class
   class Config
+    include Singleton
+
     # @return [String] default allure results directory
     DEFAULT_RESULTS_DIRECTORY = "reports/allure-results"
     # @return [String] default loggin level
     DEFAULT_LOGGING_LEVEL = Logger::INFO
 
-    class << self
-      attr_accessor :link_tms_pattern, :link_issue_pattern, :clean_results_directory
-      attr_writer :results_directory, :logging_level
+    attr_accessor :link_tms_pattern, :link_issue_pattern, :clean_results_directory
+    attr_writer :results_directory, :logging_level
 
-      def results_directory
-        @results_directory || DEFAULT_RESULTS_DIRECTORY
-      end
+    def results_directory
+      @results_directory || DEFAULT_RESULTS_DIRECTORY
+    end
 
-      def logging_level
-        @logging_level || DEFAULT_LOGGING_LEVEL
-      end
+    def logging_level
+      @logging_level || DEFAULT_LOGGING_LEVEL
     end
   end
 end

data/lib/allure_ruby_commons/file_writer.rb

@@ -59,7 +59,7 @@ module Allure
     private
 
     def output_dir
-      @output_dir ||= FileUtils.mkpath(Allure::Config.results_directory).first
+      @output_dir ||= FileUtils.mkpath(Config.instance.results_directory).first
     end
 
     def write(name, source)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 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: uuid