eac_ruby_utils 0.33.1 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b15ce47fc0a4be7f0d4d5c508e7460447818bcc4eef4f1b49d70c21475320091
-  data.tar.gz: 904f3e7fddda7113e1b70decadd20e9d1fd0e36c5a2f5467067a76abc1680ee1
+  metadata.gz: 68c46afaacfcbdd7bb63906f6d7ec668edfaeb5da500d46c68e8ee82e7ee6d20
+  data.tar.gz: 184a7551426a3ba8dc7117254119ad49f53713fa420a67f9b7c80f8697b92f7d
 SHA512:
-  metadata.gz: 24b859d02cbb17c2a87f89fecfac6d066cc3446516ecb34dc92d56bbc403a3969229e59622e0c654daf816585b539d14bed37400a072cd63fdf67160804e9d42
-  data.tar.gz: b02dc4a1d20787d3cbc0de8a0831d6c0cda42a5f2a6c7af3ce6fb7b6e85e65fd93ef9253d889297c034f8452e867735a8b9a4e5f1cbcd8c49028f4ee26f1a201
+  metadata.gz: 3236d13fa87bba223b8d88387fb2e3f55de304a933f9e91f5919f51a9ab9fd69fd2f5dc6e355e172d24d37cb435d245e105344a4510f0aa6e6145230fd335c79
+  data.tar.gz: ad219efa4bef8a2dc636f36c9e4a8535d37fe7ea2b90bb6633cf104860fa357cd4248896e70ea8f8894aa3dfd0ce793d559dd880e650327cb48302599db8d2cf

data/lib/eac_ruby_utils/common_concern.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'eac_ruby_utils/simple_cache'
+require 'eac_ruby_utils/patches/object/if_present'
+
+module EacRubyUtils
+  class CommonConcern
+    CLASS_METHODS_MODULE_NAME = 'ClassMethods'
+    INSTANCE_METHODS_MODULE_NAME = 'InstanceMethods'
+
+    attr_reader :after_callback
+
+    def initialize(&after_callback)
+      @after_callback = after_callback
+    end
+
+    def setup(a_module)
+      Setup.new(self, a_module).run
+    end
+
+    class Setup
+      include ::EacRubyUtils::SimpleCache
+      attr_reader :a_module, :common_constructor
+
+      def initialize(common_constructor, a_module)
+        @common_constructor = common_constructor
+        @a_module = a_module
+      end
+
+      def run
+        setup = self
+        a_module.extend(::ActiveSupport::Concern)
+        a_module.included do
+          %w[class_methods instance_methods after_callback].each do |suffix|
+            setup.send("setup_#{suffix}", self)
+          end
+        end
+      end
+
+      def setup_class_methods(base)
+        class_methods_module.if_present { |v| base.extend v }
+      end
+
+      def setup_instance_methods(base)
+        instance_methods_module.if_present { |v| base.include v }
+      end
+
+      def setup_after_callback(base)
+        common_constructor.after_callback.if_present do |v|
+          base.instance_eval(&v)
+        end
+      end
+
+      def class_methods_module_uncached
+        a_module.const_get(CLASS_METHODS_MODULE_NAME)
+      rescue NameError
+        nil
+      end
+
+      def instance_methods_module_uncached
+        a_module.const_get(INSTANCE_METHODS_MODULE_NAME)
+      rescue NameError
+        nil
+      end
+    end
+  end
+end

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/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/module/common_concern.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/common_concern'
+require 'eac_ruby_utils/console/speaker'
+
+class Module
+  def common_concern(&after_callback)
+    ::EacRubyUtils::CommonConcern.new(&after_callback).setup(self)
+  end
+end

data/lib/eac_ruby_utils/patches/module/require_sub.rb

@@ -3,7 +3,7 @@
 require 'eac_ruby_utils/require_sub'
 
 class Module
-  def require_sub(file_path)
-    ::EacRubyUtils.require_sub(file_path)
+  def require_sub(file_path, options = {})
+    ::EacRubyUtils.require_sub(file_path, { base: self }.merge(options))
   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

@@ -2,9 +2,52 @@
 
 module EacRubyUtils
   class << self
-    def require_sub(file)
+    def require_sub(file, options = {})
+      ::EacRubyUtils::RequireSub.new(file, options).apply
+    end
+  end
+
+  class RequireSub
+    BASE_OPTION_KEY = :base
+    INCLUDE_MODULES_OPTION_KEY = :include_modules
+    REQUIRE_DEPENDENCY_OPTION_KEY = :require_dependency
+
+    attr_reader :file, :options
+
+    def initialize(file, options = {})
+      @file = file
+      @options = options
+    end
+
+    def apply
+      require_sub_files
+      include_modules
+    end
+
+    private
+
+    def include_modules
+      return unless options[INCLUDE_MODULES_OPTION_KEY]
+
+      base.constants.each do |constant_name|
+        constant = base.const_get(constant_name)
+        next unless constant.is_a?(::Module) && !constant.is_a?(::Class)
+
+        base.include(constant)
+      end
+    end
+
+    def base
+      options[BASE_OPTION_KEY] || raise('Option :base not setted')
+    end
+
+    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.33.1'
+  VERSION = '0.37.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.33.1
+  version: 0.37.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,6 +110,7 @@ files:
 - lib/eac_ruby_utils.rb
 - lib/eac_ruby_utils/arguments_consumer.rb
 - lib/eac_ruby_utils/by_reference.rb
+- lib/eac_ruby_utils/common_concern.rb
 - lib/eac_ruby_utils/common_constructor.rb
 - lib/eac_ruby_utils/configs.rb
 - lib/eac_ruby_utils/configs/file.rb
@@ -154,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
@@ -167,6 +169,7 @@ files:
 - lib/eac_ruby_utils/patches/hash/options_consumer.rb
 - lib/eac_ruby_utils/patches/hash/sym_keys_hash.rb
 - lib/eac_ruby_utils/patches/module.rb
+- lib/eac_ruby_utils/patches/module/common_concern.rb
 - lib/eac_ruby_utils/patches/module/console_speaker.rb
 - lib/eac_ruby_utils/patches/module/listable.rb
 - lib/eac_ruby_utils/patches/module/patch.rb
@@ -198,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: