eco-helpers 2.1.6 → 2.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a60227ce2638442d0a7b4cb8a292506ef2b4f13b59535c53e7397afb0ac48eb0
-  data.tar.gz: 794d2c7e3c85e1a9e97c22677efd483e94fb47687ff6dd2c238613099022a7e1
+  metadata.gz: 34fabf1bbcb318ac7860992bc5a24a5b27e7941e6976cda455d1e65e274fa16c
+  data.tar.gz: e44bc288d08d82ce98921f63c978d84e8813883a729e17a718978aab293d9c44
 SHA512:
-  metadata.gz: 4186a76a325a920057c6a71a0dd1f774a9342a4f1e280c392e639ceb008f845a104b7615fa8e03d11f9dab73fd995e15f25551c3b989577fa2595a64505550b9
-  data.tar.gz: 2ab664150646c1f9af560aca8c2a1dff9ddd651f867e28bddd5d560ec89c4ae9bbc8884fadd07346ab7ec6544288adcc2ce9be866adadbb63db04f0e521ee3e9
+  metadata.gz: a94bc6ca7d5c012dc03491e6e96456d4ae620c4ecfc52023716525caadb4e6683e49de8fe8d56479dc883b4710bef1c2a3b9f51fd4a7d6e7da52e0cf1d15cb50
+  data.tar.gz: 7ca163e67e3675bf3d0a84b4f11cb57cf25c164b169d418164da94963cfdbdcb5d6cc8b8ae78fb5311e955119190b93d254c715e24a05de73f90974e6ed154dd

data/CHANGELOG.md

@@ -1,18 +1,39 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.1.7] - 2022-11-xx
+## [2.1.9] - 2022-11-xx
 
 ### Added
 ### Changed
 ### Fixed
 
+## [2.1.8] - 2022-11-18
+
+### Added
+  - `Eco::API::UseCases::OozeSamples::RegisterMigrationCase`
+    - When in `dry-run` mode, it adds one line before creation feedback, so it is clear the feedback is about creation (i.e. none of the source entries got mistakenly updated)
+  - **enhanced** `Eco::API::UseCases::OozeSamples::OozeBaseCase#with_fields`
+    - It allows to optionally pass as first parameter a section or a stage (default: ooze)
+
+### Changed
+  - upgraded gem dependency `ecoportal-api-v2`
+
+## [2.1.7] - 2022-11-17
+
+### Added
+  - `Eco::API::UseCases::OozeSamples::RegisterMigrationCase` method `excluded_field_hooks`
+    - This enables the ability to prevent fields from being paired/copied/written on
+
+### Changed
+  - **refactored** `#with_src_dst_field_pair` helper
+    - from `Eco::API::UseCases::OozeSamples::HelpersMigration::Copying`
+
 ## [2.1.6] - 2022-11-17
 
 ### Fixed
   - `Eco::API::UseCases::OozeSamples::Helpers::Shortcuts#to_i` (missing param on method)
-  - `Eco::API::UseCases::OozeSamples::module HelpersMigration::TypedFieldsPairing#multi_delete` typo
-  
+  - `Eco::API::UseCases::OozeSamples::HelpersMigration::TypedFieldsPairing#multi_delete` typo
+
 ## [2.1.5] - 2022-11-17
 
 ### 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.9.5', '< 0.10'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.9.6', '< 0.10'
   spec.add_dependency 'ecoportal-api-graphql', '>= 0.1.10', '< 0.2'
   spec.add_dependency 'aws-sdk-s3',    '>= 1.83.0', '< 2'
   spec.add_dependency 'aws-sdk-ses',   '>= 1.36.0', '< 2'

data/lib/eco/api/usecases/ooze_samples/helpers_migration/copying.rb

@@ -9,8 +9,8 @@ class Eco::API::UseCases::OozeSamples
         session.logger
       end
 
-      def copy_generic_paired_fields(src, dst, exclude_ximport: false)
-        HelpersMigration::TypedFieldsPairing.new(src, dst, exclude_ximport: false).tap do |pairing|
+      def copy_generic_paired_fields(src, dst, src_excluded: [], dst_excluded: [], exclude_ximport: false)
+        HelpersMigration::TypedFieldsPairing.new(src, dst, src_excluded: src_excluded, dst_excluded: dst_excluded, exclude_ximport: false).tap do |pairing|
           pairing.each_pair do |src_fld, dst_fld|
             copy_field_content(src_fld, dst_fld)
             yield(src_fld, dst_fld, pairing) if block_given?
@@ -18,11 +18,11 @@ class Eco::API::UseCases::OozeSamples
         end
       end
 
