eac_ruby_utils 0.49.0 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79201cf9333f8dd3efce24ef1a00fe30c90a8c5c96c549c77db9d6f875009786
-  data.tar.gz: e55dd71229d8047e6be0d1ad8b08b0bc92bb97dff785371a92803ccbe13568ba
+  metadata.gz: d1cd6f8891c93e7a6a866a11fa705c3ce0609b5b0d6b5e5468d73a46ed135121
+  data.tar.gz: 49a544fac4a944b2c58ad8cbd0f06eeec6a3e9e5e1df4a66872bdd34bf79c1ef
 SHA512:
-  metadata.gz: 8e6761d989f6f31c684403237f53066a59d7990b5a6b081084bb7e82740cc94a259e605250b45190759afd1ae9e6963e1b3c200f65439062b678e8249f8e1a21
-  data.tar.gz: 6c70b64908695c5b273c32a2b2413ee5884173b1c81c02aa7e5951951664afe223b8cd09f6e17f335ea284660c4f3800444b9c44914579aea18e7aa9c32e5763
+  metadata.gz: 00e8db1cb8da1ed4b54aee6e704820b8962b22e5f9bdb0321354db5ed044cd1799024775c8704765a25d302d2cce776de2511e511665b5d55d00150c3e897271
+  data.tar.gz: 8da830a3af85dc78d88b919645522cdec79e52c61086517b35bb9a64a14e5f9d4bc2af067f9cef31153268e1b1522b7adbad3e0507d04a62fcd2255e9f090d2f

data/lib/eac_ruby_utils/abstract_methods.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patches/module/common_concern'
+
+module EacRubyUtils
+  # Support to abstract methods.
+  #
+  # Usage:
+  #
+  #   require 'eac_ruby_utils/abstract_methods'
+  #
+  #   class BaseClass
+  #     include EacRubyUtils::AbstractMethods
+  #
+  #     abstract_methods :mymethod
+  #   end
+  #
+  #   BaseClass.new.mymethod # raise "Abstract method: mymethod"
+  #
+  #   class SubClass
+  #     def mymethod
+  #       "Implemented"
+  #     end
+  #   end
+  #
+  #   SubClass.new.mymethod # return "Implemented"
+  module AbstractMethods
+    common_concern
+
+    module ClassMethods
+      def abstract_methods(*methods_names)
+        @abstract_methods ||= Set.new
+        @abstract_methods += methods_names.map(&:to_sym)
+
+        @abstract_methods.to_enum
+      end
+    end
+
+    module InstanceMethods
+      def respond_to_missing?(method_name, include_private = false)
+        super || abstract_method?(method_name)
+      end
+
+      def method_missing(method_name, *arguments, &block)
+        raise_abstract_method(method_name) if abstract_method?(method_name)
+
+        super
+      end
+
+      def abstract_method?(method_name)
+        self.class.abstract_methods.include?(method_name.to_sym)
+      end
+
+      def raise_abstract_method(method_name)
+        raise ::NoMethodError, "Abstract method \"#{method_name}\" hit in \"#{self}\""
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/console/configs.rb

@@ -1,31 +1,20 @@
 # frozen_string_literal: true
 
-require 'eac_ruby_utils/common_constructor'
 require 'eac_ruby_utils/configs'
-require 'eac_ruby_utils/console/speaker'
-require 'eac_ruby_utils/options_consumer'
-require 'eac_ruby_utils/patches/object/asserts'
-require 'eac_ruby_utils/simple_cache'
+require 'eac_ruby_utils/core_ext'
 
 module EacRubyUtils
   module Console
     class Configs
-      include ::EacRubyUtils::Console::Speaker
+      require_sub __FILE__
+      enable_console_speaker
 
       class << self
         def entry_key_to_envvar_name(entry_key)
-          path = if entry_key.is_a?(::Array)
-                   entry_key
-                 else
-                   ::EacRubyUtils::PathsHash.parse_entry_key(entry_key)
-                 end
-          path.join('_').gsub(/[^a-z0-9_]/i, '').gsub(/\A_+/, '').gsub(/_+\z/, '')
-              .gsub(/_{2,}/, '_').upcase
+          ::EacRubyUtils::Console::Configs::EntryReader.entry_key_to_envvar_name(entry_key)
         end
       end
 
