umbrellio-utils 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ad8f07af559cdaaabcb97428722b18a80109a4719922f2e32a3f1ab32b40dba
-  data.tar.gz: 47d944ce423bd48a3e1fb8e56601a97e184830fdd696f2322acc97e4e75058d1
+  metadata.gz: cb8113580849f3996fb8afb0859ef04df431f6e816cf9fcc89df3bab0066e751
+  data.tar.gz: 70e23152849fcb46aa8a012d04444ab6f164a0f0bca16a7aa46cd856987c208b
 SHA512:
-  metadata.gz: 01fb5c648f8789a1feb93cf6aa8f1664798eb416f0a9d37048f90da4dd6d0ce402b9ce87436ff9dee75617ba372ee0b9c1a11db082c8a8763cc4cf0f3d988789
-  data.tar.gz: 5cb141aa1495ba285ffe2afaf0fed3acfb256f520b98ce555e6c882e9ff9ac584e7bfb284b949dd31462b141a13d63c9ee48248a5d7a24c2285ad9b260946792
+  metadata.gz: 475aea0da1551e6b5104eb684f3fd815dee4654529f0cdfbf807bad0a21efdf19df9d37a5caad4a2bb024998dd8dcae1b8458cbe241b26e63ab57d33ff0fb030
+  data.tar.gz: e035b81cebc72254342d4ff40583afc2f26ed37978aea4a9d01953971ff6bce3ee3c8536c5a76760e99de3f6f0ff8c1f59dafebafb15506e55dc2d120513f77d

data/.github/workflows/test.yml

@@ -32,7 +32,6 @@ jobs:
           github-token: ${{ secrets.GITHUB_TOKEN }}
   specs:
     runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.experimental }}
 
     env:
       FULL_TEST_COVERAGE_CHECK: false
@@ -44,10 +43,6 @@ jobs:
       fail-fast: false
       matrix:
         ruby: [2.6, 2.7]
-        experimental: [false]
-        include:
-          - ruby: head
-            experimental: true
 
 
     steps:

data/Gemfile.lock

@@ -1,20 +1,21 @@
 PATH
   remote: .
   specs:
-    umbrellio-utils (0.3.0)
+    umbrellio-utils (0.4.1)
       memery (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.1)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
-    bundler-audit (0.8.0)
+    awesome_print (1.9.2)
+    bundler-audit (0.9.0.1)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
     ci-helper (0.4.2)
@@ -23,25 +24,30 @@ GEM
       umbrellio-sequel-plugins (~> 0.4)
     coderay (1.1.3)
     colorize (0.8.1)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    docile (1.3.5)
-    dry-inflector (0.2.0)
+    docile (1.4.0)
+    dry-inflector (0.2.1)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    memery (1.4.0)
+    json (2.6.1)
+    memery (1.4.1)
       ruby2_keywords (~> 0.0.2)
     method_source (1.0.0)
     minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.1.0)
