eco-helpers 3.0.37 → 3.1.1

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

@@ -10,7 +10,7 @@ module Eco::API::UseCases::Lib::Files
 
     # Can't pass this via CLI option, as it breaks the regular expression
     def file_pattern(required: true)
-      fpc = file_pattern_const
+      fpc = file_pattern_from_const
       return fpc if fpc
       return     unless required
 
@@ -19,21 +19,48 @@ module Eco::API::UseCases::Lib::Files
       raise WrongConst, msg
     end
 
-    def file_pattern_const
-      if (fpc = options.dig(:sftp, :file_pattern_const))
-        msg = "(#{self.class}) Invalid file pattern const referral: #{fpc}"
-        raise WrongConst, msg unless fpc.match(CONST_REFERRAL)
-
-        begin
-          self.eval(fpc)
-        rescue NameError
-          self.class.const_get(fpc)
-        end
-      elsif self.class.const_defined?(:FILE_PATTERN)
-        self.class::FILE_PATTERN
+    def file_pattern_from_const
+      as_regex(insensitive: true) do
+        value = fetch_pattern_const(file_pattern_const_from_options)
+
+        next value                    unless value.nil?
+        next self.class::FILE_PATTERN if self.class.const_defined?(:FILE_PATTERN)
+      end
+    end
+
+    def file_pattern_const_from_options
+      return unless (fpc = options.dig(:sftp, :file_pattern_const))
+
+      fpc
+    end
+
+    def fetch_pattern_const(name, exception: true)
+      return if name.to_s.strip.empty?
+
+      msg = "(#{self.class}) Invalid file pattern const referral: #{name}"
+      raise WrongConst, msg unless name.match(CONST_REFERRAL)
+
+      begin
+        self.eval(name)
+      rescue NameError
+        self.class.const_get(name)
       end
     rescue NameError
-      raise WrongConst, "(#{self.class}) Unknown constant: #{fpc}"
+      raise WrongConst, "(#{self.class}) Unknown constant: #{name}" if exception
+    end
+
+    def as_regex(value = nil, insensitive: true)
+      value = yield if block_given?
+
+      case value
+      when Regexp
+        value
+      when String
+        esub = Regexp.escape(value)
+        return /#{esub}/i if insensitive
+
+        /#{esub}/
+      end
     end
   end
 end

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

@@ -0,0 +1,110 @@
+module Eco::API::UseCases::Lib::Files
+  # @note Assumes that, if **Cli** invoked, there could be **Cli** `options` defined
+  # under `:input` `:file`:
+  #   - `:name`
+  #   - `:format` (overriding `INPUT_FORMAT` const)
+  #   - `:encoding`
+  #   - `:pattern` (target pattern const)
+  # @note it includes and extends `FilePattern`:
+  #   - `file_pattern_from_const` would prioritize constants as accepted
+  #     in `INPUT_FILENAME_CONSTS`
+  #   - `file_pattern_const_from_options` would prioritize `:input` `:file` `:pattern`
+  module InputFile
+    INPUT_FILENAME_CONSTS = %i[
+      INPUT_FILENAME IN_FILENAME INPUT_FILE_PATTERN IN_FILE_PATTERN
+    ]
+
+    class << self
+      def included(base)
+        super
+
+        base.send :include, Eco::API::UseCases::Lib::Base::Env unless base.include?(Eco::API::UseCases::Lib::Base::Env)
+        base.send :extend, Eco::Data::Files::Folder
+        base.send :include, Eco::API::UseCases::Lib::Files::FilePattern
+        base.send :include, InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      private
+
+      # @todo REVIEW: in practice, it collides with Sftp#local_folder
+      # @todo it is not clear if it should join onto `config.active_enviro`
+      def input_folder
+        File.join(
+          config.active_enviro,
+          self.class::IN_FOLDER
+        )
+      end
+
+      def input_file
+        @input_file ||= (input_file_from_options || newest_file).tap do |file|
+          if file
+            log(:info) { "Using input file '#{file}'" }
+          else
+            log(:warn) { 'Could not find any input file' }
+            exit 0
+          end
+        end
+      end
+
+      def input_file_from_options
+        options.dig(:input, :file, :name)
+      end
+
+      # @note assuming filenames hold a name pattern `YYYY-MM-dd`.
+      def newest_file
+        @newest_file ||= input_files.last
+      end
+
+      # @note based on `input_folder` && `input_file_pattern`
+      # @todo it some cases it has been used/defined as csv_files
+      def input_files(&block)
+        self.class.folder_files(
+          input_folder,
+          input_format,
+          regexp: input_file_pattern,
+          &block
+        )
+      end
+
+      def input_encoding
+        options.dig(:input, :file, :encoding) || 'utf-8'
+      end
+
+      # It helps to identify the extension of the input file.
+      # @note it may not be essential, but good practice as a safe-guard.
+      def input_format
+        frm = options.dig(:input, :file, :format)
+        return frm                             if frm
+        return self.class::INPUT_FORMAT.to_sym if self.class.const_defined?(:INPUT_FORMAT)
+
+        :csv
+      end
+
+      def input_file_pattern
+        file_pattern
+      end
+
+      # Overrides to FilePattern
+
+      def file_pattern_from_const
+        as_regex(insensitive: true) do
+          value = INPUT_FILENAME_CONSTS.detect do |const|
+            next self.class.const_get(const) if self.class.const_defined?(const)
+          end
+
+          next value if value
+
+          super
+        end
+      end
+
+      def file_pattern_const_from_options
+        return super unless (fpc = options.dig(:input, :file, :pattern))
+
+        fpc
+      end
+    end
+  end
+end

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

