openmct/platform/features/timeline/test/controllers/drag/TimelineSnapHandlerSpec.js

/*****************************************************************************
 * Open MCT Web, Copyright (c) 2009-2015, United States Government
 * as represented by the Administrator of the National Aeronautics and Space
 * Administration. All rights reserved.
 *
 * Open MCT Web is licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Open MCT Web includes source code licensed under additional open source
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/

define(
    ['../../../src/controllers/drag/TimelineSnapHandler'],
    function (TimelineSnapHandler) {

        describe("A Timeline snap handler", function () {
            var mockDragHandler,
                handler;

            beforeEach(function () {
                var starts = { a: 1000, b: 2000, c: 2500, d: 2600 },
                    ends = { a: 2050, b: 3000, c: 2700, d: 10000 };

                mockDragHandler = jasmine.createSpyObj(
                    'dragHandler',
                    ['start', 'end', 'ids']
                );

                mockDragHandler.ids.andReturn(['a', 'b', 'c', 'd']);
                mockDragHandler.start.andCallFake(function (id) {
                    return starts[id];
                });
                mockDragHandler.end.andCallFake(function (id) {
                    return ends[id];
                });

                handler = new TimelineSnapHandler(mockDragHandler);
            });

            it("provides a preferred snap location within tolerance", function () {
                expect(handler.snap(2511, 15, 'a')).toEqual(2500); // c's start
                expect(handler.snap(2488, 15, 'a')).toEqual(2500); // c's start
                expect(handler.snap(10, 1000, 'b')).toEqual(1000); // a's start
                expect(handler.snap(2711, 20, 'd')).toEqual(2700); // c's end
            });

            it("excludes provided id from snapping", function () {
                // Don't want objects to snap to themselves, so we need
                // this exclusion.
                expect(handler.snap(2010, 50, 'b')).toEqual(2050); // a's end
                // Verify that b's start would have been used had the
                // id not been provided
                expect(handler.snap(2010, 50, 'd')).toEqual(2000);
            });

            it("snaps to the closest point, when multiple match", function () {
                // 2600 and 2700 (plus others) are both in range here
                expect(handler.snap(2651, 1000, 'a')).toEqual(2700);
            });

            it("does not snap if no points are within tolerance", function () {
                // Closest are 1000 and 2000, which are well outside of tolerance
                expect(handler.snap(1503, 100, 'd')).toEqual(1503);
            });

        });
    }
);