eco-helpers 3.0.35 → 3.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 066f83734d88958d4068ea25131fdf31b9f1e8002a120ddfa9869831f859a548
-  data.tar.gz: 874dcfebe7974fea10d8b68220ce665748851862da15724c1f62a16e1ae990df
+  metadata.gz: 0e20a7da6586a0761a6f727d17030b1d7f193d2e4784f993b03ea6fdb2e5dc59
+  data.tar.gz: da8b1b55aa5b4724fd1addf04117c2ffbcc528e14fb3c2a4606c4d736bad2d5d
 SHA512:
-  metadata.gz: 0ae22bb1f7d33eb073ce0cb55e2f35f8bf4d3480e21af463b5f9921f423a65672cad9626d0a2e8eb197bc3a050c8e3dd558bcdcaa15bcb3236b0f117fdbb3e8d
-  data.tar.gz: 87ebd3f93e78286e4615afd833230ed0744debde8d8c6382e8dcc0f0e44f697d4871bd7b6636ae0c2d05bc9c5fe2d56ecb25da1bab9d2dadb989d5cfb0cb91a7
+  metadata.gz: 3c83dbf3bd230f10db7db729c68856817a83957f666cbba326fcec9e49b8564fb1b360af759aa7739a41918e23d85a854addacac6983dba351b8a242b896aa2c
+  data.tar.gz: a672f177a39d3e0d38bfb090f267d8111dc296a0953e91554907866c506f841c91594e5856870bf4bd005aa67dc69f3e5cca86bd36cbd311537191747f7ac40d

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.36] - 2025-04-xx
+## [3.0.37] - 2025-04-xx
 
 ### Added
 
@@ -10,6 +10,17 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [3.0.36] - 2025-04-15
+
+### Added
+
+- `UseCases::Lib::Base::Env`
+- `UseCases::Service::Sftp` wrap specific methods to use different `sftp` paths.
+
+### Changed
+
+- `UseCases::Lib::Files::Sftp` to use `Lib::Base::Env`
+
 ## [3.0.35] - 2025-04-09
 
 ### Fixed

data/lib/eco/api/usecases/lib/base/env.rb

@@ -0,0 +1,46 @@
+module Eco::API::UseCases::Lib::Base
+  # Basic stuff you would need in any use case
+  # @note this is intended to be at the foremost part upfront
+  module Env
+    class << self
+      def included(base)
+        super
+
+        base.send :include, Eco::Language::AuxiliarLogger
+        base.prepend(InstanceMethods)
+      end
+    end
+
+    module InstanceMethods
+      private
+
+      def config
+        session.config
+      end
+
+      def session(required: true)
+        if instance_variable_defined?(:@session) && !@session.nil?
+          @session
+        elsif defined?(super) && !super.nil?
+          super
+        elsif Object.const_defined?(:ASSETS)
+          ASSETS.session
+        elsif required
+          raise 'Missing session object'
+        end
+      end
+
+      def options(required: true)
+        if instance_variable_defined?(:@options) && !@options.nil?
+          @session
+        elsif defined?(super) && !super.nil?
+          super
+        elsif Object.const_defined?(:ASSETS)
+          ASSETS.cli.options
+        else
+          raise 'Missing options object'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Eco::API::UseCases::Lib
+  module Base
+  end
+end
+
+require_relative 'base/env'

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

@@ -1,5 +1,5 @@
 module Eco::API::UseCases::Lib
-  # Basic stuff you would need in any use case
+  # Basic error handling you would need in any use case
   module ErrorHandling
     include Eco::Language::AuxiliarLogger
 

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

@@ -2,9 +2,13 @@ module Eco::API::UseCases::Lib::Files
   module Sftp
     class UnspecifiedRemoteFolder < ArgumentError; end
 
-    include Eco::Language::AuxiliarLogger
+    class << self
+      def included(base)
+        super
 
-    attr_reader :session, :options
+        base.send :include, Eco::API::UseCases::Lib::Base::Env
+      end
+    end
 
     private
 
@@ -136,6 +140,7 @@ module Eco::API::UseCases::Lib::Files
 
     # `remote_target_folder` overrides `sftp_config.remote_folder` as well as `remote_subfolder`
     # `remote_folder` overrides `sftp_config.remote_folder` but NOT `remote_subfolder`
+    # @note `sftp_config.remote_folder` has already the subpath of the active enviro.
     def remote_folder(subfolder = remote_subfolder)
       return super if defined?(super) && !super.nil?
 
@@ -177,7 +182,7 @@ module Eco::API::UseCases::Lib::Files
     end
 
     def sftp_config
-      session.config.sftp
+      config.sftp
     end
 
     def sftp_session

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

@@ -8,4 +8,5 @@ module Eco
 end
 
 require_relative 'lib/error_handling'
