New index.js (tiny JS) for OOP Exercise #342

Levi123 · 2022-08-29T11:10:28Z

OOP exercise

Demo |
Code base

The code is submitted in a dedicated feature branch.

Only code files are submitted.

Please, review.

github-actions · 2022-08-29T15:17:02Z

Hey!

Congratulations on your PR! 😎😎😎

Let's do some self-checks to fix most common issues and to make some improvements to the code before reviewers put their hands on the code.

Go through the requirements/most common mistakes listed/linked below and fix the code as appropriate.

If you have any questions to requirements/common mistakes feel free asking them here or in Students' chat.

When you genuinely believe you are done put a comment stating that you have completed self-checks and fixed code accordingly.

Also, be aware, that if you would silently ignore this recommendation, a mentor can think that you are still working on fixes. And your PR will not be reviewed. 😒

A Tiny JS World -- OOP exercise check list

Relates to A Tiny JS World OOP exercise.

Check-list - definition of done

Minimal requirements to meet:

Optional level up (not required to implement):

Friends list is a list of objects refs rather than names (strings)
Cat-woman class is built employing composition rather than inheritance only

Bonus:

toString magic method; when implemented print(inhabitant) does the job as .toString is called implicitly
this.constructor.name; when used for output then no need to store species property

Helpful resources:

Universal recommendations:

Give variables and functions meaningful names. Avoid generic names like item, element, key, object, array or their variations. Exception: helper functions that are specifically and intentionally designed to be multipurpose.
Function names should start with a verb as they denote actions; variables are normally nouns; boolean variables/functions start with is, does, has etc; variable containing multiple entities and functions returning lists contain entity name in plural form.
Have consistent code style and formatting. Employ Prettier to do all dirty work for you.
Use common sense or seek for an advice whenever requirements look ambiguous or unclear.

Also take a note of the requirements above and follow them in all your future projects.

By the way, you may proceed to the next task before this one is reviewed and merged.

Sincerely yours,
Submissions Kottachecker 😺

Levi123 · 2022-08-31T13:39:28Z

@OleksiyRudenko I'm ready to check

Levi123 · 2022-09-05T10:48:38Z

@OleksiyRudenko Hello? tell me, are you all right? when will you be able to give feedback? Thank you.

OleksiyRudenko

@Levi123 need to make the code OOP compliant.

If two classes have the same property then they need a common base class that handles this shared property.
This will be OOP-compliant and will make the code DRY.

Also see comments below.

OleksiyRudenko · 2022-09-05T12:38:05Z

submissions/Levi123/oop-exercise/index.js

