allure-ruby-commons 2.13.8.1 → 2.13.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be70de370f6d6732ca70063312ccb4ffd0cf27ede2c50f53f7427ba718ce11d9
-  data.tar.gz: 67b723e4ef1b8092f279a27a9c250a093124b8f78c93dbc34a8655afc29420bd
+  metadata.gz: e7dae51d906f8c03cbac0b9f14ffabccf8a1ce9fdb0c70b9e27fb3793f34acb7
+  data.tar.gz: 104d5f939e1fdad7417206d2bdb96e7c3b301a74cc7b63073c9d39ddcd7525db
 SHA512:
-  metadata.gz: c10538c94a3334367b08d536db7f2449ef184201d7c5d95e02914c018ad4691b80dac94e898ee03d10e53f98741532afec30192b4e558be1ad19aeaf27324eb2
-  data.tar.gz: dad294ed8428f5e84a514203f8515cbe7241ebab5535ceb5163c2cf83df589ba5874ad5bd8aa3f820e5e18b42e92436567c96b8d5f5f3ab2554447ef1f4915b7
+  metadata.gz: dc66fddcc805f1a645bd46ec35c518bac76bc6bdbc4ce0612f3edd0acea2173b7d58771bd03ba1bc478cd9af7172c33a1ff3c9c6efe9b99a599297b9031d3f72
+  data.tar.gz: '00830082315dd4ed519da75c1fe12ef565ed1d79080b8e21be17fa8945dce733c26982131cac8463e6e34f898a1918dc27abc47d0b0878321c4c4325e4e615b9'

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/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.8.2
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-14 00:00:00.000000000 Z
+date: 2021-02-16 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