+require_relative 'lib/base'
 require_relative 'lib/files'

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

@@ -0,0 +1,74 @@
+module Eco::API::UseCases::Service
+  # Class that pulls configuration from the subject (i.e. `remote_folder`)
+  class Sftp
+    module WithTargetConfig
+      class << self
+        def included(base)
+          super
+
+          # base.send :include, Eco::Language::Methods::InstanceMethodHelpers
+          # base.extend ClassMethods
+          base.send :include, InstanceMethods
+        end
+      end
+
+      module InstanceMethods
+        private
+
+        def with_target_sftp_config
+          src_base = sftp_config.base_path
+          src_path = sftp_config.enviro_subpaths
+
+          sftp_config.base_path       = _base_path
+          sftp_config.enviro_subpaths = _env_paths
+
+          yield
+        ensure
+          sftp_config.base_path       = src_base
+          sftp_config.enviro_subpaths = src_path
+        end
+
+        def _base_path
+          self.class::BASE_PATH if self.class.const_defined?(:BASE_PATH)
+        end
+
+        def _env_paths
+          self.class::ENV_PATHS if self.class.const_defined?(:ENV_PATHS)
+        end
+      end
+
+      # module ClassMethods
+      #   def wrap_with_target_sftp(*mtds)
+      #     mtds.map(&:to_sym).each do |method_name|
+      #       msg = "#{self} does not have instance method '#{method_name}'"
+      #       has_method = instance_method?(name: method_name, include_private: true, inherited: true)
+      #       raise ArgumentError, msg unless has_method
+      #
+      #       method_was_inherited = instance_inherited_method?(name: method_name)
+      #       method_is_public     = instance_method?(name: method_name, include_private: false)
+      #       original_method      = :"method_to_wrap_with_target_sftp_#{method_name}"
+      #
+      #       # don't over-override
+      #       next if instance_method?(name: original_method, include_private: true, inherited: true)
+      #
+      #       method_def = proc do |*args, **kargs, &block|
+      #         with_target_sftp_config do
+      #           if method_was_inherited
+      #             super(*args, **kargs, &block)
+      #           else
+      #             send(original_method, *args, **kargs, &block)
+      #           end
+      #         end
+      #       end
+      #
+      #       alias_method(original_method, method_name) unless method_was_inherited
+      #       define_method(method_name, &method_def)
+      #       private method_name unless method_is_public
+      #     end
+      #
+      #     self
+      #   end
+      # end
+    end
+  end
+end

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

@@ -1,7 +1,12 @@
+require_relative 'sftp/with_target_config'
 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
+    public(*Eco::API::UseCases::Lib::Files::Sftp.private_instance_methods(inherited: false))
+
+    include WithTargetConfig
+
     # include Eco::Language::Delegation::DelegatingMissing
     include Eco::Language::Delegation::DelegatingMissingConst
     include Eco::Language::Delegation::DelegatingBlank
@@ -19,18 +24,34 @@ module Eco::API::UseCases::Service
       @subject = subject
     end
 
-    # @note overriding Sftp `attr_reader`
-    def session
-      subject.send(:session)
+    private
+
+    attr_reader :subject
+
+    def to_remote_path(...)
+      with_target_sftp_config do
+        super
+      end
+    end
+
+    def remote_folder(...)
+      with_target_sftp_config do
+        super
+      end
     end
 
-    # @note overriding Sftp `attr_reader`
-    def options
-      subject.send(:options)
+    def _base_path
+      return send(:base_path) if respond_to?(:base_path, true)
+      return super            if defined?(super) && !super.nil?
+
+      sftp_config.base_path
     end
 
-    private
+    def _env_paths
+      return send(:env_paths) if respond_to?(:env_paths, true)
+      return super            if defined?(super) && !super.nil?
 
-    attr_reader :subject
+      sftp_config.enviro_subpaths
+    end
   end
 end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.0.35'.freeze
+  VERSION = '3.0.36'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.35
+  version: 3.0.36
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-08 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -881,6 +881,8 @@ files:
 - lib/eco/api/usecases/graphql/utils.rb
 - lib/eco/api/usecases/graphql/utils/sftp.rb
 - lib/eco/api/usecases/lib.rb
+- lib/eco/api/usecases/lib/base.rb
+- lib/eco/api/usecases/lib/base/env.rb
 - lib/eco/api/usecases/lib/error_handling.rb
 - lib/eco/api/usecases/lib/files.rb
 - lib/eco/api/usecases/lib/files/file_pattern.rb
@@ -915,6 +917,7 @@ files:
 - 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/service/sftp/with_target_config.rb
 - lib/eco/api/usecases/use_case.rb
 - lib/eco/api/usecases/use_case/chainer.rb
 - lib/eco/api/usecases/use_case_chain.rb