umbrellio-utils 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f09a52e459529d80c1d72569930d27d97d470c5e0fe54955e0c877e5144f8ca8
-  data.tar.gz: 9f1bc2c3e3e6508e2f7fcfe5a980fe2a0e38cd889f75ea4e596c2d4b7323f0e5
+  metadata.gz: 85dd7dea4f1dee04c26507a0196e6a0520e99ef08db6b880ff5238c09980472a
+  data.tar.gz: 1377376c2ca11c16c1df7ac09dd64c4c7851d3a0e068b73b69d8701d31362488
 SHA512:
-  metadata.gz: 2d566f694d524defa6e321dd62df3cb762ce1adab4b026397d7592254c1f9b06f7b896e39e5ab4192a2558aee394063bb34f58176666d5f78da9e8291b5cf9de
-  data.tar.gz: 8767c6c8428665f5b4d2c150fabfd9b9a4118fc122a8e3582fc4e923ab92999ad9101e4a75b24a7d7b293327332ef8078a5a4ecad1f5e3984bc9bf679700eda8
+  metadata.gz: 272cc4be8c75bb75a63c0ad649feda6da475aada4ec411a03e74fd404533d68087095781b965e1ac4d1ed2f6f5fa515ec40e9977d3a5da8f094ac05c9d34d259
+  data.tar.gz: 1ac80ccf3221cb5c4a5461fa949b6bc7e858d554e1dafe3781041d6146b6807b00e97b86649973900a14812715bed4ecf6735bd8f5d06e21094b02cf1e707444

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/.gitignore

@@ -6,5 +6,3 @@
 /pkg/
 /spec/reports/
 /tmp/
-
-Gemfile.lock

data/Gemfile.lock

@@ -0,0 +1,149 @@
+PATH
+  remote: .
+  specs:
+    umbrellio-utils (0.4.0)
+      memery (~> 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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)
+    awesome_print (1.9.2)
+    bundler-audit (0.9.0.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    ci-helper (0.4.2)
+      colorize (~> 0.8)
+      dry-inflector (~> 0.2)
+      umbrellio-sequel-plugins (~> 0.4)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    dry-inflector (0.2.1)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    json (2.6.1)
+    memery (1.4.1)
+      ruby2_keywords (~> 0.0.2)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    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.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    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.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.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.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)
+      rubocop-rspec (= 2.2.0)
+      rubocop-sequel (= 0.2.0)
+    rubocop-performance (1.10.0)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    rubocop-sequel (0.2.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.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.3)
+    symbiont-ruby (0.7.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    umbrellio-sequel-plugins (0.5.1.27)
+      sequel
+      symbiont-ruby
+    unicode-display_width (2.1.0)
+    yard (0.9.26)
+    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.29

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

@@ -61,10 +61,20 @@ module UmbrellioUtils
       format("%<part>02d", part: part)
     end
 
-    def expand_hash(hash, delemiter: ".", key_converter: :to_sym)
-      hash.each_with_object(Misc.build_infinite_hash) do |entry, memo|
+    #
+    # Expands a hash whose keys contain the path.
+    #
+    # @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, 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
@@ -73,6 +83,27 @@ 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 **expand_hash_options [Hash] options, that the
+    #  {#expand_hash} method accepts
+    #
+    # @return [Hash] expanded hash
+    #
+    def deeply_expand_hash(hash, **expand_hash_options)
+      transformed_hash = hash.transform_values do |value|
+        next deeply_expand_hash(value, **expand_hash_options) if value.is_a?(Hash)
+
+        value
+      end
+
+      expand_hash(transformed_hash, **expand_hash_options)
     end
   end
 end

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,84 @@
+# 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,
+        app_tags: :app_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] :app_tags custom name for the `app_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.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.2.0"
+  VERSION = "0.4.0"
 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

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/umbrellio/utils"
+  spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/umbrellio-utils"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -26,15 +27,21 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "memery"
+  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"
 end

metadata

@@ -1,23 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: umbrellio-utils
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - JustAnotherDude
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -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
@@ -150,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
 description: UmbrellioUtils is collection of utility classes and helpers
 email:
 - VanyaZ158@gmail.com
@@ -163,6 +247,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -183,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
@@ -193,6 +279,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/umbrellio/utils
   source_code_uri: https://github.com/umbrellio/utils
+  documentation_uri: https://rubydoc.info/gems/umbrellio-utils
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -208,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