allure-ruby-commons 2.10.0.beta3 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cabe6f5bc2c95461cfc64b0e394c73d3f3154dfda6f205fc09b5de9072a99bae
-  data.tar.gz: 82c3515e7571f061029982351f221d14910ba25fd613f380107331bd3f04c2fe
+  metadata.gz: f87a04ab08ca894c406ea456552a64243acc4b91beb359e4c4673efc27c5b2e4
+  data.tar.gz: ce8af253d321e87a8115afb86df0e5d882555469de95969abac529c2b7b4c8c3
 SHA512:
-  metadata.gz: 427009e13aad7950cae2a688a9e6e6fa2f5d0d92d632644b5d2ea984e37748e3e472196371e889d5e2504a68fc541becc0a1c7ff9d4a5b31dc77ebe6bae2889e
-  data.tar.gz: 2b35e2c90e93115bb8e6f235e90e33c5efa5369f3302d63239af7de1fcf878f25684028890bb5a4641a9c04ef63b35595f5ef03958b926d0f37d2da05c7f6822
+  metadata.gz: dd99f1bb1d1d4fd31d0a3bdd91a4752f2105f17149e73a3c2b031a03741eab5483557b50bb45e7af52e016620390fe820866937605724587baa15f0d1a4a61b4
+  data.tar.gz: 063dc9cd0a43cfa264396d7c21b26d2080233fb8d89eba446602c51243af305774c99b9e0553d3f6f51c483d35f8bfb1ad3ae7ff7ad3463f0820e20d11c53150

data/README.md

@@ -19,6 +19,7 @@ Following configuration options are supported:
 ```ruby
     Allure.configure do |c|
       c.results_directory = "/whatever/you/like"
+      c.clean_results_directory = true
       c.logging_level = Logger::INFO
       # these are used for creating links to bugs or test cases where {} is replaced with keys of relevant items
       c.link_tms_pattern = "http://www.jira.com/browse/{}"
@@ -43,6 +44,7 @@ Additional methods in [Allure](lib/allure-ruby-commons.rb) exist to add various
 
 ```ruby
 Allure.add_attachment(name: "attachment", source: "Some string", type: Allure::ContentType::TXT, test_case: false)
