eco-helpers 2.0.26 → 2.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 722e1dc695f9d9fae5fbceca8a2269f4836393ee4dc50fc0f850e43fefc88789
-  data.tar.gz: bc34444cdf33bff51895fa5ed6bb7a89b89074e5bd11852c0a1a4f4bf6bcc574
+  metadata.gz: dd31d354667802423a4003fe347af67916015eaeac0d1682cbe511d7afc11b40
+  data.tar.gz: d0f9d23f2ad6db33861441d9f865a9e5925eec7a1e4042f7246bbded8f61ce6f
 SHA512:
-  metadata.gz: 9a18aaa7abf012872f21209907909f1c309ddb530586bc9e27d595ace57377c3c4dba2b0a7bacc902e160cf2f51d4171a5de3e0536b6eda4dff7d018307744ca
-  data.tar.gz: efcaa1832677c0cf13d5dfb0ba6a3abaa8bff3fec4e1d2639b2b832358a1e51b849e594da64827bed096eb4f8f03a5664a6a8245c58128acf3478eaf0e94d38a
+  metadata.gz: fafda0f2b9f6866499df3a641598800ea5dd2c2536710a759bbd0d30a307f36da8cc1cb30056de965134aea509ce1700df152d233d322b41c590048569ecd23e
+  data.tar.gz: d2f953274727fa35d8474da766dabee715f21b4ae227be9e0b4f31363d58fdcc1b0e410d10976b3f8608e14335d5f42c97dccd6a3d2e55ea37fb4a945d02d091

data/CHANGELOG.md

@@ -1,7 +1,46 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.26] - 2021-06-xx
+## [2.0.31] - 2021-07-xx
+
+### Added
+
+### Changed
+
+### Fixed
+  - `Eco::API::Session::Batch::Job`: `include-excluded` was triggering a type error.
+
+## [2.0.30] - 2021-07-08
+
+### Added
+  * `Eco::API::Common::People::DefaultParsers::XLSParser` uses as default the `fields_map.json` to identify the headers.
+
+### Fixed
+  * `Eco::API::Common::People::DefaultParsers::XLSParser` should return all `String` values
+
+## [2.0.29] - 2021-07-08
+
+### Fixed
+  - `Eco::API::Common::People::PersonEntryAttributeMapper#details_attrs`
+    * What a mess this was doing to the `csv` export :/
+
+## [2.0.27] - 2021-07-05
+
+### Changed
+  -  Parent class `Eco::API::UseCases::DefaultCases::ToCsvCase` shouldn't know header maps necessary for `Eco::API::UseCases::DefaultCases::ToCsvDetailedCase`
+    * Moved related header maps to `ToCsvDetailedCase`
+
+### Fixed
+  - `--help` should work fine now
+  - Attribute parsers that depended on indirect parser attributes were **not** included
+    - **changed** a couple of classes
+      - `Eco::API::Common::People::PersonEntryAttributeMapper`, where methods should receive `data` to re-scope if the data is available (most specifically `#internal_attrs`)
+      - `Eco::API::Common::People::PersonEntry`, where when setting the final values on `Person`, it should include any internal attribute that is present in the `final_entry` (the result of all the parsing process)
+  - `Eco::API::Common::People::DefaultParsers::CSVParser`
+    - indirect attributes that depended on other indirect attributes would show as missing even if they were active
+      - i.e. `name` depends on `first-name` & `surname`, **AND** `details-name` depends on `name`
+
+## [2.0.26] - 2021-06-25
 
 ### Added
   - `Eco::API::MicroCases#set_supervisor`, tries to keep in sync the `#subordinates` **count** of previous and new supervisor
@@ -49,9 +88,6 @@ All notable changes to this project will be documented in this file.
     * when in `dry-run` it fakes the `id` with a counter
   - `Eco::API::Common::People::PersonFactory` gets `subordinates` initialized to `0` (when **creating** a `new` person)
 
-### Fixed
-
-
 ## [2.0.25] - 2021-06-23
 
 ### Added

data/lib/eco/api/common/loaders/base.rb

@@ -5,7 +5,7 @@ module Eco
         class Base
           extend Eco::API::Common::ClassHelpers
 
-          class << self              
+          class << self
             # Sort order
             def <=>(other)
               created_at <=> other.created_at

data/lib/eco/api/common/people/default_parsers/csv_parser.rb

@@ -70,20 +70,14 @@ class Eco::API::Common::People::DefaultParsers::CSVParser < Eco::API::Common::Lo
   end
 
   def missing_headers(headers)
-    hint = headers & all_internal_attrs
-    hext = headers - hint
-    int_head = hint + hext.map {|e| fields_mapper.to_internal(e)}.compact
-    known_as_int = known_headers.select do |e|
-      i = fields_mapper.to_internal(e)
-      int_head.include?(i)
-    end
+    int_head = internal_present_or_active(headers)
     ext  = headers.select do |e|
       i = fields_mapper.to_internal(e)
       int_head.include?(i)
     end
-    ext_present = known_as_int | ext
+    ext_present = known_headers_present(int_head) | ext
     ext_miss    = known_headers - ext_present
-    #int_miss  = ext_miss.map {|ext| fields_mapper.to_internal(ext)}
+
     ext_miss.each_with_object({}) do |ext, missing|
       next unless int = fields_mapper.to_internal(ext)
       if all_internal_attrs.include?(int)
@@ -91,7 +85,10 @@ class Eco::API::Common::People::DefaultParsers::CSVParser < Eco::API::Common::Lo
         missing[:direct] << ext
       end
       related_attrs_requirements = required_attrs.values.select do |req|
-        req.dependant?(int) && !int_head.include?(req.attr)
+        dep       = req.dependant?(int)
+        affects   = dep && !int_head.include?(int)
+        in_header = int_head.include?(req.attr)
+        affects || (dep && !in_header)
       end
       next if related_attrs_requirements.empty?
       missing[:indirect] ||= {}
@@ -106,6 +103,41 @@ class Eco::API::Common::People::DefaultParsers::CSVParser < Eco::API::Common::Lo
     end
   end
 
+  def known_headers_present(headers_internal)
+    @known_internal ||= known_headers.select do |ext|
+      int = fields_mapper.to_internal(ext)
+      headers_internal.include?(int)
+    end
+  end
+
+  def internal_present_or_active(headers, inactive_requirements = {})
+    hint = headers & all_internal_attrs
+    hext = headers - hint
+    int_present = hint + hext.map {|e| fields_mapper.to_internal(e)}.compact
+
+    update_inactive = Proc.new do
+      inactive_requirements.dup.each do |attr, req|
+        if req.active?(*int_present)
+          inactive_requirements.delete(attr)
+          int_present << attr
+          update_inactive.call
+        end
+      end
+    end
+
+    required_attrs.values.each do |req|
+      next if int_present.include?(req)
+      if req.active?(*int_present)
+        inactive_requirements.delete(req.attr)
+        int_present << req.attr
+        update_inactive.call
+      else
+        inactive_requirements[req.attr] = req
+      end
+    end
+    int_present
+  end
+
   def known_headers
     @known_headers ||= fields_mapper.list(:external).compact
   end
@@ -121,7 +153,11 @@ class Eco::API::Common::People::DefaultParsers::CSVParser < Eco::API::Common::Lo
   end
 
   def all_internal_attrs
-    person_parser.all_attrs(include_defined_parsers: true)
+    @all_internal_attrs ||= [].tap do |int_attrs|
+      known_int_attrs  = person_parser.all_attrs(include_defined_parsers: true)
+      known_int_attrs |= fields_mapper.list(:internal).compact
+      int_attrs.concat(known_int_attrs)
+    end
   end
 
   def person_parser

data/lib/eco/api/common/people/default_parsers/xls_parser.rb

@@ -6,7 +6,12 @@ class Eco::API::Common::People::DefaultParsers::XLSParser < Eco::API::Common::Lo
 
   def parser(file, deps)
     @file = file
