eco-helpers 2.7.11 → 2.7.13

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

@@ -1,10 +1,10 @@
-class Eco::API::UseCases::Default::People::SupersHierarchy < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Treat::SupersHierarchy < Eco::API::Common::Loaders::UseCase
   name "supers-hierarchy"
   type :export
 
   attr_reader :people
 
-  def main(people, session, options, usecase)
+  def main(people, _session, options, _usecase)
     options[:end_get] = false
     @people = people
 
@@ -22,20 +22,19 @@ class Eco::API::UseCases::Default::People::SupersHierarchy < Eco::API::Common::L
   end
 
   def save!(data)
-    ext  = File.extname(file).downcase.delete(".")
-
-    File.open(file, "w") do |fd|
-      if ext == "txt"
-        create_file(data, file: file, format: :txt)
-      elsif ext == "html"
-        puts "html is still not supported"
-        exit(1)
-        create_file(data, file: file, format: :html)
-      elsif ext == "json"
-        puts "json is still not supported"
-        exit(1)
-        create_file(data, file: file, format: :json)
-      end
+    ext = File.extname(file).downcase.delete(".")
+
+    case ext
+    when "txt"
+      create_file(data, file: file, format: :txt)
+    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"
+      exit(1)
+      # create_file(data, file: file, format: :json)
     end
   end
 
@@ -50,7 +49,9 @@ class Eco::API::UseCases::Default::People::SupersHierarchy < Eco::API::Common::L
     raise "Required Hash tree structure. Given: #{tree.class}" unless tree.is_a?(Hash)
     "".tap do |str|
       tree.each do |entry, subtree|
-        str << "#{"  " * lev}#{(lev > 0)? "+-#{lev}- " : ""}#{entry.name} (#{entry.external_id}|#{entry.email}|#{entry.id})\n"
+        str << "#{"  " * lev}#{lev.positive? ? "+-#{lev}- " : ""}"
+        str << entry.name
+        str << " (#{entry.external_id}|#{entry.email}|#{entry.id})\n"
         str << tree_to_str(subtree, lev: lev + 1, format: format) unless !subtree || subtree.empty?
       end
     end

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

@@ -0,0 +1,9 @@
+module Eco::API::UseCases::Default::People
+  module Treat
+  end
+end
+
+require_relative 'treat/analyse_people_case'
+require_relative 'treat/supers_hierarchy_case'
+require_relative 'treat/supers_cyclic_identify_case'
+require_relative 'treat/org_data_convert_case'

data/lib/eco/api/usecases/default/people/{change_email_case.rb → utils/change_email_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::ChangeEMailCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Utils::ChangeEMailCase < Eco::API::Common::Loaders::UseCase
   name "change-email"
   type :sync
 

data/lib/eco/api/usecases/default/people/{set_default_tag_case.rb → utils/set_default_tag_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::SetDefaultTagCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Utils::SetDefaultTagCase < Eco::API::Common::Loaders::UseCase
   name "set-default-tag"
   type :transform
 

data/lib/eco/api/usecases/default/people/{switch_supervisor_case.rb → utils/switch_supervisor_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::SwitchSupervisorCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Utils::SwitchSupervisorCase < Eco::API::Common::Loaders::UseCase
   name "switch-supervisor"
   type :transform
 

data/lib/eco/api/usecases/default/people/{transfer_account_case.rb → utils/transfer_account_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::TransferAccountCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Utils::TransferAccountCase < Eco::API::Common::Loaders::UseCase
   name "transfer-account"
   type :sync
 

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

@@ -0,0 +1,9 @@
+module Eco::API::UseCases::Default::People
+  module Utils
+  end
+end
+
+require_relative 'utils/change_email_case'
+require_relative 'utils/set_default_tag_case'
+require_relative 'utils/switch_supervisor_case'
+require_relative 'utils/transfer_account_case'

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

@@ -9,17 +9,7 @@ module Eco
   end
 end
 
-require_relative 'people/analyse_people_case'
-require_relative 'people/change_email_case'
-require_relative 'people/clean_unknown_tags_case'
-require_relative 'people/clear_abilities_case'
-require_relative 'people/reinvite_trans_case'
-require_relative 'people/reinvite_sync_case'
-require_relative 'people/org_data_convert_case'
-require_relative 'people/refresh_case'
-require_relative 'people/restore_db_case'
-require_relative 'people/set_default_tag_case'
-require_relative 'people/supers_hierarchy_case'
-require_relative 'people/supers_cyclic_identify_case'
-require_relative 'people/switch_supervisor_case'
-require_relative 'people/transfer_account_case'
+require_relative 'people/treat'
+require_relative 'people/utils'
+require_relative 'people/amend'
+require_relative 'people/migrate'

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

@@ -0,0 +1,15 @@
+class Eco::API::UseCases::Default::People::Utils::SplitCsv
+  class Cli < Eco::API::UseCases::Cli
+    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)
+      options.deep_merge!(output: {file: {max_rows: count}})
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+class Eco::API::UseCases::Default::People::Utils::SplitCsv < Eco::API::Common::Loaders::UseCase
+  require_relative 'cli/split_csv_cli'
+
+  MAX_ROWS = 15_000
+
+  name "split-csv"
+  type :other
+
+  def main(*_args)
+    Eco::CSV.split(input_file, max_rows: max_rows).each do |file|
+      log(:info) {
+        "Generated file '#{file}'"
+      }
+    end
+  end
+
+  private
+
+  def input_file
+    options.dig(:source, :file)
+  end
+
+  def max_rows
+    max_rows_options || self.class::MAX_ROWS
+  end
+
+  def max_rows_options
+    return nil unless (num = options.dig(:output, :file, :max_rows))
+
+    num = num.to_i
+    num = nil if num.zero?
+    num
+  end
+end

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

@@ -0,0 +1,12 @@
+module Eco
+  module API
+    class UseCases
+      class Default
+        module Utils
+        end
+      end
+    end
+  end
+end
+
+require_relative 'utils/split_csv_case'

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

@@ -14,3 +14,4 @@ end
 
 require_relative 'default/people'
 require_relative 'default/locations'
+require_relative 'default/utils'

data/lib/eco/api/usecases/graphql/samples/location/command/service/tree_update.rb

@@ -69,8 +69,7 @@ class Eco::API::UseCases::GraphQL::Samples::Location
         end
 
         # Generates the file and pushes to the SFTP folder
-        # @note this method can only work if we can run cummulative dry-runs to the back-end.
-        #   This is only possible using a draft, which is not that desired.
+        # @note it also displays the mappings on screen
         # @note the SFTP push only happens if `remote_subfolder` is defined, via:
         #   1. `options.dig(:sftp, :remote_subfolder)`
         #   2. `REMOTE_FOLDER` const

data/lib/eco/api/usecases/graphql/samples/location/command/track_changed_ids.rb

@@ -25,10 +25,10 @@ class Eco::API::UseCases::GraphQL::Samples::Location
     end
 
     # Generates the file
-    # @note this method can only work if we can run cummulative dry-runs to the back-end.
-    #   This is only possible using a draft, which is not that desired.
+    # @note this method used to only work if we could run cummulative dry-runs to the back-end.
+    #   However, after RS P3, as mappings are one-to-one (not many-to-many per row),
+    #   we can just display the mappings in dry-run as well.
     def close_handling_tags_remap_csv
-      return false if simulate?
       if tags_remap_table.any?
         puts "REMAP LOC IDs CSV (content):"
         puts tags_remap_table

data/lib/eco/csv/split.rb

@@ -0,0 +1,114 @@
+module Eco
+  class CSV
+    class Split
+      include Eco::Language::AuxiliarLogger
+
+      attr_reader :filename
+
+      def initialize(filename, max_rows:, **kargs)
+        raise ArgumentError, "File '#{filename}' does not exist" unless ::File.exist?(filename)
+        @filename = filename
+        @max_rows = max_rows
+        @params   = kargs
+        init
+      end
+
+      # @yield [idx, file] a block to spot the filename
+      # @yieldparam idx [Integer] the number of the file
+      # @yieldparam file [String] the default name of the file
+      # @yieldreturn [String] the filename of the file `idx`.
+      #   - If `nil` it will create its own filename convention
+      # @return [Array<String>] names of the generated files
+      def call(&block)
+        stream.for_each do |row, ridx|
+          copy_row(row, ridx, &block)
+        end
+        out_files
+      ensure
+        puts "Close at row #{row_idx}"
+        @csv&.close
+      end
+
+      private
+
+      attr_reader :params
+      attr_reader :idx, :max_rows
+      attr_reader :headers, :row_idx
+
+      attr_accessor :exception
+
+      def copy_row(row, ridx, &block)
+        @headers ||= row.headers
+        @row_idx   = ridx
+        current_csv(ridx, &block) << row.fields
+      end
+
+      def current_csv(ridx)
+        if split?(ridx) || @csv.nil?
+          puts "Split at row #{row_idx}"
+          @csv&.close
+          out_filename = generate_name(nidx = next_idx)
+          out_filename = yield(nidx, out_filename) if block_given?
+          @csv       = ::CSV.open(out_filename, "w")
+          @csv      << headers
+          out_files << out_filename
+        end
+        @csv
+      end
+
+      def split?(ridx)
+        ((ridx + 1) % max_rows).zero?
+      end
+
+      def next_idx
+        idx.tap { @idx += 1 }
+      end
+
+      def init
+        @idx ||= 0 # rubocop:disable Naming/MemoizedInstanceVariableName
+      end
+
+      def stream
+        @stream ||= Eco::CSV::Stream.new(filename, **params)
+      end
+
+      def generate_name(fidx)
+        File.join(input_dir, "#{input_name}_#{file_number(fidx)}#{input_ext}")
+      end
+
+      def file_number(num)
+        "#{zeroed}#{num}"[-5..]
+      end
+
+      def zeroed
+        "0" * 5
+      end
+
+      def out_files
+        @out_files ||= []
+      end
+
+      def input_name
+        @input_name ||= File.basename(input_basename, input_ext)
+      end
+
+      def input_ext
+        @input_ext ||= input_basename.split('.')[1..].join('.').then do |name|
+          ".#{name}"
+        end
+      end
+
+      def input_basename
+        @input_basename ||= File.basename(input_full_filename)
+      end
+
+      def input_dir
+        @input_dir = File.dirname(input_full_filename)
+      end
+
+      def input_full_filename
+        @input_full_filename ||= File.expand_path(filename)
+      end
+    end
+  end
+end

data/lib/eco/csv/stream.rb

@@ -0,0 +1,66 @@
+module Eco
+  class CSV
+    class Stream
+      include Eco::Language::AuxiliarLogger
+
+      attr_reader :filename
+
+      def initialize(filename, **kargs)
+        raise ArgumentError, "File '#{filename}' does not exist" unless ::File.exist?(filename)
+        @filename = filename
+        @params   = {
+          headers:     true,
+          skip_blanks: true
+        }.merge(kargs)
+        init
+      end
+
+      def for_each(start_at_idx: 0)
+        raise ArgumentError, 'Expecting block, but not given.' unless block_given?
+
+        move_to_idx(start_at_idx)
+
+        yield(row, next_idx) while (self.row = csv.shift)
+      rescue StandardError => err
+        self.exception = err
+        raise
+      ensure
+        (fd.close; @fd = nil) if fd.is_a?(::File) # rubocop:disable Style/Semicolon
+        if exception
+          # Give some feedback if it crashes
+          msg  = []
+          msg << "Last row IDX: #{idx}"
+          msg << "Last row content: #{row.to_h.pretty_inspect}"
+          puts msg
+          log(:debug) { msg.join("\n") }
+        end
+      end
+
+      def move_to_idx(start_at_idx)
+        next_idx while (idx < start_at_idx) && (self.row = csv.shift)
+      end
+
+      private
+
+      attr_reader :params
+      attr_reader :idx, :fd
+
+      attr_accessor :row, :exception
+
+      def next_idx
+        idx.tap { @idx += 1 }
+      end
+
+      # see https://dalibornasevic.com/posts/68-processing-large-csv-files-with-ruby
+      def csv
+        return @csv if instance_variable_defined?(:@csv)
+        @fd  = ::File.open(filename, 'r')
+        @csv = Eco::CSV.new(fd, **params)
+      end
+
+      def init
+        @idx ||= 0 # rubocop:disable Naming/MemoizedInstanceVariableName
+      end
+    end
+  end
+end

data/lib/eco/csv.rb

@@ -17,8 +17,22 @@ module Eco
         end
         parse(get_file_content(file, **params), **kargs)
       end
+
+      # @yield [idx, file] a block to spot the filename
+      # @yieldparam idx [Integer] the number of the file
+      # @yieldparam file [String] the default name of the file
+      # @yieldreturn [String] the filename of the file `idx`.
+      #   - If `nil` it will create its own filename convention
+      # @param filename [String] the orignal file
+      # @param max_rows [Integer] number of rows per file
+      # @see Eco::CSV::Split#call
+      def split(filename, max_rows:, **kargs, &block)
+        Eco::CSV::Split.new(filename, max_rows: max_rows, **kargs).call(&block)
+      end
     end
   end
 end
 
 require_relative 'csv/table'
+require_relative 'csv/stream'
+require_relative 'csv/split'

data/lib/eco/language/basic_logger.rb

@@ -19,12 +19,12 @@ module Eco
       attr_writer :timestamp
       attr_reader :level
 
-      forward *LOG_LEVELS, *METHODS
+      forward(*LOG_LEVELS, *METHODS)
 
       def initialize(level: ::Logger::INFO, timestamp: false)
         @level             = level
         self.timestamp     = timestamp
-        loggers[:console]  = ::Logger.new(STDOUT).tap do |logger|
+        loggers[:console]  = ::Logger.new($stdout).tap do |logger|
           logger.formatter = format_proc(console: true)
           logger.level     = level
         end
@@ -41,7 +41,7 @@ module Eco
       private
 
       def forward(meth, *args, &block)
-        loggers.each do |_key, logger|
+        loggers.each_value do |logger|
           logger.send(meth, *args, &block)
         end
       end
@@ -52,6 +52,7 @@ module Eco
 
       def console_timestamp(datetime)
         return nil unless timestamp?
+
         timestamp(datetime)
       end
 
@@ -62,10 +63,10 @@ module Eco
       end
 
       def format_proc(console: true, &block)
-        proc do |severity, datetime, progname, msg|
-          str_stamp     = console ? console_timestamp(datetime) : timestamp(datetime)
+        proc do |severity, datetime, _progname, msg|
+          str_stamp = console ? console_timestamp(datetime) : timestamp(datetime)
           "#{severity.to_s[0]}: #{str_stamp}#{msg}\n".tap do |formatted_msg|
-            block.call(severity, datetime, msg, formatted_msg) if block
+            block&.call(severity, datetime, msg, formatted_msg)
           end
         end
       end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '2.7.11'.freeze
+  VERSION = '2.7.13'.freeze
 end