cucumber/spec/cucumber/runtime/ast_tree_walker/event_spec.js

The official JavaScript implementation of Cucumber.

require('../../../support/spec_helper');

describe("Cucumber.Runtime.AstTreeWalker.Event", function() {
  var Cucumber = requireLib('cucumber');

  describe("non-instance method", function() {
  });

  describe("instance method", function() {
    var event, name, payload;

    beforeEach(function() {
      name = "SomeEvent";
      payloadItems = [
        createSpy("First payload item"),
        createSpy("Second payload item"),
        createSpy("Third payload item")
      ];
      payload = {
        firstItem:  payloadItems[0],
        secondItem: payloadItems[1],
        thirdItem:  payloadItems[2]
      };
      event = Cucumber.Runtime.AstTreeWalker.Event(name, payload);
    });

    describe("getName()", function() {
      it("returns the name of the event", function() {
        expect(event.getName()).toBe(name);
      });
    });

    describe("replicateAsPreEvent()", function() {
      var preEvent;

      beforeEach(function() {
        preEvent = createSpy("Pre-event (before)");
        spyOn(Cucumber.Runtime.AstTreeWalker, 'Event').andReturn(preEvent);
      });

      it("creates a new event with the before prefix prepended to the event name and the same payload", function() {
        var newName = Cucumber.Runtime.AstTreeWalker.BEFORE_EVENT_NAME_PREFIX + name;
        event.replicateAsPreEvent();
        expect(Cucumber.Runtime.AstTreeWalker.Event).toHaveBeenCalledWith(newName, payload);
      });

      it("returns the new event", function() {
        expect(event.replicateAsPreEvent()).toBe(preEvent);
      });
    });

    describe("replicateAsPostEvent()", function() {
      var postEvent;

      beforeEach(function() {
        postEvent = createSpy("Post-event (after)");
        spyOn(Cucumber.Runtime.AstTreeWalker, 'Event').andReturn(postEvent);
      });

      it("creates a new event with the after prefix prepended to the event name and the same payload", function() {
        var newName = Cucumber.Runtime.AstTreeWalker.AFTER_EVENT_NAME_PREFIX + name;
        event.replicateAsPostEvent();
        expect(Cucumber.Runtime.AstTreeWalker.Event).toHaveBeenCalledWith(newName, payload);
      });

      it("returns the new event", function() {
        expect(event.replicateAsPostEvent()).toBe(postEvent);
      });
    });

    describe("getPayloadItem()", function() {
      it("returns the requested item from the payload", function() {
        expect(event.getPayloadItem('firstItem')).toBe(payloadItems[0]);
        expect(event.getPayloadItem('secondItem')).toBe(payloadItems[1]);
        expect(event.getPayloadItem('thirdItem')).toBe(payloadItems[2]);
      });

      it("returns undefined when the item does not exist in the payload", function() {
        expect(event.getPayloadItem('unknownItem')).toBeUndefined();
      });
    });

    describe("occurredOn()", function() {
      it("returns true when the received event name matches the actual event name", function() {
        expect(event.occurredOn(name)).toBeTruthy();
      });

      it("returns false when the received event name does not match the actual event name", function() {
        expect(event.occurredOn("SomeOtherEvent")).toBeFalsy();
      });
    });

    describe("occurredAfter()", function() {
      beforeEach(function() {
        var afterName = Cucumber.Runtime.AstTreeWalker.AFTER_EVENT_NAME_PREFIX + name;
        event = Cucumber.Runtime.AstTreeWalker.Event(afterName, payload);
      });

      it("returns true when the received event name prefixed by the 'after' keyword matches the actual event name", function() {
        expect(event.occurredAfter(name)).toBeTruthy();
      });

      it("returns false when the received event name prefixed by the 'after' keyword does not match the actual event name", function() {
        expect(event.occurredAfter('SomeOtherEvent')).toBeFalsy();
      });
    });
  });
});