Class: Eco::API::Common::People::PersonEntry
- Inherits:
-
Object
- Object
- Eco::API::Common::People::PersonEntry
- Defined in:
- lib/eco/api/common/people/person_entry.rb
Instance Method Summary collapse
- #default_tag ⇒ Object
- #default_tag? ⇒ Boolean
-
#email ⇒ String?
The email of this person if defined.
- #email? ⇒ Boolean
-
#external_entry ⇒ Hash
Entry
Hash
with external attribute names, and values and types thereof. -
#external_id ⇒ String?
The external id of this person if defined.
- #external_id? ⇒ Boolean
- #filter_tags ⇒ Object
- #filter_tags? ⇒ Boolean
-
#final_entry ⇒ Hash
Entry
Hash
with internal attribute names, values and types. -
#id ⇒ String?
The internal id of this person if defined.
- #id? ⇒ Boolean
-
#identify ⇒ String
Provides a reference to this person entry.
-
#idx ⇒ Integer
The entry number in the input file.
-
#initialize(data, person_parser:, attr_map:, dependencies: {}, logger: ::Logger.new(IO::NULL)) ⇒ PersonEntry
constructor
This class is meant to provide a common interface to access entries of source data that come in different formats.
-
#internal_entry ⇒ Hash
Entry
Hash
with internal attribute names and values, but external types. -
#mapped_entry ⇒ Hash
Entry
Hash
with internal attribute names, but external types and values. -
#name ⇒ String?
The name of this person if defined.
- #name? ⇒ Boolean
-
#new(data) ⇒ PersonEntry
Generates a new entry.
-
#parsing? ⇒ Boolean
To know if currently the object is in parse or serialize mode.
- #policy_group_ids ⇒ Object
- #policy_group_ids? ⇒ Boolean
-
#serializing? ⇒ Boolean
To know if currently the object is in parse or serialize mode.
-
#set_account(person, exclude: nil) ⇒ Object
Setter to fill in the
account
properties of thePerson
that are present in theEntry
. -
#set_core(person, exclude: nil) ⇒ Object
Setter to fill in all the
core
properties of thePerson
that are present in theEntry
. -
#set_details(person, exclude: nil) ⇒ Object
TO DO: use person.details.schema_id to switch @emap and @person_parser (or just crash if they don't match?) Setter to fill in all the schema
details
fields of thePerson
that are present in theEntry
. -
#supervisor_id ⇒ String?
The supervisor id of this person if defined.
- #supervisor_id=(value) ⇒ Object
- #supervisor_id? ⇒ Boolean
-
#to_s(options) ⇒ String
Provides a reference of this person entry.
Constructor Details
#initialize(data, person_parser:, attr_map:, dependencies: {}, logger: ::Logger.new(IO::NULL)) ⇒ PersonEntry
- if
data
is aPerson
object, its behaviour isserialise
. - if
data
is not aPerson
object, it does aparse
. - currently in rework, so there may be subtle differences that make it temporarily unstable (yet it is reliable).
This class is meant to provide a common interface to access entries of source data that come in different formats.
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# File 'lib/eco/api/common/people/person_entry.rb', line 17 def initialize(data, person_parser:, attr_map:, dependencies: {}, logger: ::Logger.new(IO::NULL)) raise "Constructor needs a PersonParser. Given: #{parser}" if !person_parser.is_a?(Eco::API::Common::People::PersonParser) raise "Expecting Mapper object. Given: #{attr_map}" if attr_map && !attr_map.is_a?(Eco::Data::Mapper) @source = data @person_parser = person_parser @deps = dependencies @logger = logger @attr_map = attr_map @emap = PersonEntryAttributeMapper.new(@source, person_parser: @person_parser, attr_map: @attr_map, logger: @logger) if parsing? @external_entry = __external_entry(data) @mapped_entry = __mapped_entry(@external_entry) @internal_entry = __internal_entry(@mapped_entry) @final_entry = __final_entry(@internal_entry) else # SERIALIZING @person = data @final_entry = __final_entry(@person) @internal_entry = __internal_entry(@final_entry) @mapped_entry = __mapped_entry(@internal_entry) @external_entry = __external_entry(@mapped_entry) end end |
Instance Method Details
#default_tag ⇒ Object
158 159 160 |
# File 'lib/eco/api/common/people/person_entry.rb', line 158 def default_tag final_entry["default_tag"] end |
#default_tag? ⇒ Boolean
154 155 156 |
# File 'lib/eco/api/common/people/person_entry.rb', line 154 def default_tag? final_entry.key?("default_tag") end |
#email ⇒ String?
Returns the email of this person if defined.
117 118 119 |
# File 'lib/eco/api/common/people/person_entry.rb', line 117 def email final_entry["email"] end |
#email? ⇒ Boolean
121 122 123 |
# File 'lib/eco/api/common/people/person_entry.rb', line 121 def email? final_entry.key?("email") end |
#external_entry ⇒ Hash
completely serialized entry.
Returns entry Hash
with external attribute names, and values and types thereof.
50 51 52 |
# File 'lib/eco/api/common/people/person_entry.rb', line 50 def external_entry @external_entry end |
#external_id ⇒ String?
Returns the external id of this person if defined.
99 100 101 |
# File 'lib/eco/api/common/people/person_entry.rb', line 99 def external_id final_entry["external_id"] end |
#external_id? ⇒ Boolean
103 104 105 |
# File 'lib/eco/api/common/people/person_entry.rb', line 103 def external_id? final_entry.key?("external_id") end |
#filter_tags ⇒ Object
138 139 140 |
# File 'lib/eco/api/common/people/person_entry.rb', line 138 def final_entry["filter_tags"] || [] end |
#filter_tags? ⇒ Boolean
142 143 144 |
# File 'lib/eco/api/common/people/person_entry.rb', line 142 def final_entry.key?("filter_tags") end |
#final_entry ⇒ Hash
values ready to be set to a person.
Returns entry Hash
with internal attribute names, values and types.
67 68 69 |
# File 'lib/eco/api/common/people/person_entry.rb', line 67 def final_entry @final_entry end |
#id ⇒ String?
Returns the internal id of this person if defined.
90 91 92 |
# File 'lib/eco/api/common/people/person_entry.rb', line 90 def id final_entry["id"] end |
#id? ⇒ Boolean
94 95 96 |
# File 'lib/eco/api/common/people/person_entry.rb', line 94 def id? final_entry.key?("id") end |
#identify ⇒ String
Provides a reference to this person entry.
164 165 166 167 |
# File 'lib/eco/api/common/people/person_entry.rb', line 164 def identify str_id = id ? "id: '#{id}'; " : "" "(row: #{idx}) '#{name}' (#{str_id}ext_id: '#{external_id}'; email: '#{email}')" end |
#idx ⇒ Integer
Eco::API::Common::People::EntryFactory#entries
adds this idx
(i.e. row number)
Returns the entry number in the input file.
85 86 87 |
# File 'lib/eco/api/common/people/person_entry.rb', line 85 def idx final_entry["idx"] end |
#internal_entry ⇒ Hash
just one step away from being completely parsed (only types parsing pending).
Returns entry Hash
with internal attribute names and values, but external types.
56 57 58 |
# File 'lib/eco/api/common/people/person_entry.rb', line 56 def internal_entry @internal_entry end |
#mapped_entry ⇒ Hash
Returns entry Hash
with internal attribute names, but external types and values.
61 62 63 |
# File 'lib/eco/api/common/people/person_entry.rb', line 61 def mapped_entry @mapped_entry end |
#name ⇒ String?
Returns the name of this person if defined.
108 109 110 |
# File 'lib/eco/api/common/people/person_entry.rb', line 108 def name final_entry["name"] end |
#name? ⇒ Boolean
112 113 114 |
# File 'lib/eco/api/common/people/person_entry.rb', line 112 def name? final_entry.key?("name") end |
#new(data) ⇒ PersonEntry
Generates a new entry
44 45 46 |
# File 'lib/eco/api/common/people/person_entry.rb', line 44 def new(data) self.class.new(data, person_parser: @person_parser, attr_map: @attr_map, dependencies: @deps, logger: @logger) end |
#parsing? ⇒ Boolean
To know if currently the object is in parse or serialize mode.
73 74 75 |
# File 'lib/eco/api/common/people/person_entry.rb', line 73 def parsing? !@source.is_a?(Ecoportal::API::Internal::Person) end |
#policy_group_ids ⇒ Object
146 147 148 |
# File 'lib/eco/api/common/people/person_entry.rb', line 146 def policy_group_ids final_entry["policy_group_ids"] || [] end |
#policy_group_ids? ⇒ Boolean
150 151 152 |
# File 'lib/eco/api/common/people/person_entry.rb', line 150 def policy_group_ids? final_entry.key?("policy_group_ids") end |
#serializing? ⇒ Boolean
To know if currently the object is in parse or serialize mode.
79 80 81 |
# File 'lib/eco/api/common/people/person_entry.rb', line 79 def serializing? !parsing? end |
#set_account(person, exclude: nil) ⇒ Object
it only sets those account properties defined in the entry. Meaning that if an account property is not present in the entry, this will not be set on the target person.
Setter to fill in the account
properties of the Person
that are present in the Entry
.
211 212 213 214 215 216 217 |
# File 'lib/eco/api/common/people/person_entry.rb', line 211 def set_account(person, exclude: nil) person.account = {} if !person.account 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 end |
#set_core(person, exclude: nil) ⇒ Object
- it only sets those core properties defined in the entry. Meaning that if an core property is not present in the entry, this will not be set on the target person.
- if there's an incorrect email exception, it blanks the email and logs a warning message
Setter to fill in all the core
properties of the Person
that are present in the Entry
.
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/eco/api/common/people/person_entry.rb', line 190 def set_core(person, exclude: nil) 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) rescue Exception => e if attr == "email" logger.error(e.to_s + " - setting blank email instead.") set_part(person, attr, nil) else raise end end end end |
#set_details(person, exclude: nil) ⇒ Object
it only sets those details properties defined in the entry. Meaning that if an details property is not present in the entry, this will not be set on the target person.
TO DO: use person.details.schema_id to switch @emap and @person_parser (or just crash if they don't match?)
Setter to fill in all the schema details
fields of the Person
that are present in the Entry
.
225 226 227 228 229 230 231 |
# File 'lib/eco/api/common/people/person_entry.rb', line 225 def set_details(person, exclude: nil) person.add_details(@person_parser.schema) if !person.details || !person.details.schema_id 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 end |
#supervisor_id ⇒ String?
Returns the supervisor id of this person if defined.
126 127 128 |
# File 'lib/eco/api/common/people/person_entry.rb', line 126 def supervisor_id final_entry["supervisor_id"] end |
#supervisor_id=(value) ⇒ Object
130 131 132 |
# File 'lib/eco/api/common/people/person_entry.rb', line 130 def supervisor_id=(value) final_entry["supervisor_id"] = value end |
#supervisor_id? ⇒ Boolean
134 135 136 |
# File 'lib/eco/api/common/people/person_entry.rb', line 134 def supervisor_id? final_entry.key?("supervisor_id") end |
#to_s(options) ⇒ String
Provides a reference of this person entry.
171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/eco/api/common/people/person_entry.rb', line 171 def to_s() = into_a() case when .include?(:identify) identify else final_entry.each.map do |k, v| "'#{k}': '#{v.to_json}'" end.join(" | ") end end |