eco-helpers 3.0.29 → 3.0.31

data/lib/eco/api/usecases/default/people/treat/supers_hierarchy_case.rb

@@ -1,12 +1,12 @@
 class Eco::API::UseCases::Default::People::Treat::SupersHierarchy < Eco::API::Common::Loaders::UseCase
-  name "supers-hierarchy"
+  name 'supers-hierarchy'
   type :export
 
   require_relative 'cli/supers_hierachy_cli'
 
-  OUT_FOLDER      = "sftp".freeze
+  OUT_FOLDER      = 'sftp'.freeze
   OUT_TIME_FORMAT = '%Y%m%dT%H%M%S'.freeze
-  OUT_FILENAME    = "supers_hierarchy".freeze
+  OUT_FILENAME    = 'supers_hierarchy'.freeze
 
   def main(*_args)
     options[:end_get] = false
@@ -20,24 +20,24 @@ class Eco::API::UseCases::Default::People::Treat::SupersHierarchy < Eco::API::Co
   end
 
   def save!(data, file:)
-    ext = File.extname(file).downcase.delete(".")
+    ext = File.extname(file).downcase.delete('.')
 
     case ext
-    when "txt"
+    when 'txt'
       create_file(data, file: file, format: :txt)
-    when "html"
-      puts "html is still not supported"
+    when 'html'
+      puts 'html is still not supported'
       exit(1)
       # create_file(data, file: file, format: :html)
-    when "json"
-      puts "json is still not supported"
+    when 'json'
+      puts 'json is still not supported'
       exit(1)
       # create_file(data, file: file, format: :json)
     end
   end
 
   def create_file(tree, file:, format: :txt)
-    File.open(file, "w") do |fd|
+    File.open(file, 'w') do |fd|
       fd << tree_to_str(tree, format: format)
     end
 
@@ -50,9 +50,9 @@ class Eco::API::UseCases::Default::People::Treat::SupersHierarchy < Eco::API::Co
     msg = "Required Hash tree structure. Given: #{tree.class}"
     raise msg unless tree.is_a?(Hash)
 
-    "".tap do |str|
+    ''.tap do |str|
       tree.each do |entry, subtree|
-        str << "#{"  " * lev}#{lev.positive? ? "+-#{lev}- " : ""}"
+        str << "#{'  ' * lev}#{lev.positive? ? "+-#{lev}- " : ''}"
         str << (entry.name || entry.email || entry.external_id || entry.id)
         str << " (#{entry.external_id}|#{entry.email}|#{entry.id})\n"
         str << tree_to_str(subtree, lev: lev + 1, format: format) unless !subtree || subtree.empty?

data/lib/eco/api/usecases/default/utils/cli/entries_to_csv_cli.rb

@@ -0,0 +1,20 @@
+class Eco::API::UseCases::Default::Utils::EntriesToCsv
+  class Cli < Eco::API::UseCases::Cli
+    desc 'Input file dump into a CSV as is.'
+
+    str_desc  = 'The name of the parsing phase at which the input rows '
+    str_desc << 'have been brought at (default: internal, with parsed values)'
+    add_option('-phase', str_desc) do |options|
+      phase = SCR.get_arg('-phase', with_param: true)
+      options.deep_merge!(export: {parsing_phase: phase})
+    end
+
+    add_option('-out', 'The name of the file to export') do |options|
+      next unless (file = SCR.get_file(cli_name, required: false, should_exist: false))
+
+      options.deep_merge!(
+        export: {file: file}
+      )
+    end
+  end
+end

data/lib/eco/api/usecases/default/utils/cli/group_csv_cli.rb

@@ -12,13 +12,13 @@ class Eco::API::UseCases::Default::Utils::GroupCsv
       end
     end
 
-    add_option("-start-at", "Get only the last N-start_at rows") do |options|
-      count = SCR.get_arg("-start-at", with_param: true)
+    add_option('-start-at', 'Get only the last N-start_at rows') do |options|
+      count = SCR.get_arg('-start-at', with_param: true)
       options.deep_merge!(input: {file: {start_at: count}})
     end
 
     add_option('-by', 'The column that should be used to group') do |options|
-      if (file = SCR.get_arg("-by", with_param: true))
+      if (file = SCR.get_arg('-by', with_param: true))
         options.deep_merge!(input: {group_by_field: file})
       end
     end

data/lib/eco/api/usecases/default/utils/cli/json_to_csv_cli.rb

@@ -1,6 +1,6 @@
 class Eco::API::UseCases::Default::Utils::JsonToCsv
   class Cli < Eco::API::UseCases::Cli
-    desc "Transforms an input JSON file into a CSV one."
+    desc 'Transforms an input JSON file into a CSV one.'
 
     callback do |_sess, options, _case|
       file = SCR.get_file(cli_name, required: true, should_exist: true)

data/lib/eco/api/usecases/default/utils/cli/sort_csv_cli.rb

@@ -9,7 +9,7 @@ class Eco::API::UseCases::Default::Utils::SortCsv
     end
 
     add_option('-by', 'The column that should be used to sorting') do |options|
-      if (file = SCR.get_arg("-by", with_param: true))
+      if (file = SCR.get_arg('-by', with_param: true))
         options.deep_merge!(input: {sort_by: file})
       end
     end

data/lib/eco/api/usecases/default/utils/cli/split_csv_cli.rb

@@ -1,19 +1,19 @@
 class Eco::API::UseCases::Default::Utils::SplitCsv
   class Cli < Eco::API::UseCases::Cli
-    desc "Splits an input file into multiple ones"
+    desc 'Splits an input file into multiple ones'
 
     callback do |_sess, options, _case|
       file = SCR.get_file(cli_name, required: true, should_exist: true)
       options.deep_merge!(source: {file: file})
     end
 
-    add_option("-max-rows", "The max count of rows of the output files") do |options|
-      count = SCR.get_arg("-max-rows", with_param: true)
+    add_option('-max-rows', 'The max count of rows of the output files') do |options|
+      count = SCR.get_arg('-max-rows', with_param: true)
       options.deep_merge!(output: {file: {max_rows: count}})
     end
 
-    add_option("-start-at", "Get only the last N-start_at rows") do |options|
-      count = SCR.get_arg("-start-at", with_param: true)
+    add_option('-start-at', 'Get only the last N-start_at rows') do |options|
+      count = SCR.get_arg('-start-at', with_param: true)
       options.deep_merge!(output: {file: {start_at: count}})
     end
   end

data/lib/eco/api/usecases/default/utils/cli/split_json_cli.rb

@@ -7,8 +7,8 @@ class Eco::API::UseCases::Default::Utils::SplitJson
       options.deep_merge!(source: {file: file})
     end
 
-    add_option("-max-items", "The max count of items of the output files") do |options|
-      count = SCR.get_arg("-max-items", with_param: true)
+    add_option('-max-items', 'The max count of items of the output files') do |options|
+      count = SCR.get_arg('-max-items', with_param: true)
       options.deep_merge!(output: {file: {max_items: count}})
     end
   end

data/lib/eco/api/usecases/default/utils/entries_to_csv_case.rb

@@ -0,0 +1,39 @@
+class Eco::API::UseCases::Default::Utils::EntriesToCsv < Eco::API::Common::Loaders::UseCase
+  name 'entries-to-csv'
+  type :import
+
+  require_relative 'cli/entries_to_csv_cli'
+
+  DEFAULT_PARSING_STAGE = :internal
+  OUT_FOLDER            = 'sftp'.freeze
+
+  def main(*_args)
+    input.export(
+      filename,
+      parsing_phase: parsing_phase.to_sym
+    )
+
+    log(:info) {
+      "Generated file: #{filename}"
+    }
+  end
+
+  private
+
+  def filename
+    @filename ||= File.join(
+      config.active_enviro,
+      self.class::OUT_FOLDER,
+      basename
+    )
+  end
+
+  def basename
+    options.dig(:export, :file) || 'entries.csv'
+  end
+
+  def parsing_phase
+    options.dig(:export, :parsing_phase) ||
+      self.class::DEFAULT_PARSING_STAGE
+  end
+end

data/lib/eco/api/usecases/default/utils/group_csv_case.rb

@@ -116,7 +116,7 @@ class Eco::API::UseCases::Default::Utils::GroupCsv < Eco::API::Custom::UseCase
     return true unless row[group_by_field].to_s.strip.empty?
 
     msg  = "Row #{idx} doesn't have value for pivot field '#{group_by_field}'"
-    msg << ". Skipping (discared) ..."
+    msg << '. Skipping (discared) ...'
     log(:warn) { msg }
     false
   end
@@ -200,8 +200,8 @@ class Eco::API::UseCases::Default::Utils::GroupCsv < Eco::API::Custom::UseCase
       next unless flds.empty?
 
       log(:warn) {
-        msg  = "There were no fields to be grouped/joined. "
-        msg << "This is equivalent to launch a unique operation."
+        msg  = 'There were no fields to be grouped/joined. '
+        msg << 'This is equivalent to launch a unique operation.'
         msg
       }
     end

data/lib/eco/api/usecases/default/utils/sort_csv_case.rb

@@ -114,7 +114,7 @@ class Eco::API::UseCases::Default::Utils::SortCsv < Eco::API::Custom::UseCase
     @sort_field ||= opts_sort_by.tap do |pivot|
       next if pivot
 
-      msg = "The pivot field should be specified with -by option"
+      msg = 'The pivot field should be specified with -by option'
 
       log(:error) { msg }
       raise msg

data/lib/eco/api/usecases/default/utils/split_csv_case.rb

@@ -3,7 +3,7 @@ class Eco::API::UseCases::Default::Utils::SplitCsv < Eco::API::Common::Loaders::
 
   MAX_ROWS = 15_000
 
-  name "split-csv"
+  name 'split-csv'
   type :other
 
   def main(*_args)
@@ -19,7 +19,7 @@ class Eco::API::UseCases::Default::Utils::SplitCsv < Eco::API::Common::Loaders::
       ).tap do |split|
         msg  = []
         msg << "Total rows copied: #{split.copy_count} (out of #{split.total_count})"
-        msg << "Generated files:"
+        msg << 'Generated files:'
         split.out_files.each do |file|
           msg << "  * #{file}'"
         end
@@ -44,7 +44,7 @@ class Eco::API::UseCases::Default::Utils::SplitCsv < Eco::API::Common::Loaders::
   end
 
   def max_rows_options
-    return nil unless (num = options.dig(:output, :file, :max_rows))
+    return unless (num = options.dig(:output, :file, :max_rows))
 
     num = num.to_i
     num = nil if num.zero?
@@ -52,7 +52,7 @@ class Eco::API::UseCases::Default::Utils::SplitCsv < Eco::API::Common::Loaders::
   end
 
   def start_at
-    return nil unless (num = options.dig(:output, :file, :start_at))
+    return unless (num = options.dig(:output, :file, :start_at))
 
     num = num.to_i
     num = nil if num.zero?

data/lib/eco/api/usecases/default/utils/split_json_case.rb

@@ -3,7 +3,7 @@ class Eco::API::UseCases::Default::Utils::SplitJson < Eco::API::Common::Loaders:
 
   MAX_ITEMS = 15_000
 
-  name "split-json"
+  name 'split-json'
   type :other
 
   def main(*_args)
@@ -15,7 +15,7 @@ class Eco::API::UseCases::Default::Utils::SplitJson < Eco::API::Common::Loaders:
 
       msg  = []
       msg << "Total elements: #{total_count}"
-      msg << "Generated files:"
+      msg << 'Generated files:'
       out_files.each do |file|
         msg << "  * #{file}'"
       end
@@ -115,11 +115,13 @@ class Eco::API::UseCases::Default::Utils::SplitJson < Eco::API::Common::Loaders:
 
     if curr_json.empty?
       log(:info) {
-        msg  = "No pending elements to be transferred "
+        msg  = 'No pending elements to be transferred '
         msg << "(skipping creation of file '#{curr_file}')"
         msg
       }
-      out_files -= [curr_file]
+
+      @out_files = out_files - [curr_file]
+
       return
     end
 
@@ -139,7 +141,7 @@ class Eco::API::UseCases::Default::Utils::SplitJson < Eco::API::Common::Loaders:
 
       fd << '['
       data.each do |elem|
-        fd << "," unless first
+        fd << ',' unless first
         first = false
 
         fd << elem.to_json
@@ -180,7 +182,7 @@ class Eco::API::UseCases::Default::Utils::SplitJson < Eco::API::Common::Loaders:
   end
 
   def zeroed
-    "0" * 5
+    '0' * 5
   end
 
   # INPUT FILE

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

@@ -14,3 +14,4 @@ require_relative 'utils/split_json_case'
 require_relative 'utils/json_to_csv_case'
 require_relative 'utils/sort_csv_case'
 require_relative 'utils/group_csv_case'
+require_relative 'utils/entries_to_csv_case'

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

@@ -17,7 +17,6 @@ require_relative 'default_cases/create_case'
 require_relative 'default_cases/delete_trans_case'
 require_relative 'default_cases/delete_sync_case'
 require_relative 'default_cases/hris_case'
-require_relative 'default_cases/entries_to_csv_case'
 require_relative 'default_cases/to_csv_case'
 require_relative 'default_cases/to_csv_detailed_case'
 require_relative 'default_cases/update_case'

data/lib/eco/api/usecases/graphql/samples/location/service/tree_diff/convertible/inputable.rb

@@ -46,7 +46,10 @@ module Eco::API::UseCases::GraphQL::Samples::Location::Service
         end
 
         def input_folder
-          File.join(config.active_enviro, self.class::IN_FOLDER)
+          File.join(
+            config.active_enviro,
+            self.class::IN_FOLDER
+          )
         end
       end
     end

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

