allure-ruby-commons 2.14.2 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 167b883e345ddf9b55cf96986f203371ea865bc470212f578e906989d10d3ea0
-  data.tar.gz: a7568ffb62caa98ac0e74c836630493b5ae228d2e4ff7ed7707be0862b4b012b
+  metadata.gz: 284b37ad75460156a0b06aa8725ae5687b69a6ee7aa9a59691cf5148e51b1db0
+  data.tar.gz: e635323b10208124ee787334132bde0c714fb70e42b1b969595e6c35e0eb989e
 SHA512:
-  metadata.gz: 974f8f097b193e9abfa0f17c1dadbcf4592f87734512a579540389982e5c05d3ef9bc68b22f5971c479a3279044195b46cce3b20ad010275b900d5a5c7919ae9
-  data.tar.gz: 36ffc3d9a9c9dfdc4ba4f03699fdb49d74e2db4f076404c698170dd0d95384876930c3150a39fe5381b7ea6d82dc692d9d451199194d4d808ef6084a97d76f55
+  metadata.gz: 2c90af87fa423669ec1bf027bbd32f316a567df317f9d07ea03a9dab86107f2753609f00208510bb1ca9b4f5c4f71a20cfda08f4332ad2f667bfb8053be4fb08
+  data.tar.gz: 56bf9f7d9ea0ae31d8b35749d999a9b2a98d3dca0de6ee27124a428402a2d152a2c6b7874faa2f3b97e363155debfcea9b7ad2d76b40199eed7e6f663f322059

data/README.md

@@ -53,6 +53,22 @@ It is possible to set up custom allure environment which will be used as custom
 * via `ALLURE_ENVIRONMENT` environment variable
 * via `configure` method
 
+### Environment properties
+
+To add additional environment information to the report it is possible to set configuration property `environment_properties`.
+
+Option can be set to hash or block returning a hash:
+
+```ruby
+# hash
+config.environment_properties = {
+        custom_attribute: "foo"
+      }
+
+# lambda
+config.environment_properties = -> { { custom_attributes: "foo"} }
+```
+
 ### Log level
 
 Log level can be also configured via environment variable `ALLURE_LOG_LEVEL` which accepts one of the following values: `DEBUG INFO WARN ERROR FATAL UNKNOWN`.

data/lib/allure-ruby-commons.rb

@@ -164,7 +164,7 @@ module Allure
   # Manually create environment.properties file
   #   if this method is called before test run started and
   #   option clean_results_directory is enabled, the file will be deleted
-  # @param [Hash<Symbol, String>] environment
+  # @param [Hash<Symbol, String>, Proc] environment
   # @return [void]
   def add_environment(environment)
     lifecycle.write_environment(environment)

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -223,12 +223,13 @@ module Allure
 
     # Add environment.properties file
     #
-    # @param [Hash] env
+    # @param [Hash, Proc] env
     # @return [void]
     def write_environment(env = config.environment_properties)
       return unless env
 
-      file_writer.write_environment(env)
+      env_properties = env.respond_to?(:call) ? env.call : env
+      file_writer.write_environment(env_properties)
     end
 
     # Add categories.json

data/lib/allure_ruby_commons/result_utils.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "socket"
+require "uri"
 
 module Allure
   # Variouse helper methods
@@ -133,16 +134,18 @@ module Allure
       # @param [String] value
       # @param [String] link_pattern
       # @return [Allure::Link]
-      def tms_link(value, link_pattern)
-        Link.new(TMS_LINK_TYPE, value, url(value, link_pattern))
+      def tms_link(name, value, link_pattern)
+        link_name = url?(value) ? name : value
+        Link.new(TMS_LINK_TYPE, link_name, url(value, link_pattern))
       end
 
       # Issue link
       # @param [String] value
       # @param [String] link_pattern
       # @return [Allure::Link]
-      def issue_link(value, link_pattern)
-        Link.new(ISSUE_LINK_TYPE, value, url(value, link_pattern))
+      def issue_link(name, value, link_pattern)
+        link_name = url?(value) ? name : value
+        Link.new(ISSUE_LINK_TYPE, link_name, url(value, link_pattern))
       end
 
       # Get status based on exception type
@@ -171,6 +174,19 @@ module Allure
 
       private
 
+      # Check if value is full url
+      #
+      # @param [String] value
+      # @return [Boolean]
+      def url?(value)
+        URI.parse(value.to_s).scheme
+      end
+
+      # Construct url from pattern
+      #
+      # @param [String] value
+      # @param [String] link_pattern
+      # @return [String]
       def url(value, link_pattern)
         link_pattern.sub("{}", value)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 version: !ruby/object:Gem::Version
-  version: 2.14.2
+  version: 2.15.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types