Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Remove default value of offset parameter from model methods.
Browse files Browse the repository at this point in the history
  • Loading branch information
jodator committed Oct 4, 2018
1 parent a740dbd commit 8b1e410
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 11 deletions.
4 changes: 2 additions & 2 deletions src/model/position.js
Original file line number Diff line number Diff line change
Expand Up @@ -816,7 +816,7 @@ export default class Position {
* * {@link module:engine/model/position~Position.createFromPosition}.
*
* @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} offset Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* first parameter is a {@link module:engine/model/item~Item model item}.
*/
static createAt( itemOrPosition, offset ) {
Expand All @@ -834,7 +834,7 @@ export default class Position {
} else if ( offset !== 0 && !offset ) {
throw new CKEditorError(
'model-position-createAt-required-second-parameter: ' +
'Position.createAt requires the second parameter offset.' );
'Position.createAt requires the second parameter offset when first parameter is a model item.' );
}

return this.createFromParentAndOffset( node, offset );
Expand Down
2 changes: 1 addition & 1 deletion src/model/range.js
Original file line number Diff line number Diff line change
Expand Up @@ -824,7 +824,7 @@ export default class Range {
* or on the given {@link module:engine/model/item~Item item}.
*
* @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* first parameter is a {@link module:engine/model/item~Item model item}.
*/
static createCollapsedAt( itemOrPosition, offset ) {
Expand Down
2 changes: 1 addition & 1 deletion src/model/selection.js
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ export default class Selection {
*
* @fires change:range
* @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* first parameter is a {@link module:engine/model/item~Item model item}.
*/
setFocus( itemOrPosition, offset ) {
Expand Down
8 changes: 4 additions & 4 deletions src/model/writer.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ export default class Writer {
* @param {module:engine/model/item~Item|module:engine/model/documentfragment~DocumentFragment} item Item or document
* fragment to insert.
* @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* second parameter is a {@link module:engine/model/item~Item model item}.
*/
insert( item, itemOrPosition, offset = 0 ) {
Expand Down Expand Up @@ -230,7 +230,7 @@ export default class Writer {
* @param {String} data Text data.
* @param {Object} [attributes] Text attributes.
* @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* third parameter is a {@link module:engine/model/item~Item model item}.
*/
insertText( text, attributes, itemOrPosition, offset ) {
Expand Down Expand Up @@ -262,7 +262,7 @@ export default class Writer {
* @param {String} name Name of the element.
* @param {Object} [attributes] Elements attributes.
* @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* third parameter is a {@link module:engine/model/item~Item model item}.
*/
insertElement( name, attributes, itemOrPosition, offset ) {
Expand Down Expand Up @@ -440,7 +440,7 @@ export default class Writer {
*
* @param {module:engine/model/range~Range} range Source range.
* @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* second parameter is a {@link module:engine/model/item~Item model item}.
*/
move( range, itemOrPosition, offset ) {
Expand Down
2 changes: 1 addition & 1 deletion src/view/position.js
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ export default class Position {
} else if ( offset !== 0 && !offset ) {
throw new CKEditorError(
'view-position-createAt-required-second-parameter: ' +
'Position.createAt requires the second parameter offset.' );
'Position.createAt requires the second parameter offset when first parameter is a view item.' );
}

return new Position( node, offset );
Expand Down
2 changes: 1 addition & 1 deletion tests/model/position.js
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ describe( 'Position', () => {
} );

describe( 'createAt()', () => {
it( 'should throw if uknown offset is passed', () => {
it( 'should throw if no offset is passed', () => {
expect( () => Position.createAt( ul ) ).to.throw( CKEditorError, /model-position-createAt-required-second-parameter/ );
} );

Expand Down
8 changes: 7 additions & 1 deletion tests/view/position.js
Original file line number Diff line number Diff line change
Expand Up @@ -152,12 +152,18 @@ describe( 'Position', () => {
} );

describe( 'createAt', () => {
it( 'should throw if no offset is passed', () => {
const element = new Element( 'p' );

expect( () => Position.createAt( element ) ).to.throw( CKEditorError, /view-position-createAt-required-second-parameter/ );
} );

it( 'should create positions from positions', () => {
const spy = sinon.spy( Position, 'createFromPosition' );

const p = new Element( 'p' );
const position = new Position( p, 0 );
const created = Position.createAt( position );
const created = Position.createAt( position, 0 );

expect( created.isEqual( position ) ).to.be.true;
expect( spy.calledOnce ).to.be.true;
Expand Down

0 comments on commit 8b1e410

Please sign in to comment.