-      def copy_hooked_fields(src, dst, hook:, type:, fields_tracker: nil)
+      def copy_hooked_fields(src, dst, hook:, type:, fields_tracker: nil, src_excluded: [], dst_excluded: [])
         case hook
         when String
-          with_src_dest_field_pair(src, dst, label: to_regex(hook), type: type) do |src_fld, dst_fld|
-            copy_field_content(src_fld, dst_fld, type).tap do |result|
+          with_src_dst_field_pair(src, dst, label: to_regex(hook), type: type, src_excluded: src_excluded, dst_excluded: dst_excluded) do |src_fld, dst_fld|
+            copy_field_content(src_fld, dst_fld).tap do |result|
               fields_tracker.resolve(src_fld, dst_fld) if fields_tracker
               yield(src_fld, dst_fld, fields_tracker) if block_given?
             end
@@ -30,8 +30,8 @@ class Eco::API::UseCases::OozeSamples
         when Hash
           hook.each do |hook_src, hook_dst|
             src_lab, dst_lab = to_regex(hook_src), to_regex(hook_dst)
-            with_src_dest_field_pair(src, dst, label: src_lab, label_dst: dst_lab, type: type) do |src_fld, dst_fld|
-              copy_field_content(src_fld, dst_fld, type).tap do |result|
+            with_src_dst_field_pair(src, dst, label: src_lab, label_dst: dst_lab, type: type, src_excluded: src_excluded, dst_excluded: dst_excluded) do |src_fld, dst_fld|
+              copy_field_content(src_fld, dst_fld).tap do |result|
                 fields_tracker.resolve(src_fld, dst_fld) if fields_tracker
                 yield(src_fld, dst_fld, fields_tracker) if block_given?
               end
@@ -44,33 +44,59 @@ class Eco::API::UseCases::OozeSamples
         /^#{str}$/i
       end
 
-      def with_src_dest_field_pair(src, dst, label: nil, label_dst: label, type: nil)
+      # @note
+      #   - When used with `type: nil` it may pair fields of different type. There isn't refinement for this yet.
+      def with_src_dst_field_pair(src, dst, label: nil, label_dst: label, type: nil, src_excluded: [], dst_excluded: [])
         unless respond_to?(:with_fields, true)
           raise "These helpers are to be included in class cases inheriting from Eco::API::UseCases::OozeSamples::RegisterUpdateCase"
         end
         src_flds = with_fields(src, label: label, type: type)
         dst_flds = with_fields(dst, label: label_dst, type: type)
+        src_fld, dst_fld = src_flds.first, dst_flds.first
+
+        # Not found
+        if dst_flds.empty? || src_flds.empty?
+          msg = "There isn't a '#{type}'"
+          dst_msg = dst_flds.empty?? "destination field named '#{label_dst}'" : nil
+          src_msg = src_flds.empty?? "source field named '#{label}'" : nil
+          msg << " #{[dst_msg, src_msg].join(" or ")} (source: '#{src.id}')"
+          logger.warn(msg)
+          return nil, nil
+        end
+
+        # Fields exclusion
+        dst_flds -= dst_excluded unless dst_excluded.empty?
+        src_flds -= src_excluded unless src_excluded.empty?
+        src_fld, dst_fld = src_flds.first, dst_flds.first
+        return src_fld, dst_fld if dst_flds.empty? || src_flds.empty?
 
         if dst_flds.count > 1
           logger.warn("There are #{dst_flds.count} destination '#{type}' fields named '#{label_dst}' (source: '#{src.id}'). Using first...")
-        elsif dst_flds.empty?
-          logger.warn("There isn't a destination '#{type}' field named '#{label_dst}' (source: '#{src.id}')")
-          return nil, nil
         end
 
         if src_flds.count > 1
-          logger.warn("There are #{src_flds.count} source '#{type}' fields named '#{label}' (source: '#{src.id}'). Using first...")
-        elsif src_flds.empty?
-          logger.warn("There isn't a source '#{type}' field named '#{label}' (source: '#{src.id}')")
-          return nil, dst
+          msg = "There are #{src_flds.count} source '#{type}' fields named '#{label}' (source: '#{src.id}'). "
+          src_content = src_flds.reject(&:empty?)
+          if src_content.empty?
+            msg << "None with content. Using first..."
+          else
+            src_fld = src_content.first
+            if src_content.count == 1
+              msg << "Using the only one with content (idx: #{src_flds.index(src_fld)})..."
+            else
+              msg << "#{src_content.count} have content. Using first..."
+            end
+          end
+          logger.warn(msg)
         end
 
