allure-ruby-commons 2.13.3 → 2.13.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63f3f8681c7437dcc8be0da1a0da44ba238d3103b56f6146746ae910d38ed76d
-  data.tar.gz: e0a6e79db8e67121bfe250c1bc576d18dcbeb1bfa5f3679513dba37759d97d64
+  metadata.gz: 12cb6b2b1132dd43b17becb6b9a32c47cb9aa44a3be793dc09f083d7e5784370
+  data.tar.gz: a34abfd6a9dff13b8b6b1d571b33f348549c59848579220c4a8add6d5317004c
 SHA512:
-  metadata.gz: 3e6d27dc40e461f96695f5c7a93ad9b27bdd12982ea77e669aad7d5dc3fb76bec86149fe267124bcf1711a153bda175f44ae5f80f872723035bc714d7a20e361
-  data.tar.gz: d0905aa7da8b94c983614db9f7693cfa7c37e8fca7655eb4b40084fe650e92f00883c4158d83adbcb5c2c7608bd5e5604c62e7cd0b6733e9d8d7d2aaef2cdf2e
+  metadata.gz: 1d6bf42ce012302f708869666f94ea4a8a408dc2c17f4989e2b469b3a100458a36226d5b9790ba497b4b69c87306ee437f6825187255f1c00dc9d1a579e5d322
+  data.tar.gz: f15cadf664ae40f2152a86f541bd2a3ef68de4bc60bc72908b04ace4a90753088a6342a3eb63846a95a38b5e311c573223fe5d901fc29c78b2f4cd76f5958ddc

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,10 +154,11 @@ 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))
+      lifecycle.stop_test_step
     end
 
     # Run passed block as step with given name

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -11,6 +11,8 @@ module Allure
     def initialize
       @test_context = []
       @step_context = []
+      @logger = Logger.new(STDOUT, level: Config.instance.logging_level)
+      @file_writer = FileWriter.new
     end
 
     def_delegators :file_writer, :write_attachment, :write_environment, :write_categories
@@ -193,7 +195,7 @@ module Allure
     # @param [Boolean] test_case add attachment to current test case
     # @return [void]
     def add_attachment(name:, source:, type:, test_case: false)
-      attachment = prepare_attachment(name, type) || begin
+      attachment = ResultUtils.prepare_attachment(name, type) || begin
         return logger.error("Can't add attachment, unrecognized mime type: #{type}")
       end
       executable_item = (test_case && @current_test_case) || current_executable
@@ -203,16 +205,6 @@ module Allure
       write_attachment(source, attachment)
     end
 
-    # Create attachment object
-    # @param [String] name
-    # @param [String] type
-    # @return [Allure::Attachment]
-    def prepare_attachment(name, type)
-      extension = ContentType.to_extension(type) || return
-      file_name = "#{UUID.generate}-attachment.#{extension}"
-      Attachment.new(name: name, source: file_name, type: type)
-    end
-
     # Add step to current fixture|step|test case
     # @param [Allure::StepResult] step_result
     # @return [Allure::StepResult]
@@ -232,13 +224,7 @@ module Allure
 
     private
 
-    def logger
-      @logger ||= Logger.new(STDOUT, level: Config.logging_level)
-    end
-
-    def file_writer
-      @file_writer ||= FileWriter.new
-    end
+    attr_accessor :logger, :file_writer
 
     def current_executable
       current_test_step || @current_fixture || @current_test_case

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)

data/lib/allure_ruby_commons/model/category.rb

@@ -3,8 +3,8 @@
 require_relative "jsonable"
 
 module Allure
+  # Defects category
   class Category < JSONable
-    # Defects category
     # @param [String] name
     # @param [Array<Allure::Status>] matched_statuses
     # @param [String, Regexp] message_regex

data/lib/allure_ruby_commons/model/jsonable.rb

@@ -5,6 +5,9 @@ require "json"
 module Allure
   # General jsonable object implementation
   class JSONable
+    # Return object has represantation
+    # @param [Hash] _options
+    # @return [Hash]
     def as_json(_options = {})
       instance_variables.each_with_object({}) do |var, map|
         key = camelcase(var.to_s.delete_prefix("@"))
@@ -13,22 +16,33 @@ module Allure
       end
     end
 
+    # Convert object to json string
+    # @param [Array<Object>] options
+    # @return [String]
     def to_json(*options)
       as_json(*options).to_json(*options)
     end
 
+    # Object comparator
+    # @param [JSONable] other
+    # @return [Booelan]
     def ==(other)
       self.class == other.class && state == other.state
     end
 
     protected
 
+    # Object state
+    # @return [Array]
     def state
       instance_variables.map { |var| instance_variable_get(var) }
     end
 
     private
 
+    # Covert string to camelcase
+    # @param [String] str
+    # @return [String]
     def camelcase(str)
       str = str.gsub(/(?:_+)([a-z])/) { Regexp.last_match(1).upcase }
       str.gsub(/(\A|\s)([A-Z])/) { Regexp.last_match(1) + Regexp.last_match(2).downcase }

data/lib/allure_ruby_commons/result_utils.rb

@@ -46,10 +46,15 @@ module Allure
         Label.new(HOST_LABEL_NAME, Socket.gethostname)
       end
 
+      # Language label
+      # @return [Allure::Label]
       def language_label
         Label.new(LANGUAGE_LABEL_NAME, "ruby")
       end
 
+      # Framework label
+      # @param [String] value
+      # @return [Allure::Label]
       def framework_label(value)
         Label.new(FRAMEWORK_LABEL_NAME, value)
       end
@@ -145,6 +150,16 @@ module Allure
         StatusDetails.new(message: exception&.message, trace: exception&.backtrace&.join("\n"))
       end
 
+      # Allure attachment object
+      # @param [String] name
+      # @param [String] type
+      # @return [Allure::Attachment]
+      def prepare_attachment(name, type)
+        extension = ContentType.to_extension(type) || return
+        file_name = "#{UUID.generate}-attachment.#{extension}"
+        Attachment.new(name: name, source: file_name, type: type)
+      end
+
       private
 
       def tms_url(value)

metadata

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