eac_tools 0.3.0 → 0.4.0

data/sub/eac_ruby_utils/lib/eac_ruby_utils/options_consumer.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'ostruct'
+
+module EacRubyUtils
+  class OptionsConsumer
+    DEFAULT_OPTIONS = { validate: true, ostruct: false }.with_indifferent_access.freeze
+
+    def initialize(data)
+      @data = data.with_indifferent_access
+    end
+
+    def consume(key, default_value = nil, &block)
+      return default_value unless data.key?(key)
+
+      value = data.delete(key)
+      value = yield(value) if block
+      value
+    end
+
+    # If last argument is a Hash it is used a options.
+    # Options:
+    # * +validate+: validate after consume.
+    # * +ostruct+: return a [OpenStruct] instead a [Hash].
+    # @return [Hash] (Default) or [OpenStruct].
+    def consume_all(*keys)
+      options = consume_all_extract_options(keys)
+      result = consume_all_build_result(keys, options.fetch(:ostruct))
+      validate if options.fetch(:validate)
+      result
+    end
+
+    def validate
+      return if data.empty?
+
+      raise "Invalid keys: #{data.keys}"
+    end
+
+    def left_data
+      data.dup
+    end
+
+    private
+
+    attr_reader :data
+
+    def consume_all_extract_options(keys)
+      options = DEFAULT_OPTIONS
+      options = options.merge(keys.pop.with_indifferent_access) if keys.last.is_a?(Hash)
+      options
+    end
+
+    def consume_all_build_result(keys, ostruct)
+      if ostruct
+        ::OpenStruct.new(keys.map { |key| [key, consume(key)] }.to_h)
+      else
+        keys.map { |key| consume(key) }
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patch.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class << self
+    def patch(target, patch)
+      return if target.included_modules.include?(patch)
+
+      target.send(:include, patch)
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/class/abstract.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/abstract_methods'
+
+class Class
+  def abstract?
+    ::EacRubyUtils::AbstractMethods.abstract?(self)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/class/common_constructor.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/common_constructor'
+
+class Class
+  def common_constructor(*args, &block)
+    ::EacRubyUtils::CommonConstructor.new(*args, &block).setup_class(self)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/class/self_included_modules.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Class
+  def self_included_modules
+    ancestors.take_while { |a| a != superclass }.select { |ancestor| ancestor.instance_of?(Module) }
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/class/settings_provider.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patch'
+require 'eac_ruby_utils/settings_provider'
+
+class Class
+  def enable_settings_provider
+    ::EacRubyUtils.patch(self, ::EacRubyUtils::SettingsProvider)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/class.rb

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

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/enumerable/boolean_combinations.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Enumerable
+  # Produces a array with values's all combinations.
+  #
+  # Example:
+  #   %i[a b].boolean_combinations
+  #   => [[], [:a], [:b], [:a, :b]]
+  #
+  # @return [Array]
+  def bool_array_combs
+    bool_combs([], method(:bool_array_combs_new_comb))
+  end
+
+  # Produces a hash with values's all combinations.
+  #
+  # Example:
+  #   %i[a b].boolean_combinations
+  #   => [{a: false, b: false}, {a: false, b: true}, {a: true, b: false}, {a: true, b: true}]
+  #
+  # @return [Hash]
+  def bool_hash_combs
+    bool_combs({}, method(:bool_hash_combs_new_comb))
+  end
+
+  private
+
+  def bool_combs(empty_value, new_comb_method)
+    head = [empty_value]
+    r = inject(head) do |a, value|
+      new_comb_method.call(value, a)
+    end
+    r == head ? [] : r
+  end
+
+  def bool_array_combs_new_comb(value, combs)
+    combs + combs.map { |c| c + [value] }
+  end
+
+  def bool_hash_combs_new_comb(value, combs)
+    combs.flat_map do |comb|
+      [false, true].map { |bool_value| comb.dup.merge(value => bool_value) }
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/enumerable.rb

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

