eco-helpers 3.0.4 → 3.0.7

data/lib/eco/cli_default/usecases.rb

@@ -1,55 +1,5 @@
-ASSETS.cli.config do |cnf|
-  cnf.usecases do |cases|
-
-    desc = "Draws the Supervisors hiearchy in a file"
-    cases.add("-supers-hierarchy", :export, desc, case_name: "supers-hierarchy") do |people, session, options|
-      options.deep_merge!(output: {file: "supers_hierarchy.txt"}) unless options.dig(:output, :file)
-    end.add_option("-to", "Specify the output file") do |options|
-      file = SCR.get_file("-to", required: true, should_exist: false)
-      options.deep_merge!(output: {file: file})
-    end
-
-    desc = "Draws the Cyclic Supervisors when identified"
-    cases.add("-identify-cyclic-supers", :export, desc, case_name: "identify-cyclic-supers") do |people, session, options|
-      options.deep_merge!(output: {file: "cyclic_supers.txt"}) unless options.dig(:output, :file)
-    end.add_option("-to", "Specify the output file") do |options|
-      file = SCR.get_file("-to", required: true, should_exist: false)
-      options.deep_merge!(output: {file: file})
-    end
-
-    desc = "Provides a set of tools to analyse a set of people (i.e. detect duplicates)"
-    cases.add("-analyse-people", :export, desc, case_name: "analyse-people") do |people, session, options|
-      options.deep_merge!(output: {file: "people_analysis.txt"}) unless options.dig(:output, :file)
-      #unless options.dig(:usecase, :analyse_people, :use_field)
-      #  options.deep_merge!(usecase: {analyse_people: {use_field: :name}})
-      #end
-    end.add_option("-to", "Specify the output file.") do |options|
-      file = SCR.get_file("-to", required: true, should_exist: false)
-      options.deep_merge!(output: {file: file})
-    end.add_option("-identify-duplicates", "Generates a list of people with possible duplicates.") do |options|
-      options.deep_merge!(usecase: {analyse_people: {identify_duplicates: true}})
-    end.add_option("-use-field", "Works with -identify-duplicates. Sets field to be used in the comparison.") do |options|
-      expression = SCR.get_arg("-use-field", with_param: true)
-      options.deep_merge!(usecase: {analyse_people: {use_field: expression}})
-    end.add_option("-facet-field", "Works with -identify-duplicates. Adds an additional layer of comparison.") do |options|
-      expression = SCR.get_arg("-facet-field", with_param: true)
-      options.deep_merge!(usecase: {analyse_people: {facet_field: expression}})
-    end.add_option("-only-screening", "Works with -identify-duplicates. Skips the rearrangement stage.") do |options|
-      options.deep_merge!(usecase: {analyse_people: {only_screening: true}})
-    end.add_option("-ignore-matching-words", "Works with -identify-duplicates. Re-adjust scores ignoring matching words.") do |options|
-      options.deep_merge!(usecase: {analyse_people: {ignore_matching_words: true}})
-    end.add_option("-unique-words", "Works with -identify-duplicates. Re-adjust the comparing strings to do not have repeated words.") do |options|
-      options.deep_merge!(usecase: {analyse_people: {unique_words: true}})
-    end.add_option("-identify-unnamed", "Identifies all people with no names.") do |options|
-      options.deep_merge!(usecase: {analyse_people: {identify_unnamed: true}})
-    end.add_option("-backup-people-results", "Generates a json file with all the people involved in the final results of the analysis.") do |options|
-      file = SCR.get_file("-backup-people-results", required: true, should_exist: false)
-      options.deep_merge!(usecase: {analyse_people: {backup_people: File.expand_path(file)}})
-    end.add_option("-to-csv", "Genarates a CSV file with all people of the final results.") do |options|
-      file = SCR.get_file("-to-csv", required: true, should_exist: false) || "Results.csv"
-      options.deep_merge!(usecase: {analyse_people: {csv_file: File.expand_path(file)}})
-    end
-
+ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
+  cnf.usecases do |cases| # rubocop:disable Metrics/BlockLength
     desc = "It exports to a CSV the (filtered) people"
     cases.add("-people-to-csv", :export, desc) do |people, session, options|
       file = SCR.get_file("-people-to-csv", required: true, should_exist: false)
