eco-helpers 3.0.20 → 3.0.22

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

@@ -0,0 +1,24 @@
+class Eco::API::UseCases::UseCaseIO
+  module Chain
+    def chain(usecase:)
+      msg = "It should be a Eco::API::UseCases::UseCase. Given: #{usecase.class}"
+      raise ArgumentError, msg unless usecase.is_a?(Eco::API::UseCases::UseCase)
+
+      #aux_io = self.class.new(input: input, data: data, session: session, options: options, usecase: usecase)
+      #kargs  = aux_io.params(keyed: true)
+      kargs = params(keyed: true, all: true).merge(usecase: usecase)
+      kargs.delete(:job)
+
+      case type
+      when :import
+        kargs[:input] = output
+      when :filter
+        kargs[:data] = output
+      when :transform, :sync, :export, :error_handler, :other
+        # no redirections => should it redirect the input?
+      end
+
+      self.class.new(**kargs)
+    end
+  end
+end

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

@@ -7,7 +7,8 @@ module Eco
       #  - provides a helper to `chain` InputOutput between usecases
       # @attr_reader usecase [Eco::API::UseCases::UseCase] the usecase this InputOuput is linked to
       class UseCaseIO < BaseIO
-        @types  = BaseIO.types
+        require_relative 'use_case_io/chain'
+        include Chain
 
         attr_reader :usecase
 
@@ -31,17 +32,28 @@ module Eco
 
         # @param value [Eco::API::UseCases::UseCase] the usecase this InputOuput should be linked to
         def usecase=(value)
-          raise "It should be a Eco::API::UseCases::UseCase. Given: #{value}" if !value.is_a?(Eco::API::UseCases::UseCase)
+          msg = "It should be a Eco::API::UseCases::UseCase. Given: #{value}"
+          raise ArgumentError, msg unless value.is_a?(Eco::API::UseCases::UseCase)
+
           @usecase = value
         end
 
         # @return [Symbol] the `type` of the UseCase this InputOuput is linked to
         def type
-          @usecase.type
+          usecase.type
+        end
+
+        # @return [Symbol] the `model` of the UseCase this InputOuput is linked to
+        def model
+          usecase.model
+        end
+
+        def type=(_value)
+          raise "Can't modify type: depends on the usecase linked to this IO object"
         end
 
-        def type=(value)
-          raise "Can't modify type depends on the usecase linked to this IO object"
+        def model=(_value)
+          raise "Can't modify model: depends on the usecase linked to this IO object"
         end
 
         # @see Eco::API::UseCases::BaseIO#params
@@ -57,23 +69,6 @@ module Eco
             end
           end
         end
-
-        def chain(usecase:)
-          raise "It should be a UseCase. Given: #{usecase}" if !usecase.is_a?(UseCase)
-          #aux_io = self.class.new(input: input, people: people, session: session, options: options, usecase: usecase)
-          #kargs  = aux_io.params(keyed: true)
-          kargs  = params(keyed: true, all: true).merge(usecase: usecase)
-          kargs.delete(:job)
-          case self.type
-          when :import
-            kargs[:input]  = output
-          when :filter
-            kargs[:people] = output
-          when :transform, :sync, :export, :error_handler, :other
-            # no redirections => should it redirect the input?
-          end
-          self.class.new(**kargs)
-        end
       end
     end
   end

data/lib/eco/api/usecases.rb

@@ -42,6 +42,7 @@ module Eco
 
       def each(&block)
         return to_enum(:each) unless block
+
         items.each(&block)
       end
 
@@ -59,8 +60,14 @@ module Eco
       end
 
       # @return [Eco::API::UseCases::UseCase] the `name` usecase of type `type` with the defined `block`.
-      def define(name, type:, &block)
-        Eco::API::UseCases::UseCase.new(name, type: type, root: self, &block).tap do |usecase|
+      def define(name, type:, model: nil, &block)
+        Eco::API::UseCases::UseCase.new(
+          name,
+          type:  type,
+          model: model,
+          root:  self,
+          &block
+        ).tap do |usecase|
           add(usecase)
         end
       end
@@ -69,11 +76,12 @@ module Eco
       # @param usecase [Eco::API::UseCases::UseCase] the usecase to be added.
       def add(usecase)
         msg = "Expected Eco::API::UseCases::UseCase object. Given: #{usecase.class}"
