eco-helpers 3.0.25 → 3.0.27

data/lib/eco/cli_default/usecases.rb

@@ -1,149 +1,149 @@
 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)
+    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)
       options.deep_merge!(export: {file: {name: file, format: :csv}})
 
-      case_name = options.dig(:export, :options, :detailed) ? "to-csv-detailed" : "to-csv"
+      case_name = options.dig(:export, :options, :detailed) ? 'to-csv-detailed' : 'to-csv'
       session.usecases.case(case_name)
-    end.add_option("-nice-header", "Outputs more descriptive standard headers") do |options|
+    end.add_option('-nice-header', 'Outputs more descriptive standard headers') do |options|
       options.deep_merge!(export: {options: {nice_header: true}})
-    end.add_option("-internal-names", "It is the most raw export. Useful to see all the data when name mappings override/overlap") do |options|
+    end.add_option('-internal-names', 'It is the most raw export. Useful to see all the data when name mappings override/overlap') do |options|
       options.deep_merge!(export: {options: {internal_names: true}})
-    end.add_option("-detailed", "Includes much more information to the file (i.e. permissions_merged abilities, preferences)") do |options|
+    end.add_option('-detailed', 'Includes much more information to the file (i.e. permissions_merged abilities, preferences)') do |options|
       options.deep_merge!(export: {options: {detailed: true}})
-    end.add_option("-permissions-custom", "Used with -detailed. Adds the permissions_custom abilities") do |options|
+    end.add_option('-permissions-custom', 'Used with -detailed. Adds the permissions_custom abilities') do |options|
       options.deep_merge!(export: {options: {permissions_custom: true}})
-    end.add_option("-split-schemas", "It will generate 1 file per each schema") do |options|
+    end.add_option('-split-schemas', 'It will generate 1 file per each schema') do |options|
       options.deep_merge!(export: {options: {split_schemas: true}})
     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")
+    cases.add('-change-email-from', :sync, desc, case_name: 'change-email')
 
     desc = "Sets to -new-super the supervisor_id of the -old-super's subordinates"
-    cases.add("-switch-supervisor", :transform, desc, case_name: "switch-supervisor") do |people, session, options|
+    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"
+        msg = 'You must specify an -old-super to target whose supervisor is changing'
         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."
+        msg = 'You must specify the -new-super id. To reset to nil the supervisor, please, specify nil.'
         session.log(:error) { msg }
         exit(1)
       end
-    end.add_option("-old-super", "The supervisor id to be replaced on the subordinates") do |options|
-      if old_id = SCR.get_arg("-old-super", with_param: true)
-        old_id = old_id == "nil"? nil : old_id
+    end.add_option('-old-super', 'The supervisor id to be replaced on the subordinates') do |options|
+      if (old_id = SCR.get_arg('-old-super', with_param: true))
+        old_id = old_id == 'nil'? nil : old_id
         options.deep_merge!(super: {old: old_id})
       end
-    end.add_option("-new-super", "The new supervisor id") do |options|
-      if new_id = SCR.get_arg("-new-super", with_param: true)
-        new_id = new_id == "nil"? nil : new_id
+    end.add_option('-new-super', 'The new supervisor id') do |options|
+      if (new_id = SCR.get_arg('-new-super', with_param: true))
+        new_id = new_id == 'nil'? nil : new_id
         options.deep_merge!(super: {new: new_id})
       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")
+    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")
+    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')
 
-    desc = "Deletes everybody that has been filtered from the people manager"
-    cases.add("-delete", :transform, desc, case_name: "delete")
-    desc = "Deletes the people specified in the input data"
-    cases.add("-delete-from", :sync, desc, case_name: "delete")
+    desc = 'Deletes everybody that has been filtered from the people manager'
+    cases.add('-delete', :transform, desc, case_name: 'delete')
+    desc = 'Deletes the people specified in the input data'
+    cases.add('-delete-from', :sync, desc, case_name: 'delete')
 
-    desc = "Re-freshes the default_tag of users"
-    cases.add("-set-default-tag", :transform, desc, case_name: "set-default-tag")
+    desc = 'Re-freshes the default_tag of users'
+    cases.add('-set-default-tag', :transform, desc, case_name: 'set-default-tag')
 