@@ -69,25 +19,6 @@ ASSETS.cli.config do |cnf|
       options.deep_merge!(export: {options: {split_schemas: true}})
     end
 
-    desc = "Adds a column 'ecoPortalTag' to the input CSV with the tags that the location codes map to"
-    cases.add("-codes-to-tags-from", :other, desc, case_name: "codes-to-tags-from")
-    .add_option("-codes-to-tags-from", "Specify the input 'csv' file") do |options|
-      file = SCR.get_file("-codes-to-tags-from", required: true, should_exist: true)
-      options.deep_merge!(other: {file: {name: file, format: :csv}})
-    end.add_option("-column", "Specify the input column header with the codes") do |options|
-      col_codes = SCR.get_arg("-column", with_param: true)
-      options.deep_merge!(other: {file: {codes_column: col_codes}})
-    end
-
-    desc = "Creates a CSV with the paths to each tag"
-    cases.add("-create-tag-paths", :other, desc, case_name: "create-tag-paths")
-
-    desc = "Creates a JSON file with the tagtree from a CSV file"
-    cases.add("-csv-to-tree", :other, desc, case_name: "csv-to-tree") do |session, options, usecase|
-      file = SCR.get_file("-csv-to-tree", required: true, should_exist: true)
-      options.deep_merge!(source: {file: file})
-    end
-
     desc = "Forces a change of email in the same org. It won't succeed if email taken by an org member user"
     cases.add("-change-email-from", :sync, desc, case_name: "change-email")
 
@@ -95,12 +26,12 @@ ASSETS.cli.config do |cnf|
     cases.add("-switch-supervisor", :transform, desc, case_name: "switch-supervisor") do |people, session, options|
       unless options[:super]&.key?(:old)
         msg = "You must specify an -old-super to target whose supervisor is changing"
-        session.logger.error(msg)
+        session.log(:error) { msg }
         exit(1)
       end
       unless options[:super]&.key?(:new)
         msg = "You must specify the -new-super id. To reset to nil the supervisor, please, specify nil."
-        session.logger.error(msg)
+        session.log(:error) { msg }
         exit(1)
       end
     end.add_option("-old-super", "The supervisor id to be replaced on the subordinates") do |options|
@@ -115,59 +46,13 @@ ASSETS.cli.config do |cnf|
       end
     end
 
