eac_ruby_utils 0.34.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a1ec180f3a7aef3fae244443ddd7d9650402e4a7f26757068ee318dce2e9cc9
-  data.tar.gz: bf7cb26680fb44edcf31b169dd8014dc0bb7f2e7ccbfee664a480751a11fc967
+  metadata.gz: 5fc852bc0ba01d1706a2f6c6dc7a0a09b1725b3dc3e54741abbf4c1d2022cac0
+  data.tar.gz: 288360947e10bbef4f1b4cf100306e8bfcb7b5e146adead41184c96e4c66c2d3
 SHA512:
-  metadata.gz: 8c97935d7790e791ffa864420a353abe203751af236dd494a91729a27f7caaaf796430025a3a11e3e32023e8330570cd2bb1c328be2702caaaa7110a62b9a8cf
-  data.tar.gz: acbb32cb1398e8fb4b36eaf367cf222a7de7d92f2afbca5dd3de3747d77a2e2c9b7ea4ad72e4852e6e79bd69dd336e6a46cd32a67717cf0be00ef60c6fc45866
+  metadata.gz: 579594be75a7160855c0b530cd4b5d9bf8f918f065b5e2d4938274d2395dd47f14ee7b827c8461fa6775a7962936ae729d90320124398d3f8220eb0c914243eb
+  data.tar.gz: d287cd78c95da6e3d28c628c6059af23b3710d70f150672cbe13c47e80caa2989b3c93b084292e253380ef342128f780cc9b302cc09dfd36d9a0142ebf9a564b

data/lib/eac_ruby_utils/configs.rb

@@ -20,17 +20,11 @@ module EacRubyUtils
       load
     end
 
-    def clear
-      file.clear
-    end
+    delegate :clear, to: :file
 
-    def save
-      file.save
-    end
+    delegate :save, to: :file
 
-    def load
-      file.load
-    end
+    delegate :load, to: :file
 
     def []=(entry_key, entry_value)
       write_entry(entry_key, entry_value)
@@ -48,9 +42,7 @@ module EacRubyUtils
       file.read(entry_key)
     end
 
-    def autosave?
-      file.autosave?
-    end
+    delegate :autosave?, to: :file
 
     private
 

data/lib/eac_ruby_utils/console/configs.rb

@@ -85,7 +85,7 @@ module EacRubyUtils
       def looped_entry_value_from_input(entry_key, options)
         loop do
           entry_value = entry_value_from_input(entry_key, options)
-          next unless entry_value.present?
+          next if entry_value.blank?
           next if options[:validator] && !options[:validator].call(entry_value)
 
           return entry_value

data/lib/eac_ruby_utils/console/docopt_runner/_class_methods.rb

@@ -10,7 +10,7 @@ module EacRubyUtils
           new(options).send(:run)
         rescue Docopt::Exit => e
           STDERR.write(e.message + "\n")
-          ::Kernel.exit(DOCOPT_ERROR_EXIT_CODE)
+          ::Kernel.exit(DOCOPT_ERROR_EXIT_CODE) # rubocop:disable Rails/Exit
         end
       end
     end

data/lib/eac_ruby_utils/console/speaker.rb

@@ -26,7 +26,7 @@ module EacRubyUtils
 
       def fatal_error(string)
         puts "ERROR: #{string}".white.on_red
-        Kernel.exit 1
+        Kernel.exit 1 # rubocop:disable Rails/Exit
       end
 
       def title(string)

data/lib/eac_ruby_utils/envs/command.rb

@@ -54,6 +54,7 @@ module EacRubyUtils
       end
 
       def execute!(options = {})
+        options[:exit_outputs] = status_results.merge(options[:exit_outputs].presence || {})
         er = ExecuteResult.new(execute(options), options)
         return er.result if er.success?
 

data/lib/eac_ruby_utils/envs/command/extra_options.rb

@@ -16,6 +16,10 @@ module EacRubyUtils
           duplicate_by_extra_options(envvars: envvars.merge(name => value))
         end
 
+        def status_result(status_code, result)
+          duplicate_by_extra_options(status_results: status_results.merge(status_code => result))
+        end
+
         def pipe(other_command)
           duplicate_by_extra_options(pipe: other_command)
         end
@@ -28,6 +32,10 @@ module EacRubyUtils
           extra_options[:envvars] ||= {}.with_indifferent_access
         end
 
+        def status_results
+          extra_options[:status_results] ||= {}.with_indifferent_access
+        end
+
         def append_envvars(command)
           e = envvars.map { |k, v| "#{Shellwords.escape(k)}=#{Shellwords.escape(v)}" }.join(' ')
           e.present? ? "#{e} #{command}" : command