@@ -59,7 +59,11 @@ module Eco::API::UseCases::Lib::Files
     def sftp_move_file(source, dest)
       sftp.move(source, dest, 0x0001) do |response|
         if response.ok?
-          log(:info) { "#{source}\n  -to-> #{dest}"    }
+          log(:info) {
+            msg  = 'Moving file '
+            msg << "#{source}\n  -to-> #{dest}"
+            msg
+          }
         else
           log(:info) { "Could not move file #{source}" }
         end

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

@@ -101,10 +101,11 @@ module Eco
         # @return [String] the filename.
         def get_file(key, required: false, should_exist: true)
           filename = get_arg(key, with_param: true)
-          if !filename && required
+
+          if required && !filename
             puts "You need to specify a file or folder '#{key} file_or_folder'"
             exit(1)
-          elsif !file_exists?(filename) && should_exist && required
+          elsif should_exist && filename && !file_exists?(filename)
             puts "This file/folder doesn't exist '#{filename}'"
             exit(1)
           end

data/lib/eco/cli_default/input.rb

@@ -49,6 +49,7 @@ class Eco::CliDefault::Input < Eco::API::Common::Loaders::CliConfig
     @options = options
     @session = session
     input    = []
+
     next input unless SCR.get_arg(str_opt)
 
     file = SCR.get_file(str_opt, required: true)

data/lib/eco/cli_default/usecases.rb

@@ -46,13 +46,6 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       end
     end
 
-    desc = 'Input file dump into a CSV as is.'
-    cases.add('-entries-to-csv', :import, desc, case_name: 'entries-to-csv')
-    .add_option('-out') do |options|
-      file = SCR.get_file('-out')
-      options.deep_merge!(export: {file: file})
-    end
-
     desc  = 'Clears the `permissions_custom`, provided that Policy Group abilities alone apply.'
     desc << ' Please be mindfull if you use this option (there may be users that have been upgraded in ad-hoc manner).'
     cases.add('-clear-abilities', :transform, desc, case_name: 'clear-abilities')

data/lib/eco/data/files/helpers.rb

@@ -115,7 +115,10 @@ module Eco
         end
 
         def folder_files(folder = '.', pattern = '*', regexp: nil, older_than: nil)
+          return [] unless folder.is_a?(String)
+
           target = File.join(File.expand_path(folder), pattern)
+
           Dir[target].tap do |dir_files|
             dir_files.select! {|f| File.file?(f)}
 

data/lib/eco/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.29
+  version: 3.0.31
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -243,7 +243,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.9
+        version: 0.10.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -253,7 +253,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.9
+        version: 0.10.10
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-graphql
   requirement: !ruby/object:Gem::Requirement
@@ -796,11 +796,13 @@ files:
 - lib/eco/api/usecases/default/people/utils/switch_supervisor_case.rb
 - lib/eco/api/usecases/default/people/utils/transfer_account_case.rb
 - lib/eco/api/usecases/default/utils.rb
+- lib/eco/api/usecases/default/utils/cli/entries_to_csv_cli.rb
 - lib/eco/api/usecases/default/utils/cli/group_csv_cli.rb
 - lib/eco/api/usecases/default/utils/cli/json_to_csv_cli.rb
 - lib/eco/api/usecases/default/utils/cli/sort_csv_cli.rb
 - lib/eco/api/usecases/default/utils/cli/split_csv_cli.rb
 - lib/eco/api/usecases/default/utils/cli/split_json_cli.rb
+- lib/eco/api/usecases/default/utils/entries_to_csv_case.rb
 - lib/eco/api/usecases/default/utils/group_csv_case.rb
 - lib/eco/api/usecases/default/utils/json_to_csv_case.rb
 - lib/eco/api/usecases/default/utils/sort_csv_case.rb
@@ -810,7 +812,6 @@ files:
 - lib/eco/api/usecases/default_cases/create_case.rb
 - lib/eco/api/usecases/default_cases/delete_sync_case.rb
 - lib/eco/api/usecases/default_cases/delete_trans_case.rb
-- lib/eco/api/usecases/default_cases/entries_to_csv_case.rb
 - lib/eco/api/usecases/default_cases/hris_case.rb
 - lib/eco/api/usecases/default_cases/samples.rb
 - lib/eco/api/usecases/default_cases/samples/sftp.rb

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

@@ -1,14 +0,0 @@
-class Eco::API::UseCases::DefaultCases::EntriesToCsv < Eco::API::Common::Loaders::UseCase
-  name "entries-to-csv"
-  type :import
-
-  def main(*_args)
-    input.export(filename)
-  end
-
-  private
-
-  def filename
-    options.dig(:export, :file) || "entries.csv"
-  end
-end