eac_tools 0.88.0 → 0.90.0

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+
+class Hash
+  # @return +block.call(fetch(key))+ if +self+ has the key +key+, +default_value+ otherwise.
+  def if_key(key, default_value = nil)
+    return default_value unless key?(key)
+
+    block_given? ? yield(fetch(key)) : fetch(key)
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Kernel
+  # Raise exception with text "Invalid branch reached".
+  def ibr(message = nil)
+    s = "Invalid branch reached (Called in #{caller.first})"
+    s += ": #{message}" if message
+    raise s
+  end
+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/patches/module/acts_as_abstract'
+
+class Module
+  # @deprecated Use {#acts_as_abstract} instead.
+  def enable_abstract_methods(*methods)
+    acts_as_abstract(*methods)
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/acts_as_abstract'
+
+class Module
+  # Include [EacRubyUtils::ActsAsAbstract] and perform EacRubyUtils::ActsAsAbstract.abstract_methods
+  # on parameter +methods+.
+  # @param methods [Array<Symbol>]
+  # @return [void]
+  def acts_as_abstract(*methods)
+    include ::EacRubyUtils::ActsAsAbstract
+    abstract_methods(*methods)
+  end
+end

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

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

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/acts_as_instance_method'
+
+class Module
+  # @return [EacRubyUtils::ActsAsInstanceMethod]
+  def acts_as_instance_method
+    ::EacRubyUtils::ActsAsInstanceMethod.new(self).setup
+  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,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patch'
+require 'eac_ruby_utils/acts_as_immutable'
+
+class Module
+  # @deprecated Use {#acts_as_immutable} instead.
+  def enable_immutable
+    ::EacRubyUtils.patch(self, ::EacRubyUtils::ActsAsImmutable)
+  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/module_parent.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/introspection'
+
+Module.alias_method :module_parent, :parent unless Module.method_defined?(:module_parent)

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,55 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/compact'
+require 'eac_ruby_utils/patches/object/if_present'
+require 'pp'
+
+class Object
+  # @param attributes [Enumerable<Symbol>] Attributes for +EacRubyUtils::Compact.new+.
+  # @return [void]
+  def compact_debug(*attributes)
+    ::EacRubyUtils::Compact.new(self, attributes).to_h.each do |name, value|
+      value.print_debug(label: name)
+    end
+  end
+
+  def pretty_debug(options = {})
+    print_debug_options(options)
+
+    $stderr.write(pretty_inspect)
+
+    self
+  end
+
+  def print_debug(options = {})
+    print_debug_options(options)
+    $stderr.write("#{to_debug}\n")
+
+    self
+  end
+
+  def print_debug_label(label)
+    $stderr.write("#{label}: ")
+  end
+
+  def print_debug_options(options)
+    options[:title].if_present { |v| print_debug_title(v) }
+    options[:label].if_present { |v| print_debug_label(v) }
+  end
+
+  def print_debug_title(title)
+    title = title.to_s
+    char = '='
+    $stderr.write("#{char * (4 + title.length)}\n")
+    $stderr.write("#{char} #{title} #{char}\n")
+    $stderr.write("#{char * (4 + title.length)}\n")
+  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/recursive_build.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/recursive_builder'
+
+class Object
+  # Equivalent to +EacRubyUtils::RecursiveBuilder.new(self, &neighbors_block).result+.
+  # @param &neighbors_block [Proc]
+  # @return [Enumerable]
+  def recursive_build(&neighbors_block)
+    ::EacRubyUtils::RecursiveBuilder.new(self, &neighbors_block).result
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/boolean'
+
+class Object
+  # Shortcut to +EacRubyUtils::Boolean.parse(self).
+  #
+  # @return [Boolean]
+  def to_bool
+    ::EacRubyUtils::Boolean.parse(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/assert_parent.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Pathname
+  # Invoke +mkpath+ for parent path and return +self+.
+  # @return [self]
+  def assert_parent
+    parent.mkpath
+    self
+  end
+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,13 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Pathname
+  # @param suffix [String]
+  # @return [Pathname]
+  def basename_sub(suffix = '')
+    new_basename = basename(suffix)
+    new_basename = yield(new_basename) if block_given?
+    parent.join(new_basename)
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Pathname
+  # Indicate if +self+ is child of +parent_path+.
+  #
+  # @return [Boolean]
+  def child_of?(parent_path)
+    self_parts = expand_path.each_filename.to_a
+    parent_parts = parent_path.expand_path.each_filename.to_a
+    return false if self_parts == parent_parts
+
+    parent_parts.zip(self_parts).all? { |x, y| x == y }
+  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

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Pathname
+  # Apply .parent n times.
+  # @return [Pathname]
+  def parent_n(n) # rubocop:disable Naming/MethodParameterName
+    n.times.inject(self) { |a, _e| a.parent }
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Pathname
+  def readlink_r
+    r = self
+    r = r.readlink while r.symlink?
+    r
+  end
+end