@@ -74,10 +74,10 @@ module Eco::API::UseCases::Lib::Files
       end
     end
 
-    def sftp_archive_file!(filename, folder: 'Archive')
+    def sftp_archive_file!(filename, subfolder: 'Archive')
       basename       = File.basename(filename)
       remote_file    = to_remote_path(basename)
-      archive_folder = to_remote_path(folder)
+      archive_folder = to_remote_path(subfolder)
       archived_file  = "#{archive_folder}/#{basename}"
 
       sftp_move_file(remote_file, archived_file)
@@ -124,6 +124,9 @@ module Eco::API::UseCases::Lib::Files
       end
     end
 
+    # @note it can be used for both:
+    #   - for pulling files to
+    #   - and for pushing files from
     def local_folder
       return super if defined?(super) && !super.nil?
 

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

@@ -5,3 +5,4 @@ end
 
 require_relative 'files/sftp'
 require_relative 'files/file_pattern'
+require_relative 'files/input_file'

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

@@ -0,0 +1,23 @@
+module Eco::API::UseCases::Lib::Locations
+  module Base
+    class << self
+      def included(base)
+        super
+
+        base.send :include, Eco::API::UseCases::Lib::Base::Env unless base.included?(Eco::API::UseCases::Lib::Base::Env)
+      end
+    end
+
+    private
+
+    def location?(value)
+      locations.tag?(value)
+    end
+    alias_method :tag?, :location?
+
+    def locations
+      config.tagtree
+    end
+    alias_method :tagtree, :locations
+  end
+end

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

@@ -0,0 +1,94 @@
+module Eco::API::UseCases::Lib::Locations
+  module Mapping
+    LOCATION_MAPPING          = true
+    LOCATION_MAPS_FILE        = nil
+    LOCATION_MAPS_INTERNAL    = :first
+    LOCATION_MAPS_INSENSITIVE = true
+
+    class << self
+      def included(base)
+        super
+
+        base.send :include, Locations::Base
+      end
+    end
+
+    def unknown_locations
+      @unknown_locations ||=
+        Eco::Data::CountTrace.new(self)
+    end
+
+    def report_unknown_locations!(msg: nil, level: :warn)
+      unknown_locations.report!(msg: msg, level: level)
+    end
+
+    private
+
+    def to_location(value)
+      value = value.to_s.strip
+      return if value.empty?
+
+      if location_mapping? && locations_mapper.external?(value)
+        locations_mapper.to_internal(value)
+      elsif location?(value)
+        value
+      else
+        unknown_locations.trace!(value)
+      end
+    end
+    alias_method :to_tag, :to_location
+
+    def to_location_code(value)
+      value = value.to_s.strip
+      return if value.empty?
+
+      if location_mapping? && locations_mapper.internal?(value)
+        locations_mapper.to_external(value)
+      else
+        value
+      end
+    end
+
+    def locations_mapper(
+      internal:    loc_maps_internal_order,
+      insensitive: loc_maps_insensitive,
+      maps_file:   loc_maps_file
+    )
+      return @locations_mapper if instance_variable_defined?(:@locations_mapper)
+
+      @locations_mapper = config.locations_mapper(
+        internal:    internal,
+        insensitive: insensitive,
+        maps_file:   maps_file
+      )
+    end
+
+    def location_mapping?
+      return false unless self.class::LOCATION_MAPPING
+      return false unless loc_maps_file
+      return false unless locations_mapper
+      return false unless locatoins_mapper.empty?
+
+      true
+    end
+
+    def loc_maps_file
+      return @loc_maps_file if instance_variable_defined?(:@loc_maps_file)
+
+      @loc_maps_file   = loc_maps_file_const
+      @loc_maps_file ||= config.locations_map_file
+    end
+
+    def loc_maps_file_const
+      self.class::LOCATION_MAPS_FILE if self.class.const_defined?(:MAPS_FILE)
+    end
+
+    def loc_maps_internal_order
+      self.class::LOCATION_MAPS_INTERNAL
+    end
+
+    def loc_maps_insensitive
+      self.class::LOCATION_MAPS_INSENSITIVE
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Eco::API::UseCases::Lib
+  module Locations
+  end
+end
+
+require_relative 'locations/base'
+require_relative 'locations/mapping'

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

@@ -0,0 +1,20 @@
+module Eco::API::UseCases::Lib::People
+  module Base
+    class << self
+      def included(base)
+        super
+
+        base.send :include, Eco::API::UseCases::Lib::Base::Env unless base.included?(Eco::API::UseCases::Lib::Base::Env)
+      end
+    end
+
+    private
+
+    def people
+      return @people if instance_variable_defined?(:@people) && !@people.nil?
+      return super   if defined?(super) && !super.nil?
+
+      @people ||= micro.people_load(modifier: %i[newest save])
+    end
+  end
+end

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

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

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

@@ -10,3 +10,5 @@ end
 require_relative 'lib/error_handling'
 require_relative 'lib/base'
 require_relative 'lib/files'
+require_relative 'lib/locations'
+require_relative 'lib/people'

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

@@ -1,7 +1,7 @@
 module Eco
   module API
     class UseCases
-      class OozeCases
+      class OozeCases # rubocop:disable Lint/EmptyClass
       end
     end
   end

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

@@ -9,6 +9,7 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
     def batch_size(size = nil)
       @batch_size ||= 25
       return @batch_size unless size
+
       @batch_size = size
     end
   end

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

@@ -11,6 +11,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
     def batch_size(size = nil)
       @batch_size ||= 25
       return @batch_size unless size
+
       @batch_size = size
     end
   end

data/lib/eco/api/usecases/samples/drivers/sftp_sample.rb

@@ -57,6 +57,8 @@ class Eco::API::UseCases::Samples::Drivers::Sftp < Eco::API::Common::Loaders::Us
     end
   end
 
+  # @todo when `sftp_move_file` fails, it still `puts` the message
+  #   that it moved the file(s) to the `archive_subfolder`
   def archive_files
     with_remote_files(pattern: file_pattern) do |file|
       source = to_remote_path(file.name) # should probably be file.longname

data/lib/eco/api/usecases/samples/drivers/url_pull_sample.rb

@@ -62,7 +62,12 @@ class Eco::API::UseCases::Samples::Drivers::UrlPull < Eco::API::Common::Loaders:
   end
 
   def http_start(uri, &block)
-    Net::HTTP.start(uri.hostname, uri.port, request_options(uri), &block)
+    Net::HTTP.start(
+      uri.hostname,
+      uri.port,
+      request_options(uri),
+      &block
+    )
   end
 
   def base_request(uri, user: nil, pass: '')
@@ -95,7 +100,8 @@ class Eco::API::UseCases::Samples::Drivers::UrlPull < Eco::API::Common::Loaders:
 
   def target_url_const
     if (fpc = options.dig(:url_pull, :target_url_const))
-      raise WrongConst, "(#{self.class}) Invalid file pattern const referral: #{fpc}" unless fpc.match(CONST_REFERRAL)
+      msg = "(#{self.class}) Invalid file pattern const referral: #{fpc}"
+      raise WrongConst, msg unless fpc.match(CONST_REFERRAL)
 
       begin
         self.eval(fpc)

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

@@ -36,39 +36,6 @@ module Eco::API::UseCases::Service
           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,9 +1,15 @@
 require_relative 'sftp/with_target_config'
 module Eco::API::UseCases::Service
   # Class that pulls configuration from the subject (i.e. `remote_folder`)
+  # @note It accepts modify the targt SFTP in subclasses by defining two constants:
+  #   - `BASE_PATH` (String)
+  #   - `ENV_PATHS` (Hash)
+  # @note it makes public all methods of the `Files::Sftp` module.
   class Sftp
+    include Eco::Language::Methods::AccessModifier
     include Eco::API::UseCases::Lib::Files::Sftp
-    public(*Eco::API::UseCases::Lib::Files::Sftp.private_instance_methods(inherited: false))
+
+    make_public_all from: Eco::API::UseCases::Lib::Files::Sftp, inherited: false
 
     include WithTargetConfig
 

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

@@ -26,7 +26,7 @@ module Eco
         end
 
         def source_object
-          return nil unless callback_from_loader?
+          return unless callback_from_loader?
 
           callback_self
         end
@@ -77,7 +77,7 @@ module Eco
         attr_reader :callback
 
         def callback_self
-          eval("self", callback.binding, __FILE__, __LINE__)
+          eval('self', callback.binding, __FILE__, __LINE__)
         end
 
         def callback_from_loader?
@@ -86,6 +86,7 @@ module Eco
 
         # Set the instance variables `@session` and `@options`
         # in the use case definition
+        # @todo check if this method shouldn't really just be part of `uio`
         # @note this only works when the use case was defined
         #   via an children class of `Eco::API::Common::Loaders::Base`
         def set_session_n_options(uio) # rubocop:disable Naming/AccessorMethodName

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

@@ -0,0 +1,5 @@
+class Eco::API::UseCases
+  class Workflow < Eco::Language::Models::Workflow
+    INPUT_OUTPUT_CLASS = Eco::API::UseCases::BaseIO
+  end
+end

data/lib/eco/api/usecases.rb

@@ -19,7 +19,7 @@ module Eco
         end
       end
 
-      extend  Eco::API::Common::ClassAutoLoader
+      extend  Eco::Language::Klass::AutoLoader
       include Enumerable
 
       autoloads_children_of 'Eco::API::Common::Loaders::UseCase'
@@ -29,6 +29,7 @@ module Eco
         @usecases      = {}
         @cache_init    = false
         @cases_by_name = {}
+
         init_caches
       end
 
@@ -52,6 +53,7 @@ module Eco
 
       def defined?(name, type: nil)
         return to_h.key?(key(name, type)) if type
+
         name?(name)
       end
 
@@ -83,7 +85,8 @@ module Eco
         puts "Warning: overriding '#{type}' case #{name}" if self.defined?(name, type: type)
 
         to_h[key(name, type)] = usecase
-        @cache_init = false
+        @cache_init           = false
+
         usecase
       end
 
@@ -102,7 +105,9 @@ module Eco
         msg = "Expected a Eco::API::UseCases object. Given #{cases.class}"
         raise msg unless cases.is_a?(Eco::API::UseCases)
 
-        to_h.merge!(cases.to_h).transform_values do |usecase|
+        to_h.merge!(
+          cases.to_h
+        ).transform_values do |usecase|
           usecase.root = self
         end
 
@@ -126,6 +131,7 @@ module Eco
         elsif type
           raise UseCases::UnknownCase.new(case_name: name, type: type)
         end
+
         raise UseCases::UnknownCase.new(case_name: name, type: type) unless (cases = by_name[name])
         raise UseCases::AmbiguousCaseReference.new(case_name: name)  if cases.length > 1
 
@@ -148,10 +154,10 @@ module Eco
 
       def init_caches
         # first, make sure it loads pending `:custom_children` children to be loaded
-        re_init = self.class.autoload_children(self)
+        re_init = self.class.autoload_children!(self)
         return true if @cache_init && !re_init
 
-        @by_name = @usecases.values.group_by(&:name)
+        @by_name    = @usecases.values.group_by(&:name)
         @cache_init = true
       end
 
@@ -176,6 +182,7 @@ require_relative 'usecases/use_case_chain'
 require_relative 'usecases/base_io'
 require_relative 'usecases/use_case_io'
 require_relative 'usecases/cli'
+require_relative 'usecases/workflow'
 require_relative 'usecases/lib'
 require_relative 'usecases/service'
 require_relative 'usecases/graphql'

data/lib/eco/cli/scripting/args_helpers.rb

@@ -105,7 +105,7 @@ module Eco
           if required && !filename
             puts "You need to specify a file or folder '#{key} file_or_folder'"
             exit(1)
-          elsif should_exist && filename && !file_exists?(filename)
+          elsif should_exist && filename && !File.exist?(filename)
             puts "This file/folder doesn't exist '#{filename}'"
             exit(1)
           end
@@ -113,14 +113,6 @@ module Eco
           filename = File.expand_path(filename) if filename && should_exist
           filename
         end
-
-        private
-
-        def file_exists?(filename)
-          return false if filename.nil?
-
-          File.exist?(filename) || File.exist?(File.expand_path(filename))
-        end
       end
     end
   end