-      STORE_PASSWORDS_KEY = 'core.store_passwords'
-
       attr_reader :configs
 
       def initialize(configs_key, options = {})
@@ -34,104 +23,15 @@ module EacRubyUtils
       end
 
       def read_password(entry_key, options = {})
-        options = options.merge(noecho: true)
-        if store_passwords?
-          read_entry(entry_key, options)
-        else
-          looped_entry_value_from_input(entry_key, options)
-        end
+        ::EacRubyUtils::Console::Configs::PasswordEntryReader.new(self, entry_key, options).read
       end
 
       def read_entry(entry_key, options = {})
-        options = ReadEntryOptions.new(options)
-        unless options[:noenv]
-          envvar_value = envvar_read_entry(entry_key)
-          return envvar_value if envvar_value.present?
-        end
-        stored_value = configs.read_entry(entry_key)
-        return stored_value if stored_value
-        return read_entry_from_console(entry_key, options) unless options[:noinput]
-
-        raise "No value found for entry \"#{entry_key}\"" if options[:required]
+        ::EacRubyUtils::Console::Configs::EntryReader.new(self, entry_key, options).read
       end
 
       def store_passwords?
-        read_entry(
-          STORE_PASSWORDS_KEY,
-          before_input: -> { store_password_banner },
-          validator: ->(entry_value) { %w[yes no].include?(entry_value) }
-        ) == 'yes'
-      end
-
-      protected
-
-      def envvar_read_entry(entry_key)
-        env_entry_key = self.class.entry_key_to_envvar_name(entry_key)
-        return nil unless ENV.key?(env_entry_key)
-
-        ENV.fetch(env_entry_key).if_present(::EacRubyUtils::BlankNotBlank.instance)
-      end
-
-      def read_entry_from_console(entry_key, options)
-        options[:before_input].call if options[:before_input].present?
-        entry_value = looped_entry_value_from_input(entry_key, options)
-        configs.write_entry(entry_key, entry_value)
-        entry_value
-      end
-
-      def store_password_banner
-        infom 'Do you wanna to store passwords?'
-        infom "Warning: the passwords will be store in clear text in \"#{configs.storage_path}\""
-        infom 'Enter "yes" or "no"'
-      end
-
-      def looped_entry_value_from_input(entry_key, options)
-        loop do
-          entry_value = entry_value_from_input(entry_key, options)
-          next if entry_value.blank?
-          next if options[:validator] && !options[:validator].call(entry_value)
-
-          return entry_value
-        end
-      end
-
-      def entry_value_from_input(entry_key, options)
-        entry_value = request_input("Value for entry \"#{entry_key}\"",
-                                    options.request_input_options)
-        warn('Entered value is blank') if entry_value.blank?
-        entry_value
-      end
-
-      class ReadEntryOptions
-        include ::EacRubyUtils::SimpleCache
-        ::EacRubyUtils::CommonConstructor.new(:options).setup_class(self)
-
-        DEFAULT_VALUES = {
-          before_input: nil, bool: false, list: false, noecho: false, noenv: false, noinput: false,
-          required: true, validator: nil
-        }.freeze
-
-        def [](key)
-          values.fetch(key.to_sym)
-        end
-
-        def request_input_options
-          values.slice(:bool, :list, :noecho)
-        end
-
-        private
-
-        def values_uncached
-          consumer = ::EacRubyUtils::OptionsConsumer.new(options)
-          r = {}
-          DEFAULT_VALUES.each do |key, default_value|
-            value = consumer.consume(key)
-            value = default_value if value.nil?
-            r[key] = value
-          end
-          consumer.validate
-          r
-        end
+        ::EacRubyUtils::Console::Configs::StorePasswordsEntryReader.new(self) == 'yes'
       end
     end
   end