-    rows.tap {|r| @file = nil}
+    rows.tap do |rws|
+      @file = nil
+      rws.each do |row|
+        to_string!(row)
+      end
+    end
   end
 
   def serializer(array_hash, deps)
@@ -15,8 +20,18 @@ class Eco::API::Common::People::DefaultParsers::XLSParser < Eco::API::Common::Lo
 
   private
 
+  def to_string!(row)
+    row.transform_values! do |val|
+      next nil unless val
+      next val if val.is_a?(String)
+      val.to_s
+    end
+  end
+
+
   def headers
-    raise "You should implement this method"
+    logger.warn("Headers detection is using your fields_map.json file (native behaviour)")
+    session.fields_mapper.list(:external).uniq
   end
 
   def sheet_name
@@ -34,7 +49,7 @@ class Eco::API::Common::People::DefaultParsers::XLSParser < Eco::API::Common::Lo
 
   def rows(target = headers)
     begin
-      spreadheet.parse(header_search: target)
+      spreadheet.parse(header_search: target, clean: true)
     rescue Roo::HeaderRowNotFoundError => e
       missing  = JSON.parse(e.message)
       logger.warn("The input file is missing these headers: #{missing}")

data/lib/eco/api/common/people/person_entry.rb

@@ -188,7 +188,7 @@ module Eco
           # @param person [Ecoportal::API::V1::Person] the person we want to set the core values to.
           # @param exclude [String, Array<String>] core attributes that should not be set/changed to the person.
           def set_core(person, exclude: nil)
-            scoped_attrs = @emap.core_attrs - into_a(exclude)
+            scoped_attrs = @emap.core_attrs(@final_entry) - into_a(exclude)
             @final_entry.slice(*scoped_attrs).each do |attr, value|
               begin
                 set_part(person, attr, value)
@@ -210,7 +210,7 @@ module Eco
           # @param exclude [String, Array<String>] account properties that should not be set/changed to the person.
           def set_account(person, exclude: nil)
             person.account = {} if !person.account
-            scoped_attrs = @emap.account_attrs - into_a(exclude)
+            scoped_attrs = @emap.account_attrs(@final_entry) - into_a(exclude)
             @final_entry.slice(*scoped_attrs).each do |attr, value|
               set_part(person.account, attr, value)
             end
@@ -224,7 +224,7 @@ module Eco
           # @param exclude [String, Array<String>] schema field attributes that should not be set/changed to the person.
           def set_details(person, exclude: nil)
             person.add_details(@person_parser.schema) if !person.details || !person.details.schema_id
-            scoped_attrs = @emap.details_attrs - into_a(exclude)
+            scoped_attrs = @emap.details_attrs(@final_entry) - into_a(exclude)
             @final_entry.slice(*scoped_attrs).each do |attr, value|
               set_part(person.details, attr, value)
             end
@@ -326,12 +326,13 @@ module Eco
           # @param internal_entry [Hash] the entry with the **internal** _attribute_ names and values but the **external** types.
           # @return [Hash] the `parsed entry` with the **internal** final attributes names, values and types.
           def _final_parsing(internal_entry)
-            core_account      = @emap.account_attrs + @emap.core_attrs
-            core_account_hash = internal_entry.slice(*core_account).each_with_object({}) do |(attr, value), hash|
+            core_account_attrs = @emap.account_attrs(internal_entry) + @emap.core_attrs(internal_entry)
+            core_account_hash  = internal_entry.slice(*core_account_attrs).each_with_object({}) do |(attr, value), hash|
               hash[attr]  = _parse_type(attr, value)
             end
 
-            details_hash      = internal_entry.slice(*@emap.details_attrs).each_with_object({}) do |(attr, value), hash|
+            details_attrs     = @emap.details_attrs(internal_entry)
+            details_hash      = internal_entry.slice(*details_attrs).each_with_object({}) do |(attr, value), hash|
               hash[attr] = _parse_type(attr, value, schema: @person_parser.schema)
             end
 

data/lib/eco/api/common/people/person_entry_attribute_mapper.rb

@@ -3,18 +3,11 @@ module Eco
     module Common
       module People
 
-        # @attr_reader core_attrs [Array<String>] core attributes that are present in the person entry.
-        # @attr_reader details_attrs [Array<String>] schema details attributes that are present in the person entry.
-        # @attr_reader account_attrs [Array<String>] account attributes that are present in the person entry.
-        # @attr_reader all_model_attrs [Array<String>] all the attrs that are present in the person entry.
-        # @attr_reader internal_attrs [Array<String>] all the internally named attributes that the person entry has.
-        # @attr_reader aliased_attrs [Array<String>] only those internal attributes present in the person entry that have an internal/external name mapping.
         # @attr_reader direct_attrs [Array<String>] only those internal attributes present in the person entry that do **not** have an internal/external name mapping.
         class PersonEntryAttributeMapper
           @@cached_warnings = {}
 
-          attr_reader :core_attrs, :details_attrs, :account_attrs, :all_model_attrs
-          attr_reader :internal_attrs, :aliased_attrs, :direct_attrs
+          attr_reader :aliased_attrs, :direct_attrs
 
           # Helper class tied to `PersonEntry` that allows to track which attributes of a person entry are present
           # and how they should be mapped between internal and external names if applicable.
@@ -38,17 +31,64 @@ module Eco
 
             if parsing?
               @external_entry   = data
-              init_attr_trackers
             else  # SERIALIZING
               @person          = data
-              @internal_attrs  = @person_parser.all_model_attrs
-              @aliased_attrs   = @attr_map.list(:internal)
             end
+          end
 
-            @core_attrs    = @person_parser.target_attrs_core(@internal_attrs)
-            @details_attrs = @person_parser.target_attrs_details(@internal_attrs)
-            @account_attrs = @person_parser.target_attrs_account(@internal_attrs)
-            @all_model_attrs = @core_attrs | @account_attrs | @details_attrs
+          # @return [Array<String>] only those internal attributes present in the person entry that have an internal/external name mapping.
+          def aliased_attrs
+            return @aliased_attrs unless !@aliased_attrs
+            if parsing?
+              init_attr_trackers
+            else
+              @aliased_attrs = @attr_map.list(:internal)
+            end
+            @aliased_attrs
+          end
+
+          # @return [Array<String>] all the internally named attributes that the person entry has.
+          def internal_attrs(data = nil)
+            return @internal_attrs unless data || !@internal_attrs
+            if parsing?
+              init_attr_trackers unless @internal_attrs
+              if data
+                return data.keys & @person_parser.all_model_attrs
+              end
+            else
+              @internal_attrs = @person_parser.all_model_attrs
+            end
+            @internal_attrs
+          end
+
+
+          # @return [Array<String>] all the attrs that are present in the person entry.
+          def all_model_attrs(data = nil)
+            core_attrs(data) | account_attrs(data) | details_attrs(data)
+          end
+
+          # @return [Array<String>] core attributes that are present in the person entry.
+          def core_attrs(data = nil)
+            return @core_attrs unless data || !@core_attrs
+            @person_parser.target_attrs_core(internal_attrs(data)).tap do |core_attrs|
+              @core_attrs ||= core_attrs
+            end
+          end
+
+          # @return [Array<String>] schema details attributes that are present in the person entry.
+          def details_attrs(data = nil)
+            return @details_attrs unless data || !@details_attrs
+            @person_parser.target_attrs_details(internal_attrs(data)).tap do |details_attrs|
+              @details_attrs ||= details_attrs
+            end
+          end
+
+          # @return [Array<String>] account attributes that are present in the person entry.
+          def account_attrs(data = nil)
+            return @account_attrs unless data || !@account_attrs
+            @person_parser.target_attrs_account(internal_attrs(data)).tap do |account_attrs|
+              @account_attrs ||= account_attrs
+            end
           end
 
           # To know if currently the object is in parse or serialize mode.
@@ -151,7 +191,6 @@ module Eco
             def_unlinked      = @person_parser.undefined_model_attrs.select { |attr| !to_external(attr) }
             # (def) those with parser or alias:
             def_linked        = def_all_attrs - def_unlinked
-
             # (data) data attributes (actual attributes of the entry)
             data_attrs        = attributes(@external_entry)
             # (data) attributes of the data that come directly as internal attribute names

data/lib/eco/api/session/batch/job.rb

@@ -253,7 +253,8 @@ module Eco
           def api_included(full_queue)
             return full_queue if type == :create
             return full_queue unless excluded = session.config.people.api_excluded
-            if options.dig(:include, :excluded, :only)
+            excluded = options.dig(:include, :excluded)
+            if excluded.is_a?(Hash) && excluded[:only]
               full_queue.select {|entry| excluded.call(entry, session, options, self)}
             elsif options.dig(:include, :excluded)
               full_queue

data/lib/eco/api/usecases/default_cases/to_csv_case.rb

@@ -125,43 +125,7 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
       "id"                 => "ecoPortal ID",
       "external_id"        => "Reference ID (ext_id)",
       "login_provider_ids" => "Login Methods",
-      "landing_page_id"    => "Landing Page ID",
-      "show_sidebar"       => "(pref) Sidebar Open?",
-      "show_shortcuts"     => "(pref) Link to Registers?",
-      "show_coming_soon"   => "(pref) Coming Soon List?",
-      "show_recently_visited_forms" => "(pref) Recently Visited Forms List?",
-      "show_tasks"         => "(pref) Tasks List?",
-      "show_task_bubbles"  => "(pref) Task Count Bubbles",
-      "kiosk_enabled"      => "Kiosk User?",
-      "freemium"           => "Freemium User?",
-      "files"              => "(able) on Files",
-      "reports"            => "(able) on Report Structures",
-      "data"               => "(able) on Data (hours, datasets)",
-      "organization"       => "(able) on Organization Config",
-      "pages"              => "(able) on Page/Entries",
-      "page_editor"        => "(able) page Editor Level",
-      "registers"          => "(able) on Registers",
-      "tasks"              => "(able) on Tasks",
-      "person_core"        => "(able) on People",
-      "person_core_create" => "(able) Create People?",
-      "person_core_edit"   => "(able) Edit People?",
-      "person_details"     => "(able) on People Schema Details",
-      "person_account"     => "(able) on Users",
-      "person_abilities"   => "(able) on Users' Abilities",
-      "custom_files"              => "(min) on Files",
-      "custom_reports"            => "(min) on Report Structures",
-      "custom_data"               => "(min) on Data (hours, datasets)",
-      "custom_organization"       => "(min) on Organization Config",
-      "custom_pages"              => "(min) on Page/Entries",
-      "custom_page_editor"        => "(min) page Editor Level",
-      "custom_registers"          => "(min) on Registers",
-      "custom_tasks"              => "(min) on Tasks",
-      "custom_person_core"        => "(min) on People",
-      "custom_person_core_create" => "(min) Create People?",
-      "custom_person_core_edit"   => "(min) Edit People?",
-      "custom_person_details"     => "(min) on People Schema Details",
-      "custom_person_account"     => "(min) on Users",
-      "custom_person_abilities"   => "(min) on Users' Abilities"
+      "landing_page_id"    => "Landing Page ID"
     }
   end
 

data/lib/eco/api/usecases/default_cases/to_csv_detailed_case.rb

@@ -75,4 +75,46 @@ class Eco::API::UseCases::DefaultCases::ToCsvDetailedCase < Eco::API::UseCases::
     ]
   end
 
+  def nice_header_maps
+    @nice_header_maps ||= super.merge({
+      "landing_page_id"    => "Landing Page ID",
+      "show_sidebar"       => "(pref) Sidebar Open?",
+      "show_shortcuts"     => "(pref) Link to Registers?",
+      "show_coming_soon"   => "(pref) Coming Soon List?",
+      "show_recently_visited_forms" => "(pref) Recently Visited Forms List?",
+      "show_tasks"         => "(pref) Tasks List?",
+      "show_task_bubbles"  => "(pref) Task Count Bubbles",
+      "kiosk_enabled"      => "Kiosk User?",
+      "freemium"           => "Freemium User?",
+      "files"              => "(able) on Files",
+      "reports"            => "(able) on Report Structures",
+      "data"               => "(able) on Data (hours, datasets)",
+      "organization"       => "(able) on Organization Config",
+      "pages"              => "(able) on Page/Entries",
+      "page_editor"        => "(able) page Editor Level",
+      "registers"          => "(able) on Registers",
+      "tasks"              => "(able) on Tasks",
+      "person_core"        => "(able) on People",
+      "person_core_create" => "(able) Create People?",
+      "person_core_edit"   => "(able) Edit People?",
+      "person_details"     => "(able) on People Schema Details",
+      "person_account"     => "(able) on Users",
+      "person_abilities"   => "(able) on Users' Abilities",
+      "custom_files"              => "(min) on Files",
+      "custom_reports"            => "(min) on Report Structures",
+      "custom_data"               => "(min) on Data (hours, datasets)",
+      "custom_organization"       => "(min) on Organization Config",
+      "custom_pages"              => "(min) on Page/Entries",
+      "custom_page_editor"        => "(min) page Editor Level",
+      "custom_registers"          => "(min) on Registers",
+      "custom_tasks"              => "(min) on Tasks",
+      "custom_person_core"        => "(min) on People",
+      "custom_person_core_create" => "(min) Create People?",
+      "custom_person_core_edit"   => "(min) Edit People?",
+      "custom_person_details"     => "(min) on People Schema Details",
+      "custom_person_account"     => "(min) on Users",
+      "custom_person_abilities"   => "(min) on Users' Abilities"
+    })
+  end
+
 end

data/lib/eco/cli/config/default/options.rb

@@ -2,7 +2,12 @@ ASSETS.cli.config do |cnf|
   cnf.options_set do |options_set, options|
     options_set.add("--help", "Offers a HELP") do |options, sesssion|
       conf   = ASSETS.cli.config
-      active = Proc.new {|opt| SCR.get_arg(opt) && SCR.get_arg(opt, with_param: true)}
+      active = Proc.new do |opt|
+        if there = SCR.get_arg(opt)
+          refine = SCR.get_arg(opt, with_param: true)
+        end
+        refine || there
+      end
 
       if hpf = active.call("-filters")
         puts conf.people_filters.help(refine: hpf)

data/lib/eco/cli/config/filters.rb

@@ -18,7 +18,7 @@ module Eco
           [msg].yield_self do |lines|
             max_len = keys_max_len(@filters.keys)
             @filters.keys.sort.select do |key|
-              refine.is_a?(String) && key.include?(refine)
+              !refine.is_a?(String) || key.include?(refine)
             end.each do |key|
               lines << help_line(key, @description[key], max_len)
             end

data/lib/eco/cli/config/options_set.rb

@@ -25,7 +25,7 @@ module Eco
               str_indent = is_general ? "" : " " * indent
               lines << help_line(namespace, "", max_len) unless is_general
               options_set(namespace).select do |arg, option|
-                refine.is_a?(String) && option.name.include?(refine)
+                !refine.is_a?(String) || option.name.include?(refine)
               end.each do |arg, option|
                 lines << help_line(" " * indent + "#{option.name}", option.description, max_len)
               end

data/lib/eco/cli/config/use_cases.rb

@@ -34,7 +34,7 @@ module Eco
           ["The following are the available use cases#{refinement}:"].yield_self do |lines|
             max_len = keys_max_len(@linked_cases.keys)
             @linked_cases.keys.sort.select do |key|
-              refine.is_a?(String) && key.include?(refine)
+              !refine.is_a?(String) || key.include?(refine)
             end.each do |option_case|
               lines << help_line(option_case, @linked_cases[option_case].description, max_len)
             end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.26"
+  VERSION = "2.0.31"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.26
+  version: 2.0.31
 platform: ruby
 authors:
 - Oscar Segura