data/sub/eac_ruby_utils/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/sub/eac_ruby_utils/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/sub/eac_ruby_utils/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/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/hash/options_consumer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/options_consumer'
+
+class Hash
+  # Returns an <tt>EacRubyUtils::OptionsConsumer</tt> out of its receiver.
+  def to_options_consumer
+    ::EacRubyUtils::OptionsConsumer.new(self)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/hash/sym_keys_hash.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Hash
+  def to_sym_keys_hash
+    each_with_object({}) do |(key, value), memo|
+      symbol_key = key.respond_to?(:to_sym) ? key.to_sym : key.to_s.to_sym
+      memo[symbol_key] = value
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/hash/to_struct.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/struct'
+
+class Hash
+  # Returns an <tt>EacRubyUtils::Struct</tt> out of its receiver.
+  def to_struct
+    ::EacRubyUtils::Struct.new(self)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/hash.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/#{::File.basename(__FILE__, '.*')}/*.rb"].sort.each do |path|
+  require path
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/kernel/nyi.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Kernel
+  # Raise exception with text "Not yet implemented".
+  def nyi(message = nil)
+    s = "Not yet implemented (Called in #{caller.first})"
+    s += ": #{message}" if message
+    raise s
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/kernel.rb

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

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/module/abstract_methods.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/abstract_methods'
+
+class Module
+  def enable_abstract_methods(*methods)
+    include ::EacRubyUtils::AbstractMethods
+    abstract_methods(*methods)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/module/common_concern.rb

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

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/module/compare_by.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/compare_by'
+
+class Module
+  def compare_by(*fields)
+    ::EacRubyUtils::CompareBy.new(fields).apply(self)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/module/context.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patch'
+require 'eac_ruby_utils/contextualizable'
+
+class Module
+  # Patches module with [EacRubyUtils::Contextualizable].
+  def enable_context
+    ::EacRubyUtils.patch(self, ::EacRubyUtils::Contextualizable)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/module/i18n_translate.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/locales/module_i18n_translate'
+
+class Module
+  def i18n_translate(entry_suffix, values = {})
+    ::EacRubyUtils::Locales::ModuleI18nTranslate.new(self, entry_suffix, values).result
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/module/immutable.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patch'
+require 'eac_ruby_utils/immutable'
+
+class Module
+  def enable_immutable
+    ::EacRubyUtils.patch(self, ::EacRubyUtils::Immutable)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/module/listable.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patch'
+require 'eac_ruby_utils/listable'
+
+class Module
+  def enable_listable
+    ::EacRubyUtils.patch(self, ::EacRubyUtils::Listable)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/module/method_class.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/method_class'
+
+class Module
+  def enable_method_class
+    ::EacRubyUtils.patch(self, ::EacRubyUtils::MethodClass)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/module/patch.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patch'
+
+class Module
+  def patch(patch_module)
+    ::EacRubyUtils.patch(self, patch_module)
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+
+class Module
+  def require_sub(file_path, options = {})
+    ::EacRubyUtils.require_sub(file_path, { base: self }.merge(options))
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/module/simple_cache.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patch'
+require 'eac_ruby_utils/simple_cache'
+
+class Module
+  def enable_simple_cache
+    ::EacRubyUtils.patch(self, ::EacRubyUtils::SimpleCache)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/module/speaker.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/speaker/sender'
+
+class Module
+  def enable_speaker
+    include ::EacRubyUtils::Speaker::Sender
+  end
+end

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

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

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/object/asserts.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Object
+  # Raises a ArgumentError if +self+ is not a +klass+.
+  #
+  # @return +self+
+  def assert_argument(klass, argument_name = 'unknown_argument_name')
+    return self if is_a?(klass)
+
+    raise ::ArgumentError,
+          "Argument \"#{argument_name}\" is not a #{klass}" \
+          "(Actual class: #{self.class}, actual value: #{self})"
+  end
+
+  # Raises a ArgumentError if +self.count+ is not equal to +count+.
+  #
+  # @return +self+
+  def assert_count(count, argument_name = 'unknown_argument_name')
+    return self if self.count == count
+
+    raise ::ArgumentError,
+          "Argument \"#{argument_name}\" has wrong elements count" \
+          "(Actual: #{self.count}, Required: #{count})"
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/object/call_if_proc.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/compact'
+
+class Object
+  # If +self+ is a Proc, return the value of +.call+. If not, return +self+.
+  # @return [Object]
+  def call_if_proc
+    is_a?(::Proc) ? call : self
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/object/compact.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/compact'
+
+class Object
+  # @return [EacRubyUtils::Compact]
+  def compact(*attributes)
+    ::EacRubyUtils::Compact.new(self, attributes)
+  end
+
+  # @return [Array]
+  def compact_to_a(*attributes)
+    compact(*attributes).to_a
+  end
+
+  # @return [Hash]
+  def compact_to_h(*attributes)
+    compact(*attributes).to_h
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Object
+  def pretty_debug
+    STDERR.write(pretty_inspect)
+
+    self
+  end
+
+  def print_debug
+    STDERR.write(to_debug + "\n")
+
+    self
+  end
+
+  def to_debug
+    "|#{::Object.instance_method(:to_s).bind(self).call}|#{self}|"
+  end
+
+  def raise_debug
+    raise to_debug
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/object/i18n_translate.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patches/module/i18n_translate'
+
+class Object
+  def i18n_translate(entry_suffix, values = {})
+    self.class.i18n_translate(entry_suffix, values)
+  end
+
+  def on_i18n_locale(locale)
+    self.class.on_i18n_locale(locale)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/object/if_nil.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Object
+  # @return +block.call(self)+ if +self+ is not nil, +default_value+ otherwise.
+  def if_not_nil(default_value = nil)
+    return default_value if nil?
+
+    block_given? ? yield(self) : self
+  end
+
+  # @return +yield+ if +self+ is nil, +self+ otherwise.
+  def if_nil
+    return yield if nil? && block_given?
+
+    self
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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 if blank?
+
+    block_given? ? yield(self) : self
+  end
+
+  # @return +yield+ if +self+ is blank.
+  def if_blank
+    return yield if blank? && block_given?
+
+    self
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/object/if_respond.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+
+class Object
+  # @return +block.call(self.method_name)+ if +self+ responds to +method_name+, +default_value+
+  # otherwise.
+  def if_respond(method_name, default_value = nil)
+    return default_value unless respond_to?(method_name)
+
+    value = send(method_name)
+
+    block_given? ? yield(value) : value
+  end
+
+  # @return +yield+ if +self+ is blank.
+  def if_blank
+    return yield if blank? && block_given?
+
+    self
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/object/to_pathname.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'pathname'
+
+class Object
+  # Convert +self+ to String and then to Pathname. Return nil if +self+ is +blank?+.
+  #
+  # @return [Pathname]
+  def to_pathname
+    return self if is_a?(::Pathname)
+
+    to_s.blank? ? nil : ::Pathname.new(to_s)
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/object/to_uri.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'addressable/uri'
+
+class Object
+  # Convert +self+ to String and then to Addressable::URI. Return nil if +self+ is +blank?+.
+  #
+  # @return [Addressable::URI]
+  def to_uri
+    return self if is_a?(::Addressable::URI)
+
+    to_s.blank? ? nil : ::Addressable::URI.parse(to_s)
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/#{::File.basename(__FILE__, '.*')}/*.rb"].sort.each do |path|
+  require path
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/pathname/basename_noext.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/fs/extname'
+require 'pathname'
+
+class Pathname
+  def basename_noext(limit = 1)
+    basename(::EacRubyUtils::Fs.extname(basename.to_path, limit))
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/pathname/basename_sub.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Pathname
+  def basename_sub(suffix = '')
+    parent.join(yield(basename(suffix)))
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/pathname/if_exist.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Pathname
+  # @return +block.call(self)+ if +self+ exists, +default_value+ otherwise.
+  def if_exist(default_value = nil)
+    return default_value unless exist?
+
+    block_given? ? yield(self) : self
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/patches/pathname/mkpath_s.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Pathname
+  # Execute .mkpath and return +self+.
+  # @return [Pathname]
+  def mkpath_s
+    mkpath
+    self
+  end
+end