bbk-utils 1.0.1.72694 → 1.0.1.84207

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a86ec4de4754fcf815121f81c291c035a58caf3edec0dc1a1f1ca83d8c6131ef
-  data.tar.gz: 22ec5e9d066b63f606e21de19071670c5d64e5025991f6f35b33d9f6e44da34b
+  metadata.gz: d4c885cb45d09a4268faf157c86945257ffff5e9581a12379c8ef01576df1137
+  data.tar.gz: 139acd30f3c496710ad5d07bf1760833d7069b5dc23ea364c90d739c3eec022b
 SHA512:
-  metadata.gz: 601f36b04bff4192c66a13ce13088bca9caf0c840976e5da6d4de48800df6f8a24de1acad6fe4f1ce778944afe6929559428cbcb7359e88dd1dec7d4c96e6f75
-  data.tar.gz: adbc95627e6ee9d94492bc781017fdbd02905566584b70e2d86db6f65c3448afbac27866effa9220645fa0a2e1405a38277c5a5b75bc6e587b23685df20a4770
+  metadata.gz: 8e6e5899f32ceca3fb0422f568a0696667ed6ee2da0e6ede474fbf9e71fc4a37eadb12b08a8e64524a8ef366e84d351b9ae48f0652f43602a5a76d847e272027
+  data.tar.gz: ec65ba53e4026ee33242883dd2f42058214b3f0bd8d384ba833c952fd0b0391c24e349ad6b3b89b33914d14d9dbed259773c2a5dea24e01a200f956f05365595

data/Gemfile

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bbk-utils.gemspec
 gemspec
+

data/Gemfile.lock

@@ -1,18 +1,19 @@
 PATH
   remote: .
   specs:
-    bbk-utils (1.0.1.72694)
-      activesupport
+    bbk-utils (1.0.1.84207)
+      activesupport (~> 6.0)
       russian
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.1)
+    activesupport (6.1.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
@@ -49,6 +50,7 @@ GEM
     launchy (2.5.0)
       addressable (~> 2.7)
     minitest (5.15.0)
+    parallel (1.21.0)
     parser (3.0.3.1)
       ast (~> 2.4.1)
     path_expander (1.1.0)
@@ -59,6 +61,7 @@ GEM
       kwalify (~> 0.7.0)
       parser (~> 3.0.0)
       rainbow (>= 2.0, < 4.0)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -75,6 +78,20 @@ GEM
     rspec-support (3.10.3)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
     ruby_parser (3.18.1)
       sexp_processor (~> 4.16)
     rubycritic (4.6.1)
@@ -116,6 +133,7 @@ GEM
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
       equalizer (~> 0.0, >= 0.0.9)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -129,6 +147,8 @@ DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
   rspec_junit_formatter
+  rubocop
+  rubocop-rspec
   rubycritic
   simplecov
   simplecov-cobertura

data/README.md

@@ -42,6 +42,11 @@ gem "bbk-utils", "~> 1.0.0"
 * Ruby (MRI) 2.5.x
 * Ruby (MRI) 3.0.x
 
+## Contributing
+
+See the file [CONTRIBUTING.md](./CONTRIBUTING.md)
+
 ## License
 
-The gem is available as open source under the terms of the MIT License.
+See the file [LICENSE](./LICENSE)
+

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'bbk/utils'
@@ -12,3 +13,4 @@ require 'bbk/utils'
 
 require 'irb'
 IRB.start(__FILE__)
+

data/lib/bbk/utils/config.rb

@@ -1,223 +1,240 @@
+# frozen_string_literal: true
+
 module BBK
-  class Config
-    attr_accessor :store, :name
-
-    class BooleanCaster
-    
-      FALSE_VALUES = [
-        false, 0,
-        "0", :"0",
-        "f", :f,
-        "F", :F,
-        "false", :false,
-        "FALSE", :FALSE,
-        "off", :off,
-        "OFF", :OFF,
-      ].to_set.freeze
-
-      def self.cast(value)
-        if value.nil? || value == ''
-          nil
-        else
-          !FALSE_VALUES.include?(value)
+  module Utils
+    class Config
+
+      attr_accessor :store, :name
+
+      class BooleanCaster
+
+        FALSE_VALUES = [
+          false, 0,
+          '0', :"0",
+          'f', :f,
+          'F', :F,
+          'false', false,
+          'FALSE', :FALSE,
+          'off', :off,
+          'OFF', :OFF
+        ].to_set.freeze
+
+        def self.cast(value)
+          if value.nil? || value == ''
+            nil
+          else
+            !FALSE_VALUES.include?(value)
+          end
         end
+
       end
-    end
 
-    def self.instance
-      @instance ||= new
-    end
+      def self.instance
+        @instance ||= new
+      end
 
-    class << self
-      delegate :map, :require, :optional, :run!, :[], :[]=, :content, :to_s, :to_json, :as_json, :to_yaml, :fetch, to: :instance
-    end
+      class << self
 
-    def initialize(name = nil)
-      @name = name
-      @store = {}
-    end
+        delegate :map, :require, :optional, :run!, :[], :[]=, :content, :to_s, :to_json, :as_json, :to_yaml, :fetch,
+                 to: :instance
 
-    def map(env, file, required: true, desc: nil, bool: false, key: nil)
-      @store[env.to_s.upcase] = {
-        env: (key || env).to_s.upcase,
-        file: file,
-        required: required,
-        desc: desc,
-        bool: bool
-      }
-    end
+      end
 
-    def require(env, desc: nil, bool: false, type: nil, key: nil)
-      raise ArgumentError.new('Specified type and bool') if bool && type.present?
-
-      type = BBK::Config::BooleanCaster.singleton_method(:cast) if bool
-      @store[env.to_s.upcase] = {
-        env: (key || env).to_s.upcase,
-        required: true,
-        desc: desc,
-        bool: bool,
-        type: type
-      }
-    end
+      def initialize(name = nil)
+        @name = name
+        @store = {}
+      end
 
-    def optional(env, default: nil, desc: nil, bool: false, type: nil, key: nil)
-      raise ArgumentError.new('Specified type and bool') if bool && type.present?
-
-      type = BBK::Config::BooleanCaster.singleton_method(:cast) if bool
-      @store[env.to_s.upcase] = {
-        env: (key || env).to_s.upcase,
-        required: false,
-        default: default,
-        desc: desc,
-        type: type
-      }
-    end
+      def map(env, file, required: true, desc: nil, bool: false, key: nil)
+        @store[env.to_s.upcase] = {
+          env:      (key || env).to_s.upcase,
+          file:     file,
+          required: required,
+          desc:     desc,
+          bool:     bool,
+          type:     nil
+        }
+      end
 
-    def run!(source = ENV)
-      @store.values.each do |item|
-        process(source, item)
+      def require(env, desc: nil, bool: false, type: nil, key: nil)
+        raise ArgumentError.new('Specified type and bool') if bool && type.present?
+
+        type = BBK::Config::BooleanCaster.singleton_method(:cast) if bool
+        @store[env.to_s.upcase] = {
+          env:      (key || env).to_s.upcase,
+          file:     nil,
+          required: true,
+          desc:     desc,
+          bool:     bool,
+          type:     type
+        }
       end
-    end
 
-    def [](key)
-      @store[normalize_key(key)][:value]
-    end
+      def optional(env, default: nil, desc: nil, bool: false, type: nil, key: nil)
+        raise ArgumentError.new('Specified type and bool') if bool && type.present?
+
+        type = BBK::Utils::Config::BooleanCaster.singleton_method(:cast) if bool
+        @store[env.to_s.upcase] = {
+          env:      (key || env).to_s.upcase,
+          file:     nil,
+          required: false,
+          default:  default,
+          desc:     desc,
+          bool:     true,
+          type:     type
+        }
+      end
 
-    def []=(key, value)
-      @store[normalize_key(key)][:value] = value
-    end
+      def run!(source = ENV)
+        @store.each_value do |item|
+          process(source, item)
+        end
+      end
 
-    def content(key)
-      item = @store[normalize_key(key)]
-      if (file = item[:file])
-        File.read(file)
-      else
-        item[:value]
+      def [](key)
+        @store[normalize_key(key)][:value]
       end
-    end
 
-    def fetch(key, default = nil)
-      # store.fetch(key.to_s.upcase, default)
-      if (field = store[key.to_s.upcase]).present? && field.key?(:value)
-        field[:value]
-      else
-        default
+      def []=(key, value)
+        @store[normalize_key(key)][:value] = value
       end
-    end
 
-    def to_s
-      result = StringIO.new
-      result.puts "Environment variables#{@name ? " for #{@name}" : ''}:"
-      padding = ' ' * 3
-      sorted = @store.values.sort_by { |item| [item[:file].present? ? 0 : 1, item[:required] ? 0 : 1] }
+      def content(key)
+        item = @store[normalize_key(key)]
+        if (file = item[:file])
+          File.read(file)
+        else
+          item[:value]
+        end
+      end
 
-      sorted.each do |item|
-        if item[:file]
-          result.puts print_file_item(item, padding)
+      def fetch(key, default = nil)
+        # store.fetch(key.to_s.upcase, default)
+        if (field = store[key.to_s.upcase]).present? && field.key?(:value)
+          field[:value]
         else
-          result.puts print_item(item, padding)
+          default
         end
       end
-      result.string
-    end
 
-    def as_json(*_args)
-      values = @store.values.sort_by do |item|
-        [item[:file].present? ? 0 : 1, item[:required] ? 0 : 1]
-      end.reduce({}) do |ret, item|
-        ret.merge(item[:env] => item)
+      def to_s
+        result = StringIO.new
+        result.puts "Environment variables#{@name ? " for #{@name}" : ''}:"
+        padding = ' ' * 3
+        sorted = @store.values.sort_by do |item|
+          [item[:file].present? ? 0 : 1, item[:required] ? 0 : 1]
+        end
+
+        sorted.each do |item|
+          if item[:file]
+            result.puts print_file_item(item, padding)
+          else
+            result.puts print_item(item, padding)
+          end
+        end
+        result.string
       end
 
-      @name ? { @name => values } : values
-    end
+      def as_json(*_args)
+        values = @store.values.sort_by do |item|
+          [item[:file].present? ? 0 : 1, item[:required] ? 0 : 1]
+        end.reduce({}) do |ret, item|
+          ret.merge(item[:env] => item)
+        end
 
-    def to_json(*_args)
-      JSON.pretty_generate(as_json)
-    end
+        @name ? { @name => values } : values
+      end
 
-    def to_yaml(*_args)
-      JSON.parse(to_json).to_yaml
-    end
+      def to_json(*_args)
+        JSON.pretty_generate(as_json)
+      end
 
-    private
+      def to_yaml(*_args)
+        JSON.parse(to_json).to_yaml
+      end
 
-    def normalize_key(key)
-      k = key.to_s.upcase
-      raise "There is no such key: #{k} in config!" unless @store.key?(k)
+      private
 
-      k
-    end
+        def normalize_key(key)
+          k = key.to_s.upcase
+          raise "There is no such key: #{k} in config!" unless @store.key?(k)
 
-    def process(source, item)
-      content = source.fetch(item[:env], item[:default])
+          k
+        end
 
-      # Если данные есть, либо указан тип (нужно для того чтобы переменная была нужного типа)
-      if content.present? || item[:type].present?
-        if file = item[:file]
-          dirname = File.dirname(file)
-          FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
-          File.write(file, content)
-          item[:value] = file
-        else
-          item[:value] = if (type = item[:type])
-                           if type.respond_to? :call
-                             type.call(content)
-                           else
-                             type.new(content)
-                           end
-                         else
-                           content
-                         end
+        def process(source, item)
+          content = source.fetch(item[:env], item[:default])
+
+          # Если данные есть, либо указан тип (нужно для того чтобы переменная была нужного типа)
+          if content.present? || item[:type].present?
+            if file = item[:file]
+              dirname = File.dirname(file)
+              FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+              File.write(file, content)
+              item[:value] = file
+            else
+              item[:value] = if (type = item[:type])
+                if type.respond_to? :call
+                  type.call(content)
+                else
+                  type.new(content)
+                end
+              else
+                content
+              end
+            end
+          elsif item[:required]
+            required!(item)
+          else
+            item[:value] = content
+          end
+        rescue StandardError => e
+          msg = "Failed processing #{item[:env]} parameter. #{e.inspect}"
+          if $logger
+            $logger.error msg
+          else
+            puts msg
+          end
+          raise
         end
-      elsif item[:required]
-        required!(item)
-      else
-        item[:value] = content
-      end
-    rescue => e
-      msg = "Failed processing #{item[:env]} parameter. #{e.inspect}"
-      if $logger
-        $logger.error msg
-      else
-        puts msg
-      end
-      raise
-    end
 
-    def required!(item)
-      raise "ENV [#{item[:env]}] is required!"
-    end
+        def required!(item)
+          raise "ENV [#{item[:env]}] is required!"
+        end
 
-    def print_file_item(item, padding)
-      line = padding + 'File ' + wrap_required(item)
-      line = if item[:desc].present?
-               line.ljust(50) + ' ' + item[:desc]
-             else
-               line
-             end
+        def print_file_item(item, padding)
+          line = "#{padding}File #{wrap_required(item)}"
+          line = if item[:desc].present?
+            "#{line.ljust(50)} #{item[:desc]}"
+          else
+            line
+          end
 
-      line + "\n" + (padding * 2) + '-> ' + item[:file].inspect
-    end
+          "#{line}\n#{padding * 2}-> #{item[:file].inspect}"
+        end
 
-    def print_item(item, padding)
-      line = padding + wrap_required(item)
-      line += " (=#{item[:default]})" if item[:default].present?
+        def print_item(item, padding)
+          line = padding + wrap_required(item)
+          line += " (=#{item[:default]})" if item[:default].present?
 
-      line = if item[:desc].present?
-               line.ljust(50) + ' ' + item[:desc]
-             else
-               line
-             end
+          line = if item[:desc].present?
+            "#{line.ljust(50)} #{item[:desc]}"
+          else
+            line
+          end
 
-      line + "\n" + (padding * 2) + '-> ' + item[:value].inspect
-    end
+          "#{line}\n#{padding * 2}-> #{item[:value].inspect}"
+        end
+
+        def wrap_required(item)
+          if item[:required]
+            "<#{item[:env]}>"
+          else
+            "[#{item[:env]}]"
+          end
+        end
 
-    def wrap_required(item)
-      if item[:required]
-        "<#{item[:env]}>"
-      else
-        "[#{item[:env]}]"
-      end
     end
   end
 end
+

data/lib/bbk/utils/crypt.rb

@@ -1,34 +1,42 @@
+# frozen_string_literal: true
+
 require 'openssl'
 
 module BBK
-  class Crypt
-    def self.full_check(key_path, cert_path, *cacert_chain)
-      errors = []
-      errors << 'Invalid key and cert pair' unless valid_key_cert?(key_path, cert_path)
-      errors << 'Invalid cert and cacert pair' unless valid_cert_sign?(cert_path, *cacert_chain.compact)
-      if errors.empty?
-        nil
-      else
-        errors
+  module Utils
+    class Crypt
+
+      def self.full_check(key_path, cert_path, *cacert_chain)
+        errors = []
+        errors << 'Invalid key and cert pair' unless valid_key_cert?(key_path, cert_path)
+        errors << 'Invalid cert and cacert pair' unless valid_cert_sign?(cert_path,
+                                                                         *cacert_chain.compact)
+        if errors.empty?
+          nil
+        else
+          errors
+        end
       end
-    end
 
-    def self.valid_key_cert?(key_path, cert_path)
-      raise "Key file #{key_path} not exists" unless File.exist? key_path
-      raise "Cert file #{cert_path} not exists" unless File.exist? cert_path
+      def self.valid_key_cert?(key_path, cert_path)
+        raise "Key file #{key_path} not exists" unless File.exist? key_path
+        raise "Cert file #{cert_path} not exists" unless File.exist? cert_path
 
-      key = OpenSSL::PKey::RSA.new(File.read(key_path))
-      cert = OpenSSL::X509::Certificate.new(File.read(cert_path))
-      cert.check_private_key(key)
-    end
+        key = OpenSSL::PKey::RSA.new(File.read(key_path))
+        cert = OpenSSL::X509::Certificate.new(File.read(cert_path))
+        cert.check_private_key(key)
+      end
+
+      def self.valid_cert_sign?(cert_path, *ca_certs_paths)
+        raise "Cert file #{cert_path} not exists" unless File.exist? cert_path
+        raise "Not all files in ca chain #{ca_certs_paths} exists" unless ca_certs_paths.all? {|pth| File.exist? pth }
 
-    def self.valid_cert_sign?(cert_path, *ca_certs_paths)
-      raise "Cert file #{cert_path} not exists" unless File.exist? cert_path
-      raise "Not all files in ca chain #{ca_certs_paths} exists" unless ca_certs_paths.all? { |pth| File.exist? pth }
+        store = ca_certs_paths.reduce(OpenSSL::X509::Store.new) {|st, c| st.add_file(c) }
+        cert = OpenSSL::X509::Certificate.new File.read(cert_path)
+        store.verify(cert)
+      end
 
-      store = ca_certs_paths.reduce(OpenSSL::X509::Store.new) { |st, c| st.add_file(c) }
-      cert = OpenSSL::X509::Certificate.new File.read(cert_path)
-      store.verify(cert)
     end
   end
 end
+