allure-ruby-commons 2.20.0 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45a1f4e2bc042a8f2b67fe58b8284e74cb4d0d168d459afc27bdea01321ae9f6
-  data.tar.gz: 7f30563da1d722fbc6b23336a2b62d013ca60ab90ad1d71acfb7c4bcdc9cea78
+  metadata.gz: 66e09f6d14fc5e93508a0d861d0df40b93b76e86a9b89a1ab8d6a5f72a0e036a
+  data.tar.gz: d81cc78375aac9293ffa6f23a35a9ae3dfb8a4a923b20dfddcbae74ce5f8d0be
 SHA512:
-  metadata.gz: fa6429c14832af4f93443251b2a99d285bfa489ef877e5ea2498365faba17ffb6cfaff094baae188653f42f88a871de9002c27f8c374ebb5f1050d8561f1d5ac
-  data.tar.gz: 14995f7ec541d876461bf89326006bbaf205c64ab55da75acd1bdde263b0e69d955083a544a7dfaf8342ba5133aa54dab81014be6346c0cd588df4c1df29ccaf
+  metadata.gz: c37fb24ee8dde0d460a3bcef86c2e515421d09ca22579f249320662542ceaa6cc506c8db017c5e1808dd1b24f428db0e4a258c7be20132c2044f271208959cb2
+  data.tar.gz: dff9c7508de915a8e834d6715bb25883e5607279e3716d73aa42d502801dde3c1cb274c21d8d7a4081298de5896e74055253c7f6b70460bb36dce992dabc68cf

data/README.md

@@ -104,3 +104,7 @@ class TestHelper
   def standard_method; end
 end
 ```
+
+## JSON parsing
+
+Internally, allure-ruby-common produces JSON files. To improve performance, [oj](https://www.ohler.com/oj/) gem is used for parsing and generating JSON files if it is available. Otherwise default ruby json implementation is used.

data/lib/allure_ruby_commons/_json_helper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Allure
+  # Json helper methods
+  #
+  # @!method dump_json(obj)
+  #   Dump object to json using Oj or JSON
+  #   @param [Hash] obj
+  #   @return [String]
+  # @!method load_json(json)
+  #   Load json from file using Oj or JSON
+  #   @param [String] json
+  #   @return [Hash]
+  # @!method json_parse_error
+  #   Json parse error class
+  #   @return [Class]
+  module JsonHelper
+    # @return [Hash] Oj json options
+    OJ_OPTIONS = { mode: :custom, use_to_hash: true, ascii_only: true }.freeze
+
+    begin
+      require "oj"
+
+      define_method(:dump_json) do |obj|
+        Oj.dump(obj, OJ_OPTIONS)
+      end
+
+      define_method(:load_json) do |json|
+        Oj.load_file(json, symbol_keys: true)
+      rescue Oj::ParseError
+        nil
+      end
+    rescue LoadError
+      define_method(:dump_json) do |obj|
+        JSON.generate(obj)
+      end
+
+      define_method(:load_json) do |json|
+        JSON.parse(File.read(json), symbolize_names: true)
+      rescue JSON::ParserError
+        nil
+      end
+    end
+  end
+end

data/lib/allure_ruby_commons/file_writer.rb

@@ -3,6 +3,8 @@
 module Allure
   # Allure result file writer
   class FileWriter
+    include JsonHelper
+
     # @return [String] test result suffix
     TEST_RESULT_SUFFIX = "-result.json"
     # @return [String] test result container suffix
@@ -13,8 +15,6 @@ module Allure
     ENVIRONMENT_FILE = "environment.properties"
     # @return [String] categories definition json
     CATEGORIES_FILE = "categories.json"
-    # @return [Hash] Oj json options
-    OJ_OPTIONS = { mode: :custom, use_to_hash: true, ascii_only: true }.freeze
 
     # File writer instance
     #
@@ -27,14 +27,14 @@ module Allure
     # @param [Allure::TestResult] test_result
     # @return [void]
     def write_test_result(test_result)
-      write("#{test_result.uuid}#{TEST_RESULT_SUFFIX}", Oj.dump(test_result, OJ_OPTIONS))
+      write("#{test_result.uuid}#{TEST_RESULT_SUFFIX}", dump_json(test_result))
     end
 
     # Write test result container
     # @param [Allure::TestResultContainer] test_container_result
     # @return [void]
     def write_test_result_container(test_container_result)
-      write("#{test_container_result.uuid}#{TEST_RESULT_CONTAINER_SUFFIX}", Oj.dump(test_container_result, OJ_OPTIONS))
+      write("#{test_container_result.uuid}#{TEST_RESULT_CONTAINER_SUFFIX}", dump_json(test_container_result))
     end
 
     # Write allure attachment file
@@ -61,7 +61,7 @@ module Allure
       if categories.is_a?(File)
         copy(categories.path, CATEGORIES_FILE)
       else
-        write(CATEGORIES_FILE, Oj.dump(categories, OJ_OPTIONS))
+        write(CATEGORIES_FILE, dump_json(categories.map(&:to_hash)))
       end
     end
 

data/lib/allure_ruby_commons/model/01_jsonable.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "oj"
-
 module Allure
   # General jsonable object implementation
   class JSONable
@@ -15,6 +13,14 @@ module Allure
       end
     end
 
+    # Return object json string
+    #
+    # @param [Array] *options
+    # @return [String]
+    def to_json(*options)
+      to_hash.to_json(*options)
+    end
+
     # Object comparator
     # @param [JSONable] other
     # @return [Booelan]

data/lib/allure_ruby_commons/testplan.rb

@@ -2,6 +2,8 @@
 
 module Allure
   class TestPlan
+    extend JsonHelper
+
     # @return [String] test plan path env var name
     TESTPLAN_PATH = "ALLURE_TESTPLAN_PATH"
 
@@ -26,9 +28,7 @@ module Allure
       #
       # @return [Array<Hash>]
       def tests
-        @tests ||= Oj.load_file(ENV[TESTPLAN_PATH], symbol_keys: true)&.fetch(:tests) if ENV[TESTPLAN_PATH]
-      rescue Oj::ParseError
-        nil
+        @tests ||= load_json(ENV[TESTPLAN_PATH])&.fetch(:tests) if ENV[TESTPLAN_PATH]
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 version: !ruby/object:Gem::Version
-  version: 2.20.0
+  version: 2.21.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-28 00:00:00.000000000 Z
+date: 2023-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -30,26 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +93,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/allure-ruby-commons.rb
+- lib/allure_ruby_commons/_json_helper.rb
 - lib/allure_ruby_commons/allure_lifecycle.rb
 - lib/allure_ruby_commons/config.rb
 - lib/allure_ruby_commons/file_writer.rb