-        raise ArgumentError, msg if !usecase || !usecase.is_a?(Eco::API::UseCases::UseCase)
+        raise ArgumentError, msg unless usecase.is_a?(Eco::API::UseCases::UseCase)
 
         name = usecase.name
         type = usecase.type
         puts "Warning: overriding '#{type}' case #{name}" if self.defined?(name, type: type)
+
         to_h[key(name, type)] = usecase
         @cache_init = false
         usecase
@@ -107,7 +115,7 @@ module Eco
       end
 
       def types(name)
-        return nil unless name?(name)
+        return unless name?(name)
 
         by_name[name].map(&:type)
       end

data/lib/eco/assets.rb

@@ -32,7 +32,7 @@ module Eco
       @configs ||= {}
     end
 
-    def cli(&block)
+    def cli
       unless @cli_init
         @cli_init = true
         require_relative('cli_default')

data/lib/eco/cli/config/filters/people_filters.rb

@@ -3,23 +3,24 @@ module Eco
     class Config
       class Filters
         class PeopleFilters < Eco::CLI::Config::Filters
-
           def help(refine: nil)
             refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ""
             super("The following are the available filters on people#{refinement}:", refine: refine)
           end
 
           def process(io:)
-            unless io && io.is_a?(Eco::API::UseCases::BaseIO)
+            unless io.is_a?(Eco::API::UseCases::BaseIO)
               raise "You need to provide Eco::API::UseCases::BaseIO object. Given: #{io.class}"
             end
 
             io = io.new(type: :transform)
+
             @filters.each do |arg, callback|
-              if SCR.get_arg(arg)
-                io = io.new(people: callback.call(*io.params))
-              end
+              next unless SCR.get_arg(arg)
+
+              io = io.new(data: callback.call(*io.params))
             end
+
             io.people
           end
         end

data/lib/eco/cli/config/input.rb

@@ -17,8 +17,12 @@ module Eco
 
         def define(option: nil, &block)
           option ||= default_option
-          raise "Missing option to identify the input (no default defined)" unless !!option
-          raise "Missing block to define the input obtention process" unless block
+
+          msg = "Missing option to identify the input (no default defined)"
+          raise ArgumentError, msg unless option
+
+          msg = "Missing block to define the input obtention process"
+          raise ArgumentError, msg unless block_given?
 
           @callbacks[option] = block
         end

data/lib/eco/cli/config/use_cases.rb

@@ -57,7 +57,7 @@ module Eco
         # @param desc [String] description of the case.
         # @param case_name [String, nil] the name of the usecase as defined.
         def add(option_case, type, desc = nil, case_name: nil, &callback)
-          Eco::API::UseCases::UseCase.validate_type(type)
+          Eco::API::UseCases::UseCase.validate_type!(type)
 
           unless block_given?
             raise "You must specify a valid 'case_name' when no block is provided" unless case_name
@@ -154,7 +154,9 @@ module Eco
         def validate_io!(io)
           return if io.is_a?(Eco::API::UseCases::BaseIO)
 
-          raise ArgumentError, "You need to provide Eco::API::UseCases::BaseIO object. Given: #{io.class}"
+          msg  = "You need to provide Eco::API::UseCases::BaseIO object. "
+          msg << "Given: #{io.class}"
+          raise ArgumentError, msg
         end
       end
     end

data/lib/eco/cli_default/input.rb

@@ -1,6 +1,5 @@
-# rubocop:disable Metrics/BlockLength
-ASSETS.cli.config do |cnf|
-  formats = {
+class Eco::CliDefault::Input < Eco::API::Common::Loaders::CliConfig
+  FORMATS = {
     csv:  {
       option:  ["-csv"],
       extname: [".csv", ".txt"]
@@ -17,51 +16,74 @@ ASSETS.cli.config do |cnf|
       option:  ["-json"],
       extname: [".json"]
     }
-  }
+  }.freeze
 
-  cnf.input(default_option: "-entries-from") do |session, str_opt, options|
-    input = []
+  class << self
+    attr_reader :options, :session
 