-    desc = "Creates people with with details and account"
-    as1  = "During the run, if new people is created, they are included in the People object of the current session."
-    as1 << " This makes them available to find them (i.e. via 'external-id') before they exist"
-    cases.add("-create-from", :sync, desc, case_name: "create")
-    .add_option("-append-starters", as1) do |options|
-      options.deep_merge!(people: {append_created: true})
-    end
+    desc  = 'Creates people with with details and account'
+    as_1  = 'During the run, if new people is created, they are included in the People object of the current session.'
+    as_1 << " This makes them available to find them (i.e. via 'external-id') before they exist"
+    cases.add('-create-from', :sync, desc, case_name: 'create').
+      add_option('-append-starters', as_1) do |options|
+        options.deep_merge!(people: {append_created: true})
+      end
 
-    desc = "It just adds everybody to an update job without doing any change. If the org has policies, it will refresh"
-    cases.add("-refresh", :transform, desc, case_name: "refresh")
+    desc = 'It just adds everybody to an update job without doing any change. If the org has policies, it will refresh'
+    cases.add('-refresh', :transform, desc, case_name: 'refresh')
 
-    desc = "Updates the people specified in the input data"
-    cases.add("-update-from", :sync, desc, case_name: "update")
+    desc = 'Updates the people specified in the input data'
+    cases.add('-update-from', :sync, desc, case_name: 'update')
 
     desc = "Does an actual transfer of USER from id|external_id account to 'destination-id' person"
-    cases.add("-transfer-account-from", :sync, desc, case_name: "transfer-account")
-    .add_option("-include-email", "Specifies if the email should also be moved. Otherwise it only moves the account") do |options|
-      options.deep_merge!(include: {email: true})
-    end
+    cases.add('-transfer-account-from', :sync, desc, case_name: 'transfer-account').
+      add_option('-include-email', 'Specifies if the email should also be moved. Otherwise it only moves the account') do |options|
+        options.deep_merge!(include: {email: true})
+      end
 
-    desc = "Tries to find the input entries and update them. It creates them if not found"
-    cases.add("-upsert-from", :sync, desc, case_name: "upsert")
-    .add_option("-append-starters", as1) do |options|
-      options.deep_merge!(people: {append_created: true})
-    end
+    desc = 'Tries to find the input entries and update them. It creates them if not found'
+    cases.add('-upsert-from', :sync, desc, case_name: 'upsert').
+      add_option('-append-starters', as_1) do |options|
+        options.deep_merge!(people: {append_created: true})
+      end
 
-    desc = "It does like -upsert-from and additionally removes account and supervisor of those in people that are not in the entries (leavers)"
-    cases.add("-hris-from", :sync, desc, case_name: "hris")
-    .add_option("-append-starters", as1) do |options|
-      options.deep_merge!(people: {append_created: true})
-    end
+    desc = 'It does like -upsert-from and additionally removes account and supervisor of those in people that are not in the entries (leavers)'
+    cases.add('-hris-from', :sync, desc, case_name: 'hris').
+      add_option('-append-starters', as_1) do |options|
+        options.deep_merge!(people: {append_created: true})
+      end
 
     # Ooze cases
-    desc = "APIv2 Case: Exports the target register into a CSV"
-    cases.add("-export-register", :other, desc, case_name: "export-register") do |session, options, usecase|
-      file = SCR.get_file("-export-register", required: false, should_exist: false)
-      options.deep_merge!(export: {file: {name: file || "RegisterExport.csv", format: :csv}})
+    desc = 'APIv2 Case: Exports the target register into a CSV'
+    cases.add('-export-register', :other, desc, case_name: 'export-register') do |session, options, usecase|
+      file = SCR.get_file('-export-register', required: false, should_exist: false)
+      options.deep_merge!(export: {file: {name: file || 'RegisterExport.csv', format: :csv}})
 
       unless options.dig(:source, :register_id)
         session.log(:error) {
-          "You should specify the target register id"
+          'You should specify the target register id'
         }
         exit(1)
       end
-    end.add_option("-register-id", "Target register id") do |options|
-      reg_id = SCR.get_arg("-register-id", with_param: true)
+    end.add_option('-register-id', 'Target register id') do |options|
+      reg_id = SCR.get_arg('-register-id', with_param: true)
       options.deep_merge!(source: {register_id: reg_id})
-    end.add_option("-include-deindexed", "Tells if deindexed fields should be included") do |options|
+    end.add_option('-include-deindexed', 'Tells if deindexed fields should be included') do |options|
       options.deep_merge!(export: {options: {include: {deindexed: true}}})
