eco-helpers 2.7.2 → 2.7.4

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

@@ -33,6 +33,7 @@ module Eco::API::UseCases::GraphQL::Samples
       def process
         as_nodes_json(input_tagtree).tap do |list|
           next generate_live_nodes_file(list) unless list.empty?
+
           log(:error) { "There are no location nodes!" }
         end
       end

data/lib/eco/api/usecases/ooze_cases/export_register_case.rb

@@ -92,7 +92,7 @@ class Eco::API::UseCases::OozeCases::ExportRegisterCase < Eco::API::UseCases::Oo
   def filename
     @filename ||= (options[:file] || options.dig(:export, :file, :name)).tap do |filename|
       unless filename
-        session.logger.error("Destination file not specified")
+        log(:error) { "Destination file not specified" }
         return false
       end
     end

data/lib/eco/api/usecases/ooze_samples/ooze_base_case.rb

@@ -114,7 +114,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
     apiv2.pages.get(ooze_id, stage_id: stage_id).tap do |ooze|
       if ooze
         new_target(ooze)
-        logger.info("Got #{object_reference(ooze)}")
+        log(:info) { "Got #{object_reference(ooze)}" }
       else
         exit_error "Could not get ooze '#{ooze_id}'"
       end
@@ -134,7 +134,9 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
       return apiv2.pages.get(ooze_id, stage_id: stg.id).tap do |stage|
         if stage
           new_target(stage)
-          logger.info("Got #{object_reference(stage)} from #{object_reference(ooze)}")
+          log(:info) {
+            "Got #{object_reference(stage)} from #{object_reference(ooze)}"
+          }
         else
           exit_error "Could not get stage '#{id_name}' in ooze '#{ooze_id}'"
         end
@@ -159,9 +161,11 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
       apiv2.pages.update(ooze).tap do |response|
         if response.success?
           ooze.consolidate!
-          logger.info("Successful update of #{object_reference(ooze)}")
+          log(:info) { "Successful update of #{object_reference(ooze)}" }
         else
-          logger.error("Could not update #{object_reference(ooze)} (created_at: #{ooze.created_at}: #{response.body}")
+          log(:error) {
+            "Could not update #{object_reference(ooze)} (created_at: #{ooze.created_at}: #{response.body}"
+          }
         end
       end
     end
@@ -172,7 +176,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
       if warn_pending_changes
         msg =  "You you are switching to a new target #{object_reference(object)}"
         msg += " after doing unsaved changes to #{object_reference(target)}"
-        logger.warn msg
+        log(:warn) { msg }
       end
       yield(target) if block_given?
     end
@@ -185,7 +189,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   def backup_patch!(ooze = target)
     unless (patch = (patch_doc(ooze) || {})["page"])
-      logger.info "No changes to update for #{object_reference(ooze)}."
+      log(:info) { "No changes to update for #{object_reference(ooze)}." }
       return
     end
 
@@ -216,12 +220,12 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   def dry_run_feedback(entry = target)
     entry.validate.tap do |validation|
-      logger.error(validation) if validation.is_a?(String)
+      log(:error) { validation } if validation.is_a?(String)
     end
     display_patch(entry)
     backup_patch!(entry)
     if dirty?(entry) && dry_count > self.class::DRY_COUNT
-      logger.info("Reached #{self.class::DRY_COUNT} dry-run samples.")
+      log(:info) { "Reached #{self.class::DRY_COUNT} dry-run samples." }
       exit(0)
     end
     false
@@ -232,7 +236,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   end
 
   def exit_error(msg)
-    logger.error(msg)
+    log(:error) { msg }
     exit(1)
   end
 end

data/lib/eco/api/usecases/ooze_samples/ooze_run_base_case.rb

@@ -47,10 +47,10 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::Ooz
   end
 
   def exit_if_no_changes!
-    unless changes = !!patch_doc["page"]
-      logger.warn "No Changes!!"
-      exit(0)
-    end
+    return if (changes = !!patch_doc["page"])
+
+    log(:info) { "No Changes!!" }
+    exit(0)
   end
 
   def prompt_to_confirm!

data/lib/eco/api/usecases/ooze_samples/register_export_case.rb

@@ -111,7 +111,7 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
     apiv2.pages.get(ooze_id, stage_id: stage_id).tap do |ooze|
       if ooze
         new_target(ooze)
-        logger.info("Got #{object_reference(ooze)}")
+        log(:info) { "Got #{object_reference(ooze)}" }
       else
         exit_error "Could not get ooze '#{ooze_id}'"
       end
@@ -125,12 +125,15 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
       exit_error "There's no target ooze to get retrieve stages from"
     end
 