data/lib/eac_ruby_utils/listable/list.rb

@@ -12,6 +12,10 @@ module EacRubyUtils
         apply_constants
       end
 
+      def each_value(&block)
+        values.each(&block)
+      end
+
       def values
         @values.values.map(&:value)
       end

data/lib/eac_ruby_utils/listable/lists.rb

@@ -4,6 +4,7 @@ require 'active_support/hash_with_indifferent_access'
 require 'active_support/core_ext/string/inflections'
 require_relative 'integer_list'
 require_relative 'string_list'
+require_relative 'symbol_list'
 
 module EacRubyUtils
   module Listable
@@ -14,18 +15,10 @@ module EacRubyUtils
         @source = source
       end
 
-      def add_integer(item, *labels)
-        check_acts_as_listable_new_item(item)
-        acts_as_listable_items[item] = ::EacRubyUtils::Listable::IntegerList.new(
-          self, item, labels
-        )
-      end
-
-      def add_string(item, *labels)
-        check_acts_as_listable_new_item(item)
-        acts_as_listable_items[item] = ::EacRubyUtils::Listable::StringList.new(
-          self, item, labels
-        )
+      %w[integer string symbol].each do |list_type|
+        define_method "add_#{list_type}" do |item, *labels|
+          add(::EacRubyUtils::Listable.const_get("#{list_type}_list".camelize), item, labels)
+        end
       end
 
       def method_missing(name, *args, &block)
@@ -43,6 +36,11 @@ module EacRubyUtils
 
       private
 
+      def add(list_class, item, labels)
+        check_acts_as_listable_new_item(item)
+        acts_as_listable_items[item] = list_class.new(self, item, labels)
+      end
+
       def check_acts_as_listable_new_item(item)
         return unless acts_as_listable_items.key?(item)
 

data/lib/eac_ruby_utils/listable/symbol_list.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'list'
+
+module EacRubyUtils
+  module Listable
+    class SymbolList < ::EacRubyUtils::Listable::List
+      protected
+
+      def parse_labels(labels)
+        if labels.first.is_a?(Hash)
+          Hash[labels.first.map { |k, v| [k.to_sym, v.to_sym] }]
+        else
+          Hash[labels.map { |v| [v.to_sym, v.to_sym] }]
+        end
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ require 'active_support/core_ext/object/blank'
 class Object
   # @return +block.call(self)+ if +self+ is present, +default_value+ otherwise.
   def if_present(default_value = nil)
-    return default_value unless present?
+    return default_value if blank?
 
     block_given? ? yield(self) : self
   end

data/lib/eac_ruby_utils/paths_hash.rb

@@ -33,9 +33,7 @@ module EacRubyUtils
       root.write_entry(self.class.parse_entry_key(entry_key), entry_value, [])
     end
 
-    def to_h
-      root.to_h
-    end
+    delegate :to_h, to: :root
 
     private
 

data/lib/eac_ruby_utils/require_sub.rb

@@ -10,6 +10,7 @@ module EacRubyUtils
   class RequireSub
     BASE_OPTION_KEY = :base
     INCLUDE_MODULES_OPTION_KEY = :include_modules
+    REQUIRE_DEPENDENCY_OPTION_KEY = :require_dependency
 
     attr_reader :file, :options
 
@@ -42,7 +43,11 @@ module EacRubyUtils
 
     def require_sub_files
       Dir["#{File.dirname(file)}/#{::File.basename(file, '.*')}/*.rb"].sort.each do |path|
-        require path
+        if options[REQUIRE_DEPENDENCY_OPTION_KEY]
+          require_dependency path
+        else
+          require path
+        end
       end
     end
   end

data/lib/eac_ruby_utils/templates/directory.rb

@@ -10,7 +10,7 @@ module EacRubyUtils
       attr_reader :path
 
       def initialize(path)
-        @path = path
+        @path = path.is_a?(::Pathname) ? path : ::Pathname.new(path.to_s)
       end
 
       def apply(variables_source, directory)
@@ -25,6 +25,12 @@ module EacRubyUtils
         raise "Child \"#{subpath}\" from \"#{path}\" not found"
       end
 
+      def children
+        path.children.map do |path_child|
+          child(path_child.basename.to_path)
+        end
+      end
+
       private
 
       def apply_fs_object(source_relative, target)

data/lib/eac_ruby_utils/templates/file.rb

@@ -1,32 +1,29 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/hash/indifferent_access'
-require 'eac_ruby_utils/simple_cache'
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/templates/variable_providers'
 
 module EacRubyUtils
   module Templates
     class File