+const allResidents = [woman, man, dog, cat, catWoman]
+
+function printAllResidents(allResidentsArray) {
+   for (let i = 0; i < allResidentsArray.length; i++){


Why not an Array method to loop through the residents?

OleksiyRudenko · 2022-09-05T12:39:04Z

submissions/Levi123/oop-exercise/index.js

+
+function printAllResidents(allResidentsArray) {
+   for (let i = 0; i < allResidentsArray.length; i++){
+      const prop = Object.keys(allResidentsArray[i]);


From the checklist:

Object methods like keys, values, entries as well as for...in shouldn't be used as these do not guarantee any particular order of keys/values

From the checklist:

Object methods like keys, values, entries as well as for...in shouldn't be used as these do not guarantee any particular order of keys/values

Done

OleksiyRudenko

@Levi123 there are improvements, although in other parts the code became less clear.
Note that a comment can relate to multiple similar code fragments. You will need to extrapolate it by yourself.

Check the comments below. Double-check yourself against the checklist posted by bot and refer to the learning materials if needed.

OleksiyRudenko · 2022-09-05T20:30:42Z

submissions/Levi123/oop-exercise/index.js

+class Human extends Entity {
+   constructor(options){
+      super(options);
+      this.species = 'Human';


From the checklist

A parent class shouldn't know anything about its children's props. Child classes must have good reasons to assign or refer to any parent's props. There are no such reasons in this task. Method overloading is to the rescue when building an inhabitant's presentation string.

OleksiyRudenko · 2022-09-05T20:36:55Z

submissions/Levi123/oop-exercise/index.js

+// }
+
+class Entity {
+   constructor (options){


Code is written for other people.
As a peer developer I am tasked to add a class that extends entity. In our team we are used to rely on code editors intellisense. Having current constructor specification it will only tell that constructor expects some "options". We would need to go through the code and read the method body to understand what is expected. As a team member you will also love when peer developers take care of you and write clear code.

At the same time if function specification is detailed there is no such need. There are methods to write self-explaining functions specifications: (1) regular list of parameters, (2) object destructuring syntax when parameters are supplied as objects. Use either of those.

Code is written for other people. As a peer developer I am tasked to add a class that extends entity. In our team we are used to rely on code editors intellisense. Having current constructor specification it will only tell that constructor expects some "options". We would need to go through the code and read the method body to understand what is expected. As a team member you will also love when peer developers take care of you and write clear code.

At the same time if function specification is detailed there is no such need. There are methods to write self-explaining functions specifications: (1) regular list of parameters, (2) object destructuring syntax when parameters are supplied as objects. Use either of those.

Object destructuring, I understood correctly?

For example:
class Entity {
constructor ({name, species, gender, saying}){
this.name = name;
this.species = species;
this.gender = gender;
this.saying = saying;
}
}

OleksiyRudenko

@Levi123 good job.
Let's leverage the power of OOP, so that you are able to use JS OOP mechanism to their full extent when a bigger project arrives.

OleksiyRudenko · 2022-09-20T11:47:06Z

submissions/Levi123/oop-exercise/index.js

+   arrayAllObjects.forEach((characters) => {
+      toPrint(characters);


Does forEach receive multiple characters or a single character on every iteration?

@OleksiyRudenko single character on every iteration

OleksiyRudenko · 2022-09-20T11:51:12Z

submissions/Levi123/oop-exercise/index.js

+const allProp = ['name', 'species', 'gender', 'saying', 'legs', 'hands', 'paws']
+
+
+function toPrint (arrayAllResidents) {
+   const propToPrint = allProp.filter((propOfObj) => arrayAllResidents[propOfObj] !== undefined)
+      .map((propOfObj) => arrayAllResidents[propOfObj]).join('; ');
+   print(propToPrint);
+}


This approach was good enough before OOP.
Following the OOP paradigm classes encapsulate properties and behaviour (properties handling).
Every class handles props it owns immediately.
Method overloading and explicit call to inherited method version via super methods are to the rescue.
Task and original project docs offer links to the materials you will find helpful in these regards.

This approach was good enough before OOP. Following the OOP paradigm classes encapsulate properties and behaviour (properties handling). Every class handles props it owns immediately. Method overloading and explicit call to inherited method version via super methods are to the rescue. Task and original project docs offer links to the materials you will find helpful in these regards.

done

OleksiyRudenko

@Levi123 great job!
Let's polish it.
Naming is important. Take learnings for any future proejcts - educational or commercial - you will contribute to.

OleksiyRudenko · 2022-09-21T12:38:47Z

submissions/Levi123/oop-exercise/index.js

+// class Animal {
+//    constructor (species, name, gender){
+//       this.species = species;
+//       this.name = name;
+//       this.gender = gender;
+//    }
+// }


Don't keep comments in production code.
Exception: comments that explain reasons behind implementation peculiarities, that cannot be understood from the code itself (e.g. we cache data because server is down often and we want users to have some data anyways)

OleksiyRudenko · 2022-09-21T12:40:50Z

submissions/Levi123/oop-exercise/index.js

+//    }
+// }
+
+class Entity {


entity is a generic term. Business domain and task requirements are a good source of naming ideas. Name should describe what entity it represents at a given level of abstraction - dog, cat, human, mammal, herbivore - in the given business domain.

OleksiyRudenko · 2022-09-21T12:41:11Z

submissions/Levi123/oop-exercise/index.js

+
+class Animal extends Entity {
+   constructor(name, gender, saying){
+      super(name, 'Animal', gender, saying);


"Animal" is not a species.

I changed the name of the main parent class entity to mammal. The animal class has a species - animals, and a person - human species I think this is not a mistake, but simply a manifestation of fantasy in this task. We do not receive a clear structure that should be followed.

OleksiyRudenko · 2022-09-21T12:41:24Z

submissions/Levi123/oop-exercise/index.js

+
+class Woman extends Human {
+   constructor(name, saying){
+      super(name, 'Woman', saying)


Men and women are the same species.

Yes, a man and a woman get one species - a person. But it has a gender property to display gender, if that's what you're after.

OleksiyRudenko

@Levi123 great job!

New index.js (tiny JS) for OOP Exercise

e62a175

OleksiyRudenko added the task-TJSW-OOP label Aug 29, 2022

OleksiyRudenko requested changes Sep 5, 2022

View reviewed changes

Remove object methods and make code OOP compliant

943acc8

Levi123 requested a review from OleksiyRudenko September 5, 2022 20:15

OleksiyRudenko requested changes Sep 5, 2022

View reviewed changes

Change method super

37c3130

OleksiyRudenko self-assigned this Sep 20, 2022

OleksiyRudenko requested changes Sep 20, 2022

View reviewed changes

call to inherited method version via super

b62f9a7

Levi123 requested a review from OleksiyRudenko September 21, 2022 09:19

Fix bug with wrong name variable

59760b4

OleksiyRudenko requested changes Sep 21, 2022

View reviewed changes

Delete comments, change entity term

75e81f2

Levi123 requested a review from OleksiyRudenko September 21, 2022 13:53

Change species value in Animal, and change gender value in Man/Woman

c064a94

OleksiyRudenko added the Stage0.1 label Oct 1, 2022

OleksiyRudenko approved these changes Oct 9, 2022

View reviewed changes

OleksiyRudenko merged commit 763d6be into kottans:main Oct 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New index.js (tiny JS) for OOP Exercise #342

New index.js (tiny JS) for OOP Exercise #342

Levi123 commented Aug 29, 2022

github-actions bot commented Aug 29, 2022

Levi123 commented Aug 31, 2022

Levi123 commented Sep 5, 2022

OleksiyRudenko left a comment

OleksiyRudenko Sep 5, 2022

Levi123 Sep 5, 2022

OleksiyRudenko Sep 5, 2022

Levi123 Sep 5, 2022

OleksiyRudenko left a comment

OleksiyRudenko Sep 5, 2022

OleksiyRudenko Sep 5, 2022

Levi123 Sep 6, 2022 •

edited

Loading

OleksiyRudenko left a comment

OleksiyRudenko Sep 20, 2022

Levi123 Sep 21, 2022

OleksiyRudenko Sep 20, 2022

Levi123 Sep 21, 2022

OleksiyRudenko left a comment •

edited

Loading

OleksiyRudenko Sep 21, 2022

Levi123 Sep 21, 2022

OleksiyRudenko Sep 21, 2022

Levi123 Sep 21, 2022

OleksiyRudenko Sep 21, 2022

Levi123 Sep 21, 2022

OleksiyRudenko Sep 21, 2022

Levi123 Sep 21, 2022

OleksiyRudenko left a comment

		arrayAllObjects.forEach((characters) => {
		toPrint(characters);

New index.js (tiny JS) for OOP Exercise #342

New index.js (tiny JS) for OOP Exercise #342

Conversation

Levi123 commented Aug 29, 2022

OOP exercise

github-actions bot commented Aug 29, 2022

A Tiny JS World -- OOP exercise check list

Check-list - definition of done

Levi123 commented Aug 31, 2022

Levi123 commented Sep 5, 2022

OleksiyRudenko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OleksiyRudenko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Levi123 Sep 6, 2022 • edited Loading

Choose a reason for hiding this comment

OleksiyRudenko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OleksiyRudenko left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OleksiyRudenko left a comment

Choose a reason for hiding this comment

Levi123 Sep 6, 2022 •

edited

Loading

OleksiyRudenko left a comment •

edited

Loading