-    if stg = ooze.stages[id_name] || ooze.stages.get_by_name(id_name)
+    stg = ooze.stages[id_name] || ooze.stages.get_by_name(id_name)
+    if stg
       return ooze if ooze.respond_to?(:current_stage_id) && (ooze.current_stage_id == stg.id)
       return apiv2.pages.get(ooze_id, stage_id: stg.id).tap do |stage|
         if stage
           new_target(stage)
-          logger.info("Got #{object_reference(stage)} from #{object_reference(ooze)}")
+          log(:info) {
+            "Got #{object_reference(stage)} from #{object_reference(ooze)}"
+          }
         else
           exit_error "Could not get stage '#{id_name}' in ooze '#{ooze_id}'"
         end
@@ -154,7 +157,7 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
       ) do |res|
         next if res.upcase.start_with?("Y")
         puts "..."
-        logger.info "Aborting script..."
+        log(:info) { "Aborting script..." }
         exit(0)
       end
     end
@@ -175,7 +178,7 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
   end
 
   def conf_search
-    return search if respond_to?(:search)
+    search if respond_to?(:search)
   end
 
   def register_id
@@ -187,7 +190,7 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
   end
 
   def exit_error(msg)
-    logger.error(msg)
+    log(:error) { msg }
     exit(1)
   end
 end

data/lib/eco/api/usecases/ooze_samples/register_migration_case.rb

@@ -52,7 +52,7 @@ class Eco::API::UseCases::OozeSamples::RegisterMigrationCase < Eco::API::UseCase
         csv << ["src_page_id", "dst_page_id"]
         super(session, options, usecase, &block)
       end
-      logger.info("File '#{out_csv_filename}' has been created.")
+      log(:info) { "File '#{out_csv_filename}' has been created." }
     end
   end
 
@@ -79,15 +79,15 @@ class Eco::API::UseCases::OozeSamples::RegisterMigrationCase < Eco::API::UseCase
         end
 
         if msg = pairing_tracking.report_src_unpaired(only_present: !self.class::REPORT_SRC_EMTPY, only_indexed: !self.class::REPORT_SRC_DEINDEX)
-          logger.warn(msg)
+          log(:warn) { msg }
         end
 
         if msg = pairing_tracking.report_multi_pairs(only_present: !self.class::REPORT_SRC_EMTPY, only_indexed: !self.class::REPORT_SRC_DEINDEX, dst_exclude_ximport: !self.class::REPORT_DST_XIMPORT)
-          logger.warn(msg)
+          log(:warn) { msg }
         end
 
         if msg = pairing_tracking.report_dst_unpaired(only_required: false, exclude_ximport: !self.class::REPORT_DST_XIMPORT)
-          logger.warn(msg)
+          log(:warn) { msg }
         end
       end
     end
@@ -150,7 +150,7 @@ class Eco::API::UseCases::OozeSamples::RegisterMigrationCase < Eco::API::UseCase
     if stg = target_stage(name)
       yield(stg)
     else
-      logger.warn("Entry '#{target.id}' does not have stage '#{name}'")
+      log(:warn) { "Entry '#{target.id}' does not have stage '#{name}'" }
     end
   end
 

data/lib/eco/api/usecases/ooze_samples/register_update_case.rb

@@ -80,7 +80,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
         if (pending = queue_shift(page_result.id)) && dirty?(pending)
           msg  = "Inconsistent search results. "
           msg << "Launching update on '#{object_reference(pending)}' to be able to queue it back"
-          logger.warn msg
+          log(:warn) { msg }
           update_ooze(pending)
         end
         if (ooz = ooze(page_result.id))
@@ -88,7 +88,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
           yield(ooz)
         else
           @non_retrieved_oozes += 1
-          logger.warn "Could not get page #{page_result.id}"
+          log(:warn) { "Could not get page #{page_result.id}" }
         end
       end
       update_oozes
@@ -106,7 +106,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
         msg << "trying to queue different objects with same page id:\n"
         msg << " • already queued (changes will go): #{object_reference(elem)}\n"
         msg << " • tried to queue (lost changes): #{object_reference(object)}"
-        logger.warn msg
+        log(:warn) { msg }
       end
     else
       batch_queue << object unless batch_queue.include?(object)
@@ -180,7 +180,9 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
 
   def backup_patch!(ooze = target)
     return if (patch_doc(ooze) || {})["page"]
-    logger.info "No changes to update for #{object_reference(ooze)}."
+    log(:info) {
+      "No changes to update for #{object_reference(ooze)}."
+    }
   end
 
   def results_preview
@@ -196,7 +198,7 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
       ) do |res|
         next if res.upcase.start_with?("Y")
         puts "..."
-        logger.info "Aborting script..."
+        log(:info) { "Aborting script..." }
         exit(0)
       end
     end

data/lib/eco/api/usecases/ooze_samples/target_oozes_update_case.rb

@@ -21,7 +21,7 @@ class Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase < Eco::API::UseCase
           yield(ooz)
         else
           @non_retrieved_oozes += 1
-          logger.warn "Could not get page #{id}"
+          log(:warn) { "Could not get page #{id}" }
         end
       end
       update_oozes
@@ -53,7 +53,7 @@ class Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase < Eco::API::UseCase
     session.prompt_user("Do you want to proceed (y/N):", explanation: msg, default: "N", timeout: 10) do |res|
       unless res.upcase.start_with?("Y")
         puts "..."
-        logger.info "Aborting script..."
+        log(:info) { "Aborting script..." }
         exit(0)
       end
     end

data/lib/eco/api/usecases.rb

@@ -17,7 +17,6 @@ module Eco
           msg += ". Case name '#{case_name}'" if case_name
           super(msg)
         end
-
       end
 
       extend  Eco::API::Common::ClassAutoLoader
@@ -26,7 +25,7 @@ module Eco
       autoloads_children_of "Eco::API::Common::Loaders::UseCase"
       autoload_namespace_ignore "Eco::API"
 
-      def initialize()
+      def initialize
         @usecases      = {}
         @cache_init    = false
         @cases_by_name = {}
@@ -38,7 +37,7 @@ module Eco
       end
 
       def empty?
-        count == 0
+        count.zero?
       end
 
       def each(&block)
@@ -69,10 +68,12 @@ module Eco
       # Adds `usecase` to the _Collection_. Before it tries to auto-load pending classes of `auto_loaded_class`.
       # @param usecase [Eco::API::UseCases::UseCase] the usecase to be added.
       def add(usecase)
-        raise "Expected Eco::API::UseCases::UseCase object. Given: #{usecase}" if !usecase || !usecase.is_a?(Eco::API::UseCases::UseCase)
+        msg = "Expected Eco::API::UseCases::UseCase object. Given: #{usecase.class}"
+        raise ArgumentError, msg if !usecase || !usecase.is_a?(Eco::API::UseCases::UseCase)
+
         name = usecase.name
         type = usecase.type
-        puts "Warning: overriding '#{type.to_s}' case #{name}" if self.defined?(name, type: type)
+        puts "Warning: overriding '#{type}' case #{name}" if self.defined?(name, type: type)
         to_h[key(name, type)] = usecase
         @cache_init = false
         usecase
@@ -88,8 +89,10 @@ module Eco
       # @param cases [Eco::API::UseCases] the source set of cases to be merged.
       # @return [Eco::API::UseCases] `self`.
       def merge(cases)
-        return self if !cases
-        raise "Expected a Eco::API::UseCases object. Given #{cases.class}" if !cases.is_a?(Eco::API::UseCases)
+        return self unless cases
+
+        msg = "Expected a Eco::API::UseCases object. Given #{cases.class}"
+        raise msg unless cases.is_a?(Eco::API::UseCases)
 
         to_h.merge!(cases.to_h).transform_values do |usecase|
           usecase.root = self
@@ -104,18 +107,20 @@ module Eco
       end
 
       def types(name)
-        return nil if !name?(name)
-        by_name[name].map { |usecase| usecase.type }
+        return nil unless name?(name)
+
+        by_name[name].map(&:type)
       end
 
       def case(name, type: nil)
-        if type && target_case = to_h[key(name, type)]
+        if type && (target_case = to_h[key(name, type)])
           return target_case
         elsif type
           raise UseCases::UnknownCase.new(case_name: name, type: type)
         end
-        raise UseCases::UnknownCase.new(case_name: name, type: type) unless cases = by_name[name]
-        raise UseCases::AmbiguousCaseReference.new(case_name: name) if cases.length > 1
+        raise UseCases::UnknownCase.new(case_name: name, type: type) unless (cases = by_name[name])
+        raise UseCases::AmbiguousCaseReference.new(case_name: name)  if cases.length > 1
+
         cases.first
       end
 
@@ -137,7 +142,8 @@ module Eco
         # first, make sure it loads pending `:custom_children` children to be loaded
         re_init = self.class.autoload_children(self)
         return true if @cache_init && !re_init
-        @by_name = @usecases.values.group_by { |usecase| usecase.name }
+
+        @by_name = @usecases.values.group_by(&:name)
         @cache_init = true
       end
 

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

@@ -88,6 +88,8 @@ module Eco
         private
 
         def file_exists?(filename)
+          return false if filename.nil?
+
           File.exist?(filename) || File.exist?(File.expand_path(filename))
         end
       end

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

@@ -1,7 +1,8 @@
+# rubocop:disable Style/SpecialGlobalVars
 module Eco
   module Data
     module Files
-      DEFAULT_TIMESTAMP_PATTERN = '%Y-%m-%dT%H%M%S'
+      DEFAULT_TIMESTAMP_PATTERN = '%Y-%m-%dT%H%M%S'.freeze
 
       class << self
         def included(base)
@@ -22,9 +23,11 @@ module Eco
         end
 
         def read_with_tolerance(file, encoding:, tolerance: 5)
-          return nil unless content = get_file_content_with_encoding(file, encoding: encoding)
+          content = get_file_content_with_encoding(file, encoding: encoding)
+          return nil unless content
+
           content.scrub do |bytes|
-            replacement = '<' + bytes.unpack('H*')[0] + '>'
+            replacement = "<#{bytes.unpack1('H*')}>"
             if tolerance <= 0
               logger.error("There were more than 5 encoding errors in the file '#{file}'.")
               return content
@@ -67,8 +70,9 @@ module Eco
         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 dir_exists?(path)
@@ -79,9 +83,9 @@ module Eco
           date.strftime(timestamp_pattern)
         end
 
-        def timestamp_file(filename, timestamp_pattern =DEFAULT_TIMESTAMP_PATTERN)
+        def timestamp_file(filename, timestamp_pattern = DEFAULT_TIMESTAMP_PATTERN)
           file_pattern = Eco::Data::Files::FilePattern.new(filename)
-          file_pattern.resolve(start: timestamp(timestamp_pattern) + '_')
+          file_pattern.resolve(start: timestamp(timestamp_pattern) + '_') # rubocop:disable Style/StringConcatenation
         end
 
         def copy_file(source_file, dest_file, time_stamp: false)
@@ -90,8 +94,9 @@ module Eco
         end
 
         def file_empty?(path)
-          return true if !File.file?(path)
-          File.zero?(path)
+          return true unless File.file?(path)
+
+          File.empty?(path)
         end
 
         def script_subfolder
@@ -104,11 +109,17 @@ module Eco
           target = File.join(File.expand_path(folder), pattern)
           Dir[target].tap do |dir_files|
             dir_files.select! {|f| File.file?(f)}
+
             if older_than
-              dir_files.select! {|f| File.mtime(f) < (Time.now - (60*60*24*older_than))}
+              dir_files.select! do |f|
+                File.mtime(f) < (Time.now - (60*60*24*older_than))
+              end
             end
-            if regexp && regexp.is_a?(Regexp)
-              dir_files.select! {|f| File.basename(f).match(regexp)}
+
+            if regexp.is_a?(Regexp)
+              dir_files.select! do |f|
+                File.basename(f).match(regexp)
+              end
             end
           end.sort
         end
@@ -125,3 +136,5 @@ module Eco
     end
   end
 end
+
+# rubocop:enable Style/SpecialGlobalVars

data/lib/eco/data/hashes/sanke_camel_indifferent_access.rb

@@ -37,14 +37,9 @@ module Eco
             target_key = ext_keys.first unless ext_keys.empty? || ext_keys.include?(target_key)
           end
 
-          puts "final target_key: '#{key}' => '#{target_key}'" if key == 'barCamel'
-
           hash[target_key] = value
           hash_isca_resolve_key!(hash, key, prefer: prefer, residual: residual)
 
-          pp hash if key == 'barCamel'
-          puts "*" * 20 if key == 'barCamel'
-
           value
         end
 

data/lib/eco/language/models/parser_serializer.rb

@@ -8,7 +8,8 @@ module Eco
 
         # Parser/serializer.
         # @param attr [String, Symbol] name of the parsed/serialized.
-        # @param dependencies [Hash] provisioning of _**default dependencies**_ that will be required when calling back to the
+        # @param dependencies [Hash] provisioning of _**default dependencies**_
+        #   that will be required when calling back to the
         #   parsing or serializing functions.
         def initialize(attr, dependencies: {})
           @attr         = attr
@@ -67,7 +68,8 @@ module Eco
         # @param object [Any] source data to be serialized.
         # @param dependencies [Hash] _additional dependencies_ that should be merged to the _default dependencies_.
         def serialize(object, category = :default, dependencies: {}, &block)
-          raise "There is no serializer of type '#{category}' for this attribue '#{attr}'" unless serializer_category?(category)
+          msg = "There is no serializer of type '#{category}' for this attribue '#{attr}'"
+          raise msg unless serializer_category?(category)
 
           deps = resolve_dependencies(@dependencies.merge(dependencies), &block)
           call_block(object, deps, attr, &@serializer[category.to_sym])

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.7.2"
+  VERSION = '2.7.4'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.7.4
 platform: ruby
 authors:
 - Oscar Segura
@@ -156,7 +156,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.15
+        version: 0.3.16
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.4'
@@ -166,7 +166,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.15
+        version: 0.3.16
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.4'