-    end.add_option("-include-unnamed", "Tells if unnamed fields should be included") do |options|
+    end.add_option('-include-unnamed', 'Tells if unnamed fields should be included') do |options|
       options.deep_merge!(export: {options: {include: {unnamed: true}}})
-    end.add_option("-include-unhashed", "Tells if fields with no hash reference (very short label) should be included") do |options|
+    end.add_option('-include-unhashed', 'Tells if fields with no hash reference (very short label) should be included') do |options|
       options.deep_merge!(export: {options: {include: {unhashed: true}}})
-    end.add_option("-delimiter", "Sets the delimiter to be used in fields multi value") do |options|
-      str = SCR.get_arg("-delimiter", with_param: true)
+    end.add_option('-delimiter', 'Sets the delimiter to be used in fields multi value') do |options|
+      str = SCR.get_arg('-delimiter', with_param: true)
       options.deep_merge!(export: {options: {delimiter: str}})
-    end.add_option("-created-from", "Filters the register to the entries created FROM the specified date") do |options|
-      str = SCR.get_arg("-created-from", with_param: true)
+    end.add_option('-created-from', 'Filters the register to the entries created FROM the specified date') do |options|
+      str = SCR.get_arg('-created-from', with_param: true)
       date = Time.parse(str)
       options.deep_merge!(export: {options: {filters: {created_at: {from: date}}}})
-    end.add_option("-created-to", "Filters the register to the entries created up TO the specified date") do |options|
-      str = SCR.get_arg("-created-to", with_param: true)
+    end.add_option('-created-to', 'Filters the register to the entries created up TO the specified date') do |options|
+      str = SCR.get_arg('-created-to', with_param: true)
       date = Time.parse(str)
       options.deep_merge!(export: {options: {filters: {created_at: {to: date}}}})
-    end.add_option("-updated-from", "Filters the register by entries updated FROM the specified date") do |options|
-      str = SCR.get_arg("-updated-from", with_param: true)
+    end.add_option('-updated-from', 'Filters the register by entries updated FROM the specified date') do |options|
+      str = SCR.get_arg('-updated-from', with_param: true)
       date = Time.parse(str)
       options.deep_merge!(export: {options: {filters: {updated_at: {from: date}}}})
-    end.add_option("-updated-to", "Filters the register by entries updated up TO the specified date") do |options|
-      str = SCR.get_arg("-updated-to", with_param: true)
+    end.add_option('-updated-to', 'Filters the register by entries updated up TO the specified date') do |options|
+      str = SCR.get_arg('-updated-to', with_param: true)
       date = Time.parse(str)
       options.deep_merge!(export: {options: {filters: {updated_at: {to: date}}}})
-    end.add_option("-all-tags", "Filters the register to entries with ALL specified tags (| separator)") do |options|
-      str = SCR.get_arg("-all-tags", with_param: true)
-      tags = str.split("|")
+    end.add_option('-all-tags', 'Filters the register to entries with ALL specified tags (| separator)') do |options|
+      str = SCR.get_arg('-all-tags', with_param: true)
+      tags = str.split('|')
       options.deep_merge!(export: {options: {filters: {tags: {all: tags}}}})
-    end.add_option("-any-tags", "Filters the register to entries with ANY specified tags (| separator)") do |options|
-      str = SCR.get_arg("-all-tags", with_param: true)
-      tags = str.split("|")
+    end.add_option('-any-tags', 'Filters the register to entries with ANY specified tags (| separator)') do |options|
+      str = SCR.get_arg('-all-tags', with_param: true)
+      tags = str.split('|')
       options.deep_merge!(export: {options: {filters: {tags: {any: tags}}}})
     end
   end

data/lib/eco/cli_default/workflow.rb

@@ -11,7 +11,7 @@ class Eco::CliDefault::Workflow < Eco::API::Common::Loaders::Workflow
 #     workflows that assembly those classes?
 #   5. Right on the load:data stage, set the io model
 #     based on (1).
-
+#
   class << self
     attr_accessor :rescued
   end
@@ -90,7 +90,7 @@ class Eco::CliDefault::Workflow < Eco::API::Common::Loaders::Workflow
   on(:usecases) do
     next if cli_usecases.process(io: io)
 
-    log(:info) { "No update operation specified... quitting" }
+    log(:info) { 'No update operation specified... quitting' }
     exit 0
   end
 