+Allure.add_attachment(name: "attachment", source: "/path/to/test.txt", type: Allure::ContentType::TXT, test_case: false)
 Allure.add_link(name: "Custom Url", url: "http://www.github.com")
 ```
 

data/lib/allure-ruby-commons.rb

@@ -131,7 +131,7 @@ module Allure
     # Add attachment to current test case or step
     # @param [String] name Attachment name
     # @param [File, String] source File or string to save as attachment
-    # @param [String] type attachment type defined in {Allure::ContentType}
+    # @param [String] type attachment type defined in {Allure::ContentType} or any other valid mime type
     # @param [Boolean] test_case add attachment to current test case instead of test step
     # @return [void]
     def add_attachment(name:, source:, type:, test_case: false)

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -163,6 +163,8 @@ module Allure
       yield(@current_fixture)
     end
 
+    # Stop current test fixture
+    # @return [void]
     def stop_fixture
       return logger.error("Could not stop fixture, fixture is not started") unless @current_fixture
 
@@ -175,7 +177,7 @@ module Allure
     # Add attachment to current test or step
     # @param [String] name Attachment name
     # @param [File, String] source File or string to save as attachment
-    # @param [String] type attachment type defined in {Allure::ContentType}
+    # @param [String] type attachment type defined in {Allure::ContentType} or any other valid mime type
     # @param [Boolean] test_case add attachment to current test case
     # @return [void]
     def add_attachment(name:, source:, type:, test_case: false)

data/lib/allure_ruby_commons/config.rb

@@ -3,12 +3,15 @@
 require "logger"
 
 module Allure
+  # Allure configuration class
   class Config
+    # @return [String] default allure results directory
     DEFAULT_RESULTS_DIRECTORY = "reports/allure-results"
+    # @return [String] default loggin level
     DEFAULT_LOGGING_LEVEL = Logger::INFO
 
     class << self
-      attr_accessor :link_tms_pattern, :link_issue_pattern
+      attr_accessor :link_tms_pattern, :link_issue_pattern, :clean_results_directory
       attr_writer :results_directory, :logging_level
 
       def results_directory

data/lib/allure_ruby_commons/file_writer.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 module Allure
+  # Allure result file writer
   class FileWriter
+    # @return [String] test result suffix
     TEST_RESULT_SUFFIX = "-result.json"
+    # @return [String] test result container suffix
     TEST_RESULT_CONTAINER_SUFFIX = "-container.json"
+    # @return [String] attachment file suffix
     ATTACHMENT_FILE_SUFFIX = "-attachment"
 
     # Write test result

data/lib/allure_ruby_commons/model/attachment.rb

@@ -3,6 +3,7 @@
 require_relative "jsonable"
 
 module Allure
+  # Allure model attachment object
   class Attachment < JSONable
     # @param [String] name attachment name
     # @param [String] type attachment type, {Allure::ContentType}

data/lib/allure_ruby_commons/model/content_type.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
+require "mime/types"
+
 module Allure
+  # Commonly used mime type definitions
   class ContentType
     TXT = "text/plain"
     XML = "application/xml"
@@ -14,8 +17,11 @@ module Allure
     WEBM = "video/webm"
     JPG = "image/jpeg"
 
+    # Get file extension from mime type
+    # @param [String] content_type mime type
+    # @return [String] file extension
     def self.to_extension(content_type)
-      constants.detect { |const| const_get(const) == content_type }&.to_s&.downcase
+      MIME::Types[content_type]&.first&.preferred_extension
     end
   end
 end

data/lib/allure_ruby_commons/model/executable_item.rb

@@ -3,6 +3,7 @@
 require_relative "jsonable"
 
 module Allure
+  # Allure model executable item
   class ExecutableItem < JSONable
     # @param [Hash] options
     # @option options [String] :name

data/lib/allure_ruby_commons/model/fixture_result.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Allure
+  # Allure model fixture result
   class FixtureResult < ExecutableItem; end
 end

data/lib/allure_ruby_commons/model/jsonable.rb

@@ -3,6 +3,7 @@
 require "json"
 
 module Allure
+  # General jsonable object implementation
   class JSONable
     def as_json(_options = {})
       instance_variables.each_with_object({}) do |var, map|

data/lib/allure_ruby_commons/model/label.rb

@@ -3,6 +3,7 @@
 require_relative "jsonable"
 
 module Allure
+  # Allure model label object
   class Label < JSONable
     def initialize(name, value)
       @name = name

data/lib/allure_ruby_commons/model/link.rb

@@ -3,6 +3,7 @@
 require_relative "jsonable"
 
 module Allure
+  # Allure model link object
   class Link < JSONable
     def initialize(type, name, url)
       @type = type

data/lib/allure_ruby_commons/model/parameter.rb

@@ -3,6 +3,7 @@
 require_relative "jsonable"
 
 module Allure
+  # Allure model parameter object
   class Parameter < JSONable
     def initialize(name, value)
       @name = name

data/lib/allure_ruby_commons/model/stage.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Allure
+  # Allure stages
   class Stage
     SCHEDULED = "scheduled"
     RUNNING = "running"

data/lib/allure_ruby_commons/model/status.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Allure
+  # Allure model statuses
   class Status
     FAILED = :failed
     BROKEN = :broken

data/lib/allure_ruby_commons/model/status_details.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Allure
+  # Allure model status detail object
   class StatusDetails < JSONable
     # @param [Boolean] known
     # @param [Boolean] muted

data/lib/allure_ruby_commons/model/step_result.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Allure
+  # Allure model step result object
   class StepResult < ExecutableItem; end
 end

data/lib/allure_ruby_commons/model/test_result.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Allure
+  # Allure model test result container
   class TestResult < ExecutableItem
     # @param [String] uuid
     # @param [String] history_id

data/lib/allure_ruby_commons/model/test_result_container.rb

@@ -2,6 +2,7 @@
 
 require_relative "jsonable"
 module Allure
+  # Allure model step result container
   class TestResultContainer < JSONable
     def initialize(uuid: UUID.generate, name: "Unnamed")
       @uuid = uuid

data/lib/allure_ruby_commons/result_utils.rb

@@ -3,6 +3,7 @@
 require "socket"
 
 module Allure
+  # Variouse helper methods
   module ResultUtils
     ISSUE_LINK_TYPE = "issue"
     TMS_LINK_TYPE = "tms"

data/lib/allure_ruby_commons/util.rb

@@ -5,8 +5,11 @@ require "zip"
 require "pathname"
 
 module Allure
+  # Utility for downloading allure commandline binary
   class Util
-    ALLURE_CLI_VERSION = "2.10.0"
+    # @return [String] CLI version
+    ALLURE_CLI_VERSION = "2.12.1"
+    # @return [String] CLI bin download url
     ALLURE_BIN_URL = "http://repo.maven.apache.org/maven2/io/qameta/allure/allure-commandline/"\
                       "#{ALLURE_CLI_VERSION}/allure-commandline-#{ALLURE_CLI_VERSION}.zip"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 version: !ruby/object:Gem::Version
-  version: 2.10.0.beta3
+  version: 2.13.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2019-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.9
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.9
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 description: Utilities allowing to implement allure result generation by other test
   frameworks
 email: andrejs.cunskis@gmail.com
@@ -100,7 +114,7 @@ files:
 - lib/allure_ruby_commons/model/test_result_container.rb
 - lib/allure_ruby_commons/result_utils.rb
 - lib/allure_ruby_commons/util.rb
-homepage: http://allure.qatools.ru
+homepage: https://github.com/allure-framework/allure-ruby
 licenses:
 - Apache-2.0
 metadata: {}
@@ -115,9 +129,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: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: