eco-helpers 2.0.53 → 2.0.56

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71ac6b334999283d1bab07efdb1ece3fdbbfaa56052f292010a3741faad92351
-  data.tar.gz: e432429671478dcca99ef444f1db0eeab66d9ad2dc7150cfc12577fb06f5b1e7
+  metadata.gz: c9227a13716393bdd79a7bdf3d4729dbc2b426f43e16d1525001ffd0a2c58bb4
+  data.tar.gz: 00adb8c5c5abc08e53e4130a1cdf9ff03cf4307ac86c4cbe8e84ebffd8ba2458
 SHA512:
-  metadata.gz: ff99f0de94a2e87730f2d6b8496d4d556cbfe7ec3bb99289f3e27cf30512e0644b33f142f0664ee2c5f9f91e7fc13b83bc62178af26f3e0929668acd94f95088
-  data.tar.gz: 3b9b43011552a1cb9f37a46c18cabab8ad2892b3634908895ddd99b2269151c65bd3a4c5a6281ab080396ea3ec0890f29fd5f1e37c8427d80bbdb2c2e240b91f
+  metadata.gz: 0c69583967b50677bf012fdd354d3fb17abf521fcceb702f71ccfbfd942fb1e11963ff50b103f351e9cbebcfd531751dc9c54094e6b645c40b0e77d5ef6c7d8b
+  data.tar.gz: 60a0e1e311f8a3aae34bbfcf1f4c5dccf3bd541dfaef0ab60b3f7b557a69bc6b5f7a74febdea0a85aa4db658c508da69fef99753c89459db0eab58112c577bc2

data/CHANGELOG.md

@@ -1,17 +1,46 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.53] - 2022-03-xx
+## [2.0.56] - 2022-04-xx
+
+### Added
+  - `Eco::API::UseCases::OozeSamples::OozeBaseCase#add_field_by_doc`
+    - Same as `#add_field` but using an existing _**doc**_ as a model
+
+### Changed
+  - `ecoportal-api-v2` dependency upgrade
+  - `Eco::API::Common::Session::FileManager#file_content`
+    - added parameter `mode:` to options can be used as well
+  - `Eco::API::UseCases::OozeSamples::Helpers::Shortcuts#same_string?`
+    - Added parameter `mild:` to compare the strings with only alphabetic characters
+  - `Eco::API::UseCases::OozeSamples::OozeRunBaseCase`
+    - `#main` and `#process_ooze` methods were not obvious to use
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase` slight change on the **`run` summary message**
+
+### Fixed
+  - `Eco::API::UseCases::OozeSamples::OozeBaseCase#update_ooze`
+    - Added call to `validate` also when we are on `dry-run` **mode**
+
+## [2.0.55] - 2022-04-04
+
+### Fixed
+  - `Eco::API::UseCases::DefaultCases::Samples::Sftp` should move the basename to Windows compatible chars.
+
+## [2.0.54] - 2022-04-04
+
+### Added
+  - `Eco::API::UseCases::DefaultCases::Samples::Sftp` should tell where the files went in the local.
+
+
+## [2.0.53] - 2022-04-04
 
 ### Added
   - `Eco::API::MicroCases#set_supervisor` prevent to set someone as supervisor of themselves.
   - `Eco::API::UseCases::DefaultCases::Samples::Sftp` integration to modify the `source_folder`
-  
+
 ### Changed
   - upgrade `ecoportal-api` and `ecoportal-api-v2` dependencies
 
-### Fixed
-
 ## [2.0.52] - 2022-03-04
 
 ### Added

data/eco-helpers.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
 
   spec.add_dependency 'ecoportal-api', '>= 0.8.5', '< 0.9'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.26', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.27', '< 0.9'
   spec.add_dependency 'aws-sdk-s3',    '>= 1.83.0', '< 2'
   spec.add_dependency 'aws-sdk-ses',   '>= 1.36.0', '< 2'
   spec.add_dependency 'dotenv',        '>= 2.7.6', '< 2.8'

data/lib/eco/api/common/session/file_manager.rb

@@ -38,14 +38,14 @@ module Eco
             dir.newest_file(file: filename)
           end
 
-          def file_content(filename)
+          def file_content(filename, mode: nil)
             file = dir.file(filename, should_exist: true)
             if !file
               logger.error("Can't read from file '#{filename}' because it does not exist.")
               return nil
             end
             logger.debug("Reading from file '#{file}'")
-            File.read(file)
+            mode ? File.read(file, mode: mode) : File.read(file)
           end
 
           def load_json(filename)

data/lib/eco/api/common/session/sftp.rb

@@ -65,8 +65,11 @@ module Eco
           # @param files [String, Array<String>] full path to remote file(s) to be downloaded
           # @param local_folder [String] local destination folder (`"."` if not specified)
           def download(files, local_folder: nil)
+            puts "Creating local files:"
             [files].flatten.compact.map do |fullname|
-              dest_fullname = File.join(local_folder || ".", File.basename(fullname))
+              basename = windows_basename(fullname)
+              dest_fullname = File.join(local_folder || ".", basename)
+              puts " • #{dest_fullname}"
               sftp_session.download(fullname, dest_fullname)
             end.each do |dw|
               # run SSH event loop while dw.active?
@@ -76,6 +79,12 @@ module Eco
 
           private
 
+          def windows_basename(remote_fullname)
+            parts = remote_fullname.split(/[\\\/]/).map {|node| node.gsub(/[<>:\\\/\|?*]/, '_')}
+            local_fullname = File.join(*parts)
+            File.basename(local_fullname)
+          end
+
           def logger
             @enviro&.logger || ::Logger.new(IO::NULL)
           end

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

@@ -50,7 +50,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
     with_remote_files.tap do |files|
       unless files.empty?
         file_names = files.map {|file| to_remote_path(file.name)}
-        puts "Getting the following files:"
+        puts "Getting the following files into the local folder '#{local_folder}':"
         puts file_names
         sftp.download(file_names, local_folder: local_folder)
       end

data/lib/eco/api/usecases/ooze_samples/helpers/shortcuts.rb

@@ -6,13 +6,20 @@ module Eco
           module Shortcuts
 
             # Offers multiple ways to compare two strings
-            def same_string?(value1, value2, exact: false)
+            def same_string?(value1, value2, exact: false, mild: false)
               case
               when value1.is_a?(String) && value2.is_a?(String)
                 if exact
                   value1 == value2
                 else
-                  value1.to_s.strip.downcase == value2.to_s.strip.downcase
+                  v1 = value1.to_s.strip.downcase
+                  v2 = value2.to_s.strip.downcase
+
+                  if mild
+                    v1 = v1.gsub(/[^a-z ]+/, ' ').gsub(/\s+/, ' ').strip
+                    v2 = v2.gsub(/[^a-z ]+/, ' ').gsub(/\s+/, ' ').strip
+                  end
+                  v1 == v2
                 end
               when value1.is_a?(Regexp) && value2.is_a?(String)
                 value2 =~ value1
@@ -64,11 +71,31 @@ module Eco
                   ref << "Page (#{obj.id}) (#{object_reference(obj.current_stage)})"
                 when Ecoportal::API::V2::Page
                   ref << "Page"
+                when Ecoportal::API::V2::Page::Section
+                  ref << "Section '#{obj.heading || "(unnamed)"}'"
+                when Ecoportal::API::V2::Page::Component
+                  ref << "Component '#{obj.label || "(unnamed of type '#{obj.type}')"}' in #{object_reference(obj.section)}"
+                when Ecoportal::API::V2::Page::Force
+                  ref << "Force '#{obj.name}'"
+                when Ecoportal::API::V2::Page::Force::Binding
+                  ref << "Binding '#{obj.name}' in #{object_reference(obj.force)}"
                 end
                 ref << " '#{obj.name}'" if obj.respond_to?(:name)
               end
             end
 
+            def to_i
+              Float(value).to_i
+            end
+
+            # https://stackoverflow.com/a/5661695/4352306
+            def is_number?(value)
+              begin
+                true if Float(value)
+              rescue ArgumentError => e
+                false
+              end
+            end
           end
         end
       end

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

@@ -29,7 +29,18 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   protected
 
-  def add_field(name, type, section, after:  nil, before: nil, side: :left)
+  def add_field_by_doc(doc, section, after: nil, before: nil, side: :left)
+    unless section.is_a?(Ecoportal::API::V2::Page::Section)
+      raise "You need to specify a section for a new field. Given: #{section.class}"
+    end
+    target.components.add(doc: doc) do |field|
+      section.add_component(field, after: after, before: before, side: side)
+    end.tap do |field|
+      yield(field) if block_given?
+    end
+  end
+
+  def add_field(name, type, section, after: nil, before: nil, side: :left)
     unless section.is_a?(Ecoportal::API::V2::Page::Section)
       raise "You need to specify a section for a new field. Given: #{section.class}"
     end
@@ -92,7 +103,7 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
     if ooze_id = ooze && ooze.id
       exit_error "#{object_reference(ooze)} does not have stages!" unless ooze.stages?
     else
-      exit_error "There's no target ooze to get retrieve stages from"
+      exit_error "There's no target ooze to retrieve stages from"
     end
 
     if stg = ooze.stages[id_name] || ooze.stages.get_by_name(id_name)
@@ -129,11 +140,15 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
         end
       end
     else
+      ooze.validate.tap do |validation|
+        logger.error(validation) if validation.is_a?(String)
+      end
       unless options.dig(:feedback, :only_stats)
         if patch = (patch_doc(ooze) || {})["page"]
           pp patch
         end
       end
+
       backup_patch!(ooze)
       exit(0) if dirty?(ooze) && dry_count > DRY_COUNT
       false
@@ -189,6 +204,4 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
     logger.error(msg)
     exit(1)
   end
-
-
 end

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

@@ -3,24 +3,26 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::Ooz
   name "ooze-run-base"
   type :other
 
-  attr_reader :session, :options, :usecase
-
   SAVE_PATCH = "ooze_patch_update.json"
 
-  def main(session, options, usecase, &block)
-    raise "You need to inherit from this class and call super with a block" unless block
-    @session = session; @options = options; @usecase = usecase
-    process_ooze(&block)
-  end
-
-  def process_ooze(ooze = target)
-    raise "You need to inherit from this class and call super with a block" unless block_given?
-    super(ooze) do
-      yield(ooze)
+  def main(session, options, usecase)
+    super(session, options, usecase) do
+      if method(:process_ooze).parameters.count == 0
+        ooze # retrieve ooze
+        process_ooze
+      else
+        process_ooze(ooze)
+      end
+      yield(target) if block_given?
       exit_if_no_changes!
+      update_ooze(target)
     end
   end
 
+  def process_ooze(page = target)
+    raise "You need to redefine this method"
+  end
+
   private
 
   def ooze

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

@@ -39,7 +39,8 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
     msg += "  • Duplicated search results #{dupped_search_oozes}\n"
     msg += "  • Retrieved a total of #{retrieved_oozes}\n"
     msg += "  • Could not get #{non_retrieved_oozes} oozes.\n"
-    msg += "  • Updated #{updated_oozes} oozes (failed update on #{failed_update_oozes} oozes).\n"
+    msg += "  • Updated #{updated_oozes} oozes.\n"
+    msg += "    - Failed update on #{failed_update_oozes} oozes.\n"
     logger.info(msg)
   end
 
@@ -72,7 +73,6 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
         end
 
         if pending = queue_shift(page_result.id)
-
           if dirty?(pending)
             msg  = "Inconsistent search results. "
             msg << "Launching update on '#{object_reference(pending)}' to be able to queue it back"

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.53"
+  VERSION = "2.0.56"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.53
+  version: 2.0.56
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.26
+        version: 0.8.27
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.26
+        version: 0.8.27
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'