data/lib/eac_ruby_utils/console/configs/entry_reader.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/console/configs/read_entry_options'
+require 'eac_ruby_utils/core_ext'
+
+module EacRubyUtils
+  module Console
+    class Configs
+      class EntryReader
+        enable_console_speaker
+
+        class << self
+          def entry_key_to_envvar_name(entry_key)
+            path = if entry_key.is_a?(::Array)
+                     entry_key
+                   else
+                     ::EacRubyUtils::PathsHash.parse_entry_key(entry_key)
+                   end
+            path.join('_').gsub(/[^a-z0-9_]/i, '').gsub(/\A_+/, '').gsub(/_+\z/, '')
+                .gsub(/_{2,}/, '_').upcase
+          end
+        end
+
+        common_constructor :console_configs, :entry_key, :options do
+          self.options = ::EacRubyUtils::Console::Configs::ReadEntryOptions.new(options)
+        end
+
+        def read
+          %w[envvars storage console].each do |suffix|
+            value = send("read_from_#{suffix}")
+            return value if value.present?
+          end
+          return nil unless options[:required]
+
+          raise "No value found for entry \"#{entry_key}\""
+        end
+
+        def read_from_storage
+          console_configs.configs.read_entry(entry_key)
+        end
+
+        def read_from_envvars
+          return if options[:noenv]
+
+          env_entry_key = self.class.entry_key_to_envvar_name(entry_key)
+          return unless ENV.key?(env_entry_key)
+
+          ENV.fetch(env_entry_key).if_present(::EacRubyUtils::BlankNotBlank.instance)
+        end
+
+        def read_from_console
+          return if options[:noinput]
+
+          options[:before_input].if_present(&:call)
+          entry_value = looped_entry_value_from_input
+          console_configs.configs.write_entry(entry_key, entry_value) if options[:store]
+          entry_value
+        end
+
+        private
+
+        def looped_entry_value_from_input
+          loop do
+            entry_value = entry_value_from_input(entry_key, options)
+            next if entry_value.blank?
+            next if options[:validator] && !options[:validator].call(entry_value)
+
+            return entry_value
+          end
+        end
+
+        def entry_value_from_input(entry_key, options)
+          entry_value = request_input("Value for entry \"#{entry_key}\"",
+                                      options.request_input_options)
+          warn('Entered value is blank') if entry_value.blank?
+          entry_value
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/console/configs/password_entry_reader.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/console/configs/entry_reader'
+
+module EacRubyUtils
+  module Console
+    class Configs
+      class PasswordEntryReader < ::EacRubyUtils::Console::Configs::EntryReader
+        ENTRY_KEY = 'core.store_passwords'
+
+        def initialize(console_configs, entry_key, options = {})
+          super(console_configs, entry_key, options.merge(noecho: true,
+                                                          store: console_configs.store_passwords?))
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/console/configs/read_entry_options.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacRubyUtils
+  module Console
+    class Configs
+      class ReadEntryOptions
+        enable_simple_cache
+        common_constructor :options do
+          self.options = options.to_h.symbolize_keys
+                                .assert_valid_keys(DEFAULT_VALUES.keys).freeze
+        end
+
+        DEFAULT_VALUES = {
+          before_input: nil, bool: false, list: false, noecho: false, noenv: false, noinput: false,
+          required: true, store: true, validator: nil
+        }.freeze
+
+        delegate :to_h, to: :options
+
+        def [](key)
+          values.fetch(key.to_sym)
+        end
+
+        def request_input_options
+          values.slice(:bool, :list, :noecho)
+        end
+
+        private
+
+        def values_uncached
+          consumer = options.to_options_consumer
+          r = {}
+          DEFAULT_VALUES.each do |key, default_value|
+            value = consumer.consume(key)
+            value = default_value if value.nil?
+            r[key] = value
+          end
+          consumer.validate
+          r
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/console/configs/store_passwords_entry_reader.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/console/configs/entry_reader'
+
+module EacRubyUtils
+  module Console
+    class Configs
+      class StorePasswordsEntryReader < ::EacRubyUtils::Console::Configs::EntryReader
+        ENTRY_KEY = 'core.store_passwords'
+
+        def initialize(console_configs)
+          super(console_configs, ENTRY_KEY,
+            before_input: -> { banner },
+            validator: ->(entry_value) { %w[yes no].include?(entry_value) }
+          )
+        end
+
+        def banner
+          infom 'Do you wanna to store passwords?'
+          infom 'Warning: the passwords will be store in clear text in ' \
+            "\"#{console_configs.configs.storage_path}\""
+          infom 'Enter "yes" or "no"'
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/patches/enumerator.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub __FILE__