-        [src_flds.first, dst_flds.first].tap do |(src_fld, dst_fld)|
+        [src_fld, dst_fld].tap do |(src_fld, dst_fld)|
           yield(src_fld, dst_fld) if block_given?
         end
       end
 
-      def copy_field_content(src, dst, type = src.type)
+      def copy_field_content(src, dst)
+        type = src.type
         case type
         when "select"
           src.values.each {|val| dst.select(val)}

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

@@ -70,8 +70,14 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   def with_fields(entry = target, type: nil, label: nil)
     flds = entry.components
-    flds = flds.get_by_type(type) if type
-    flds = flds.select do |fld|
+    if type
+      if flds.respond_to?(:get_by_type)
+        flds = flds.get_by_type(type)
+      else
+        flds = flds.select {|fld| fld.type == type}
+      end
+    end
+    flds.select do |fld|
       value = (label == :unnamed) ? nil : label
       !label || same_string?(fld.label, value)
     end.each do |field|

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

@@ -7,12 +7,17 @@
 #         1. field label name (String or RegExp body/source),
 #         2. or an object with key-value being source-destination label names (also supports RegExp body/source)
 #     - Example: {"select": ["severity of .*:", {"type of event:" => "type of incident:"}]}
+#     - "all" as type will target all type of fields.
+#       - Caution with this! Copying between fields of different types is not yet supported.
 #   - You may either
 #     1. define the `process_ooze` method calling super with a block: super.do ||
 #     2. of define the function `custom_processing(draft, source, fields_tracker: nil)`
 #   - You can define a callback function, `paired_fields_post_callback(src_fld, dst_fld, pairing_tracking = nil)`
 #     - It will be called after copying by using any of the pairing methods, and allows to introduce modifications
 #       such as selection option mappings
+#   - You may define a method called `excluded_field_hooks` with same syntax as the json pairing file
+#     - This will exclude as source and destination targets any fields matching those patterns.
+#     - This is specially useful to discard rich text field guidelines (i.e. `{"rich_text" => [".*guideline:"]}`)
 # This case expects `options[:source][:register_id]`
 class Eco::API::UseCases::OozeSamples::RegisterMigrationCase < Eco::API::UseCases::OozeSamples::RegisterUpdateCase
   name "register-migration-case"
@@ -101,8 +106,22 @@ class Eco::API::UseCases::OozeSamples::RegisterMigrationCase < Eco::API::UseCase
 
   def copy_pairings(src, dst)
     after_copy = callback(:paired_fields_post)
-    copy_generic_paired_fields(src, dst, exclude_ximport: self.class::EXCLUDE_XIMPORT, &after_copy).tap do |pairing_tracking|
-      copy_mapped_fields(src, dst, fields_tracker: pairing_tracking, &after_copy)
+    params = {
+      src_excluded: excluded_fields(src),
+      dst_excluded: excluded_fields(dst)
+    }
+    copy_generic_paired_fields(src, dst, **params.merge(exclude_ximport: self.class::EXCLUDE_XIMPORT), &after_copy).tap do |pairing_tracking|
+      copy_mapped_fields(src, dst, **params.merge(fields_tracker: pairing_tracking), &after_copy)
+    end
+  end
+
+  def excluded_fields(entry)
+    return [] unless respond_to?(:excluded_field_hooks, true)
+    excluded_field_hooks.each_with_object([]) do |(type, hooks), excluded|
+      hooks.each do |hook|
+        type = (type == "all")? nil : type
+        excluded.push(*with_fields(entry, label: to_regex(hook), type: type))
+      end
     end
   end
 
@@ -112,11 +131,12 @@ class Eco::API::UseCases::OozeSamples::RegisterMigrationCase < Eco::API::UseCase
     raise msg
   end
 
-  def copy_mapped_fields(src, dst, fields_tracker: nil, &after_copy)
+  def copy_mapped_fields(src, dst, **kargs, &after_copy)
     return [] unless field_maps?
     field_maps.each do |type, field_hooks|
+      type = (type == "all")? nil : type
       field_hooks.each do |hook_name|
-        copy_hooked_fields(src, dst, hook: hook_name, type: type, fields_tracker: fields_tracker, &after_copy)
+        copy_hooked_fields(src, dst, hook: hook_name, type: type, **kargs, &after_copy)
       end
     end
   end
@@ -140,6 +160,7 @@ class Eco::API::UseCases::OozeSamples::RegisterMigrationCase < Eco::API::UseCase
       if !options[:dry_run]
         create_ooze(draft, template_id: from).page_id
       else
+        logger.info("Creation sample follows...")
         dry_run_feedback(draft)
         false
       end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.1.6"
+  VERSION = "2.1.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.1.6
+  version: 2.1.8
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'