allure-ruby-commons 2.13.8 → 2.13.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af257eec6eec65a050aaff6d72cf0876bc522e984d9575d743c150bd51ef0fb6
-  data.tar.gz: 9926ed3f22ce88e3ff6fdf8c2b26029101764a274824eccc5fca1cc2a8f1198e
+  metadata.gz: 0af09f2a82010cd21b1a58513757b558ec1ed18f60149fa98f27582a90f1282d
+  data.tar.gz: c8bfbc4769b01c79b78f44ded358b05ffa9bd53be814c47fa50c7f0e6f4dd9b4
 SHA512:
-  metadata.gz: c616353fd1c76cf64f6ff6969ec35101714626a09f45515a2ef9a785858e876c6cc518f863dd8f97b690357f6f1fff7c95352369c6d446ae0ada67c23bceda65
-  data.tar.gz: 13038ef5c8c8d8dedee56a3b3cbacbaf58056c4621ade1e53eb2ba4e2a821157f9f0dc400d546094e932b65afd4e369c152a4f62174ac28cc050f48d0b3e2f96
+  metadata.gz: 38e8563e40e3dcd96705e3a09cacfc561043e880abfad723ee5a482e133afde13e466d134d455bfd2549dbcb947599a1ab733fefe34d768c0aaa5fb5b8089cf7
+  data.tar.gz: 0ae240dad3392284b54ef54d3f22abed78763c39d71a88c60382af9324c79ea28438af40cb2c08e888e973f0cf22fb3961da4f9cff1eba0018bb510b8c7140e1

data/README.md

@@ -54,6 +54,23 @@ Allure.add_attachment(name: "attachment", source: "/path/to/test.txt", type: All
 Allure.add_link(name: "Custom Url", url: "http://www.github.com")
 ```
 
+## Steps
+
+It is possible to mark method definitions to be automatically added to report as steps. The class just needs to extend `AllureStepAnnotation`
+and `step` method needs to be used before the method definition.
+
+```ruby
+class TestHelper
+  extend AllureStepAnnotation
+
+  step("Singleton step")
+  def self.class_method; end
+
+  step("Standard step")
+  def standard_method; end
+end
+```
+
 ## Testing
 
 Install dependencies:

data/lib/allure-ruby-commons.rb

@@ -64,6 +64,13 @@ module Allure
       label(ResultUtils::SUITE_LABEL_NAME, value)
     end
 
+    # Add tag to current test case
+    # @param [String] value
+    # @return [void]
+    def tag(value)
+      label(ResultUtils::TAG_LABEL_NAME, value)
+    end
+
     # Add label to current test case
     # @param [String] name
     # @param [String] value
@@ -162,14 +169,16 @@ module Allure
       lifecycle.stop_test_step
     end
 
-    # Run passed block as step with given name
+    # Run passed block as step with given name and return result of yield
     # @param [String] name
     # @yield [] step block
-    # @return [void]
+    # @return [Object]
     def run_step(name)
       lifecycle.start_test_step(StepResult.new(name: name, stage: Stage::RUNNING))
-      yield
+      result = yield
       lifecycle.update_test_step { |step| step.status = Status::PASSED }
+
+      result
     rescue StandardError => e
       lifecycle.update_test_step do |step|
         step.status = ResultUtils.status(e)

data/lib/allure_ruby_commons/result_utils.rb

@@ -59,6 +59,13 @@ module Allure
         Label.new(FRAMEWORK_LABEL_NAME, value)
       end
 
+      # Epic label
+      # @param [String] value
+      # @return [Allure::Label]
+      def epic_label(value)
+        Label.new(EPIC_LABEL_NAME, value)
+      end
+
       # Feature label
       # @param [String] value
       # @return [Allure::Label]
@@ -66,6 +73,13 @@ module Allure
         Label.new(FEATURE_LABEL_NAME, value)
       end
 
+      # Story label
+      # @param [String] value
+      # @return [Allure::Label]
+      def story_label(value)
+        Label.new(STORY_LABEL_NAME, value)
+      end
+
       # Package label
       # @param [String] value
       # @return [Allure::Label]
@@ -94,13 +108,6 @@ module Allure
         Label.new(SUB_SUITE_LABEL_NAME, value)
       end
 
-      # Story label
-      # @param [String] value
-      # @return [Allure::Label]
-      def story_label(value)
-        Label.new(STORY_LABEL_NAME, value)
-      end
-
       # Test case label
       # @param [String] value
       # @return [Allure::Label]

data/lib/allure_ruby_commons/step_annotation.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Adds support for annotating methods as allure steps
+#
+module AllureStepAnnotation
+  # Mark method definition as allure step
+  #
+  # @param [String] step_name
+  # @return [void]
+  def step(step_name = "")
+    @allure_step = step_name
+  end
+
+  private
+
+  def singleton_method_added(method_name)
+    return super unless @allure_step
+
+    original_method = singleton_method(method_name)
+    step_name = @allure_step.empty? ? method_name.to_s : @allure_step
+    @allure_step = nil
+
+    define_singleton_method(method_name) do |*args, &block|
+      Allure.run_step(step_name) { original_method.call(*args, &block) }
+    end
+  end
+
+  def method_added(method_name)
+    return super unless @allure_step
+
+    original_method = instance_method(method_name)
+    step_name = @allure_step.empty? ? method_name.to_s : @allure_step
+    @allure_step = nil
+
+    define_method(method_name) do |*args, &block|
+      Allure.run_step(step_name) { original_method.bind(self).call(*args, &block) }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 version: !ruby/object:Gem::Version
-  version: 2.13.8
+  version: 2.13.8.5
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2021-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -118,6 +118,7 @@ files:
 - lib/allure_ruby_commons/model/test_result.rb
 - lib/allure_ruby_commons/model/test_result_container.rb
 - lib/allure_ruby_commons/result_utils.rb
+- lib/allure_ruby_commons/step_annotation.rb
 homepage: https://github.com/allure-framework/allure-ruby
 licenses:
 - Apache-2.0
@@ -142,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Common library for allure results generation