-    desc  = "Input file dump into a CSV as is."
+    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  = "Usage '-org-data-convert backup.json -restore-db-from'."
-    desc += " Transforms an input .json file to the values of the destination environment "
-    desc += " (names missmatch won't solve: i.e. usergroups)"
-    cases.add("-org-data-convert", :import, desc, case_name: "org-data-convert") do |input, session, options|
-      unless input && input.is_a?(Eco::API::Organization::People)
-        file  = SCR.get_file("-org-data-convert", required: true)
-        input = Eco::API::Organization::People.new(JSON.parse(File.read(file)))
-        session.logger.info("Source DB: loaded #{input.length} entries.")
-      end
-
-      unless options[:source_enviro]
-        session.logger.error("You need to specify a -source-enviro for the conversion to work out")
-        exit(1)
-      end
-
-    end.add_option("-source-enviro", "The defined -source-enviro API configuration that the backup file was generated from") do |options|
-      options.merge!(source_enviro: SCR.get_arg("-source-enviro", with_param: true))
-    end.add_option("-ignore-missing-policy-groups", "Prevents the script to crash when backup file has missing usergroups in the org") do |options|
-      options.deep_merge!(ignore: {missing: {policy_groups: true}})
-    end
-
-    desc = "Restores the people manager by using a backup.json file"
-    cases.add("-restore-db-from", :sync, desc, case_name: "restore-db") do |input, people, session, options|
-      unless input && input.is_a?(Eco::API::Organization::People)
-        file  = SCR.get_file("-restore-db-from", required: true)
-        input = Eco::API::Organization::People.new(JSON.parse(File.read(file)))
-        session.logger.info("Source DB: loaded #{input.length} entries.")
-      end
-    end.add_option("-include-delete", "If it should DELETE people that do not exist in the backup file") do |options|
-      options.deep_merge!(include: {delete: true})
-    end.add_option("-include-create", "If it should CREATE people that do not exist in the people manager") do |options|
-      options.deep_merge!(include: {create: true})
-    end
-
-    desc = "Re-sends invites to all filtered users that have not accepted the invite as yet"
-    cases.add("-reinvite", :transform, desc, case_name: "reinvite")
-    .add_option("-force", "If also send an invite email to those that have accepted the invite") do |options|
-      options.deep_merge!(force: {invite: true})
-    end
-
-    desc = "Re-sends invites to target users that have not accepted the invite as yet"
-    cases.add("-reinvite-from", :sync, desc, case_name: "reinvite")
-    .add_option("-force", "If also send an invite email to those that have accepted the invite") do |options|
-      options.deep_merge!(force: {invite: true})
-    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")
@@ -219,7 +104,9 @@ ASSETS.cli.config do |cnf|
       options.deep_merge!(export: {file: {name: file || "RegisterExport.csv", format: :csv}})
 
       unless options.dig(:source, :register_id)
-        session.logger.error "You should specify the target register id"
+        session.log(:error) {
+          "You should specify the target register id"
+        }
         exit(1)
       end
     end.add_option("-register-id", "Target register id") do |options|

data/lib/eco/cli_default/workflow.rb

@@ -38,6 +38,7 @@ ASSETS.cli do |cli| # rubocop:disable Metrics/BlockLength
 
         wf_in.on(:filter) do |_wf_if, io|
           next unless input && !input.empty?
+
           io.new(input: cli.config.input_filters.process(io: io))
         end
       end
@@ -47,6 +48,7 @@ ASSETS.cli do |cli| # rubocop:disable Metrics/BlockLength
           cases_with_people = cli.config.usecases.active(io: io).select do |usecase, _data|
             io.class.people_required?(usecase.type)
           end
+
           next if cases_with_people.empty? && !options.dig(:people, :get)
 
           io.new(people: cli.config.people(io: io))
@@ -78,7 +80,7 @@ ASSETS.cli do |cli| # rubocop:disable Metrics/BlockLength
       end
     end
 
-    wf.before(:launch_jobs) do |_wf_jobs, io|
+    wf.before(:launch_jobs) do |_wf_jobs, _io|
       available_args = cli.config.available_option_args
       SCR.stop_on_unknown!(all_available: available_args)
     end
@@ -95,7 +97,7 @@ ASSETS.cli do |cli| # rubocop:disable Metrics/BlockLength
         wf_post.skip!
         log(:info) {
           msg  = "Although there are post_launch cases, they will NOT be RUN"
-          msg += ", because we are in dry-run (simulate)." if options[:dry_run]
+          msg << ", because we are in dry-run (simulate)." if options[:dry_run]
           msg
         }
         next
@@ -109,9 +111,9 @@ ASSETS.cli do |cli| # rubocop:disable Metrics/BlockLength
         log(:info) {
           msg = "Although there are post_launch cases, data will not be refreshed before their run"
           if io.options[:dry_run]
-            msg += ", because we are in dry-run (simulate)."
+            msg << ", because we are in dry-run (simulate)."
           elsif !partial_update
-            msg += ", because it is not a partial update (-get-partial option not present)."
+            msg << ", because it is not a partial update (-get-partial option not present)."
           end
           msg
         }