data/lib/eac_ruby_utils/patches/enumerator/current.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Enumerator
+  def current(default_value = nil)
+    peek
+  rescue ::StopIteration
+    default_value
+  end
+end

data/lib/eac_ruby_utils/patches/enumerator/stopped.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Enumerator
+  def ongoing?
+    !stopped?
+  end
+
+  def stopped?
+    peek
+    false
+  rescue ::StopIteration
+    true
+  end
+end

data/lib/eac_ruby_utils/patches/object/debug.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Object
+  def print_debug
+    STDERR.write(to_debug + "\n")
+
+    self
+  end
+
+  def to_debug
+    "|#{self.class}|#{self}|"
+  end
+
+  def raise_debug
+    raise to_debug
+  end
+end

data/lib/eac_ruby_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EacRubyUtils
-  VERSION = '0.49.0'
+  VERSION = '0.52.0'
 end

data/lib/eac_ruby_utils/yaml.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
+require 'date'
 require 'yaml'
 
 module EacRubyUtils
   # A safe YAML loader/dumper with common types included.
   class Yaml
     class << self
-      DEFAULT_PERMITTED_CLASSES = [::Array, ::Date, ::FalseClass, ::Hash, ::NilClass, ::Numeric,
-                                   ::String, ::Symbol, ::Time, ::TrueClass].freeze
+      DEFAULT_PERMITTED_CLASSES = [::Array, ::Date, ::DateTime, ::FalseClass, ::Hash, ::NilClass,
+                                   ::Numeric, ::String, ::Symbol, ::Time, ::TrueClass].freeze
 
       def dump(object)
         ::YAML.dump(sanitize(object))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.49.0
+  version: 0.52.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-25 00:00:00.000000000 Z
+date: 2020-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,7 @@ extra_rdoc_files: []
 files:
 - README.rdoc
 - lib/eac_ruby_utils.rb
+- lib/eac_ruby_utils/abstract_methods.rb
 - lib/eac_ruby_utils/arguments_consumer.rb
 - lib/eac_ruby_utils/blank_not_blank.rb
 - lib/eac_ruby_utils/boolean.rb
@@ -119,6 +120,10 @@ files:
 - lib/eac_ruby_utils/configs/file.rb
 - lib/eac_ruby_utils/console.rb
 - lib/eac_ruby_utils/console/configs.rb
+- lib/eac_ruby_utils/console/configs/entry_reader.rb
+- lib/eac_ruby_utils/console/configs/password_entry_reader.rb
+- lib/eac_ruby_utils/console/configs/read_entry_options.rb
+- lib/eac_ruby_utils/console/configs/store_passwords_entry_reader.rb
 - lib/eac_ruby_utils/console/docopt_runner.rb
 - lib/eac_ruby_utils/console/docopt_runner/_class_methods.rb
 - lib/eac_ruby_utils/console/docopt_runner/_doc.rb
@@ -182,6 +187,9 @@ files:
 - lib/eac_ruby_utils/patches/class/common_constructor.rb
 - lib/eac_ruby_utils/patches/enumerable.rb
 - lib/eac_ruby_utils/patches/enumerable/boolean_combinations.rb
+- lib/eac_ruby_utils/patches/enumerator.rb
+- lib/eac_ruby_utils/patches/enumerator/current.rb
+- lib/eac_ruby_utils/patches/enumerator/stopped.rb
 - lib/eac_ruby_utils/patches/hash.rb
 - lib/eac_ruby_utils/patches/hash/options_consumer.rb
 - lib/eac_ruby_utils/patches/hash/sym_keys_hash.rb
@@ -195,6 +203,7 @@ files:
 - lib/eac_ruby_utils/patches/module/simple_cache.rb
 - lib/eac_ruby_utils/patches/object.rb
 - lib/eac_ruby_utils/patches/object/asserts.rb
+- lib/eac_ruby_utils/patches/object/debug.rb
 - lib/eac_ruby_utils/patches/object/if_present.rb
 - lib/eac_ruby_utils/patches/object/if_respond.rb
 - lib/eac_ruby_utils/patches/object/template.rb