-      include ::EacRubyUtils::SimpleCache
-
       VARIABLE_DELIMITER = ::Regexp.quote('%%')
       VARIABLE_PATTERN = /#{VARIABLE_DELIMITER}([a-z0-9\._]*)#{VARIABLE_DELIMITER}/i.freeze
 
-      attr_reader :path
-
-      def initialize(path)
-        @path = path
+      enable_simple_cache
+      common_constructor :path do
+        self.path = path.to_pathname
       end
 
       # +variables_provider+ A [Hash] or object which responds to +read_entry(entry_name)+.
       def apply(variables_source)
-        variables_provider = build_variables_provider(variables_source)
+        variables_provider = ::EacRubyUtils::Templates::VariableProviders.build(variables_source)
         variables.inject(content) do |a, e|
           a.gsub(variable_pattern(e), variables_provider.variable_value(e).to_s)
         end
       end
 
       def apply_to_file(variables_source, output_file_path)
-        ::File.write(output_file_path, apply(variables_source))
+        output_file_path.to_pathname.write(apply(variables_source))
       end
 
       private
@@ -38,64 +35,16 @@ module EacRubyUtils
       end
 
       def content_uncached
-        ::File.read(path)
+        path.read
       end
 
       def sanitize_variable_name(variable_name)
         variable_name.to_s.downcase
       end
 
-      def build_variables_provider(variables_source)
-        return HashVariablesProvider.new(variables_source) if variables_source.is_a?(::Hash)
-        return EntriesReaderVariablesProvider.new(variables_source) if
-        variables_source.respond_to?(:read_entry)
-
-        raise "Variables provider not found for #{variables_source}"
-      end
-
       def variable_pattern(name)
         /#{VARIABLE_DELIMITER}#{::Regexp.quote(name)}#{VARIABLE_DELIMITER}/i
       end
-
-      class BaseVariablesProvider
-        attr_reader :source
-
-        def initialize(source)
-          @source = source
-        end
-
-        def variable_value(name)
-          return variable_fetch(name) if variable_exist?(name)
-
-          raise VariableNotFoundError, "Variable \"#{name}\" not found in #{source}"
-        end
-      end
-
-      class HashVariablesProvider < BaseVariablesProvider
-        def initialize(source)
-          super(source.with_indifferent_access)
-        end
-
-        def variable_exist?(name)
-          source.key?(name)
-        end
-
-        def variable_fetch(name)
-          source.fetch(name)
-        end
-      end
-
-      class EntriesReaderVariablesProvider < BaseVariablesProvider
-        def variable_exist?(_name)
-          true
-        end
-
-        def variable_fetch(name)
-          source.read_entry(name)
-        end
-      end
-
-      class VariableNotFoundError < StandardError; end
     end
   end
 end

data/lib/eac_ruby_utils/templates/variable_not_found_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Templates
+    class VariableNotFoundError < StandardError; end
+  end
+end

data/lib/eac_ruby_utils/templates/variable_providers.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacRubyUtils
+  module Templates
+    module VariableProviders
+      require_sub __FILE__
+
+      PROVIDERS = %w[entries_reader hash generic].map do |name|
+        "eac_ruby_utils/templates/variable_providers/#{name}".camelize.constantize
+      end
+
+      class << self
+        def build(variables_source)
+          PROVIDERS.each do |provider|
+            return provider.new(variables_source) if provider.accept?(variables_source)
+          end
+
+          raise "Variables provider not found for #{variables_source}"
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/templates/variable_providers/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/templates/variable_not_found_error'
+
+module EacRubyUtils
+  module Templates
+    module VariableProviders
+      class Base
+        attr_reader :source
+
+        def initialize(source)
+          @source = source
+        end
+
+        def variable_value(name)
+          return variable_fetch(name) if variable_exist?(name)
+
+          raise VariableNotFoundError, "Variable \"#{name}\" not found in #{source}"
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/templates/variable_providers/entries_reader.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/templates/variable_providers/base'
+
+module EacRubyUtils
+  module Templates
+    module VariableProviders
+      class EntriesReader < ::EacRubyUtils::Templates::VariableProviders::Base
+        class << self
+          def accept?(variables_source)
+            variables_source.respond_to?(:read_entry)
+          end
+        end
+
+        def variable_exist?(_name)
+          true
+        end
+
+        def variable_fetch(name)
+          source.read_entry(name)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/templates/variable_providers/generic.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/templates/variable_providers/base'
+
+module EacRubyUtils
+  module Templates
+    module VariableProviders
+      class Generic < ::EacRubyUtils::Templates::VariableProviders::Base
+        class << self
+          def accept?(variables_source)
+            variables_source.is_a?(::Object)
+          end
+        end
+
+        def variable_exist?(name)
+          source.respond_to?(name)
+        end
+
+        def variable_fetch(name)
+          source.send(name)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/templates/variable_providers/hash.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/templates/variable_providers/base'
+
+module EacRubyUtils
+  module Templates
+    module VariableProviders
+      class Hash < ::EacRubyUtils::Templates::VariableProviders::Base
+        class << self
+          def accept?(variables_source)
+            variables_source.is_a?(::Hash)
+          end
+        end
+
+        def initialize(source)
+          super(source.with_indifferent_access)
+        end
+
+        def variable_exist?(name)
+          source.key?(name)
+        end
+
+        def variable_fetch(name)
+          source.fetch(name)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/version.rb

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

data/lib/eac_ruby_utils/yaml.rb

@@ -3,10 +3,93 @@
 require 'yaml'
 
 module EacRubyUtils
+  # A safe YAML loader/dumper with common types included.
   class Yaml
     class << self
-      def load_common(string)
-        ::YAML.safe_load(string, [::Symbol, ::Date])
+      DEFAULT_PERMITTED_CLASSES = [::Array, ::Date, ::FalseClass, ::Hash, ::NilClass, ::Numeric,
+                                   ::String, ::Symbol, ::Time, ::TrueClass].freeze
+
+      def dump(object)
+        ::YAML.dump(sanitize(object))
+      end
+
+      def load(string)
+        ::YAML.safe_load(string, permitted_classes)
+      end
+
+      def permitted_classes
+        DEFAULT_PERMITTED_CLASSES
+      end
+
+      def sanitize(object)
+        Sanitizer.new(object).result
+      end
+
+      def yaml?(object)
+        return false unless object.is_a?(::String)
+        return false unless object.start_with?('---')
+
+        load(object)
+        true
+      rescue ::Psych::SyntaxError
+        false
+      end
+
+      class Sanitizer
+        attr_reader :source
+
+        RESULT_TYPES = %w[permitted enumerableable hashable].freeze
+
+        def initialize(source)
+          @source = source
+        end
+
+        def result
+          RESULT_TYPES.each do |type|
+            return send("result_#{type}") if send("result_#{type}?")
+          end
+
+          source.to_s
+        end
+
+        private
+
+        def result_enumerableable?
+          source.respond_to?(:to_a) && !source.is_a?(::Hash)
+        end
+
+        def result_enumerableable
+          source.to_a.map { |child| sanitize_value(child) }
+        end
+
+        def result_hashable?
+          source.respond_to?(:to_h)
+        end
+
+        def result_hashable
+          source.to_h.map { |k, v| [k.to_sym, sanitize_value(v)] }.to_h
+        end
+
+        def result_nil?
+          source.nil?
+        end
+
+        def result_nil
+          nil
+        end
+
+        def result_permitted?
+          (::EacRubyUtils::Yaml.permitted_classes - [::Array, ::Hash])
+            .any? { |klass| source.is_a?(klass) }
+        end
+
+        def result_permitted
+          source
+        end
+
+        def sanitize_value(value)
+          self.class.new(value).result
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.34.0
+  version: 0.38.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-01 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -155,6 +155,7 @@ files:
 - lib/eac_ruby_utils/listable/list.rb
 - lib/eac_ruby_utils/listable/lists.rb
 - lib/eac_ruby_utils/listable/string_list.rb
+- lib/eac_ruby_utils/listable/symbol_list.rb
 - lib/eac_ruby_utils/listable/value.rb
 - lib/eac_ruby_utils/on_clean_ruby_environment.rb
 - lib/eac_ruby_utils/options_consumer.rb
@@ -200,6 +201,12 @@ files:
 - lib/eac_ruby_utils/templates/directory.rb
 - lib/eac_ruby_utils/templates/file.rb
 - lib/eac_ruby_utils/templates/searcher.rb
+- lib/eac_ruby_utils/templates/variable_not_found_error.rb
+- lib/eac_ruby_utils/templates/variable_providers.rb
+- lib/eac_ruby_utils/templates/variable_providers/base.rb
+- lib/eac_ruby_utils/templates/variable_providers/entries_reader.rb
+- lib/eac_ruby_utils/templates/variable_providers/generic.rb
+- lib/eac_ruby_utils/templates/variable_providers/hash.rb
 - lib/eac_ruby_utils/version.rb
 - lib/eac_ruby_utils/yaml.rb
 homepage: