allure-ruby-commons 2.13.8.1 → 2.13.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be70de370f6d6732ca70063312ccb4ffd0cf27ede2c50f53f7427ba718ce11d9
-  data.tar.gz: 67b723e4ef1b8092f279a27a9c250a093124b8f78c93dbc34a8655afc29420bd
+  metadata.gz: 00eb4480e678a3ec0c1f8d8e0b0885481f5be98bd0c0f4894a3665135769a7e6
+  data.tar.gz: 1763a8e08847c62bf347600cb0d2f77cd8ff324d8a90771e5ba6011b321421ff
 SHA512:
-  metadata.gz: c10538c94a3334367b08d536db7f2449ef184201d7c5d95e02914c018ad4691b80dac94e898ee03d10e53f98741532afec30192b4e558be1ad19aeaf27324eb2
-  data.tar.gz: dad294ed8428f5e84a514203f8515cbe7241ebab5535ceb5163c2cf83df589ba5874ad5bd8aa3f820e5e18b42e92436567c96b8d5f5f3ab2554447ef1f4915b7
+  metadata.gz: fd6b37bea5da7b710428231f83efeff7d9bbaf7f17fbfd2575446f43a4db2237fad3fea012b585b4648007dcfa7120012e09e918b8d1457ad29ca63e2aac0bcb
+  data.tar.gz: a9b335d4a796fcfade19f86272a3e9538fb9e5b0531fc8651a28b316b9e6ff4b2f1d9c535360ff065da2655869343950c5128a141cb69ed047d6413a8f315b11

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

data/lib/allure_ruby_commons/config.rb

@@ -40,9 +40,7 @@ module Allure
     #
     # @return [Array<Hash>]
     def tests
-      @tests ||= begin
-        Oj.load_file(ENV[TESTPLAN_PATH], symbol_keys: true)&.fetch(:tests) if ENV[TESTPLAN_PATH]
-      end
+      @tests ||= Oj.load_file(ENV[TESTPLAN_PATH], symbol_keys: true)&.fetch(:tests) if ENV[TESTPLAN_PATH]
     rescue Oj::ParseError
       nil
     end

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.1
+  version: 2.13.9
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-14 00:00:00.000000000 Z
+date: 2021-04-15 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.2.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Common library for allure results generation