+    def encoding
+      options.dig(:input, :file, :encoding)
+    end
+
+    def format_by_cli
+      FORMATS.reduce(nil) do |matched, (frm, selectors)|
+        next matched if matched
+
+        used = selectors[:option].reduce(false) do |us, option|
+          SCR.get_arg(option) || us
+        end
+
+        next frm if used
+      end
+    end
+
+    def format_by_ext(ext)
+      FORMATS.reduce(nil) do |matched, (frm, selectors)|
+        next matched if matched
+        next frm     if selectors[:extname].any? {|e| ext == e}
+      end
+    end
+  end
+
+  input(default_option: "-entries-from") do |session, str_opt, options|
+    @options = options
+    @session = session
+    input    = []
     next input unless SCR.get_arg(str_opt)
 
     file = SCR.get_file(str_opt, required: true)
 
     # Command line check
-    format = formats.reduce(nil) do |matched, (frm, selectors)|
-      used = selectors[:option].reduce(false) {|us, option| SCR.get_arg(option) || us}
-      next matched if matched
-      next frm     if used
-    end
+    format = format_by_cli
 
     # File/Folder check
     file = File.expand_path(file)
+
     if File.directory?(file)
       folder = file
       file   = Dir.glob("#{file}/*").reject {|f| File.directory?(f)}
-      ext    = (format && formats[format][:extname]) || [File.extname(file.first)]
-      file   = file.select {|f| ext.any? {|e| File.extname(f) == e}}.tap do |files|
-        if files.empty?
-          session.log(:error) {
-            "Could not find any file with extension: #{ext} in folder '#{folder}'"
-          }
-          exit(1)
-        end
+      ext    = FORMATS.dig(format, :extname)
+      ext  ||= [File.extname(file.first)]
+      file   = file.select do |f|
+        ext.any? {|e| File.extname(f) == e}
+      end.tap do |files|
+        next unless files.empty?
+
+        session.log(:error) {
+          "Could not find any file with extension: #{ext} in folder '#{folder}'"
+        }
+        exit(1)
       end
     else
-      ext = File.extname(file)
+      ext = [File.extname(file)]
     end
 
-    format ||= formats.reduce(nil) do |matched, (frm, selectors)|
-      next matched if matched
-      next frm     if selectors[:extname].any? {|e| ext == e}
-    end
+    format ||= format_by_ext(ext.first)
     format ||= :csv
 
-    options.deep_merge!(input: {file: {name: file}})
+    options.deep_merge!(input: {file: {name:   file}})
     options.deep_merge!(input: {file: {format: format}})
 
-    encoding = options.dig(:input, :file, :encoding)
-
     case format
     when :xml
       [file].flatten.each {|f| session.config.files.validate(:xml, f)}
@@ -83,5 +105,3 @@ ASSETS.cli.config do |cnf|
     input
   end
 end
-
-# rubocop:enable Metrics/BlockLength

data/lib/eco/cli_default/options.rb

@@ -69,7 +69,10 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       sch_id   = session.schemas.to_id(sch_name)
 
       unless sch_id
-        msg = "You need to specify a correct schema id or name. '#{sch_name}' does not exist"
+        msg = "You need to specify a correct schema id or name. "
+        msg << "'#{sch_name}' does not exist. Correct options are: "
+        msg << session.schemas.map(&:name).join(", ")
+
         session.log(:error) { msg }
         exit(1)
       end

data/lib/eco/cli_default/people.rb

@@ -1,69 +1,124 @@
-MAX_GET_PARTIAL = 12_000
+class Eco::CliDefault::People < Eco::API::Common::Loaders::CliConfig
+  MAX_GET_PARTIAL = 12_000
 
-ASSETS.cli.config do |cnf|
-  cnf.people do |input, session, options|
-    get         = options.dig(:people, :get)
-    get         = {} if get.nil?
+  class << self
+    attr_reader :options, :session
+    attr_writer :get_full, :get_partial
 
-    from_remote = get && get[:from] == :remote
-    from_local  = get && get[:from] == :local
+    def get_options # rubocop:disable Naming/AccessorMethodName
+      get = options.dig(:people, :get)
+      get = {} if get.nil?
+      get
+    end
+
+    def no_get?
+      get_options == false
+    end
 
