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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4e1e312da2184e17972a4064fce982fe5e38c9708990eed6b9a7845f05b15a6
-  data.tar.gz: add1145dc2d915489946708972dd873651faea543778a17689c33351ca912348
+  metadata.gz: b5e32590e85ab38aeb176662bbc9347d4db8f403b1a79faff049d54cc42ef148
+  data.tar.gz: a9fac0c1035c7a7e17aa4f08f07f461cf08c6d4dad69f10a935b08d0bb1393c1
 SHA512:
-  metadata.gz: d3f7eed0cceceadb095fdb7297ae8f10322f9faa02b65f6e7ab0c664a0fab1ea87de633a933fb8fed236d9ceaa95b196cd8be34ba6f217d99742b09954469178
-  data.tar.gz: 97513d224b1630d37260cc86889c42edb655d26b0ca37daf0bd67e9bb6d07ee0d10f06b492984399a72830694dabaffa559467db74e2c1c22f011e506891b358
+  metadata.gz: 9f101580f643b021d6854a9eb21e5aad0ff0d52a379b6dde1777390a50274bc9a513f51c0546729f3500f0d82759e6704fb25176d980e16db73064da79cb8131
+  data.tar.gz: d7acaf42f7f33cc2b7dd6fd81d99a40055603abe06cd1df1136e1472c0de6e2c18824f0b26e520e1ddf7a76be606940dc7de737dcc14a2131a829eccfd5e8c04

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -195,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
@@ -205,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]

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.4
+  version: 2.13.5.rc.1
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-25 00:00:00.000000000 Z
+date: 2020-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -126,9 +126,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: