eco-helpers 3.0.28 → 3.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f36ef48b8d70b2ac8b50e32a823d99d8bec5e32a76975357cf2298a6247a694
-  data.tar.gz: 60c6b240668df642d9bba41bc67011a02f7602e143aaabc2e4a25d2f9aa5d5dc
+  metadata.gz: 48e3cb15eee9eccde5ed9781dbff0ebcf811d26b1a7f23f503e3de733b60c19b
+  data.tar.gz: b4a84a5c1b4496706292044964256d80728f7dadabc975937306fa2f08ae29d8
 SHA512:
-  metadata.gz: 70393a40919bf80751385734885c88914a80acc47a80d5a068be431b4abd2e9677d8e1707dbeaf8510de49dc519d00441df3ffe2bed4ee8f50663895caf2e778
-  data.tar.gz: 44cc94d912bdcee5ec8140ce8d78a0b2a10feb8c609944147446e4337641ca53394ee3e798b17d970cae887b07313ed511a4840e47af7fa903595311a5923eba
+  metadata.gz: bd7335d81867d2d954a692e071ed3ca42b9c1510d8ef166a3eff0ec317e9254d4bf42a319dadb0a894c8689808ac55769dcdb6687124457e575c38c134fc70ba
+  data.tar.gz: 4364f5451f67f91228e27ad40daf10af8c2db1b99d907be9cdb84b983bb5e9f274dfddc13be174a1bed2ca4dd7c8ee42b4ffec23eaeba3ae05bae761ed5fe223

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.29] - 2025-03-xx
+## [3.0.30] - 2025-03-xx
 
 ### Added
 
@@ -10,6 +10,19 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [3.0.29] - 2025-03-31
+
+### Added
+
+- `API::UseCases::Service::Sftp` **basic wrapper** to make this easier on Sftp functions.
+- `Language::Delegation::DelegatingBlank`
+
+### Fixed
+
+- `Eco::API::UseCases::Lib::Files::Sftp`
+  - **Rectified** named argument `only_latest` to fetch only latest file (**newest**).
+  - Wrong target object to call `#upload` on.
+
 ## [3.0.28] - 2025-03-31
 
 ### Added

data/lib/eco/api/common/session/helpers/prompt_user.rb

@@ -5,7 +5,7 @@ module Eco
         module Helpers
           module PromptUser
             # Prompts user for input with option for default on timeout.
-            def prompt_user(question, default:, explanation: "", timeout: nil)
+            def prompt_user(question, default:, explanation: '', timeout: nil)
               require 'timeout'
               response =
                 if config.run_mode_remote?
@@ -18,6 +18,8 @@ module Eco
                     begin
                       Timeout::timeout(timeout) { STDIN.gets.chop }
                     rescue Timeout::Error
+                      print default
+                      puts "\n"
                       default
                     end
                   else

data/lib/eco/api/usecases/lib/files/sftp.rb

@@ -10,7 +10,7 @@ module Eco::API::UseCases::Lib::Files
 
     # @return [String, FalseClass] the path of the remote file or `false` if failed.
     def upload(local_file, subfolder: remote_subfolder, gid: sftp_group_id)
-      sftp_session.upload(
+      sftp.upload(
         local_file,
         remote_folder: remote_folder(subfolder),
         gid:           gid
@@ -40,8 +40,8 @@ module Eco::API::UseCases::Lib::Files
     )
       remote_files = with_remote_files(subfolder: subfolder, pattern: pattern)
 
-      return []                           if remote_files.empty?
-      remote_files = [remote_files.first] if only_latest
+      return []                          if remote_files.empty?
+      remote_files = [remote_files.last] if only_latest
 
       file_names = remote_files.map {|file| to_remote_path(file.name, subfolder: subfolder)}
 
@@ -92,7 +92,7 @@ module Eco::API::UseCases::Lib::Files
       files = with_remote_files(subfolder: subfolder, pattern: pattern)
       return if files.empty?
 
-      msg  = "There are still files in the remote folder that will be deleted: '#{subfolder}':\n"
+      msg  = "There are files in the remote folder that will be deleted: '#{subfolder}':\n"
       msg << '  * '
       str  = files.map(&:longname).join("\n  * ")
       str << "\n"

data/lib/eco/api/usecases/service/sftp.rb

@@ -0,0 +1,36 @@
+module Eco::API::UseCases::Service
+  # Class that pulls configuration from the subject (i.e. `remote_folder`)
+  class Sftp
+    include Eco::API::UseCases::Lib::Files::Sftp
+    # include Eco::Language::Delegation::DelegatingMissing
+    include Eco::Language::Delegation::DelegatingMissingConst
+    include Eco::Language::Delegation::DelegatingBlank
+
+    DELEGATED_BLANK_PROPERTIES = %i[
+      remote_subfolder
+      local_folder
+      sftp_group_id
+    ].freeze
+
+    delegating_missing_to :subject
+    delegating_blank(*DELEGATED_BLANK_PROPERTIES, to: :subject, safe: true)
+
+    def initialize(subject)
+      @subject = subject
+    end
+
+    # @note overriding Sftp `attr_reader`
+    def session
+      subject.send(:session)
+    end
+
+    # @note overriding Sftp `attr_reader`
+    def options
+      subject.send(:options)
+    end
+
+    private
+
+    attr_reader :subject
+  end
+end

data/lib/eco/api/usecases/service.rb

@@ -0,0 +1,15 @@
+module Eco
+  module API
+    class UseCases
+      # Service classes tied to `UseCases`
+      # @note its purpose to keep `UseCase` classes as dry as possible.
+      #   Rather than including methods into the use case, a service class
+      #   approach can prevent undesirable clashes, that in turn are very
+      #   difficult to track down.
+      module Service
+      end
+    end
+  end
+end
+
+require_relative 'service/sftp'

data/lib/eco/api/usecases.rb

@@ -177,6 +177,7 @@ require_relative 'usecases/base_io'
 require_relative 'usecases/use_case_io'
 require_relative 'usecases/cli'
 require_relative 'usecases/lib'
+require_relative 'usecases/service'
 require_relative 'usecases/graphql'
 require_relative 'usecases/default'
 require_relative 'usecases/samples'

data/lib/eco/language/delegation/delegating_blank.rb

@@ -0,0 +1,162 @@
+# rubocop:disable Naming/MethodParameterName
+
+module Eco::Language::Delegation
+  # Installs a middleware for each delegated entity
+  # @note It adds an implicit delegate missing to the target,
+  #   unless it has already been defined.
+  module DelegatingBlank
+    class << self
+      def included(base)
+        super
+
+        base.include DelegatingMissing
+        base.extend ClassMethods
+        base.inheritable_class_vars :_delegating_blank
+      end
+    end
+
+    module ClassMethods
+      include Eco::Language::Strings::Underscore
+
+      def delegating_blank(*these, to:, safe: false)
+        msg = "Delegating to: should be String or Symbol. Given: #{to.class}"
+        raise ArgumentError, msg unless sym_or_string?(to)
+
+        these.map do |this|
+          msg = "Expecting String or Symbol. Given: #{this}."
+          raise ArgumentError, msg unless sym_or_string?(this)
+
+          this.to_sym
+        end.each do |this|
+          delegating_missing(this, to: to) unless delegating_missing?(this)
+          install_blank_delegator(at: this, safe: safe)
+
+          _delegating_blank[this]      = to
+          _safe_blank_delegation[this] = safe
+        end
+
+        self
+      end
+
+      def delegating_blank?(sym)
+        return false unless sym_or_string?(sym)
+        return true  if _delegating_blank.key?(sym.to_sym)
+
+        false
+      end
+
+      def safe_blank_delegation?(sym)
+        return false unless sym_or_string?(sym)
+        return false unless _safe_blank_delegation.key?(sym.to_sym)
+
+        _safe_blank_delegation[sym.to_sym]
+      end
+
+      def delegating_blank_target(instance, at: nil)
+        return unless delegating_blank?(at)
+        return unless (subject_ref = _delegating_blank[at])
+
+        instance_has_method =
+          instance.methods.include?(subject_ref) ||
+          instance.private_methods.include?(subject_ref)
+
+        return instance.method(subject_ref).call if instance_has_method
+        return                                   unless at.to_s.start_with?('@')
+        return                                   unless instance.instance_variable_defined?(at)
+
+        instance.instance_variable_get(at)
+      end
+
+      private
+
+      def method_added(method_name)
+        return super if (@installing ||= false)
+
+        method_name = method_name.to_sym
+        return super unless delegating_blank?(method_name)
+
+        @installing = true
+        install_blank_delegator(at: method_name)
+        @installing = false
+        super
+      end
+
+      def _delegating_blank
+        @_delegating_blank ||= {}
+      end
+
+      def _safe_blank_delegation
+        @_safe_blank_delegation ||= {}
+      end
+
+      # If `base` does NOT have the method, don't install the middleware.
+      def install_blank_delegator(base = self, at:, safe: safe_blank_delegation?(at))
+        method_name  = underscore(at).gsub('@', '').to_sym
+        install_safe = safe
+
+        return unless instance_method?(base, name: method_name, include_private: true)
+
+        method_was_inherited = inherited_method?(base, name: method_name)
+        original_method      = :"delegated_blank_original_#{method_name}"
+
+        return if instance_method?(base, name: original_method, include_private: true, inherited: false)
+
+        base.alias_method(original_method, method_name) unless method_was_inherited
+
+        method_def = proc do |*args, **kargs, &block|
+          if method_was_inherited
+            super(*args, **kargs, &block)
+          else
+            send(original_method, *args, **kargs, &block)
+          end.then do |value|
+            next value unless blank?(value)
+
+            target = self.class.delegating_blank_target(self, at: at)
+
+            if at.to_s.start_with?('@')
+              target.instance_variable_get(at)
+            elsif !install_safe || target.respond_to?(method_name, true)
+              target.send(method_name, *args, **kargs, &block)
+            end
+          end
+        end
+
+        base.define_method(method_name, &method_def)
+      end
+
+      def instance_method?(base = self, name:, include_private: false, inherited: true)
+        return true  if base.method_defined?(name, inherited)
+        return false unless include_private
+
+        base.private_instance_methods(inherited).include?(name.to_sym)
+      end
+
+      def inherited_method?(base = self, name:)
+        return false if base.public_instance_methods(false).include?(name.to_sym)
+        return false if base.private_instance_methods(false).include?(name.to_sym)
+
+        true
+      end
+
+      def sym_or_string?(value)
+        return false unless value.is_a?(Symbol) || value.is_a?(String)
+        return false if value.to_s.strip.empty?
+
+        true
+      end
+    end
+
+    # INSTANCE Methods
+
+    def blank?(value)
+      return super if defined?(super)
+      return true  if value.nil?
+      return true  if value.to_s.strip.empty?
+      return true  if value.respond_to?(:empty?) && value.empty?
+
+      false
+    end
+  end
+end
+
+# rubocop:enable Naming/MethodParameterName

data/lib/eco/language/delegation/for_delegator/const_lookup_hooks.rb

@@ -88,11 +88,11 @@ module Eco::Language::Delegation::ForDelegator
         base.define_method(meth_name, &method_def)
       end
 
-      def instance_method?(base = self, name:, include_private: false)
-        return true  if base.method_defined?(name)
+      def instance_method?(base = self, name:, include_private: false, inherited: true)
+        return true  if base.method_defined?(name, inherited)
         return false unless include_private
 
-        base.private_instance_methods.include?(name.to_sym)
+        base.private_instance_methods(inherited).include?(name.to_sym)
       end
     end
   end

data/lib/eco/language/delegation.rb

@@ -8,3 +8,4 @@ require_relative 'delegation/chainable_delegator'
 require_relative 'delegation/delegating_missing_on_class'
 require_relative 'delegation/delegating_missing'
 require_relative 'delegation/delegating_missing_const'
+require_relative 'delegation/delegating_blank'

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.0.28'.freeze
+  VERSION = '3.0.29'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.28
+  version: 3.0.29
 platform: ruby
 authors:
 - Oscar Segura
@@ -912,6 +912,8 @@ files:
 - lib/eco/api/usecases/samples/drivers/cli/url_pull_cli.rb
 - lib/eco/api/usecases/samples/drivers/sftp_sample.rb
 - lib/eco/api/usecases/samples/drivers/url_pull_sample.rb
+- lib/eco/api/usecases/service.rb
+- lib/eco/api/usecases/service/sftp.rb
 - lib/eco/api/usecases/use_case.rb
 - lib/eco/api/usecases/use_case/chainer.rb
 - lib/eco/api/usecases/use_case_chain.rb
@@ -1002,6 +1004,7 @@ files:
 - lib/eco/language/curry.rb
 - lib/eco/language/delegation.rb
 - lib/eco/language/delegation/chainable_delegator.rb
+- lib/eco/language/delegation/delegating_blank.rb
 - lib/eco/language/delegation/delegating_missing.rb
 - lib/eco/language/delegation/delegating_missing_const.rb
 - lib/eco/language/delegation/delegating_missing_on_class.rb