-    get_full    = from_remote && get[:type] == :full
-    get_partial = from_remote && get[:type] == :partial
-    get_by_file = from_local  && get[:type] == :file
+    def from_remote?
+      return false unless get_options
+
+      get_options[:from] == :remote
+    end
+
+    def from_local?
+      return false unless get_options
+
+      get_options[:from] == :local
+    end
+
+    def get_full?
+      return @get_full  if instance_variable_defined?(:@get_full)
+      return false      unless from_remote?
+
+      get_options[:type] == :full
+    end
+
+    def get_partial?
+      return @get_partial if instance_variable_defined?(:@get_partial)
+      return false        unless from_remote?
+
+      @get_partial = (get_options[:type] == :partial)
+    end
+
+    def get_by_file?
+      return false unless from_local?
+
+      get_options[:type] == :file
+    end
+
+    def source_file
+      return unless get_by_file?
+
+      get_options[:file]
+    end
+
+    def switch_to_full_remote!
+      self.get_full    = true
+      self.get_partial = false
+
+      options.deep_merge!(people: {
+        get: {
+          from: :remote,
+          type: :full
+        }
+      })
+    end
+
+    def switch_to_full_local!
+      self.get_full    = true
+      self.get_partial = false
+
+      options.deep_merge!(people: {
+        get: {
+          from: :local,
+          type: :full
+        }
+      })
+    end
+
+    def optimize_get_partial!(input)
+      return unless get_partial?
 
-    # -get-partial: validate input present and under max
-    if get_partial
       msg = "To use -get-partial (partial updates), you need to use -entries-from"
       raise msg unless input.is_a?(Enumerable)
 
-      if input.count > MAX_GET_PARTIAL
-        get_full    = true
-        get_partial = false
-
-        msg  = "(Optimization) "
-        msg << "Switching from partial to full people download. "
-        msg << "Input (#{input.count}) surpases MAX_GET_PARTIAL "
-        msg << "(#{MAX_GET_PARTIAL}) entries."
-        session.log(:info) { msg }
-
-        options.deep_merge!(people: {
-          get: {
-            from: :remote,
-            type: :full
-          }
-        })
-      end
+      return unless input.count > MAX_GET_PARTIAL
+
+      msg  = "(Optimization) "
+      msg << "Switching from partial to full people download. "
+      msg << "Input (#{input.count}) surpases MAX_GET_PARTIAL "
+      msg << "(#{MAX_GET_PARTIAL}) entries."
+      session.log(:info) { msg }
+
+      switch_to_full_remote!
     end
+  end
+
+  people do |input, session, options|
+    @options = options
+    @session = session
 
-    if get == false
+    # -get-partial: validate input present and under max
+    optimize_get_partial!(input) if get_partial?
+
+    if no_get?
       Eco::API::Organization::People.new([])
-    elsif get_full
+    elsif get_full?
       # -get-people
       session.micro.people_cache
-    elsif get_partial
+    elsif get_partial?
       # -get-partial
       session.micro.people_search(input, options: options)
-    elsif get_by_file
+    elsif get_by_file?
       # -people-from-backup
-      session.micro.people_load(get[:file], modifier: :file)
+      session.micro.people_load(source_file, modifier: :file)
     else
-      options.deep_merge!(people: {
-        get: {
-          from: :local,
-          type: :full
-        }
-      })
-
+      switch_to_full_local!
       people = session.micro.people_load(modifier: %i[newest save])
 
       if people.empty?
-        options.deep_merge!(people: {
-          get: {
-            from: :remote,
-            type: :full
-          }
-        })
+        switch_to_full_remote!
         people = session.micro.people_cache
       end
 

data/lib/eco/cli_default/people_filters.rb

@@ -92,7 +92,10 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       sch_id   = session.schemas.to_id(sch_name)
 
       unless sch_id
-        msg = "You need to specify a correct schema id or name. '#{sch_name}' does not exist"
+        msg = "You need to specify a correct schema id or name. "
+        msg << "'#{sch_name}' does not exist. Correct options are: "
+        msg << session.schemas.map(&:name).join(", ")
+
         session.log(:error) { msg }
         exit(1)
       end
@@ -108,6 +111,7 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
         session.log(:info) {
           "Filtered #{filtered.count} people out of #{people.count} total"
         }
+
         people.newFrom filtered
       end
     end