Implementing 'is' methods to classes related to view and to model #1736

msamsel · 2019-05-10T12:48:38Z

Suggested merge commit message (convention)

Other: Implementing 'is' method to classes related to view and model. Closes ckeditor/ckeditor5#4479 .

coveralls · 2019-05-10T12:53:52Z

Coverage remained the same at 100.0% when pulling f33f445 on t/1667 into 44068ac on master.

Reinmar · 2019-05-22T12:34:16Z

src/model/rootelement.js

@@ -58,10 +58,11 @@ export default class RootElement extends Element {
 	 * @inheritDoc
 	 */
 	is( type, name ) {
+		const cutType = type.replace( 'model:', '' );


Missing blank line after var def.

Also, what's "cut type"?

It's type without module: at the beginning to simplify logic in further lines.
Statement like:

( ( type == 'rootElement' || type == 'module:rootElement' ) && name == this.name ) || super.is( type, name );

seems to be a little to complex in my opinion.

Reinmar · 2019-05-22T12:37:46Z

I'm unsure whether we need this method on classes such as Batch, Model, Differ, Schema. I think that the rule of thumb could be that if there's no instanceof X yet (anywhere), it's unnecessary.

WDYT, @scofalik @pjasiun?

msamsel · 2019-05-29T10:15:31Z

I'm unsure whether we need this method on classes such as Batch, Model, Differ, Schema. I think that the rule of thumb could be that if there's no instanceof X yet (anywhere), it's unnecessary.

@Reinmar, should I remove is() method from mentioned classes and put this PR on review again?

pjasiun · 2019-05-29T10:23:57Z

I'm unsure whether we need this method on classes such as Batch, Model, Differ, Schema.

It does not make sense to have is method there.

scofalik · 2019-05-29T10:24:05Z

As a rule of thumb, I'd say that we need those methods where we need those methods.

Reinmar · 2019-05-29T10:50:02Z

@Reinmar, should I remove is() method from mentioned classes and put this PR on review again?

Can you check which classes are used with instanceof and which not? We need this method for objects that we know we that we needed or may need to check the type of.

scofalik · 2019-05-29T11:02:43Z

Basically, classes like Differ or Schema aren't similar to other classes and are not returned / expected as a parameter next to (together) with other classes, so we don't need .is() for them cause we always know what are we dealing with. There's nothing like function foo( modelOrDocument ).

msamsel · 2019-05-29T12:39:34Z

Can you check which classes are used with instanceof and which not? We need this method for objects that we know we that we needed or may need to check the type of.

I take only set from engine as there is no other place where we check for model/view classes.

instanceof Array
instanceof AttributeElement
instanceof CKEditorError
instanceof DocumentFragment
instanceof DocumentSelection
instanceof DropdownButtonView
instanceof EditableElement
instanceof Element
instanceof EventInfo
instanceof FileLoader
instanceof Function
instanceof HTMLElement
instanceof HTMLTextAreaElement
instanceof Marker
instanceof Model
instanceof ModelDocumentFragment
instanceof ModelElement
instanceof ModelPosition
instanceof ModelRange
instanceof ModelSelection
instanceof Node
instanceof NodeList
instanceof Position
instanceof Promise
instanceof ProxyEmitter
instanceof Range
instanceof RegExp
instanceof RootElement
instanceof SchemaContext
instanceof Selection
instanceof SwitchButtonView
instanceof Template
instanceof TemplateBinding
instanceof TemplateIfBinding
instanceof Text
instanceof TextProxy
instanceof View
instanceof ViewCollection
instanceof ViewText

Reinmar · 2019-05-29T12:59:31Z

instanceof TemplateBinding

This is ckeditor5-ui. Could you limit this list to the things from ckeditor5-engine/src only? I mean – instanceof calls used in code located in ckeditor5-engine/src but also instanceof checks outside the engine which check stuff from the engine.

Reinmar · 2019-05-29T13:00:23Z

Also, please exclude any code from src/dev-utils from this check.

msamsel · 2019-05-30T08:12:06Z

instanceof AttributeElement
instanceof DocumentFragment
instanceof DocumentSelection
instanceof EditableElement
instanceof Element
instanceof Marker
instanceof ModelElement
instanceof ModelRange
instanceof ModelSelection
instanceof Node
instanceof NodeList
instanceof Position
instanceof Range
instanceof SchemaContext
instanceof Selection
instanceof Text
instanceof TextProxy
instanceof ViewText

scofalik · 2019-05-30T08:17:17Z

I'd guess that SchemaContext and NodeList are used together with Arrays. I wonder if we need .is() there if that's the case.

msamsel · 2019-05-30T08:22:55Z

@scofalik only those entries exists for those two:

ckeditor5-engine/src/model/schema.js

Line 1073 in 1fbee48

if ( context instanceof SchemaContext ) {

ckeditor5-engine/src/model/writer.js

Line 195 in 694ee89

    
           } else if ( nodes[ i ] instanceof DocumentFragment || nodes[ i ] instanceof NodeList ) {

Reinmar · 2019-05-30T09:02:46Z

Agree with @scofalik .SchemaContext and NodeList are mostly internal. So we can exclude those.

Reinmar · 2019-05-30T09:05:42Z

So, to conclude:

all types of view and model nodes,
selection, doc selection, range, position classes,
marker,
text proxy,
doc frags

And that's all for now.

msamsel · 2019-06-26T12:56:47Z

I've adjusted scope of this PR to cover only mentioned classes.

Reinmar · 2019-07-22T11:38:23Z

src/model/liverange.js

@@ -40,6 +40,13 @@ export default class LiveRange extends Range {
 		this.stopListening();
 	}

+	/**
+	 * @inheritDoc


You send people to Range#is() which documents that:

Checks whether given object is of range type.

Which means that you still don't know how to use this method to check for a live range

Reinmar · 2019-07-22T11:39:45Z

src/model/position.js

+	/**
+	 * Checks whether given object is of `position` type.
+	 *
+	 * Read more at {@link module:engine/model/node~Node#is `Node#is()`}.


Sending people to Node#is() from Position (which isn't a node) seems confusing.

But see my other comment below about mentioning that this is a convention.

src/view/attributeelement.js

Reinmar · 2019-07-22T11:41:21Z

src/view/downcastwriter.js

-     * @param {module:engine/view/attributeelement~AttributeElement} attribute Attribute element to use as wrapper.
-     * @returns {module:engine/view/range~Range} range Range after wrapping, spanning over wrapping attribute element.
-    */
+	 * Wraps elements within range with provided {@link module:engine/view/attributeelement~AttributeElement AttributeElement}.


Why touching this file in this PR?

At the first stage when I add is() method, my editor fix those spaces by replacing them with tabs. So it sees to be leftover. I'll revert it.

Reinmar · 2019-07-22T11:43:01Z

src/view/range.js

@@ -394,6 +394,17 @@ export default class Range {
 		}
 	}

+	/**
+	 * Checks whether given object is of `range` type following the convention set by


This wording is a lot better. I complained in the other place that you link to Node#is() without much of an explanation. Saying that "following the convention set by" is a good way out.

Reinmar

Requires documentation polishing.

Please build the API docs and try to read them as the developer would. Land in various places in these API docs and try to figure out whether it's clear from the method description how to use it.

Co-Authored-By: Piotrek Koszuliński <pkoszulinski@gmail.com>

msamsel · 2019-07-26T15:00:18Z

I've rewritten the description. I hope it's better now. :)

Reinmar · 2019-08-09T14:54:29Z

Yes, it's definitely better. But there's now a lot of repetition of things which can be centralised. It's hard to find the place where this method could be described in a bit deeper way, but Node#is sounds acceptable. In all other places, I'd keep the documentation as short as possible, but still very easy to parse thanks to examples. Because of them you don't have to necessarily go to any other place to understand how to use it. But you can if you want more details.

I applied changes to a couple of model objects. Could you update all the other model objects and the view ones accordingly?

Reinmar

As commented.

Reinmar reviewed May 22, 2019

View reviewed changes

Reinmar added the status:review- label May 22, 2019

msamsel force-pushed the t/1667 branch from 5ca03bd to f8f14eb Compare June 18, 2019 07:28

msamsel force-pushed the t/1667 branch from a2e8e3f to b73f43d Compare June 26, 2019 12:36

msamsel requested a review from Reinmar June 26, 2019 12:56

msamsel removed the status:review- label Jun 26, 2019

msamsel force-pushed the t/1667 branch from 4e9392a to 6bbdcf2 Compare June 26, 2019 13:11

Mateusz Samsel added 7 commits July 5, 2019 13:35

Add 'is' method to model's classes.

3816afb

Add unit test for 'is' methods.

b8c10d8

Replace spaces with tabs.

960bb38

Remove checks for no parameters, as those shouldn't be supported.

87dc29b

Add and update 'is()' method for view components.

cfe3b86

Fix editableelement test to actually use EditableElement class.

146bd43

Add unit tests for view components.

9d80ec3

Reinmar reviewed Jul 22, 2019

View reviewed changes

src/view/attributeelement.js Outdated Show resolved Hide resolved

Reinmar reviewed Jul 22, 2019

View reviewed changes

Reinmar added the status:review- label Jul 22, 2019

Reinmar suggested changes Jul 22, 2019

View reviewed changes

msamsel and others added 3 commits July 25, 2019 11:47

Apply suggestions from code review

76f8a51

Co-Authored-By: Piotrek Koszuliński <pkoszulinski@gmail.com>

Revert change replacing spaces to tabs.

0fb8821

Update docs for View, and replace trig with regexp in is() method.

3aa2407

msamsel force-pushed the t/1667 branch from 4d2d0ab to 3aa2407 Compare July 26, 2019 14:38

Improve description to model's is method.

887ba88

msamsel requested a review from Reinmar July 26, 2019 14:59

Merge branch 'master' into t/1667

2ef7d9e

msamsel removed the status:review- label Jul 29, 2019

Reinmar added 2 commits August 8, 2019 11:34

Merge branch 'master' into t/1667

de6f1a2

Refined the documentation.

f33f445

Reinmar added the status:review- label Aug 9, 2019

Reinmar suggested changes Aug 9, 2019

View reviewed changes

Mateusz Samsel added 4 commits August 12, 2019 12:01

Fix wrong example in docs.

96f6213

Correct description for models' classes.

a1885ed

Improve docs for views classes.

45c4c87

Minor changes in samples for is() method.

78e28c2

msamsel requested a review from Reinmar August 13, 2019 09:48

msamsel removed the status:review- label Aug 13, 2019

Merge branch 'master' into t/1667

4315a6b

Reinmar merged commit 89dbe43 into master Aug 14, 2019

Reinmar deleted the t/1667 branch August 14, 2019 12:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implementing 'is' methods to classes related to view and to model #1736

Implementing 'is' methods to classes related to view and to model #1736

msamsel commented May 10, 2019 •

edited by pomek

Loading

coveralls commented May 10, 2019 •

edited

Loading

Reinmar May 22, 2019

Reinmar May 22, 2019

msamsel May 22, 2019

Reinmar commented May 22, 2019

msamsel commented May 29, 2019

pjasiun commented May 29, 2019

scofalik commented May 29, 2019

Reinmar commented May 29, 2019

scofalik commented May 29, 2019 •

edited

Loading

msamsel commented May 29, 2019

Reinmar commented May 29, 2019

Reinmar commented May 29, 2019

msamsel commented May 30, 2019

scofalik commented May 30, 2019

msamsel commented May 30, 2019

Reinmar commented May 30, 2019

Reinmar commented May 30, 2019

msamsel commented Jun 26, 2019

Reinmar Jul 22, 2019

Reinmar Jul 22, 2019

Reinmar Jul 22, 2019

Reinmar Jul 22, 2019

msamsel Jul 25, 2019

Reinmar Jul 22, 2019

Reinmar left a comment

msamsel commented Jul 26, 2019

Reinmar commented Aug 9, 2019

Reinmar left a comment

Implementing 'is' methods to classes related to view and to model #1736

Implementing 'is' methods to classes related to view and to model #1736

Conversation

msamsel commented May 10, 2019 • edited by pomek Loading

Suggested merge commit message (convention)

coveralls commented May 10, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Reinmar commented May 22, 2019

msamsel commented May 29, 2019

pjasiun commented May 29, 2019

scofalik commented May 29, 2019

Reinmar commented May 29, 2019

scofalik commented May 29, 2019 • edited Loading

msamsel commented May 29, 2019

Reinmar commented May 29, 2019

Reinmar commented May 29, 2019

msamsel commented May 30, 2019

scofalik commented May 30, 2019

msamsel commented May 30, 2019

Reinmar commented May 30, 2019

Reinmar commented May 30, 2019

msamsel commented Jun 26, 2019

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

Reinmar left a comment

Choose a reason for hiding this comment

msamsel commented Jul 26, 2019

Reinmar commented Aug 9, 2019

Reinmar left a comment

Choose a reason for hiding this comment

msamsel commented May 10, 2019 •

edited by pomek

Loading

coveralls commented May 10, 2019 •

edited

Loading

scofalik commented May 29, 2019 •

edited

Loading