data/lib/eco/csv/split.rb

@@ -21,11 +21,13 @@ module Eco
       def copy_count
         @copy_count ||= 0
       end
+      attr_writer :copy_count
 
       # @return [Integer] number of total input rows
       def total_count
         @total_count ||= 0
       end
+      attr_writer :total_count
 
       # @return [Array<String>] list of created files
       def out_files

data/lib/eco/csv/table.rb

@@ -5,6 +5,7 @@ module Eco
       #   - when `Array<Array>` => all `rows` as arrays where first array is the **header**
       def initialize(input)
         super(to_rows_array(input))
+
         delete_if do |row|
           values = row.fields
           values.all?(&:nil?) || values.map(&:to_s).all?(&:empty?)
@@ -21,6 +22,7 @@ module Eco
             row[header] = value.empty?? nil : value
           end
         end
+
         self
       end
 
@@ -41,9 +43,11 @@ module Eco
       # @return [Eco::CSV::Table]
       def transform_headers
         cols = columns
+
         cols.each do |col|
           col[0] = yield(col.first)
         end
+
         columns_to_table(cols)
       end
 
@@ -70,6 +74,7 @@ module Eco
             end
           end
         end
+
         self.class.new(out_rows)
       end
 
@@ -83,6 +88,7 @@ module Eco
       def transform_values
         transformed_rows = rows.map do |row|
           res = yield(row)
+
           case res
           when Array
             ::CSV::Row.new(row.headers, res)
@@ -90,6 +96,7 @@ module Eco
             res
           end
         end
+
         self.class.new(transformed_rows)
       end
 
@@ -136,6 +143,7 @@ module Eco
       def add_column(header_name, pos: -1)
         header_name = header_name.to_s.strip
         raise ArgumentError, "header_name can't be blank" if header_name.empty?
+
         new_col = Array.new(length).unshift(header_name)
         columns_to_table(columns.insert(pos, new_col))
       end
@@ -146,6 +154,7 @@ module Eco
       # @return [Eco::CSV::Table] with a new column named `name` with the row number
       def add_index_column(header_name = 'idx', pos: 0)
         header_name = header_name.to_s.strip
+
         add_column(header_name, pos: pos).tap do |table|
           table.each.with_index do |row, idx|
             row[header_name] = idx + 2
@@ -163,6 +172,7 @@ module Eco
       # It removes all rows where all columns' values are the same
       def delete_duplicates!
         unique_rows = []
+
         by_row!.delete_if do |row|
           unique_rows.any? {|done| equal_rows?(row, done)}.tap do |found|
             unique_rows << row unless found
@@ -218,6 +228,7 @@ module Eco
       def columns_to_table(columns_array)
         rows_data = columns_array.transpose
         return self.class.new(rows_data) if rows_data.length.positive?
+
         raise ArgumentError, "Expecting 'columns_array' to at least have header. Given: #{columns_array}"
       end
 
@@ -232,6 +243,7 @@ module Eco
         when Enumerable
           data = data.dup.compact
           return data unless data.count.positive?
+
           sample = data.first
 
           case sample
@@ -264,6 +276,7 @@ module Eco
 
       def if_array_to_pipe_string(value)
         return value unless value.is_a?(Array)
+
         value.join('|')
       end
     end

data/lib/eco/data/files/encoding.rb

@@ -4,7 +4,7 @@ module Eco
       module Encoding
         include Eco::Language::AuxiliarLogger
 
-        BOM_BYTES = [239, 187, 191]
+        BOM_BYTES = [239, 187, 191].freeze
 
         def has_bom?(path)
           return false if !path || file_empty?(path)
@@ -16,9 +16,10 @@ module Eco
 
         def get_file_content_with_encoding(file, encoding: nil)
           encoding ||= scoped_encoding(file)
+
           unless !encoding || encoding == 'utf-8'
             msg = "File encoding: '#{encoding}'"
-            logger.debug(msg)
+            log(:debug) { msg }
             puts msg
           end
 
@@ -29,7 +30,9 @@ module Eco
           else
             content = File.read(file, encoding: encoding)
           end
-          return nil unless content
+
+          return unless content
+
           content = content.encode("utf-8") unless encoding.include?('utf-8')
           content
         end
@@ -42,6 +45,7 @@ module Eco
             content = content.sub(bom, '')
             content.force_encoding('utf-8')
           end
+
           content
         end
 
@@ -52,21 +56,24 @@ module Eco
         # Gives the parameter as it should
         def scoped_encoding(path)
           unless file_exists?(path)
-            logger.error("File does not exist: #{path}")
+            log(:error) { "File does not exist: #{path}" }
             return nil
           end
+
           encoding ||= encoding(path)
-          encoding   = (encoding == "bom") ? "#{encoding}|utf-8": encoding
+          encoding   = "#{encoding}|utf-8" if encoding == "bom"
           encoding
         end
 
         def file_exists?(file)
-          return false if !file
-          return File.exist?(file) || File.exist?(File.expand_path(file))
+          return false unless file
+
+          File.exist?(file) || File.exist?(File.expand_path(file))
         end
 
         def file_empty?(path)
-          return true if !File.file?(path)
+          return true unless File.file?(path)
+
           File.zero?(path)
         end
       end

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

@@ -30,11 +30,15 @@ module Eco
             replacement = "<#{bytes.unpack1('H*')}>"
 
             if tolerance <= 0
-              logger.error("There were more than 5 encoding errors in the file '#{file}'.")
+              log(:error) {
+                "There were more than 5 encoding errors in the file '#{file}'."
+              }
               return content
             else
               tolerance -= 1
-              logger.error("Encoding problem in file '#{file}': '#{replacement}'.")
+              log(:error) {
+                "Encoding problem in file '#{file}': '#{replacement}'."
+              }
               replacement
             end
           end

data/lib/eco/data/hashes/diff_result.rb

@@ -48,8 +48,10 @@ module Eco
         #   between `src_1` and `src_2`.
         def diff_attrs
           return (@diff_attrs = []) if new? || del?
+
           @diff_attrs ||= all_compared_attrs.each_with_object([]) do |kattr, out|
             next unless comparable_attr?(kattr)
+
             out << kattr unless eq?(attr_prev(kattr), attr(kattr))
           end
         end
@@ -71,6 +73,7 @@ module Eco
         def diff_attr?(attr)
           return true if new?
           return true if del?
+
           diff_attrs.include?(attr.to_s)
         end
 
@@ -80,6 +83,7 @@ module Eco
           target_attrs = [key] | all_compared_attrs
           return slice_attrs(src_2, *target_attrs) if new?
           return slice_attrs(src_1, key)           if del?
+
           slice_attrs(src_2, key, *diff_attrs)
         end
 
@@ -109,6 +113,7 @@ module Eco
           attr = attr.to_s
           return false unless all_compared_attrs.include?(attr)
           return true  unless self.class.compared_attr_when_present?(attr)
+
           key_present_in_both?(attr)
         end
 

data/lib/eco/data/locations/node_diff/nodes_diff.rb

@@ -28,6 +28,7 @@ class Eco::Data::Locations::NodeDiff
       @diffs ||= super.select do |dff|
         # discard entries that are to be inserted and archived at the same time
         next false if dff.insert? && dff.archive?(validate: false)
+
         dff.unarchive? || dff.id_name? || dff.insert? ||
           dff.move?    || dff.archive?
       end
@@ -67,32 +68,42 @@ class Eco::Data::Locations::NodeDiff
     def diffs_summary # rubocop:disable Metrics/AbcSize
       comp = "(#{source_2.count} input nodes VS #{source_1.count} live nodes)"
       return "There were no differences identified #{comp}" if diffs.empty?
