eac_ruby_utils 0.33.0 → 0.36.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a1862278458f2d12656dde6da578afba1edacaa582971511f39ecf04d30f080
-  data.tar.gz: 9b1d192e277da7a4fd5f740223161a08b98076498fe849291dfd8ef6a35c4d99
+  metadata.gz: 84d0ecee9144c68997a1ce006b3888d4ca47d5f3e0fbbcebb1510f1c7729f6ab
+  data.tar.gz: 1fef17107a1604d0e8bdab9cc20d5066a86957340573319f758763294d461da2
 SHA512:
-  metadata.gz: 5a6b73a58b94e8e7670dffb850d66e1453b51ecf21dee4dbff6181506f4cbdeebc31af724dc60e7fc1495db5a5cf77756edc32823f5b058cd53a61dd6e936c2b
-  data.tar.gz: 1845a0dd4dea2c126781bd197b61d28fc44ac8a9b873a355453433c56b495862663d6e5ee7d8fbfbd553bf2a03520f9fd03349deb6e5a7640617741b2e626e72
+  metadata.gz: 5389243ea1b2c4cd7c9dc433821d390e6202d42177d422a482b8efb7f73b06311d7351d43feedad9396c3551273e6ade1f4ce539915483c5271e5590cc134b2f
+  data.tar.gz: 19b375a5056cb8fd70914bfe029e780a20066ba558c84b7a934ef3b82e118139bfe62f54b4b8285ad8a46ff643431ad1e06e494912d483559dbfb5524f7f098e

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/patch.rb

@@ -4,6 +4,6 @@ require 'eac_ruby_utils/patch'
 
 class Module
   def patch(patch_module)
-    ::Eac::Ruby::Utils.patch(self, patch_module)
+    ::EacRubyUtils.patch(self, patch_module)
   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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EacRubyUtils
-  VERSION = '0.33.0'
+  VERSION = '0.36.1'
 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.0
+  version: 0.36.1
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2020-06-14 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