@@ -111,8 +111,8 @@ class Eco::CliDefault::Workflow < Eco::API::Common::Loaders::Workflow
       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  = 'Although there are post_launch cases, they will NOT be RUN'
+        msg << ', because we are in dry-run (simulate).' if options[:dry_run]
         msg
       }
 
@@ -125,11 +125,11 @@ class Eco::CliDefault::Workflow < Eco::API::Common::Loaders::Workflow
 
     unless refresh_data
       log(:info) {
-        msg = "Although there are post_launch cases, data will not be refreshed before their run"
+        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/data/files/helpers.rb

@@ -112,7 +112,7 @@ module Eco
           File.join(path, basename)
         end
 
-        def folder_files(folder = ".", pattern = "*", regexp: nil, older_than: nil)
+        def folder_files(folder = '.', pattern = '*', regexp: nil, older_than: nil)
           target = File.join(File.expand_path(folder), pattern)
           Dir[target].tap do |dir_files|
             dir_files.select! {|f| File.file?(f)}
@@ -131,8 +131,8 @@ module Eco
           end.sort
         end
 
-        def csv_files(folder = ".", regexp: nil, older_than: nil)
-          folder_files(folder, "*.csv", regexp: regexp, older_than: older_than).sort
+        def csv_files(folder = '.', regexp: nil, older_than: nil)
+          folder_files(folder, '*.csv', regexp: regexp, older_than: older_than).sort
         end
       end
 

data/lib/eco/data/fuzzy_match/result.rb

@@ -1,23 +1,64 @@
 module Eco
   module Data
     module FuzzyMatch
-      class Result < Struct.new(:match, :value, :needle_value, :dice, :levenshtein, :jaro_winkler, :ngrams, :words_ngrams, :chars_position)
-        ALL_METHODS = [:dice, :levenshtein, :jaro_winkler, :ngrams, :words_ngrams, :chars_position]
+      class Result < Struct.new(
+        :match,
+        :value,
+        :needle_value,
+        :dice,
+        :levenshtein,
+        :jaro_winkler,
+        :ngrams,
+        :words_ngrams,
+        :chars_position
+      )
+        ALL_METHODS = %i[
+          dice levenshtein jaro_winkler
+          ngrams words_ngrams chars_position
+        ].freeze
 
         attr_accessor :pivot
 
-        def dice; super&.round(3); end
-        def levenshtein; super&.round(3); end
-        def jaro_winkler; super&.round(3); end
-        def ngrams; super&.round(3); end
-        def words_ngrams; super&.round(3); end
-        def chars_position; super&.round(3); end
+        def dice
+          super&.round(3)
+        end
+
+        def levenshtein
+          super&.round(3)
+        end
+
+        def jaro_winkler
+          super&.round(3)
+        end
+
+        def ngrams
+          super&.round(3)
+        end
+
+        def words_ngrams
+          super&.round(3)
+        end
+
+        def chars_position
+          super&.round(3)
+        end
 
         #Shortcuts
-        def lev; levenshtein; end
-        def jaro; jaro_winkler; end
-        def wngrams; words_ngrams; end
-        def pos; chars_position; end
+        def lev
+          levenshtein
+        end
+
+        def jaro
+          jaro_winkler
+        end
+
+        def wngrams
+          words_ngrams
+        end
+
+        def pos
+          chars_position
+        end
 
         def average
           values = [dice, levenshtein, jaro_winkler, ngrams, words_ngrams, chars_position]
@@ -36,52 +77,54 @@ module Eco
 
         def all_threshold?(methods = order, threshold = 0.15)
           return true unless threshold
+
           [methods].flatten.compact.all? {|method| threshold?(method, threshold)}
         end
 
         def any_threshold?(methods = order, threshold = 0.15)
           return true unless threshold
+
           [methods].flatten.compact.any? {|method| threshold?(method, threshold)}
         end
 
         def threshold?(method = :dice, threshold = 0.15)
-          raise "Uknown method '#{method}'" unless self.respond_to?(method)
-          self.send(method) >= threshold
+          raise ArgumentError, "Uknown method '#{method}'" unless respond_to?(method, true)
+
+          send(method) >= threshold
         end
 
         def order=(values)
           @order = [values].flatten.compact.tap do |o|
-            o << [:words_ngrams, :dice] if o.empty?
+            o << %i[words_ngrams dice] if o.empty?
           end
         end
 
         def order
-          @order ||= [:words_ngrams, :dice]
+          @order ||= %i[words_ngrams dice]
         end
 
-        def <=>(result)
-          compare(result)
+        def <=>(other)
+          compare(other)
         end
 
         def values_at(*keys)
           keys.map do |key|
-            self.send(key) if self.respond_to?(key)
+            send(key) if respond_to?(key)
           end
         end
 
         private
 
         def compare(other, order: self.order)
-          return 0  unless method = order.first
-          raise "Uknown method '#{method}'"  unless self.respond_to?(method) && other.respond_to?(method)
-          return -1 if self.send(method) > other.send(method)
-          return  1 if self.send(method) < other.send(method)
-          compare(other, order: order[1..-1])
-        end
+          return 0 unless (method = order.first)
 
+          raise "Uknown method '#{method}'" unless respond_to?(method, true) && other.respond_to?(method, true)
 
+          return -1 if send(method) > other.send(method)
+          return  1 if send(method) < other.send(method)
+          compare(other, order: order[1..])
+        end
       end
-
     end
   end
 end

data/lib/eco/data/fuzzy_match/results.rb

@@ -12,14 +12,16 @@ module Eco
 
         def each(&block)
           return to_enum(:each) unless block
+
           raw_results.each(&block)
         end
 
         # Merges the results of both Results object
         def merge(res)
-          unless self.needle == res.needle
+          unless needle == res.needle
             raise "To merge 2 Results, needle should be the same ('#{value}'). Given '#{res.value}'"
           end
+
           self.class.new(needle, value, raw_results.concat(res.raw_results))
         end
 
@@ -29,9 +31,10 @@ module Eco
 
         def relevant_results(**options)
           options = {order: order, threshold: threshold || 0.5}.merge(options)
+
           raw_results.select do |result|
             result.all_threshold?(options[:order], options[:threshold])
-          end.yield_self do |filtered|
+          end.then do |filtered|
             self.class.new(needle, value, filtered).tap do |results|
               results.order = options[:order]
             end
@@ -47,7 +50,7 @@ module Eco
         end
 
         def order
-          @order ||= [:words_ngrams, :dice]
+          @order ||= %i[words_ngrams dice]
         end
 
         def results
@@ -55,23 +58,20 @@ module Eco
         end
 
         def print
-          msg = results.map do |result|
-            result.print
-          end.join("\n  ")
+          msg = results.map(&:print).join("\n  ")
 
           puts "'#{value}':\n  " + msg
         end
 
         private
 
-        def item_string(item, attr = self.method)
+        def item_string(item, attr = self.method) # rubocop:disable Style/RedundantSelf
           return item if !item || item.is_a?(String) || !attr
+
           attr = attr.to_sym
-          return item.send(attr) if item.respond_to?(attr)
+          item.send(attr) if item.respond_to?(attr, true)
         end
-
       end
-
     end
   end
 end

data/lib/eco/data/fuzzy_match/score.rb

@@ -2,11 +2,13 @@ module Eco
   module Data
     module FuzzyMatch
       class Score < Struct.new(:score, :total)
-
         def ratio(decimals = 6)
-          tot = self.total; sc = self.score
-          tot = tot && tot > 0 ? tot : 1
-          sc  = sc  && sc  > 0 ? sc  : 0
+          tot = total
+          sc  = score
+
+          tot = 1 unless tot&.positive?
+          sc  = 0 unless sc&.positive?
+
           (sc.to_f / tot).round(decimals)
         end
 
@@ -16,7 +18,10 @@ module Eco
 
         def increase(value = 1)
           self.score += value
-          raise "Score #{self.score} (increase: #{value}) can't be greater than total #{self.total}" if self.score > self.total
+
+          msg = "Score #{self.score} (increase: #{value}) can't be greater than total #{total}"
+          raise msg if score > total
+
           self.score
         end
 
@@ -26,7 +31,7 @@ module Eco
 
         def values_at(*keys)
           keys.map do |key|
-            self.send(key) if self.respond_to?(key)
+            send(key) if respond_to?(key, true)
           end
         end
 
@@ -37,13 +42,13 @@ module Eco
 
         def merge!(scr)
           raise "Expecting Score object. Given: #{scr.class}" unless scr.is_a?(Score)
+
           increase_total(scr.total)
           increase(scr.score)
+
           self
         end
-
       end
-
     end
   end
 end