+
       msg  = []
+
       msg << "Identified #{diffs.count} differences #{comp}:"
       msg << when_present(insert) do |count|
         "  • #{count} nodes to insert"
       end
+
       msg << when_present(update) do |count|
         "  • #{count} nodes to update"
       end
+
       msg << when_present(unarchive) do |count|
         "    • #{count} nodes to unarchive (includes ancestors of target nodes)"
       end
+
       msg << when_present(id) do |count|
         "    • #{count} nodes to change id\n"
       end
+
       msg << when_present(name) do |count|
         "    • #{count} nodes to change name"
       end
+
       msg << when_present(classifications) do |count|
         "    • #{count} nodes to change classifications"
       end
+
       msg << when_present(move) do |count|
         "    • #{count} nodes to move"
       end
+
       msg << when_present(archive) do |count|
         "  • #{count} nodes to archive"
       end
+
       msg.compact.join("\n")
     end
 
@@ -108,8 +119,10 @@ class Eco::Data::Locations::NodeDiff
 
     def when_present(list, default = nil)
       raise ArgumentError, "Expecting block but not given" unless block_given?
+
       count = list.count
       return yield(count) if count&.positive?
+
       default
     end
 

data/lib/eco/data/locations/node_diff.rb

@@ -50,12 +50,14 @@ module Eco::Data::Locations
     def id_name?
       return true if id?
       return true if name?
+
       classifications?
     end
 
     # Has the parent id changed?
     def move?
       return false unless update?
+
       parent_id?
     end
 
@@ -72,6 +74,7 @@ module Eco::Data::Locations
       return true  if     marked_for_unarchive?
       return false if     archived
       return false unless update?
+
       archived?
     end
 
@@ -86,6 +89,7 @@ module Eco::Data::Locations
       raise msg    if validate && archived && insert?
 
       return true  if del?
+
       archived
     end
   end

data/lib/eco/data/locations/node_level.rb

@@ -70,6 +70,7 @@ module Eco::Data::Locations
 
     def classifications
       return [] unless (al = actual_level).positive?
+
       original_headers[al - 1]
     end
 
@@ -111,8 +112,10 @@ module Eco::Data::Locations
     # Requires that all upper levels (lower positions) are filled-in
     def common_level_with(other)
       return nil unless other
+
       otags_array = other.tags_array.compact
       stags_array = tags_array.compact
+
       raise "Missing lower levels for #{other.id}: #{other.tags_array.pretty_inspect}" unless other.highest_levels_set?
       raise "Missing lower levels for #{id}:      #{tags_array.pretty_inspect}"        unless highest_levels_set?
 
@@ -174,6 +177,7 @@ module Eco::Data::Locations
     def highest_levels_set?
       return true if raw_level == 1
       return true unless raw_prev_empty_level?
+
       !!@highest_levels_set
     end
 
@@ -194,10 +198,12 @@ module Eco::Data::Locations
         target = i.to_a
       when Integer
         return false unless i >= 1 && i <= tag_attrs_count
+
         target = Array(i..tag_attrs_count)
       else
         return false
       end
+
       return false if target.empty?
 
       target.each do |n|

data/lib/eco/language/auxiliar_logger.rb

@@ -22,6 +22,8 @@ module Eco
 
       # Shortcut to logger.
       def log(level, &block)
+        return unless logger.respond_to?(:level)
+
         logger&.send(level, &block)
       end
     end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.0.4'.freeze
+  VERSION = '3.0.7'.freeze
 end

data/lib/eco-helpers.rb

@@ -1,7 +1,7 @@
 # rubocop:disable Naming/FileName
 require 'csv'
 require 'json'
-require 'pp'
+require 'pp' # rubocop:disable Lint/RedundantRequireStatement
 require 'dotenv'
 require 'dotenv/load'