+    nokogiri (1.12.5-x86_64-linux)
+      racc (~> 1.4)
+    nori (2.6.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    racc (1.6.0)
     rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -53,23 +59,26 @@ GEM
     rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
+    rspec-json_matcher (0.1.6)
+      awesome_print
+      json
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.11.0)
+    rubocop (1.17.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-config-umbrellio (1.11.0.40)
-      rubocop (= 1.11.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-config-umbrellio (1.17.0.53)
+      rubocop (= 1.17.0)
       rubocop-performance (= 1.10.0)
       rubocop-rails (= 2.9.1)
       rubocop-rake (= 0.5.1)
@@ -90,41 +99,49 @@ GEM
     rubocop-sequel (0.2.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
-    sequel (5.43.0)
+    ruby2_keywords (0.0.5)
+    semantic_logger (4.8.2)
+      concurrent-ruby (~> 1.0)
+    sequel (5.49.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov-lcov (0.8.0)
-    simplecov_json_formatter (0.1.2)
-    symbiont-ruby (0.6.0)
+    simplecov_json_formatter (0.1.3)
+    symbiont-ruby (0.7.0)
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    umbrellio-sequel-plugins (0.4.0.164)
+    umbrellio-sequel-plugins (0.5.1.27)
       sequel
-      symbiont-ruby (>= 0.6)
-    unicode-display_width (2.0.0)
+      symbiont-ruby
+    unicode-display_width (2.1.0)
     yard (0.9.26)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
+  x86_64-darwin-20
   x86_64-linux
 
 DEPENDENCIES
+  activesupport
   bundler
   bundler-audit
   ci-helper
+  nokogiri
+  nori
   pry
   rake
   rspec
+  rspec-json_matcher
   rubocop-config-umbrellio
+  semantic_logger
   simplecov
   simplecov-lcov
   umbrellio-utils!
   yard
 
 BUNDLED WITH
-   2.2.15
+   2.2.30

data/README.md

@@ -52,7 +52,7 @@ Some modules and classes are configurable. Here's the full list of settings and
   `UmbrellioUtils::HTTPClient`. Defaults to `:application_httpclient`
 
 You can change config in two ways. Firstly, you can change values by accessing configuration
-directly. Secondly, you can use `UmbrellioUtils::configure` method, which accepts a block.
+directly. Secondly, you can use `UmbrellioUtils::configure` method which accepts a block.
 
 ```ruby
 

data/lib/umbrellio_utils/formatting.rb

@@ -64,17 +64,17 @@ module UmbrellioUtils
     #
     # Expands a hash whose keys contain the path.
     #
-    # @param [Hash] hash hash, which you want to expand
-    # @param [String] delemiter, separator, which is used in the value of the keys
-    # @param [Proc, Lambda, Symbol] key_converter, converter for key's value.
+    # @param hash [Hash] hash which you want to expand
+    # @param delimiter [String] separator which is used in the value of the keys
+    # @param key_converter [Proc, Lambda, Symbol] converter for key's value.
     #  Defaults to :to_sym
     #
     # @return [Hash] expanded hash
     #
-    def expand_hash(hash, delemiter: ".", key_converter: :to_sym)
-      hash.each_with_object(Misc.build_infinite_hash) do |entry, memo|
+    def expand_hash(hash, delimiter: ".", key_converter: :to_sym)
+      result = hash.each_with_object(Misc.build_infinite_hash) do |entry, memo|
         path, value = entry
-        *path_to_key, key = path.to_s.split(delemiter).map(&key_converter)
+        *path_to_key, key = path.to_s.split(delimiter).map(&key_converter)
 
         if path_to_key.empty?
           memo[key] = value
@@ -83,13 +83,15 @@ module UmbrellioUtils
           resolved_hash[key] = value
         end
       end
+
+      Misc.reset_defaults_for_hash(result)
     end
 
     #
     # Expands a nested hash whose keys contain the path.
     #
-    # @param [Hash] hash, hash, which you want to expand
-    # @param [Hash] **expand_hash_options options, that the
+    # @param hash [Hash] hash which you want to expand
+    # @param **expand_hash_options [Hash] options, that the
     #  {#expand_hash} method accepts
     #
     # @return [Hash] expanded hash

data/lib/umbrellio_utils/misc.rb

@@ -19,14 +19,48 @@ module UmbrellioUtils
       end
     end
 
+    #
     # Ranges go from high to low priority
+    #
     def merge_ranges(*ranges)
       ranges = ranges.map { |x| x.present? && x.size == 2 ? x : [nil, nil] }
       ranges.first.zip(*ranges[1..]).map { |x| x.find(&:present?) }
     end
 
+    #
+    # Builds empty hash which recursively returns empty hash, if key is not found.
+    # Also note, that this hash and all subhashes has set #default_proc.
+    # To reset this attribute use {#reset_defaults_for_hash}
+    #
+    # @example Dig to key
+    #  h = UmbrellioUtils::Misc.build_infinite_hash => {}
+    #  h.dig(:kek, :pek) => {}
+    #  h => { kek: { pek: {} } }
+    #
+    # @return [Hash] empty infinite hash.
+    #
     def build_infinite_hash
       Hash.new { |hash, key| hash[key] = Hash.new(&hash.default_proc) }
     end
+
+    #
+    # Deeply sets #default and #default_proc values to nil.
+    #
+    # @param hash [Hash] hash for which you want to reset defaults.
+    #
+    # @return [Hash] reset hash.
+    #
+    def reset_defaults_for_hash(hash)
+      hash.dup.tap do |dup_hash|
+        dup_hash.default = nil
+        dup_hash.default_proc = nil
+
+        dup_hash.transform_values! do |obj|
+          next obj.deep_dup unless obj.is_a?(Hash)
+
+          reset_defaults_for_hash(obj)
+        end
+      end
+    end
   end
 end

data/lib/umbrellio_utils/parsing.rb

@@ -21,7 +21,7 @@ module UmbrellioUtils
       xml.xpath("//@*").remove if remove_attributes
 
       tags_converter = snakecase ? -> (tag) { tag.snakecase.to_sym } : -> (tag) { tag.to_sym }
-      nori = Nori.new(convert_tags_to: tags_converter)
+      nori = Nori.new(convert_tags_to: tags_converter, convert_dashes_to_underscores: false)
       nori.parse(xml.to_xml(save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION))
     end
 

data/lib/umbrellio_utils/semantic_logger/tiny_json_formatter.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module UmbrellioUtils
+  # Namespace for the differrent appenders and formatters for the SemanticLogger library.
+  # @see https://logger.rocketjob.io/ Semantic Logger documentation.
+  module SemanticLogger
+    # Simple JSON formatter, represented as callable object.
+    # @example Using of formatter
+    #   formatter = UmbrellioUtils::SemanticLogger::TinyJsonFormatter.new
+    #   SemanticLogger.add_appender(io: $stdout, formatter: formatter)
+    class TinyJsonFormatter
+      # Hash with default field names in the output JSON.
+      DEFAULT_NAMES_MAPPING = {
+        severity: :severity,
+        name: :name,
+        thread_fingerprint: :thread_fingerprint,
+        message: :message,
+        tags: :tags,
+        named_tags: :named_tags,
+        time: :time,
+      }.freeze
+
+      # Returns a new instance of the {UmbrellioUtils::SemanticLogger::TinyJsonFormatter}.
+      # @param [Hash] custom_names_mapping mapping from default field names to custom ones.
+      # @option custom_names_mapping [Symbol] :severity custom name for the `severity` field.
+      # @option custom_names_mapping [Symbol] :name custom name for the `name` field.
+      # @option custom_names_mapping [Symbol] :thread_fingerprint
+      #   custom name for the thread_fingerprint field.
+      # @option custom_names_mapping [Symbol] :message custom name for the `message` field.
+      # @option custom_names_mapping [Symbol] :tags custom name for the `tags` field.
+      # @option custom_names_mapping [Symbol] :named_tags custom name for the `named_tags` field.
+      # @option custom_names_mapping [Symbol] :time custom name for the `time` field.
+      # @example Use custom name for the `message` and `time` fields
+      #   UmbrellioUtils::SemanticLogger::TinyJsonFormatter.new(
+      #     time: :timestamp, message: :note,
+      #   ) #=> <UmbrellioUtils::SemanticLogger::TinyJsonFormatter:0x000>
+      # @return [UmbrellioUtils::SemanticLogger::TinyJsonFormatter]
+      #   a new instance of the {UmbrellioUtils::SemanticLogger::TinyJsonFormatter}
+      def initialize(**custom_names_mapping)
+        self.field_names = { **DEFAULT_NAMES_MAPPING, **custom_names_mapping }.freeze
+      end
+
+      # Formats log structure into the JSON string.
+      # @param log [SemanticLogger::Log] log's data structure.
+      # @param logger [SemanticLogger::Logger] active logger.
+      # @return [String] data
+      def call(log, _logger)
+        data = build_data_for(log)
+        data.to_json
+      end
+
+      private
+
+      # @!attribute field_names
+      #   @return [Hash<Symbol, Symbol>] the mapping from default field names to the new ones.
+      attr_accessor :field_names
+
+      # Builds hash with data from log.
+      # @return [Hash] the hash, which will be converted to the JSON later.
+      def build_data_for(log)
+        field_names.values_at(*DEFAULT_NAMES_MAPPING.keys).zip(pack_data(log)).to_h
+      end
+
+      # Builds an [Array] with all the required fields, which are arranged
+      # in the order of the declaration of keys
+      # in the {UmbrellioUtils::SemanticLogger::TinyJsonFormatter::DEFAULT_NAMES_MAPPING}.
+      # @return [Array] an array with serialized data.
+      def pack_data(log)
+        [
+          log.level.upcase,
+          log.name,
+          thread_fingerprint_for(log),
+          log.message,
+          log.tags,
+          log.named_tags,
+          log.time.utc.iso8601(3),
+        ]
+      end
+
+      # Calculates MD5 fingerprint for the thread, in which the log was made.
+      # @return [String] truncated `MD5` hash.
+      def thread_fingerprint_for(log)
+        Digest::MD5.hexdigest("#{log.thread_name}#{Process.pid}")[0...8]
+      end
+    end
+  end
+end

data/lib/umbrellio_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UmbrellioUtils
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

data/lib/umbrellio_utils.rb

@@ -5,8 +5,6 @@ require "memery"
 module UmbrellioUtils
   GLOBAL_MUTEX = Mutex.new
 
-  Dir["#{__dir__}/*/*.rb"].each { |file_path| require_relative(file_path) }
-
   extend self
 
   def included(othermod)
@@ -47,3 +45,21 @@ module UmbrellioUtils
     GLOBAL_MUTEX.owned? ? yield : GLOBAL_MUTEX.synchronize(&block)
   end
 end
+
+require_relative "umbrellio_utils/cards"
+require_relative "umbrellio_utils/checks"
+require_relative "umbrellio_utils/constants"
+require_relative "umbrellio_utils/control"
+require_relative "umbrellio_utils/database"
+require_relative "umbrellio_utils/formatting"
+require_relative "umbrellio_utils/http_client"
+require_relative "umbrellio_utils/misc"
+require_relative "umbrellio_utils/parsing"
+require_relative "umbrellio_utils/passwords"
+require_relative "umbrellio_utils/random"
+require_relative "umbrellio_utils/request_wrapper"
+require_relative "umbrellio_utils/rounding"
+require_relative "umbrellio_utils/semantic_logger/tiny_json_formatter"
+require_relative "umbrellio_utils/store"
+require_relative "umbrellio_utils/vault"
+require_relative "umbrellio_utils/version"

data/umbrellio_utils.gemspec

@@ -29,13 +29,18 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "memery", "~> 1"
 
+  spec.add_development_dependency "activesupport"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "bundler-audit"
   spec.add_development_dependency "ci-helper"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency "nori"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-json_matcher"
   spec.add_development_dependency "rubocop-config-umbrellio"
+  spec.add_development_dependency "semantic_logger"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-lcov"
   spec.add_development_dependency "yard"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: umbrellio-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - JustAnotherDude
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memery
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-config-umbrellio
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +268,7 @@ files:
 - lib/umbrellio_utils/random.rb
 - lib/umbrellio_utils/request_wrapper.rb
 - lib/umbrellio_utils/rounding.rb
+- lib/umbrellio_utils/semantic_logger/tiny_json_formatter.rb
 - lib/umbrellio_utils/store.rb
 - lib/umbrellio_utils/vault.rb
 - lib/umbrellio_utils/version.rb
@@ -224,7 +295,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.30
 signing_key:
 specification_version: 4
 summary: A set of utilities that speed up development